org.dominokit.domino.ui.icons

Class MdiIcon

java.lang.Object

org.dominokit.domino.ui.utils.BaseDominoElement<elemental2.dom.HTMLElement,T>

org.dominokit.domino.ui.icons.BaseIcon<MdiIcon>

org.dominokit.domino.ui.icons.MdiIcon

All Implemented Interfaces:

DominoStyle<elemental2.dom.HTMLElement,MdiIcon,MdiIcon>, HasChildren<MdiIcon>, HasWavesElement, IsCollapsible<MdiIcon>, IsReadOnly<MdiIcon>, org.jboss.elemento.IsElement<elemental2.dom.HTMLElement>

public class MdiIcon
extends BaseIcon<MdiIcon>

MDI icons implementation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MdiIcon.MdiContrast An enum representing the contrast of the icon
static class	MdiIcon.MdiFlip An enum representing the flip of the icon
static class	MdiIcon.MdiRotate An enum representing the rotation degree of the icon
static class	MdiIcon.MdiSize An enum representing the sizes of the icon

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.icons.BaseIcon

color, icon, name, originalName, toggleName, toggleOnClick

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

element

Method Summary

Modifier and Type	Method and Description
MdiIcon	active() Activate the icon
MdiIcon	changeTo(BaseIcon<MdiIcon> icon) Change the icon to another icon
MdiIcon	copy() Copy the same icon and return a new instance
static MdiIcon	create(String icon) Creates a new icon
static MdiIcon	create(String icon, MdiMeta meta) Creates a new icon with meta
MdiIcon	dark() Sets the contrast as dark
protected MdiIcon	doToggle()
elemental2.dom.HTMLElement	element()
MdiIcon	flipH() Flips the icon horizontally
MdiIcon	flipNone() Removes the flip
MdiIcon	flipV() Flips the icon vertically
MdiMeta	getMetaInfo()
MdiIcon	inactive() Marks the icon as inactive
MdiIcon	light() Sets the contrast as light
MdiIcon	noContrast() Removes the contrast
MdiIcon	noSpin() Removes the spinning of the icon
MdiIcon	rotate135() Rotates the icon with 135 degrees
MdiIcon	rotate180() Rotates the icon with 180 degrees
MdiIcon	rotate225() Rotates the icon with 225 degrees
MdiIcon	rotate270() Rotates the icon with 270 degrees
MdiIcon	rotate315() Rotates the icon with 315 degrees
MdiIcon	rotate45() Rotates the icon with 45 degrees
MdiIcon	rotate90() Rotates the icon with 90 degrees
MdiIcon	rotateNone() Sets the rotate to the default value
MdiIcon	setActive(boolean active) Sets if the icon is active or not
MdiIcon	setContrast(MdiIcon.MdiContrast mdiContrast) Sets the contrast of the icon
MdiIcon	setFlip(MdiIcon.MdiFlip mdiFlip) Flips the icon either horizontally or vertically
MdiIcon	setRotate(MdiIcon.MdiRotate mdiRotate) Sets the type of rotate applied to the icon
MdiIcon	setSize(MdiIcon.MdiSize mdiSize) Sets the size of the icon
MdiIcon	setSpin(boolean spin) Sets if the icon should spin
MdiIcon	size18() Sets the size to 18 px
MdiIcon	size24() Sets the size to 24 px
MdiIcon	size36() Sets the size to 36 px
MdiIcon	size48() Sets the size to 48 px
MdiIcon	sizeNone() Sets the size to the default
MdiIcon	spin() Spins the icon

Methods inherited from class org.dominokit.domino.ui.icons.BaseIcon

addClickListener, clickable, getName, isToggled, onToggle, setClickable, setColor, setToggleIcon, toggleIcon, toggleOnClick

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

add, add, 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

Method Detail

create

public static MdiIcon create(String icon)

Creates a new icon

Parameters:

icon - the name of the icon

Returns:

new instance

create

public static MdiIcon create(String icon,
                             MdiMeta meta)

Creates a new icon with meta

Parameters:

icon - the icon name

meta - the MdiMeta

Returns:

new instance

copy

