io.jmix.ui.component

Interface CompositeWithContextHelp

All Superinterfaces:

HasContextHelp

All Known Subinterfaces:

GroupFilter

All Known Implementing Classes:

FilterImpl, GroupFilterImpl

public interface CompositeWithContextHelp
extends HasContextHelp

CompositeComponent having a context help. Default implementations delegate their execution to CompositeComponent.getComposition().

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Method Summary

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.

Method Detail

getContextHelpText

@Nullable
default java.lang.String getContextHelpText()

Specified by:

getContextHelpText in interface HasContextHelp

Returns:

context help text

setContextHelpText

default void setContextHelpText(@Nullable
                                java.lang.String contextHelpText)

Description copied from interface: HasContextHelp

Sets context help text. If set, then a special icon will be added for a field.

Specified by:

setContextHelpText in interface HasContextHelp

Parameters:

contextHelpText - context help text to be set

isContextHelpTextHtmlEnabled

default boolean isContextHelpTextHtmlEnabled()

Specified by:

isContextHelpTextHtmlEnabled in interface HasContextHelp

Returns:

true if field accepts context help text in HTML format, false otherwise

setContextHelpTextHtmlEnabled

default void setContextHelpTextHtmlEnabled(boolean enabled)

Description copied from interface: HasContextHelp

Defines if context help text can be presented as HTML.

Specified by:

setContextHelpTextHtmlEnabled in interface HasContextHelp

Parameters:

enabled - true if field accepts context help text in HTML format, false otherwise

getContextHelpIconClickHandler

@Nullable
default java.util.function.Consumer<HasContextHelp.ContextHelpIconClickEvent> getContextHelpIconClickHandler()

Specified by:

getContextHelpIconClickHandler in interface HasContextHelp

Returns:

a context help icon click handler

setContextHelpIconClickHandler

default void setContextHelpIconClickHandler(@Nullable
                                            java.util.function.Consumer<HasContextHelp.ContextHelpIconClickEvent> handler)

Description copied from interface: HasContextHelp

Sets a context help icon click handler. If set, then a special icon will be added for a field. Click handler has priority over context help text, i.e. no tooltip with context help text will be shown if click listener is set.

Specified by:

setContextHelpIconClickHandler in interface HasContextHelp

Parameters:

handler - the handler to set