Package io.jmix.ui.component

Interface HasHtmlDescription

All Superinterfaces:
Component.HasDescription
All Known Subinterfaces:
Accordion, BoxLayout, BrowserFrame, Button, ButtonsPanel, Calendar<V>, CheckBox, CheckBoxGroup<I>, ColorPicker, ComboBox<V>, CompositeWithHtmlDescription, CssLayout, CurrencyField<V>, DataGrid<E>, DateField<V>, DatePicker<V>, EntityComboBox<V>, EntityLinkField<V>, EntityPicker<V>, EntitySuggestionField<V>, Field<V>, FileMultiUploadField, FileStorageUploadField, FileUploadField, Filter, FlowBoxLayout, Form, FullTextFilter, GridLayout, GroupBoxLayout, GroupFilter, GroupTable<E>, HBoxLayout, HtmlBoxLayout, Image<T>, JpqlFilter<V>, Label<V>, Link, LinkButton, MaskedField<V>, MultiSelectList<V>, NotificationsIndicator, OptionsField<V,I>, PasswordField, PopupButton, PopupView, ProgressBar, PropertyFilter<V>, RadioButtonGroup<I>, RelatedEntities<E>, ResizableTextArea<V>, ResourceView, RichTextArea, ScrollBoxLayout, SearchField, SelectList<V,I>, SingleFileUploadField, 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>, UploadField, ValuePicker<V>, ValuesPicker<V>, VBoxLayout, WebdavDocumentUploadField, WebdavDocumentVersionLink
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 HasHtmlDescription extends Component.HasDescription

  • Method Details

    • isDescriptionAsHtml

      boolean isDescriptionAsHtml()
      Returns:
      true if the description is rendered as HTML, false if rendered as plain text

    • setDescriptionAsHtml

      @StudioProperty(defaultValue="false") void setDescriptionAsHtml(boolean descriptionAsHtml)
      Sets whether the description is rendered as HTML.
      Parameters:
      descriptionAsHtml - true if the description is rendered as HTML, false if rendered as plain text
      See Also: