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, GridLayout, GroupBoxLayout, GroupFilter, GroupTable<E>, HBoxLayout, HtmlBoxLayout, Image<T>, JpqlFilter<V>, Label<V>, Link, LinkButton, MaskedField<V>, MultiSelectList<V>, OptionsField<V,I>, PasswordField, PopupButton, PopupView, ProgressBar, PropertyFilter<V>, RadioButtonGroup<I>, RelatedEntities<E>, ResizableTextArea<V>, ResourceView, RichTextArea, ScrollBoxLayout, 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

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 HasHtmlDescription
extends Component.HasDescription

Method Summary

Modifier and Type	Method and Description
boolean	isDescriptionAsHtml()
void	setDescriptionAsHtml(boolean descriptionAsHtml) Sets whether the description is rendered as HTML.

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

Method Detail

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:

Component.HasDescription.setDescription(String)