com.foreach.across.modules.bootstrapui.elements.icons

Interface IconSet

All Known Subinterfaces:

MutableIconSet

All Known Implementing Classes:

SimpleIconSet

public interface IconSet

An immutable IconSet that is registered in the IconSetRegistry and that represents a collection of icons. You can get a registered IconSet using iconSet(String). An icon should be a a HtmlViewElement.

Since:

3.0.0

Author:

Stijn Vanhoof

See Also:

MutableIconSet, SimpleIconSet, IconSetRegistry

Method Summary

Modifier and Type	Method and Description
Map<String,com.foreach.across.modules.web.ui.elements.HtmlViewElement>	getAllRegisteredIcons() Gets a map of all registered icons on the IconSet.
com.foreach.across.modules.web.ui.elements.HtmlViewElement	icon(@NonNull String name) Returns an icon with from the current SimpleIconSet.
static IconSet	iconSet(@NonNull String name) Shorthand method to get an IconSet from the IconSetRegistry

Method Detail

icon

com.foreach.across.modules.web.ui.elements.HtmlViewElement icon(@NonNull
                                                                @NonNull String name)

Returns an icon with from the current SimpleIconSet. If no iconResolver function was registered for the requested icon, a fallback to the defaultIconResolver is used.

Parameters:

name - of the icon in the SimpleIconSet

Returns:

The icon as a AbstractNodeViewElement

getAllRegisteredIcons

Map<String,com.foreach.across.modules.web.ui.elements.HtmlViewElement> getAllRegisteredIcons()

Gets a map of all registered icons on the IconSet.

Returns:

a Map<String, AbstractNodeViewElement> that holds all icons by name

iconSet

static IconSet iconSet(@NonNull
                       @NonNull String name)

Shorthand method to get an IconSet from the IconSetRegistry

Parameters:

name - of the iconSet

Returns:

an IconSet