public interface CompositeWithContextHelp extends HasContextHelp
CompositeComponent
having a context help.
Default implementations delegate their execution to CompositeComponent.getComposition()
.HasContextHelp.ContextHelpIconClickEvent
Modifier and Type | Method and Description |
---|---|
default java.util.function.Consumer<HasContextHelp.ContextHelpIconClickEvent> |
getContextHelpIconClickHandler() |
default java.lang.String |
getContextHelpText() |
default boolean |
isContextHelpTextHtmlEnabled() |
default void |
setContextHelpIconClickHandler(java.util.function.Consumer<HasContextHelp.ContextHelpIconClickEvent> handler)
Sets a context help icon click handler.
|
default void |
setContextHelpText(java.lang.String contextHelpText)
Sets context help text.
|
default void |
setContextHelpTextHtmlEnabled(boolean enabled)
Defines if context help text can be presented as HTML.
|
@Nullable default java.lang.String getContextHelpText()
getContextHelpText
in interface HasContextHelp
default void setContextHelpText(@Nullable java.lang.String contextHelpText)
HasContextHelp
setContextHelpText
in interface HasContextHelp
contextHelpText
- context help text to be setdefault boolean isContextHelpTextHtmlEnabled()
isContextHelpTextHtmlEnabled
in interface HasContextHelp
default void setContextHelpTextHtmlEnabled(boolean enabled)
HasContextHelp
setContextHelpTextHtmlEnabled
in interface HasContextHelp
enabled
- true if field accepts context help text in HTML format, false otherwise@Nullable default java.util.function.Consumer<HasContextHelp.ContextHelpIconClickEvent> getContextHelpIconClickHandler()
getContextHelpIconClickHandler
in interface HasContextHelp
default void setContextHelpIconClickHandler(@Nullable java.util.function.Consumer<HasContextHelp.ContextHelpIconClickEvent> handler)
HasContextHelp
setContextHelpIconClickHandler
in interface HasContextHelp
handler
- the handler to set