Package com.storedobject.vaadin

Interface HasIcon

All Superinterfaces:

HasElement, com.vaadin.flow.component.HasElement, HasThemeStyle, Serializable

All Known Implementing Classes:

BadgeIcon, ButtonIcon, Icon, ImageButton

public interface HasIcon
extends HasElement

Element that has an Icon.

Author:

Syam

Method Summary

Modifier and Type	Method	Description
default String	getIcon()	Get the current icon name
static String	getIconName(com.vaadin.flow.component.icon.VaadinIcon icon)	Get the name of the Vaadin icon.
static String	getIconName(String icon)	Find the real name of the icon to be used from the ApplicationEnvironment.
default void	setIcon(com.vaadin.flow.component.icon.VaadinIcon icon)	Set a Vaadin icon as the icon.
default void	setIcon(String icon)	Set the icon name.

Methods inherited from interface com.storedobject.vaadin.HasElement

getAttribute, getStyle, setAttribute, setStyle

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

getElement

Methods inherited from interface com.storedobject.vaadin.HasThemeStyle

addTheme, asPrimary, asSmall, clearThemes, getInternalElement, removeTheme, setTheme

Method Details

setIcon

default void setIcon(String icon)

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");

Parameters:

icon - Name of the Iron icon to set

setIcon

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

Set a Vaadin icon as the icon.

Parameters:

icon - Vaadin icon

getIcon

default String getIcon()

Get the current icon name

Returns:

Current icon name

getIconName

static String getIconName(String icon)

Find the real name of the icon to be used from the ApplicationEnvironment.

Parameters:

icon - Name of the icon.

Returns:

Name of the icon derived from the ApplicationEnvironment.

getIconName

static String getIconName(com.vaadin.flow.component.icon.VaadinIcon icon)

Get the name of the Vaadin icon.

Parameters:

icon - Icon

Returns:

Name of the icon.