io.jmix.ui.component

Interface HasContextHelp

All Known Subinterfaces:

Accordion, BoxLayout, BrowserFrame, ButtonsPanel, Calendar<V>, CheckBox, CheckBoxGroup<I>, ColorPicker, ComboBox<V>, CompositeWithContextHelp, CssLayout, CurrencyField<V>, DataGrid<E>, DateField<V>, DatePicker<V>, EntityComboBox<V>, EntityLinkField<V>, EntityPicker<V>, EntitySuggestionField<V>, Field<V>, FileStorageUploadField, FileUploadField, Filter, FlowBoxLayout, Form, GridLayout, GroupBoxLayout, GroupFilter, GroupTable<E>, HBoxLayout, HtmlBoxLayout, Image<T>, JavaScriptComponent, JpqlFilter<V>, Label<V>, MaskedField<V>, MultiSelectList<V>, OptionsField<V,I>, PasswordField, PopupView, ProgressBar, PropertyFilter<V>, RadioButtonGroup<I>, ResizableTextArea<V>, ResourceView, RichTextArea, ScrollBoxLayout, SelectList<V,I>, SingleFilterComponent<V>, SingleSelectList<V>, Slider<V>, SourceCodeEditor, SplitPanel, SuggestionField<V>, SuggestionFieldComponent<V,I>, Table<E>, TabSheet, TagField<V>, TagPicker<V>, TextArea<V>, TextField<V>, TextInputField<V>, TimeField<V>, Tree<E>, TreeDataGrid<E>, TreeTable<E>, TwinColumn<V>, ValuePicker<V>, ValuesPicker<V>, VBoxLayout

All Known Implementing Classes:

AbstractActionsHolderComponent, AbstractBox, AbstractComponent, AbstractDataGrid, AbstractField, AbstractFileStorageUploadField, AbstractOrderedLayout, AbstractPagination, AbstractResourceView, AbstractSelectList, AbstractSingleFileUploadField, AbstractSingleFilterComponent, AbstractSuggestionField, AbstractTable, AbstractTextArea, AbstractValueComponent, AbstractViewComponent, AccordionImpl, AngularGaugeChartImpl, AppMenuImpl, AppWorkAreaImpl, BrowserFrameImpl, ButtonImpl, ButtonsPanelImpl, CalendarImpl, CapsLockIndicatorImpl, ChartImpl, CheckBoxGroupImpl, CheckBoxImpl, ColorPickerImpl, ComboBoxImpl, CoordinateChartImpl, CssLayoutImpl, CurrencyFieldImpl, CustomChartImpl, DataGridImpl, DateFieldImpl, DatePickerImpl, DrawerImpl, EntityComboBoxImpl, EntityLinkFieldImpl, EntityPickerImpl, EntitySuggestionFieldImpl, FileMultiUploadFieldImpl, FileStorageUploadFieldImpl, FileUploadFieldImpl, FilterImpl, FlowBoxLayoutImpl, FormImpl, FragmentImpl, FunnelChartImpl, GanttChartImpl, GridLayoutImpl, GroupBoxImpl, GroupFilterImpl, GroupTableImpl, HBoxLayoutImpl, HtmlBoxLayoutImpl, ImageImpl, JavaScriptComponentImpl, JpqlFilterImpl, LabelImpl, LinkButtonImpl, LinkImpl, LogoutButtonImpl, MaskedFieldImpl, MultiSelectListImpl, NewWindowButtonImpl, PaginationImpl, PasswordFieldImpl, PieChartImpl, PivotTableImpl, PopupButtonImpl, PopupViewImpl, ProgressBarImpl, PropertyFilterImpl, RadarChartImpl, RadioButtonGroupImpl, RectangularChartImpl, RelatedEntitiesImpl, ResizableTextAreaImpl, ResponsiveGridLayoutImpl, RichTextAreaImpl, ScrollBoxLayoutImpl, SerialChartImpl, SeriesBasedChartImpl, SideMenuImpl, SimplePaginationImpl, SingleSelectListImpl, SlicedChartImpl, SliderImpl, SourceCodeEditorImpl, SplitPanelImpl, StockChartImpl, SuggestionFieldImpl, TableImpl, TabSheetImpl, TagFieldImpl, TagPickerImpl, TextAreaImpl, TextFieldImpl, TimeFieldImpl, TimeZoneIndicatorImpl, TreeDataGridImpl, TreeImpl, TreeTableImpl, TwinColumnImpl, UserActionsButtonImpl, ValuePickerImpl, ValuesPickerImpl, VBoxLayoutImpl, XYChartImpl

public interface HasContextHelp

An interface implemented by components that can provide a context help.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HasContextHelp.ContextHelpIconClickEvent Describes context help icon click event.

Method Summary

Modifier and Type	Method and Description
java.util.function.Consumer<HasContextHelp.ContextHelpIconClickEvent>	getContextHelpIconClickHandler()
java.lang.String	getContextHelpText()
boolean	isContextHelpTextHtmlEnabled()
void	setContextHelpIconClickHandler(java.util.function.Consumer<HasContextHelp.ContextHelpIconClickEvent> handler) Sets a context help icon click handler.
void	setContextHelpText(java.lang.String contextHelpText) Sets context help text.
void	setContextHelpTextHtmlEnabled(boolean enabled) Defines if context help text can be presented as HTML.

Method Detail

getContextHelpText

@Nullable
java.lang.String getContextHelpText()

Returns:

context help text

setContextHelpText

@StudioProperty(type=LOCALIZED_STRING)
void setContextHelpText(@Nullable
                                                               java.lang.String contextHelpText)

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

Parameters:

contextHelpText - context help text to be set

isContextHelpTextHtmlEnabled

boolean isContextHelpTextHtmlEnabled()

Returns:

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

setContextHelpTextHtmlEnabled

@StudioProperty(defaultValue="false")
void setContextHelpTextHtmlEnabled(boolean enabled)

Defines if context help text can be presented as HTML.

Parameters:

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

getContextHelpIconClickHandler

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

Returns:

a context help icon click handler

setContextHelpIconClickHandler

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

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.

Parameters:

handler - the handler to set