= IconUiEvent
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR  CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Emitted for subscribers to provide a cssClass hint (equivalent to the `iconName()` supporting method).

If the domain object defines its own xref:refguide:applib-methods:ui-hints.adoc[iconName()] supporting method, or if it has the xref:refguide:applib:index/annotation/DomainObjectLayout.adoc#cssClassFa[@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

[source,java]
.IconUiEvent.java
----
class IconUiEvent<S> {
  IconUiEvent()     // <.>
  IconUiEvent(S source)
  String getIconName()     // <.>
  void setIconName(String iconName)     // <.>
}
----

<.> xref:#IconUiEvent_[IconUiEvent()]
+
--
If used then the framework will set state via (non-API) setters.
--
<.> xref:#getIconName_[getIconName()]
+
--
The icon name as provided by a subscriber using _#setIconName(String)_ .
--
<.> xref:#setIconName_String[setIconName(String)]
+
--
For subscribers to call to provide an icon name for this object.
--

== Members

[#IconUiEvent_]
=== 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_]
=== getIconName()

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

[#setIconName_String]
=== setIconName(String)

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