Package 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, FullTextFilter, GridLayout, GroupBoxLayout, GroupFilter, GroupTable<E>, HBoxLayout, HtmlBoxLayout, Image<T>, JavaScriptComponent, JpqlFilter<V>, Label<V>, MaskedField<V>, MultiSelectList<V>, NotificationsIndicator, OptionsField<V,I>, PasswordField, PopupView, ProgressBar, PropertyFilter<V>, RadioButtonGroup<I>, ResizableTextArea<V>, ResourceView, RichTextArea, ScrollBoxLayout, SearchField, 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, WebdavDocumentUploadField
All Known Implementing Classes:
AbstractActionsHolderComponent, AbstractBox, AbstractCanvasLayout, AbstractComponent, AbstractDataGrid, AbstractField, AbstractFileStorageUploadField, AbstractOrderedLayout, AbstractPagination, AbstractResourceView, AbstractSelectList, AbstractSingleFileUploadField, AbstractSingleFilterComponent, AbstractSuggestionField, AbstractTable, AbstractTextArea, AbstractValueComponent, AbstractViewComponent, AccordionImpl, AngularGaugeChartImpl, AppMenuImpl, AppWorkAreaImpl, BpmnModelerImpl, BpmnViewerImpl, BrowserFrameImpl, ButtonImpl, ButtonsPanelImpl, CalendarImpl, CanvasCssLayout, CanvasGridLayout, CanvasHorizontalLayout, CanvasResponsiveLayout, CanvasRootLayout, CanvasVerticalLayout, CanvasWidgetLayout, 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, FullTextFilterImpl, FunnelChartImpl, GanttChartImpl, GeoMapImpl, GrapesJsHtmlEditorImpl, GrapesJsNewsletterHtmlEditorImpl, GrapesJsWebpageHtmlEditorImpl, GridLayoutImpl, GroupBoxImpl, GroupFilterImpl, GroupTableImpl, HBoxLayoutImpl, HtmlBoxLayoutImpl, ImageImpl, JavaScriptComponentImpl, JpqlFilterImpl, LabelImpl, LinkButtonImpl, LinkImpl, LogoutButtonImpl, MaskedFieldImpl, MultiSelectListImpl, NewWindowButtonImpl, NotificationsIndicatorImpl, OutcomesPanelImpl, PaginationImpl, PaletteButton, PasswordFieldImpl, PieChartImpl, PivotTableImpl, PopupButtonImpl, PopupViewImpl, ProgressBarImpl, PropertyFilterImpl, RadarChartImpl, RadioButtonGroupImpl, RectangularChartImpl, RelatedEntitiesImpl, ResizableTextAreaImpl, ResponsiveGridLayoutImpl, RichTextAreaImpl, ScrollBoxLayoutImpl, SearchFieldImpl, 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, WebdavDocumentLinkImpl, WebdavDocumentUploadFieldImpl, WebdavDocumentVersionLinkImpl, XYChartImpl
public interface HasContextHelp
An interface implemented by components that can provide a context help.

  • Method Details

    • getContextHelpText

      @Nullable String getContextHelpText()
      Returns:
      context help text

    • setContextHelpText

      @StudioProperty(type=LOCALIZED_STRING) void setContextHelpText(@Nullable 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 Consumer<HasContextHelp.ContextHelpIconClickEvent> getContextHelpIconClickHandler()
      Returns:
      a context help icon click handler

    • setContextHelpIconClickHandler

      void setContextHelpIconClickHandler(@Nullable 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