com.haulmont.cuba.web.gui.icons

Interface IconProvider

All Known Implementing Classes:

FontAwesomeIconProvider, ThemeIconProvider

public interface IconProvider

Marker interface for beans that can provide Resource by some icon path.

The IconResolver bean obtains all beans that implements IconProvider interface and iterates over them to find the one that can provide Resource for icon. So you should use this interface to mark new icon provider to use your custom icon set.

Field Summary

Fields

Modifier and Type	Field and Description
static int	HIGHEST_PLATFORM_PRECEDENCE Defines the highest precedence for Ordered or Order icon providers.
static int	LOWEST_PLATFORM_PRECEDENCE Defines the lowest precedence for Ordered or Order icon providers.

Method Summary

Modifier and Type	Method and Description
boolean	canProvide(java.lang.String iconPath)
com.vaadin.server.Resource	getIconResource(java.lang.String iconPath)

Field Detail

HIGHEST_PLATFORM_PRECEDENCE

static final int HIGHEST_PLATFORM_PRECEDENCE

Defines the highest precedence for Ordered or Order icon providers.

See Also:

Constant Field Values

LOWEST_PLATFORM_PRECEDENCE

static final int LOWEST_PLATFORM_PRECEDENCE

Defines the lowest precedence for Ordered or Order icon providers.

See Also:

Constant Field Values

Method Detail

getIconResource

com.vaadin.server.Resource getIconResource(java.lang.String iconPath)

Returns:

an instance of Resource by the given iconPath.

canProvide

boolean canProvide(java.lang.String iconPath)

Returns:

true if icon provider can return an instance of Resource by the given iconPath or false otherwise