public MdiIcon copy()

Copy the same icon and return a new instance

Specified by:

copy in class BaseIcon<MdiIcon>

Returns:

the new copied instance

doToggle

protected MdiIcon doToggle()

Specified by:

doToggle in class BaseIcon<MdiIcon>

changeTo

public MdiIcon changeTo(BaseIcon<MdiIcon> icon)

Change the icon to another icon

Specified by:

changeTo in class BaseIcon<MdiIcon>

Parameters:

icon - the new BaseIcon

Returns:

same instance

setSize

public MdiIcon setSize(MdiIcon.MdiSize mdiSize)

Sets the size of the icon

Parameters:

mdiSize - the MdiIcon.MdiSize

Returns:

same instance

size18

public MdiIcon size18()

Sets the size to 18 px

Returns:

same instance

size24

public MdiIcon size24()

Sets the size to 24 px

Returns:

same instance

size36

public MdiIcon size36()

Sets the size to 36 px

Returns:

same instance

size48

public MdiIcon size48()

Sets the size to 48 px

Returns:

same instance

sizeNone

public MdiIcon sizeNone()

Sets the size to the default

Returns:

same instance

setRotate

public MdiIcon setRotate(MdiIcon.MdiRotate mdiRotate)

Sets the type of rotate applied to the icon

Parameters:

mdiRotate - the MdiIcon.MdiRotate

Returns:

same instance

rotate45

public MdiIcon rotate45()

Rotates the icon with 45 degrees

Returns:

same instance

rotate90

public MdiIcon rotate90()

Rotates the icon with 90 degrees

Returns:

same instance

rotate135

public MdiIcon rotate135()

Rotates the icon with 135 degrees

Returns:

same instance

rotate180

public MdiIcon rotate180()

Rotates the icon with 180 degrees

Returns:

same instance

rotate225

public MdiIcon rotate225()

Rotates the icon with 225 degrees

Returns:

same instance

rotate270

public MdiIcon rotate270()

Rotates the icon with 270 degrees

Returns:

same instance

rotate315

public MdiIcon rotate315()

Rotates the icon with 315 degrees

Returns:

same instance

rotateNone

public MdiIcon rotateNone()

Sets the rotate to the default value

Returns:

same instance

setFlip

public MdiIcon setFlip(MdiIcon.MdiFlip mdiFlip)

Flips the icon either horizontally or vertically

Parameters:

mdiFlip - the MdiIcon.MdiFlip

Returns:

same instance

flipV

public MdiIcon flipV()

Flips the icon vertically

Returns:

same instance

flipH

public MdiIcon flipH()

Flips the icon horizontally

Returns:

same instance

flipNone

public MdiIcon flipNone()

Removes the flip

Returns:

same instance

setSpin

public MdiIcon setSpin(boolean spin)

Sets if the icon should spin

Parameters:

spin - true to spin the icon, false otherwise

Returns:

same instance

spin

public MdiIcon spin()

Spins the icon

Returns:

same instance

noSpin

public MdiIcon noSpin()

Removes the spinning of the icon

Returns:

same instance

setActive

public MdiIcon setActive(boolean active)

Sets if the icon is active or not

Parameters:

active - true to activate the icon, false otherwise

Returns:

same instance

active

public MdiIcon active()

Activate the icon

Returns:

same instance

inactive

public MdiIcon inactive()

Marks the icon as inactive

Returns:

same instance

setContrast

public MdiIcon setContrast(MdiIcon.MdiContrast mdiContrast)

Sets the contrast of the icon

Parameters:

mdiContrast - the MdiIcon.MdiContrast

Returns:

same instance

light

public MdiIcon light()

Sets the contrast as light

Returns:

same instance

dark

public MdiIcon dark()

Sets the contrast as dark

Returns:

same instance

noContrast

public MdiIcon noContrast()

Removes the contrast

Returns:

same instance

element

public elemental2.dom.HTMLElement element()

Specified by:

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

Overrides:

element in class BaseIcon<MdiIcon>

Returns:

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

getMetaInfo

public MdiMeta getMetaInfo()

Returns:

The MdiMeta of the icon