org.dominokit.domino.ui.infoboxes

Class InfoBox

java.lang.Object

org.dominokit.domino.ui.utils.BaseDominoElement<elemental2.dom.HTMLDivElement,InfoBox>

org.dominokit.domino.ui.infoboxes.InfoBox

All Implemented Interfaces:

DominoStyle<elemental2.dom.HTMLDivElement,InfoBox,InfoBox>, HasBackground<InfoBox>, HasChildren<InfoBox>, HasWavesElement, IsCollapsible<InfoBox>, IsReadOnly<InfoBox>, org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

public class InfoBox
extends BaseDominoElement<elemental2.dom.HTMLDivElement,InfoBox>
implements HasBackground<InfoBox>, org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

Container for displaying information with icons

This component provides a container which allows showing information with icons and effects

Customize the component can be done by overwriting classes provided by InfoBoxStyles

For example:

     InfoBox.create(Icons.ALL.shopping_cart(), "NEW ORDERS", "125");
 

See Also:

BaseDominoElement, HasBackground

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InfoBox.Flip An enum representing the direction of the flip done on the icon and the title elements
static class	InfoBox.HoverEffect An enum representing the hover effect

Nested classes/interfaces inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

BaseDominoElement.ElementHandler<T>, BaseDominoElement.ResizeHandler<T>, BaseDominoElement.StyleEditor<E extends elemental2.dom.HTMLElement,T extends org.jboss.elemento.IsElement<E>>, BaseDominoElement.WavesStyler

Field Summary

Fields inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

element

Constructor Summary

Constructors

Constructor and Description
InfoBox(BaseIcon<?> icon, String title)
InfoBox(BaseIcon<?> icon, String title, String value)
InfoBox(elemental2.dom.HTMLElement icon, String title)
InfoBox(elemental2.dom.HTMLElement icon, String title, String value)

Method Summary

Modifier and Type	Method and Description
static InfoBox	create(BaseIcon<?> icon, String title) Creates info box with icon and title
static InfoBox	create(BaseIcon<?> icon, String title, String value) Creates info box with icon, title and value
static InfoBox	create(elemental2.dom.HTMLElement icon, String title) Creates info box with icon and title
static InfoBox	create(elemental2.dom.HTMLElement icon, String title, String value) Creates info box with icon element, title and value
elemental2.dom.HTMLDivElement	element()
InfoBox	flip() Changes the position of the icon and title based on the current position; i.e.
InfoBox	flipLeft() Puts the icon on the left and the title on the right
InfoBox	flipRight() Puts the icon on the right and the title on the left
DominoElement<elemental2.dom.HTMLDivElement>	getIconElement()
DominoElement<elemental2.dom.HTMLDivElement>	getTitleElement()
DominoElement<elemental2.dom.HTMLDivElement>	getValueElement()
InfoBox	removeHoverEffect() Removes the hover effects
InfoBox	removeShadow() Removes the shadow of the box
InfoBox	setBackground(Color background)
InfoBox	setHoverEffect(InfoBox.HoverEffect effect) Sets the hover effect
InfoBox	setIcon(BaseIcon<?> icon) Sets the icon
InfoBox	setIcon(elemental2.dom.HTMLElement element) Sets the icon
InfoBox	setIconBackground(Color background) Sets the background of the icon element
InfoBox	setIconColor(Color color) Sets the color of the icon
InfoBox	setTitle(String title) Sets the title
InfoBox	setValue(String value) Sets the value

Methods inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, appendChild, appendChild, apply, attr, blur, childNodes, clearElement, contains, contains, contains, containsCss, css, css, cssClassByIndex, cssClassesCount, cssText, disable, elevate, elevate, enable, firstChild, getAttachObserver, getAttribute, getBoundingClientRect, getChildElementCount, getClickableElement, getCollapsible, getCollapsibleElement, getDetachObserver, getDominoId, getElementsCount, getElevation, getFirstChild, getId, getTextContent, getTooltip, getWavesElement, hasAttribute, hasChildNodes, hasDirectChild, hide, hideOn, id, init, insertAfter, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertBefore, insertFirst, insertFirst, insertFirst, isAttached, isCollapsed, isDisabled, isEmptyElement, isEqualNode, isForceHidden, isHidden, isReadOnly, item, lastChild, length, onAttached, onDetached, onResize, pullLeft, pullRight, querySelector, querySelectorAll, remove, removeAttachObserver, removeAttribute, removeChild, removeChild, removeCss, removeCss, removeCssProperty, removeDetachObserver, removeEventListener, removeEventListener, removeHideListener, removeHideOn, removeShowListener, removeShowOn, removeTooltip, removeWaves, replaceCss, setAlignItems, setAttribute, setAttribute, setAttribute, setBackgroundColor, setBackgroundColor, setBorder, setBorderColor, setBottom, setBottom, setBoxShadow, setCollapseStrategy, setColor, setColor, setContent, setContent, setCssProperty, setCssProperty, setCursor, setCursor, setDisabled, setDisplay, setDisplay, setDropMenu, setFlex, setFloat, setFloat, setFontSize, setFontSize, setForceHidden, setHeight, setHeight, setId, setInnerHtml, setLeft, setLeft, setLineHeight, setLineHeight, setMargin, setMargin, setMarginBottom, setMarginBottom, setMarginLeft, setMarginLeft, setMarginRight, setMarginRight, setMarginTop, setMarginTop, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setOpacity, setOpacity, setOverFlow, setOverFlow, setOverFlowY, setPadding, setPadding, setPaddingBottom, setPaddingBottom, setPaddingLeft, setPaddingLeft, setPaddingRight, setPaddingRight, setPaddingTop, setPaddingTop, setPointerEvents, setPosition, setPosition, setReadOnly, setRight, setRight, setTabIndex, setTextAlign, setTextAlign, setTextContent, setTooltip, setTooltip, setTooltip, setTooltip, setTop, setTop, setTransitionDuration, setWidth, setWidth, setZIndex, show, showOn, style, style, styler, textContent, toggleDisplay, toggleDisplay, withWaves, withWaves

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.dominokit.domino.ui.utils.IsCollapsible

