= TitleUiEvent
: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 obtain a title hint (equivalent to the `title()` supporting method).

The class has a number of responsibilities:

* capture the target object being interacted with
* capture the title, if any, as specified to one of the subscribers

The class itself is instantiated automatically by the framework.

== API

[source,java]
.TitleUiEvent.java
----
class TitleUiEvent<S> {
  TitleUiEvent()     // <.>
  TitleUiEvent(S source)
  void setTitle(String title)     // <.>
  void setTranslatableTitle(TranslatableString translatableTitle)     // <.>
}
----

<.> xref:#TitleUiEvent_[TitleUiEvent()]
+
--
If used then the framework will set state via (non-API) setters.
--
<.> xref:#setTitle_String[setTitle(String)]
+
--
For subscribers to call to provide a (non-translated) title for this object.
--
<.> xref:#setTranslatableTitle_TranslatableString[setTranslatableTitle(TranslatableString)]
+
--
For subscribers to call to provide a translatable (i18n) title for this object.
--

== Members

[#TitleUiEvent_]
=== TitleUiEvent()

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.

[#setTitle_String]
=== setTitle(String)

For subscribers to call to provide a (non-translated) title for this object.

[#setTranslatableTitle_TranslatableString]
=== setTranslatableTitle(TranslatableString)

For subscribers to call to provide a translatable (i18n) title for this object.
