IconUiEvent

Emitted for subscribers to provide a cssClass hint (equivalent to the iconName() supporting method).* If the domain object defines its own iconName() supporting method, or if it has the @DomainObjectLayout#cssClassFa() attribute, then these will take precedence.

The class has a number of responsibilities:

  • capture the target object being interacted with

  • capture the icon (name), if any, as specified to one of the subscribers

The class itself is instantiated automatically by the framework.

API

IconUiEvent.java
class IconUiEvent<S> {
  IconUiEvent()     (1)
  IconUiEvent(final S source)
  String getIconName()     (2)
  void setIconName(final String iconName)     (3)
}
1 IconUiEvent()

If used then the framework will set state via (non-API) setters.

2 getIconName()

The icon name as provided by a subscriber using #setIconName(String) .

3 setIconName(String)

For subscribers to call to provide an icon name for this object.

Members

IconUiEvent()

If used then the framework will set state via (non-API) setters.

Because the EventObject superclass prohibits a null source, a dummy value is temporarily used.

getIconName()

The icon name as provided by a subscriber using #setIconName(String) .

setIconName(String)

For subscribers to call to provide an icon name for this object.