com.vaadin.flow.component.icon.
Class Icon
All Implemented Interfaces:
AttachNotifier
, ClickNotifier<Icon>
, DetachNotifier
, HasElement
, HasStyle
, HasTooltip
, Serializable
Component for displaying an icon from the Vaadin Icons collection.
Author:
Vaadin Ltd
See Also:
-
Constructor Summary
ConstructorDescriptionIcon()
Creates an empty Icon.
Icon
(VaadinIcon icon) Creates an Icon component that displays the given icon from
VaadinIcon
.Creates an Icon component that displays the given icon from vaadin-icons collection.
Creates an Icon component that displays the given
icon
from the givencollection
. -
Method Summary
Modifier and TypeMethodDescriptionGets the collection of the icon (the part before :).
getColor()
Gets the color of this icon as a String.
getIcon()
Gets the full icon name, including the collection.
void
Sets the color of the icon.
void
setIcon
(VaadinIcon icon) Sets the icon to the given Vaadin icon.
void
Sets the icon to the given icon.
void
Sets the icon to the given
icon
from the givencollection
.Methods inherited from class com.vaadin.flow.component.icon.AbstractIcon
setSize
Methods inherited from class com.vaadin.flow.component.Component
addListener, findAncestor, fireEvent, from, get, getChildren, getElement, 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
addClickListener, addClickShortcut, addDoubleClickListener, addSingleClickListener
Methods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListener
Methods inherited from interface com.vaadin.flow.component.HasElement
getElement
Methods inherited from interface com.vaadin.flow.component.HasStyle
addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName
Methods inherited from interface com.vaadin.flow.component.shared.HasTooltip
getTooltip, setTooltipText
-
Constructor Details
-
Icon
public Icon()Creates an empty Icon.
-
Icon
Creates an Icon component that displays the given icon from
VaadinIcon
.Parameters:
icon
- the icon to display -
Icon
Creates an Icon component that displays the given icon from vaadin-icons collection.
Parameters:
icon
- the icon name -
Icon
Creates an Icon component that displays the given
icon
from the givencollection
. If you want to use a custom<vaadin-iconset>
-based icon set, you also need to add a dependency and an import for it, example:@NpmPackage(value = "custom-icons", version = "1.0.0") @JsModule("custom-icons/iconset.js") public class MyView extends Div {
Parameters:
collection
- the icon collectionicon
- the icon name
-
-
Method Details
-
setIcon
Sets the icon to the given icon.
If the icon name contains a ":", the first part is used as the collection and the second part as the icon name. If the icon name does not contain a ":", the current collection is used (vaadin by default).
Parameters:
icon
- the icon name -
setIcon
Sets the icon to the given Vaadin icon.
Parameters:
icon
- the icon name -
getIcon
Gets the full icon name, including the collection.
Returns:
the icon name or
null
if no icon is set -
setIcon
Sets the icon to the given
icon
from the givencollection
. If you want to use a custom<vaadin-iconset>
-based icon set, you also need to add a dependency and an import for it, example:@NpmPackage(value = "custom-icons", version = "1.0.0") @JsModule("custom-icons/iconset.js") public class MyView extends Div {
Parameters:
collection
- the icon collectionicon
- the icon name -
getCollection
Gets the collection of the icon (the part before :).
Returns:
the collection of the icon or
null
if no collection is set -
setColor
Description copied from class:
AbstractIcon
Sets the color of the icon.
The color should be in a format understood by the browser, e.g. "orange", "#FF9E2C" or "rgb(255, 158, 44)".
Specified by:
setColor
in classAbstractIcon<Icon>
Parameters:
color
- the color to set, may benull
to clear the value -
getColor
Description copied from class:
AbstractIcon
Gets the color of this icon as a String.
Specified by:
getColor
in classAbstractIcon<Icon>
Returns:
the color of the icon, or
null
if the color has not been set
-