We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.component.icon.
Package com.vaadin.flow.component.icon
Class Icon
All Implemented Interfaces:
AttachNotifier, ClickNotifier<Icon>, DetachNotifier, HasElement, HasStyle, HasTooltip, Serializable
@NpmPackage(value="@vaadin/icons",
version="24.3.13")
@JsModule("@vaadin/icons/vaadin-iconset.js")
public class Icon
extends AbstractIcon<Icon>
Component for displaying an icon from the Vaadin Icons collection.
Author:
Vaadin Ltd
See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionIcon()Creates an Icon component that displays a Vaadin logo.
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
iconfrom the givencollection. -
Method Summary
Methods inherited from class com.vaadin.flow.component.icon.AbstractIcon
setSizeMethods 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, setVisibleMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListenerMethods inherited from interface com.vaadin.flow.component.ClickNotifier
addClickListener, addClickShortcut, addDoubleClickListener, addSingleClickListenerMethods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListenerMethods inherited from interface com.vaadin.flow.component.HasElement
getElementMethods inherited from interface com.vaadin.flow.component.HasStyle
addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassNameMethods inherited from interface com.vaadin.flow.component.shared.HasTooltip
getTooltip, setTooltipText
-
Constructor Details
-
Icon
public Icon()Creates an Icon component that displays a Vaadin logo.
-
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
iconfrom 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
-
setColor
Description copied from class:
AbstractIconSets 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:
setColorin classAbstractIcon<Icon>Parameters:
color- the color to set, may benullto clear the value -
getColor
Description copied from class:
AbstractIconGets the color of this icon as a String.
Specified by:
getColorin classAbstractIcon<Icon>Returns:
the color of the icon, or
nullif the color has not been set
-