Package org.patternfly.component.icon

Class Icon

java.lang.Object

org.patternfly.component.BaseComponent<HTMLElement,Icon>

org.patternfly.component.icon.Icon

All Implemented Interfaces:

ElementAttributeMethods<HTMLElement,Icon>, ElementClassListMethods<HTMLElement,Icon>, ElementConsumerMethods<HTMLElement,Icon>, ElementContainerMethods<HTMLElement,Icon>, ElementEventMethods<HTMLElement,Icon>, ElementIdMethods<HTMLElement,Icon>, ElementQueryMethods<HTMLElement>, HTMLElementAttributeMethods<HTMLElement,Icon>, HTMLElementDataMethods<HTMLElement,Icon>, HTMLElementStyleMethods<HTMLElement,Icon>, HTMLElementVisibilityMethods<HTMLElement,Icon>, IsElement<HTMLElement>, TypedBuilder<HTMLElement,Icon>, Component, ComponentProgress<HTMLElement,Icon>, org.patternfly.style.Modifiers.Inline<HTMLElement,Icon>

public class Icon
extends BaseComponent<HTMLElement,Icon>
implements org.patternfly.style.Modifiers.Inline<HTMLElement,Icon>, ComponentProgress<HTMLElement,Icon>

An icon component is a container that allows for icons of varying dimensions, as well as spinners, to seamlessly replace each other without shifting surrounding content.

icon(check());
icon(filter())
        .size(IconSize.lg);
icon(exclamationTriangle())
        .inline()
        .status(warning);

See Also:

• https://www.patternfly.org/components/icon

Method Summary

Modifier and Type	Method	Description
static Icon	icon(Element icon)	Factory method to create a new instance of this component.
static Icon	icon(org.patternfly.icon.PredefinedIcon icon)	Factory method to create a new instance of this component.
Icon	iconSize(IconSize iconSize)	Size of icon.
Icon	progress(boolean inProgress, String label, Consumer<Spinner> spinnerConsumer)
Icon	progressIconSize(IconSize progressIconSize)	Size of progress icon.
Icon	size(IconSize size)	Size of the icon component container and icon.
Icon	status(org.patternfly.style.Status status)
Icon	that()

Methods inherited from class org.patternfly.component.BaseComponent

componentType, element

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.patternfly.component.ComponentProgress

inProgress, progress, progress, progress, startProgress, stopProgress, toggleProgress

Methods inherited from interface org.jboss.elemento.ElementAttributeMethods

aria, aria, aria, attr, attr, attr, role, role

Methods inherited from interface org.jboss.elemento.ElementClassListMethods

classList, classList, css, toggle, toggle, toggle

Methods inherited from interface org.jboss.elemento.ElementConsumerMethods

apply, run

Methods inherited from interface org.jboss.elemento.ElementContainerMethods

add, add, add, add, addAll, addAll, addAll, addAll, addAll, addAll

Methods inherited from interface org.jboss.elemento.ElementEventMethods

on, on, on

Methods inherited from interface org.jboss.elemento.ElementIdMethods

id, uniqueId

Methods inherited from interface org.jboss.elemento.ElementQueryMethods

closest, querySelector, querySelectorAll

Methods inherited from interface org.jboss.elemento.HTMLElementAttributeMethods

title

Methods inherited from interface org.jboss.elemento.HTMLElementDataMethods

data

Methods inherited from interface org.jboss.elemento.HTMLElementStyleMethods

style, style, style, style, style, style

Methods inherited from interface org.jboss.elemento.HTMLElementVisibilityMethods

hidden

Methods inherited from interface org.jboss.elemento.IsElement

element

Methods inherited from interface org.patternfly.style.Modifiers.Inline

inline, inline

Method Details

icon

public static Icon icon(org.patternfly.icon.PredefinedIcon icon)

Factory method to create a new instance of this component.

icon

public static Icon icon(Element icon)

Factory method to create a new instance of this component.

size

public Icon size(IconSize size)

Size of the icon component container and icon.

iconSize

public Icon iconSize(IconSize iconSize)

Size of icon. Overrides the icon size set by the size property.

progressIconSize

public Icon progressIconSize(IconSize progressIconSize)

Size of progress icon. Overrides the icon size set by the size(IconSize) property.

status

public Icon status(org.patternfly.style.Status status)

progress

public Icon progress(boolean inProgress,
 String label,
 Consumer<Spinner> spinnerConsumer)

Specified by:

progress in interface ComponentProgress<HTMLElement,Icon>

that

public Icon that()

Specified by:

that in interface TypedBuilder<HTMLElement,Icon>