isExpanded

Methods inherited from interface org.dominokit.domino.ui.style.DominoStyle

add, add, remove, remove, removeProperty, replace, setProperty, setProperty

Constructor Detail

InfoBox

public InfoBox(elemental2.dom.HTMLElement icon,
               String title,
               String value)

InfoBox

public InfoBox(BaseIcon<?> icon,
               String title,
               String value)

InfoBox

public InfoBox(elemental2.dom.HTMLElement icon,
               String title)

InfoBox

public InfoBox(BaseIcon<?> icon,
               String title)

Method Detail

create

public static InfoBox create(BaseIcon<?> icon,
                             String title,
                             String value)

Creates info box with icon, title and value

Parameters:

icon - The BaseIcon

title - the title

value - the value

Returns:

new instance

create

public static InfoBox create(elemental2.dom.HTMLElement icon,
                             String title,
                             String value)

Creates info box with icon element, title and value

Parameters:

icon - The HTMLElement icon

title - the title

value - the value

Returns:

new instance

create

public static InfoBox create(elemental2.dom.HTMLElement icon,
                             String title)

Creates info box with icon and title

Parameters:

icon - The HTMLElement icon

title - the title

Returns:

new instance

create

public static InfoBox create(BaseIcon<?> icon,
                             String title)

Creates info box with icon and title

Parameters:

icon - The BaseIcon

title - the title

Returns:

new instance

setBackground

public InfoBox setBackground(Color background)

Specified by:

setBackground in interface HasBackground<InfoBox>

Parameters:

background - Color

Returns:

same implementing component

setIconBackground

public InfoBox setIconBackground(Color background)

Sets the background of the icon element

Parameters:

background - The Color of the icon

Returns:

same instance

setHoverEffect

public InfoBox setHoverEffect(InfoBox.HoverEffect effect)

Sets the hover effect

Parameters:

effect - the InfoBox.HoverEffect

Returns:

same instance

removeHoverEffect

public InfoBox removeHoverEffect()

Removes the hover effects

Returns:

same instance

flipLeft

public InfoBox flipLeft()

Puts the icon on the left and the title on the right

Returns:

same instance

flipRight

public InfoBox flipRight()

Puts the icon on the right and the title on the left

Returns:

same instance

flip

public InfoBox flip()

Changes the position of the icon and title based on the current position; i.e. if the icon is left, position it to right

Returns:

same instance

setIconColor

public InfoBox setIconColor(Color color)

Sets the color of the icon

Parameters:

color - The Color of the icon

Returns:

same instance

setIcon

public InfoBox setIcon(elemental2.dom.HTMLElement element)

Sets the icon

Parameters:

element - the HTMLElement icon

Returns:

same instance

removeShadow

public InfoBox removeShadow()

Removes the shadow of the box

Returns:

same instance

setValue

public InfoBox setValue(String value)

Sets the value

Parameters:

value - the new value

Returns:

same instance

setTitle

public InfoBox setTitle(String title)

Sets the title

Parameters:

title - the new title

Returns:

same instance

setIcon

public InfoBox setIcon(BaseIcon<?> icon)

Sets the icon

Parameters:

icon - the BaseIcon

Returns:

same instance

getIconElement

public DominoElement<elemental2.dom.HTMLDivElement> getIconElement()

Returns:

The icon element

getTitleElement

public DominoElement<elemental2.dom.HTMLDivElement> getTitleElement()

Returns:

The title element

getValueElement

public DominoElement<elemental2.dom.HTMLDivElement> getValueElement()

Returns:

The value element

element

public elemental2.dom.HTMLDivElement element()

Specified by:

element in interface org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

Specified by:

element in class BaseDominoElement<elemental2.dom.HTMLDivElement,InfoBox>

Returns:

the HTML element of type E which is the root element of the component