Package com.storedobject.vaadin

Class Icon

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.Composite<com.vaadin.flow.component.Component>

com.storedobject.vaadin.Icon

All Implemented Interfaces:

HasElement, HasIcon, HasSquareElement, HasStyle, HasThemeStyle, com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.ClickNotifier<Icon>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, Serializable

Direct Known Subclasses:

BadgeIcon, ImageButton

public class Icon
extends com.vaadin.flow.component.Composite<com.vaadin.flow.component.Component>
implements HasStyle, HasIcon, HasSquareElement, com.vaadin.flow.component.ClickNotifier<Icon>

Enhancements to Vaadin's Icon to handle other collections in a generic way.

Author:

Syam

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Icon(com.vaadin.flow.component.icon.VaadinIcon icon)	Create from a Vaadin icon
Icon(String icon)	Create from an icon from the name.

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.shared.Registration	addClickHandler(ClickHandler clickHandler)	Add click handler.
com.vaadin.flow.shared.Registration	addClickListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<Icon>> listener)
String	getColor()	Get the current color.
String	getHeight()
String	getIcon()	Get the current icon name
com.vaadin.flow.dom.Element	getInternalElement()	Get the internal element to which style will be applied.
String	getMaxHeight()
String	getMaxWidth()
String	getMinHeight()
String	getMinWidth()
String	getSize()	Get the current size
String	getWidth()
protected com.vaadin.flow.component.Component	initContent()
void	setAttribute(String name, String value)	Set an attribute value.
void	setColor(String color)	Set the color.
void	setHeight(String height)
void	setIcon(com.vaadin.flow.component.icon.VaadinIcon icon)	Set a Vaadin icon as the icon.
void	setIcon(String icon)	Set the icon name.
void	setMaxHeight(String maxHeight)
void	setMaxWidth(String maxWidth)
void	setMinHeight(String minHeight)
void	setMinWidth(String minWidth)
void	setSize(String size)	Set the size (Width and height)
void	setStyle(String name, String value)	Set a style value.
void	setWidth(String width)

Methods inherited from class com.vaadin.flow.component.Composite

getChildren, getContent, getElement

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.ClickNotifier

addClickShortcut, addDoubleClickListener, addSingleClickListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.storedobject.vaadin.HasElement

getAttribute, getStyle

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasSize

getHeightUnit, getWidthUnit, setHeight, setHeightFull, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidthFull

Methods inherited from interface com.storedobject.vaadin.HasStyle

getClassName, getClassNames, getStyle, setClassName

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, hasClassName, removeClassName, removeClassNames, setClassName

Methods inherited from interface com.storedobject.vaadin.HasThemeStyle

addTheme, asPrimary, asSmall, clearThemes, removeTheme, setTheme

Constructor Details

Icon

public Icon(com.vaadin.flow.component.icon.VaadinIcon icon)

Create from a Vaadin icon

Parameters:

icon - Vaadin icon

Icon

public Icon(String icon)

Create from an icon from the name. It could specify the collection name too. See setIcon(String).

Parameters:

icon - Name of the Iron icon

Method Details

initContent

protected com.vaadin.flow.component.Component initContent()

Overrides:

initContent in class com.vaadin.flow.component.Composite<com.vaadin.flow.component.Component>

getInternalElement

public com.vaadin.flow.dom.Element getInternalElement()

Description copied from interface: HasStyle

Get the internal element to which style will be applied.

Specified by:

getInternalElement in interface HasStyle

Specified by:

getInternalElement in interface HasThemeStyle

Returns:

The internal element.

setIcon

public void setIcon(com.vaadin.flow.component.icon.VaadinIcon icon)

Description copied from interface: HasIcon

Set a Vaadin icon as the icon.

Specified by:

setIcon in interface HasIcon

Parameters:

icon - Vaadin icon

setIcon

public void setIcon(String icon)

Description copied from interface: HasIcon

Set the icon name.

In addition to Vaadin's icons, icons from Polymer Iron Icons are included.

Note: The name could be structured to denote collection too. Available collections are "vaadin", "icons", "av", "communication", "device", "editor", "hardware", "image", "maps", "notifications", "social", and "places". For example, if you want to use the "bluetooth" icon from the "device" collection -

Icon icon = new Icon("device:bluetooth"); OR icon.setIcon("device:bluetooth");

Specified by:

setIcon in interface HasIcon

Parameters:

icon - Name of the Iron icon to set

getIcon

public String getIcon()

Description copied from interface: HasIcon

Get the current icon name

Specified by:

getIcon in interface HasIcon

Returns:

Current icon name

setSize

public void setSize(String size)

Description copied from interface: HasSquareElement

Set the size (Width and height)

Specified by:

setSize in interface HasSquareElement

Parameters:

size - Width/height of the square. Null value will remove the width/height styles.

getSize

public String getSize()

Description copied from interface: HasSquareElement

Get the current size

Specified by:

getSize in interface HasSquareElement

Returns:

Current size

setWidth

public void setWidth(String width)

Specified by:

setWidth in interface com.vaadin.flow.component.HasSize

setMinWidth

public void setMinWidth(String minWidth)

Specified by:

setMinWidth in interface com.vaadin.flow.component.HasSize

setMaxWidth

public void setMaxWidth(String maxWidth)

Specified by:

setMaxWidth in interface com.vaadin.flow.component.HasSize

getWidth

public String getWidth()

Specified by:

getWidth in interface com.vaadin.flow.component.HasSize

getMinWidth

public String getMinWidth()

Specified by:

getMinWidth in interface com.vaadin.flow.component.HasSize

getMaxWidth

public String getMaxWidth()

Specified by:

getMaxWidth in interface com.vaadin.flow.component.HasSize

setHeight

public void setHeight(String height)

Specified by:

setHeight in interface com.vaadin.flow.component.HasSize

setMinHeight

public void setMinHeight(String minHeight)

Specified by:

setMinHeight in interface com.vaadin.flow.component.HasSize

setMaxHeight

public void setMaxHeight(String maxHeight)

Specified by:

setMaxHeight in interface com.vaadin.flow.component.HasSize

getHeight

public String getHeight()

Specified by:

getHeight in interface com.vaadin.flow.component.HasSize

getMinHeight

public String getMinHeight()

Specified by:

getMinHeight in interface com.vaadin.flow.component.HasSize

getMaxHeight

public String getMaxHeight()

Specified by:

getMaxHeight in interface com.vaadin.flow.component.HasSize

setColor

public void setColor(String color)

Set the color.

Parameters:

color - Color to set.

getColor

public String getColor()

Get the current color.

Returns:

Current color.

setStyle

public void setStyle(String name,
 String value)

Set a style value.

Specified by:

setStyle in interface HasElement

Parameters:

name - Name of the style.

value - Value of the style.

setAttribute

public void setAttribute(String name,
 String value)

Set an attribute value.

Specified by:

setAttribute in interface HasElement

Parameters:

name - Name of the attribute.

value - Value of the attribute.

addClickHandler

public com.vaadin.flow.shared.Registration addClickHandler(ClickHandler clickHandler)

Add click handler.

Parameters:

clickHandler - Click handler

Returns:

Registration.

addClickListener

public com.vaadin.flow.shared.Registration addClickListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<Icon>> listener)

Specified by:

addClickListener in interface com.vaadin.flow.component.ClickNotifier<Icon>