Package io.jmix.ui.component
@NonNullApi
package io.jmix.ui.component
-
ClassDescriptionAn accordion is a component similar to a
TabSheet
, but with a vertical orientation and the selected component presented between tabs.SelectedTabChangeEvents are fired when a selected tab is changed.Tab interface.Component supporting an action.Base interface for actions aware dialog facets.Immutable POJO that stores dialog action settings.The event that is fired whenActionsAwareDialogFacet.DialogAction.actionHandler
is triggered.A component containingAction
s.Work area modeWork area stateEvent that is fired when work area changed its state.Component that firesAttachEvent
andDetachEvent
events.A component displaying an embedded web page.Standard values of the attribute allow of iframe HTML element.Standard values of the attribute referrerpolicy of iframe HTML element.Standard values of the attribute sandbox of iframe HTML element.Data aware component that supports buffered write mode.Event sent when the button is clicked.A container that streamlines the use and placement of the components (usually, buttons) for data management in a components that implementHasButtonsPanel
interface.Calendar<V>Calendar is used for visualizing events in a calendar using week or month view.An event object that is fired when the user clicks backward navigation button.An event object that is fired when the user clicks on a day number of the month.An event object that is fired when the user clicks on an empty space in the day.An event object that is fired when the user clicks on an event.An event object that is fired when the user changes an event position.An event object that is fired when the user changes an event duration.An event object that is fired when the user clicks forward navigation button.An event object that is fired when the user drag-marks day or time cells using mouse.An event object that is fired when the user clicks on a week number.Component shows if CapsLock key is enabled when user inputs password.A group of Checkboxes.Component that manages editable property of child components.A resource that is located in classpath.Event that is fired when the text content of the input has been copied to the clipboard.Describes the default ways a window was closed.Is able to collapse (folding).ComboBox<V>A filtering dropdown single-select component.Caption filtering context.Root of the Generic UI components hierarchy.Component belonging to a frameComponent supporting "editable" state.Component supporting "focusable" state.Object having a caption.Object having a description.Component having an icon.Object having an XML descriptor attached.Component delegating work to some "wrapped" client-specific implementation.Component which can contain other components.Visitor used inComponentsHelper.walkComponents(HasComponents, ComponentFinder)
Contains information forComponentGenerationStrategy
when creating components usingUiComponentsGenerator
.A strategy for creating UI components byUiComponentsGenerator
.Utility class working with GenericUI components.Visitor used inComponentsHelper.walkComponents(HasComponents, ComponentVisitor)
CompositeComponent<T extends Component>An Event that is fired right before the composite component instance is returned byUiComponents
bean.Specifies a string value that is a file path to an xml descriptor that can be used for aCompositeComponent
initialization.CompositeComponent
having a caption.CompositeComponent
having a context help.CompositeComponent
having a description.CompositeComponent
having a HTML caption.CompositeComponent
having a HTML description.CompositeComponent
having an icon.Defines how the client should interpret textual values.CssLayout is a layout component renders components and their captions into a same DIV element.CurrencyField<V extends Number>The CurrencyField component is intended for displaying currency values.Defines where the currency label is located.DataGrid<E>A grid component for displaying tabular data bound to entity type.The root class from which all DataGrid editor event state objects shall be derived.The root class from which all DataGrid event state objects shall be derived.Defines the position of aggregation row.A Renderer that displays a button with a textual caption.A renderer that represents a boolean values as a graphical check box icons.A renderer for presenting simple plain-text string values as a link with call back handler.A column in the DataGrid.An event that is fired when a column's collapsing changes.Event provided by a column generatorAn event that is fired when the columns are reordered.An event that is fired when a column is resized.A renderer for UI components.Context click event fired by aDataGrid
.Class for holding information about a mouse click event.Enumeration, specifying the content type of a Cell in a DataGrid header or footer.A renderer for presenting date values.An event that is fired when the DataGrid editor is closed.class which stores information that can be used when creating a component for aDataGrid
editor.An event that is fired before the DataGrid editor is opened.An event that is fired after the item is updated.An event that is fired before the item is updated.Describes empty state link click event.Represents a footer cell in DataGrid.Represents a footer row in DataGrid.A renderer has a DateTimeFormatter.A renderer has a format string.A renderer has a locale.A renderer has a null representation.Renderer has click listener.Represents a header cell in DataGrid.Represents a header row in DataGrid.A renderer for presenting HTML content.A renderer that representsJmixIcon
.A renderer for presenting images.Click event fired by aDataGrid
A renderer for presenting LocalDate values.A renderer for presenting LocalDateTime values.A renderer for presenting number values.A renderer that represents a double values as a graphical progress bar.Marker interface to indicate that the implementing class can be used as a renderer.Click event fired by aDataGrid.HasRendererClickListener
Enumeration, specifying the destinations that are supported when scrolling rows or columns into view.Event sent when the selection changes.Describes sorting direction.An event that is fired when a sort order is changed.Sort order descriptor.Base interface for DataGrid header or footer cells.DataGrid.StaticRow<T extends DataGrid.StaticCell>Base interface for DataGrid header and footer rows.A renderer for presenting simple plain-text string values.Factory that generates components forDataGrid
editor.Controls triggering of data loaders and provides support for automatic linking data loaders to data containers and visual components.Type of the LIKE clause.Load trigger.DateField<V>A date entry component, which displays the actual date selector or date with time.DatePicker<V>A date entry component, which displays the actual date selector inline.UI component that represents a dialog window of application.Component that firesEditableChangeNotifier.EditableChangeEvent
events.Event sent when theeditable
property is changed.EditorScreenFacet<E,S extends Screen & EditorScreen<E>> Prepares and shows editor screens.Interface for entity aware screen facets.A components that adds toEntityPicker
the ability to select an entity from drop-down list.Describes editor close event.EntityPicker<V>Generic UI component designed to select and display an entity instance.EntitySuggestionField adds to EntityPicker the ability to search an entity by user input.Component container which can expand enclosing components.Expand directionNon-visual component of aScreen
orScreenFragment
.Field<V>Base interface for "fields" - components intended to display and edit value of a certain entity attribute.Component for uploading files from client to server that supports multiple file selection.Describes queue upload complete event.A resource that is stored in the server file system.A resource stored in the FileStorage.Component for uploading files to file storage.Defines when file will be placed into FileStorage.Component for uploading files from client to server.Generic filter component.A configuration is a set of filter components.Event sent when theFilter.Configuration
is changed.Component that can be used for filtering entities returned by theDataLoader
.The interface is implemented by generic filter components.A flow layout arranges components in a directional flow, much like lines of text in a paragraph.A multi-column form component.Caption alignment of form child components.Reusable part ofWindow
with separate UI controller.Root class of UI components having controller.Provides access to frame parameters and component values.A layout where the components are laid out on a grid using cell coordinates.Defines a rectangular area of cells in a GridLayout.GroupFilter is a UI component that has aGroupBoxLayout
with aResponsiveGridLayout
as its root element.GroupTable<E>Table UI component that supports grouping of rows by property values.Object that contains information about group aggregation distribution.Class describes information about group columns for the current row.Interface defining method for formatting cell value of group columns.GroupTable column.Allows to define different styles for table cells.Object having a border.Component having a buttons panel.Interface to be implemented byComponent
s that contain otherComponent
s.An interface implemented by components that can provide a context help.Describes context help icon click event.Component annotated by this interface enables to configure custom error message when conversion to specified datatype fails.HasDatatype<V>Event is fired when the user presses the enter key when the text field is on focus.Interface for UI components that support filter mode.Describes filter modes that should be used in the field.HasFormatter<V>Object having a formatter.Component which can contain other components.Interface for UI components that support a textual input prompt.A component that is marked with this interface allows to manage caption for component item.A class that implements this interface can have indentation between the outer borders and the container content.Interface to be implemented by components that enable to configuremin-height
andmin-width
CSS properties.Component which can contain other components and provides access "by-name" to children.A component that is marked with this interface allows to manage caption for options displayed by this component.A component that is marked with this interface allows to manage a description for option displayed by this component.A component that is marked with this interface allows to manage an icon for option displayed by this component.A component that is marked with this interface allows to manage an image for option displayed by this component.A component that is marked with this interface allows to manage additional style names for options displayed by this component.A class that implements this interface can have indentation outside the border.Interface to be implemented by components that can display thePagination
component.HasRange<V>An interface implemented by components that can have a required indicator.A class that implements this interface can have space between child components.Interface for UI components that provide additional objects for framework as part of component API.Component having presentations.HasValidator<V>Interface to be implemented by a component that can have validators.HasValue<V>UI component having a value.Describes value change event.Component container, which shows the subcomponents in the order of their addition (horizontally).Sets DOM and CSS attributes to UI component widgets.Common CSS property names.Common DOM attribute names.A container component with freely designed layout and style.Image<T>The Image component is intended for displaying graphic content.AImage.ClickEvent
is fired when the user clicks on anImage
.Defines image scale mode.Prepares and shows input dialogs.A JavaScript wrapper.The type of dependency.An event that is fired when a method is called by a client-side JavaScript function.JpqlFilter<V>JpqlFilter is a UI component used for filtering entities returned by theDataLoader
.Label<V>Label component for showing non-editable short texts.Layout having a mouse click listener.Event sent when a user clicks mouse inside the layout.HTML link component.A button looking like hyperlink.A component that can display tabular data.Component which can contain other filter components and can be used for filtering entities returned by theDataLoader
.Operation representing corresponding logical filtering condition.A component which can be set as lookup component for a screen.Component that firesLookupComponent.LookupSelectionChangeEvent
when lookup selected items set is changed.LookupScreenFacet<E,S extends Screen & LookupScreen<E>> Prepares and shows lookup screens.MaskedField<V>Masked field component generic interface.Prepares and shows message dialogs.Class to store mouse event details.Constants for mouse buttons.List select component.Prepares and shows notifications.Prepares and shows option dialogs.OptionsField<V,I> UI component having options.Component which can contain other components and provides indexed access to children.Component that makes a data binding to load data by pages.The event that is fired when the user selects another page or clicks on navigation buttons (next, previous, etc).Base interface for components that make a data binding to load data by pages.The event that is fired after data refresh.The event that is fired before refreshing the data when the user clicks next, previous, etc.A field that is used to enter secret text information like passwords.AButton
with a popup.Opening direction for the popup.Event sent when the visibility of the popup changes.A component for displaying a two different views to data.Popup position.Event sent when the visibility of the popup changes.Progress bar is a component that visually displays the progress of some task.PropertyFilter is a UI component used for filtering entities returned by theDataLoader
.Operation representing corresponding filtering condition.Operation type representing the required field type for editing a property value with the given operation.Event sent when theoperation
property is changed.A group of RadioButtons.A static resource that is served by the application.Interface to be implemented by a component that requires a valueResizable text area component.Represents directions in which textArea can be resized.Deprecated.Marker interface to indicate that the implementing class can be used as a resource.A class that implements this interface is intended for viewing different resources, e.g.Marker interface to indicate that the implementing class supports MIME type setting.Marker interface to indicate that the implementing class has stream settings (such as cache time, buffer size or file name).SourceChangeEvent is fired when a source is changed.A layout where the components are laid out on a grid, based on the Bootstrap's 12 columns grid system.Represents the default behavior for how flex items are laid out along the cross axis on the current row.Represents the default behavior for how individual flex item is laid out along the cross axis.Breakpoint representing minimum viewport widths used in media query ranges.Interface defining a grid column.Class containing information about logical columns number that a column occupies.Container type representing possible basic container styles.Interface to provide default functionality for grid elements.Represents the default behavior for how flex items are laid out along the main axis on the current row.Class containing information about the number of columns by which to move a column to the right.Class containing information for controlling the visual order of a column.Interface defining a grid row.Class containing information about the number of columns in the row.A simple RichTextArea to edit HTML format text.UI component that represents a top level window of application.ScreenFacet<S extends Screen>Prepares and shows screens.Component container that shows scrollbars if its content does not fit the viewport.AnActionsHolder
component that loads and controls permissions on owned actions.SelectList<V,I> Base interface for list components.The event sent when the user double-clicks mouse on a list item.The ShortcutAction is triggered when the user presses a given key combination.Component having a shortcut listener.Describes shortcut triggered event.Component that makes a data binding to load data by pages.Describes after value clear event.Describes before value clear event.Describes file upload succeeded event when the uploads are successfully finished.Component which cannot contain other filter component but can be used for filtering entities returned by theDataLoader
.List select component.A class for representing a value-unit pair.Text area component with source code highlighting support.A split panel contains two components and lays them vertically or horizontally.Specifies SplitPanel docking direction.Event that indicates a change in SplitPanel's splitter position.A resource provided as anInputStream
.A filtering dropdown single-select.Base interface for SuggestionField components.Event is fired when user pressed ARROW_DOWN key without search action.Extended version ofSuggestionFieldComponent.SearchExecutor
that allows to pass parameters.Custom suggestions search action interface.Interface to be implemented by a component that supports different caption positions.Caption position of the component.Utility interface for components that show only selected child.Interface to be implemented by a component that supports different values of the number of columns that will be displayed in one row.Component container which supports expand ratio of componentsTable<E>Table UI component bound to entity type.Object that contains information about aggregation distribution.Allows to handle a group or total aggregation value changes.The location of the aggregation row.Table.Column<E>Table column.An event is fired when the user clicks inside the table cell that belongs to the current column.Column alignment.Event sent every time column collapse state changes.Allows rendering of an arbitraryComponent
inside a table cell.An event that is fired when a columns are reordered by the user.Describes empty state link click event.Special component for generated columns which will be rendered as simple text cell.Table.Printable<E,P> Deprecated.Use export action APIs instead.Deprecated.Use export action APIs instead.Row header mode.Event sent when the selection changes.Describes sorting direction.Object that contains information about column sorting.Allows to define different styles for table cells.TabSheet component interface.SelectedTabChangeEvents are fired when a selected tab is changed.Tab interface.Handler that overrides the default behavior ifTabSheet.Tab.isClosable()
is true and a user clicks the close button.Tab window UI component.TagField<V>The field that search and shows selected values as separated tags right in the field.Enables to handle a user's entered text and add it to a TagField value.Describes tag click event.TagPicker<V>The field that shows selected values as separated closable tags which are placed near to the field.Describes tag click event.The interface that marks implementation asTagPicker
's action.Defines position of tags relative to the field.TextArea<V>A text field that supports multi line editing.TextField<V>A component for editing textual data that fits on a single line.Defines case conversion for text input fields, which implementTextInputField.CaseConversionSupported
interface.EnterPressEvents are fired when the user presses Enter while editing the text content of a field.TextChangeEvents are fired at the same time whenHasValue.ValueChangeEvent
s are fired.Different modes how the TextField can triggerTextInputField.TextChangeEvent
s.An interface for UI components that provide additional methods for text change handling.A resource located in the current UI theme.TimeField<V>A time entry component, which displays the actual time.Defines component time mode (12h AP/PM or 24h).Client-side timer component that fires events at fixed intervals.Event fired on timer tick.Event fired on timer stop afterTimer.stop()
call.Tree<E>A component is intended to display hierarchical structures represented by entities referencing themselves.An event that is fired when an item is collapsed.An event that is fired when an item is expanded.Event sent when the selection changes.TreeDataGrid<E>A DataGrid component for displaying hierarchical tabular data.An event that is fired when an item is collapsed.An event that is fired when an item is expanded.TreeTable<E>TwinColumn<V>A component with two lists: left list for available options, right list for selected values.Factory to create UI components usingComponentGenerationStrategy
.State of subcomponents can be managed by UI permissions.Drop zone descriptor.Describes file upload error event.Base class for UploadField events.Describes file upload finish event.Describes file upload start event.A resource that can be loaded from an arbitrary URL.A component which can be validatedEncapsulates errors found during components validation.Exception to be thrown by field validators.ValuePicker<V>Generic UI component designed to select and display a value of any type.The event that is fired when a user inputs value manually.Interface to be implemented by actions intended to be used by ValuePicker.ValuesPicker<V>Component container, which shows the subcomponents in the order of their addition (vertically).Represents an independent window of application.Event sent right before the window is closed by an external (relative to the window content) action, like the button in the window tab or by the Esc keyboard shortcut.Marker interface for all window close types, which describes the way a window was closed.Represents a window that can be committed on close.Defines how the managed main TabSheet switches a tab with the given window: hides or unloads its content.Window having a user indicator.Window having a work area.Provides access to window parameters and component values.Window modes
ResizableTextArea.ResizeEvent