io.jmix.ui.icon

Interface Icons

All Known Implementing Classes:

IconsImpl

public interface Icons

A bean that resolves icon sources for icon sets defined for the project.

Examples:

 excelButton.setIcon(icons.get(JmixIcon.EXCEL_ACTION));
 helpButton.setIcon(icons.get(JmixIcon.INFO));
 

See Also:

Icons.Icon

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Icons.Icon Interface for enumerations that represent icon sets.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.regex.Pattern	ICON_NAME_REGEX

Method Summary

Modifier and Type	Method and Description
java.lang.String	get(Icons.Icon icon) For the given Icons.Icon instance, returns the icon source that can be used to set this icon to components.
java.lang.String	get(java.lang.String iconName) For the given Icons.Icon.iconName(), returns the icon source that can be used to set this icon to components.

Field Detail

ICON_NAME_REGEX

static final java.util.regex.Pattern ICON_NAME_REGEX

Method Detail

get

@Nullable
java.lang.String get(@Nullable
                               Icons.Icon icon)

For the given Icons.Icon instance, returns the icon source that can be used to set this icon to components.

Example:

 createButton.setIcon(icons.get(JmixIcon.CREATE));
 

Parameters:

icon - Icons.Icon instance

Returns:

icon source (see Icons.Icon.source())

get

@Nullable
java.lang.String get(@Nullable
                               java.lang.String iconName)

For the given Icons.Icon.iconName(), returns the icon source that can be used to set this icon to components.

Example:

 importButton.setIcon(icons.get("IMPORT"));
 

Parameters:

iconName - icon name that contains only uppercase letters and underscores

Returns:

icon source (see Icons.Icon.source())