io.jmix.ui.component

Interface Component.HasDescription

All Known Subinterfaces:

Accordion, AngularGaugeChart, BoxLayout, BrowserFrame, Button, ButtonsPanel, Calendar<V>, Chart<T>, CheckBox, CheckBoxGroup<I>, ColorPicker, ComboBox<V>, Component.HasCaption, CompositeWithCaption, CompositeWithDescription, CompositeWithHtmlCaption, CompositeWithHtmlDescription, CoordinateChart<T>, CssLayout, CurrencyField<V>, CustomChart, DataGrid<E>, DateField<V>, DatePicker<V>, DialogWindow, EntityComboBox<V>, EntityLinkField<V>, EntityPicker<V>, EntitySuggestionField<V>, Field<V>, FileMultiUploadField, FileStorageUploadField, FileUploadField, Filter, FlowBoxLayout, Form, Fragment, FragmentImplementation, Frame, FunnelChart, GanttChart, GridLayout, GroupBoxLayout, GroupFilter, GroupTable<E>, GroupTable.GroupColumn<E>, HasHtmlCaption, HasHtmlDescription, HBoxLayout, HtmlBoxLayout, Image<T>, JavaScriptComponent, JpqlFilter<V>, Label<V>, Link, LinkButton, LogoutButton, MaskedField<V>, MultiSelectList<V>, NewWindowButton, OptionsField<V,I>, PasswordField, PieChart, PivotTable, PopupButton, PopupView, ProgressBar, PropertyFilter<V>, RadarChart, RadioButtonGroup<I>, RectangularChart<T>, RelatedEntities<E>, ResizableTextArea<V>, ResourceView, RichTextArea, RootWindow, ScrollBoxLayout, SelectList<V,I>, SerialChart, SeriesBasedChart<T>, SingleFileUploadField, SingleFilterComponent<V>, SingleSelectList<V>, SlicedChart<T>, Slider<V>, SourceCodeEditor, SplitPanel, StockChart, SuggestionField<V>, SuggestionFieldComponent<V,I>, Table<E>, Table.Column<E>, TabSheet, TabSheet.Tab, TabWindow, TagField<V>, TagPicker<V>, TextArea<V>, TextField<V>, TextInputField<V>, TimeField<V>, TimeZoneIndicator, Tree<E>, TreeDataGrid<E>, TreeTable<E>, TwinColumn<V>, UploadField, UserActionsButton, ValuePicker<V>, ValuesPicker<V>, VBoxLayout, Window, WindowImplementation, XYChart

All Known Implementing Classes:

AbstractActionsHolderComponent, AbstractBox, AbstractComponent, AbstractDataGrid, AbstractField, AbstractFileStorageUploadField, AbstractOrderedLayout, AbstractPagination, AbstractResourceView, AbstractSelectList, AbstractSingleFileUploadField, AbstractSingleFilterComponent, AbstractSuggestionField, AbstractTable, AbstractTable.ColumnImpl, AbstractTextArea, AbstractValueComponent, AbstractViewComponent, AccordionImpl, AngularGaugeChartImpl, AppMenuImpl, AppWorkAreaImpl, BrowserFrameImpl, ButtonImpl, ButtonsPanelImpl, CalendarImpl, CapsLockIndicatorImpl, ChartImpl, CheckBoxGroupImpl, CheckBoxImpl, ColorPickerImpl, ComboBoxImpl, CoordinateChartImpl, CssLayoutImpl, CurrencyFieldImpl, CustomChartImpl, DataGridImpl, DateFieldImpl, DatePickerImpl, DialogWindowImpl, DrawerImpl, EntityComboBoxImpl, EntityLinkFieldImpl, EntityPickerImpl, EntitySuggestionFieldImpl, FileMultiUploadFieldImpl, FileStorageUploadFieldImpl, FileUploadFieldImpl, FilterImpl, FlowBoxLayoutImpl, FormImpl, FragmentImpl, FunnelChartImpl, GanttChartImpl, GridLayoutImpl, GroupBoxImpl, GroupFilterImpl, GroupTableImpl, GroupTableImpl.GroupColumnImpl, 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, RootWindowImpl, ScrollBoxLayoutImpl, SerialChartImpl, SeriesBasedChartImpl, SideMenuImpl, SimplePaginationImpl, SingleSelectListImpl, SlicedChartImpl, SliderImpl, SourceCodeEditorImpl, SplitPanelImpl, StockChartImpl, SuggestionFieldImpl, TableImpl, TabSheetImpl, TabSheetImpl.Tab, TabWindowImpl, TagFieldImpl, TagPickerImpl, TextAreaImpl, TextFieldImpl, TimeFieldImpl, TimeZoneIndicatorImpl, TreeDataGridImpl, TreeImpl, TreeTableImpl, TwinColumnImpl, UserActionsButtonImpl, ValuePickerImpl, ValuesPickerImpl, VBoxLayoutImpl, WindowImpl, XYChartImpl

Enclosing interface:

Component

public static interface Component.HasDescription

Object having a description.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription()
void	setDescription(java.lang.String description) Sets the component's description.

Method Detail

getDescription

@Nullable
java.lang.String getDescription()

Returns:

the components description, used in tooltips

setDescription

@StudioProperty(type=LOCALIZED_STRING)
void setDescription(@Nullable
                                                           java.lang.String description)

Sets the component's description.

Parameters:

description - the new description to set