All Classes and Interfaces
Class
Description
Abstract class for
Actions.AbstractActionBindingImpl<H extends com.vaadin.flow.component.Component,A extends Action,C extends com.vaadin.flow.component.Component>
Deprecated, for removal: This API element is subject to removal in a future version.
AbstractActionsHolderSupport<C extends com.vaadin.flow.component.Component>
Abstract base class for managing and binding actions to a component.
An abstract base implementation of the
Aggregation interface.Base class for the all entities loader which is used to export to other data formats such as excel or json
The base class for area style.
The base class for axis.
AxisPointer component for the axis.
The boundary gap on both sides of a coordinate axis.
Base class for series with Cartesian and polar coordinates.
SeriesLayoutBy specifies whether the column or the row of
DataSet is mapped to the series,
namely, the series is "layout" on columns or rows.The base class for axis pointer.
Base class for events that contain information about
BackgroundTask.Provides base functionality to sort the list of scan configurations in the same order as Jmix modules have been sorted
using configuration base packages.
The base class for text with border.
Base class for configuring properties of calendar display modes (
CalendarDisplayModes).The base class for Cartesian axes.
Position of Cartesian axis.
Base detail for component aware events.
Base chart event class.
Base chart event for mouse.
Base detail for mouse events.
Abstract class for checkbox-like web-element wrappers.
Base class for events that contains information about mouse click.
Base class for actions that close tabs.
Base cluster for cluster sources.
Interface to be implemented by sources that should provide all attributes from
AbstractClusterSource.Interface to be implemented by sources that should provide
disableAtZoom management.Interface to be implemented by sources that should provide cluster distance management.
Interface to be implemented by sources that should provide cluster minimum distance management.
Interface to be implemented by sources that should provide point styles management.
Interface to be implemented by sources that should provide
pointTextStyle management.Interface to be implemented by sources that should provide
showSinglePointAsCluster option management.Interface to be implemented by sources that should contain vector source.
Interface to be implemented by sources that should provide weight property management.
Abstract class for combobox-like web-element wrappers.
AbstractComboBoxLoader<T extends com.vaadin.flow.component.combobox.ComboBox<?>>
An abstract class that provides a base implementation for custom comparators.
Abstract class for web-element wrappers.
AbstractComponentDelegate<C extends com.vaadin.flow.component.Component>
AbstractComponentLoader<T extends com.vaadin.flow.component.Component>
Base UI component class that provides UI for filter's configuration save dialog.
AbstractContainerLoader<T extends com.vaadin.flow.component.Component>
AbstractDatabaseUserRepository<T extends org.springframework.security.core.userdetails.UserDetails>
Base implementation of
UserRepository that loads users from the database.Abstract implementation of the
HasDataComponents interface providing a base for managing
data-related components such as DataContext, InstanceContainer, and DataLoader.INTERNAL.
Designed to store and share various data during load transaction.
The event is fired when a geographic object has been removed.
AbstractDataViewDelegate<C extends com.vaadin.flow.component.Component & com.vaadin.flow.data.provider.HasDataView<V,?,?> & com.vaadin.flow.data.provider.HasListDataView<V,?> & SupportsDataProvider<V>,V>
Base component witch used for zooming a specific area in the chart.
Filtering mode options.
Settings for decoding range values.
AbstractDateTimeFieldDelegate<C extends com.vaadin.flow.component.AbstractField<?,V>,T extends Comparable,V>
Base class for configuring properties of day-grid display modes.
AbstractDescriptionEditFragment<C extends com.vaadin.flow.component.Component>
Abstract class for details web-element wrappers.
AbstractDetailsLoader<C extends com.vaadin.flow.component.details.Details>
A base class representing a generic dialog window that can display a view.
Abstract wrapper class for
Dialog.DialogHeader and Dialog.DialogFooter that is used for
DialogWindow configuration.An abstract base class for dropdown button components, providing functionality for managing dropdown items,
icons, styles, and various component behaviors.
Blank item needed for correct insertion by index.
Abstract class for web-element wrappers with dropdowns.
An abstract implementation of the
AbstractSearchStrategy that contains specifics of the ElasticSearch.The base class for enhanced label.
Abstract class for entity based data providers.
Base class of application events sent on entity operations.
Class containing a basic functionality of standard JSON transformer.
Base class for
CalendarEvent change events.INTERNAL.
Class contains information about previous values of
CalendarEvent.Provides related calendar events and their data provider.
An abstract implementation of the
Facet interface, providing
base functionality for non-visual components associated with views.A base class for toolbox feature.
Source contains a list of features.
Abstract class for field web-element wrappers.
Class with basic functionality for processor of some field-mapping annotation.
Base class for
FieldMapper implementations.AbstractFilterComponentConverter<C extends com.vaadin.flow.component.Component & FilterComponent,M extends FilterCondition>
AbstractFormattableRendererProvider<R extends com.vaadin.flow.data.renderer.Renderer<?>>
Base class for all context-based "events".
INTERNAL.
Base action for saving filter configurations.
AbstractGridDelegate<C extends com.vaadin.flow.component.grid.Grid<E> & ListDataComponent<E> & EnhancedDataGrid<E> & HasActions,E,ITEMS extends DataGridItems<E>>
Contains information about metaClass, data container, loader, fetch plan.
Abstract implementation of a GridMultiSelectionModel.
AbstractGridSettingsBinder<V extends com.vaadin.flow.component.grid.Grid<?>,S extends DataGridSettings>
Abstract implementation of the
DataLoadingSettingsBinder interface for handling settings binding and
persistence in a Grid.Abstract implementation of a GridSingleSelectionModel.
A base class that adapts an implementation of
GroupListDataComponent to use it as a
DataGrid in other components and modules (e.g., in export actions).Abstract adapter for columns from
GroupListDataComponent that delegates all calls to the adaptee.AbstractGroupGridDelegate<C extends GroupDataGrid<E> & ListDataComponent<E> & EnhancedGroupDataGrid<E> & HasActions,E,ITEMS extends GroupDataGridItems<E>>
Contains information about metaClass, data container, loader, fetch plan.
Abstract implementation of the
DataLoadingSettingsBinder interface for handling settings binding and
persistence in a Grid.AbstractHtmlComponentLoader<T extends com.vaadin.flow.component.HtmlComponent>
AbstractHtmlContainerLoader<T extends com.vaadin.flow.component.HtmlContainer>
Abstract static image source.
Interface to be implemented by sources that should provide imageExtent management.
Interface to be implemented by sources that should provide all attributes from
AbstractImageStaticSource.Interface to be implemented by sources that can display image from classpath resources.
Abstract image WMS source.
Interface to be implemented by sources that should provide all attributes from
AbstractImageWmsSource.Interface to be implemented by sources that should provide ratio management.
The base class for series item style.
Simplifies join expression generation depending on mapping type.
Base class for events related to
KanbanColumnBase class for serializers to be used in
JmixKanbanSerializer.Base class for events related to Kanban task item.
AbstractLayoutLoader<T extends com.vaadin.flow.component.Component & com.vaadin.flow.component.orderedlayout.ThemableLayout & com.vaadin.flow.component.orderedlayout.FlexComponent & com.vaadin.flow.component.ClickNotifier<T>>
AbstractLdapUserDetailsSynchronizationStrategy<T extends org.springframework.security.core.userdetails.UserDetails>
A basic implementation of
LdapUserDetailsSynchronizationStrategy, which provides
a general functionality for user synchronization with UserRepository.Base class for legend component.
Legend marker and text aligning.
Component to configure the emphasis state.
The position of the selector button, which can be
placed at the end or start of the legend component.
The text label style of the selector button, which is displayed by default.
Text font style for legend component.
Base class for configuring properties of list display modes.
AbstractLoginFormLoader<C extends com.vaadin.flow.component.login.AbstractLogin>
Base class for mark point, mark line and mark area.
Base class for mark elements.
Abstract class for menu web-element wrappers.
Abstract class for multi-select combobox web-element wrappers.
AbstractMultiSelectComboBoxLoader<C extends com.vaadin.flow.component.combobox.MultiSelectComboBox<?>>
Abstract base class for implementing navigation processors that handle
navigation to specific views using a defined navigator.ting between views.
Abstract base class for performing aggregation operations on collections
of numerical data.
AbstractNumberFieldDelegate<C extends com.vaadin.flow.component.textfield.AbstractNumberField<?,V>,T extends Number,V extends Number>
An abstract implementation of the
AbstractSearchStrategy that contains specifics of the OpenSearch.Abstract class for overlays.
Abstract class for web-element wrappers that supports opening
AbstractOverlay.Abstract base class for implementing pagination components.
The base class for polar axes.
Base class for
PropertyValueExtractor implementations.INTERNAL.
AbstractRestUserRepository<T extends org.springframework.security.core.userdetails.UserDetails>
Base implementation of
UserRepository that loads users from the REST DataStore.The base class for text with rich option.
Implements common logic for all platform-specific implementations.
Base class for all search strategies.
The base class for any series.
Unified layout configuration component of labels.
Enum to move the overlapped labels to avoid overlapping.
Tooltip component for series.
AbstractShortcutActionBindingImpl<H extends com.vaadin.flow.component.Component,A extends Action,C extends com.vaadin.flow.component.Component>
Deprecated, for removal: This API element is subject to removal in a future version.
Abstract base class for creating single file upload fields.
Abstract class for
SpecificConditionHandler.AbstractTabsLoader<C extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasStyle & com.vaadin.flow.component.HasTheme & com.vaadin.flow.component.HasSize>
The base class for text components.
Abstract class for fields web-element wrapper that supports text input.
Source contains all attributes for loading tile data from WMS servers.
Interface to be implemented by sources that should provide all attributes from
AbstractTileWmsSource.Base class for configuring properties of time-grid display modes.
The base class for tooltip components.
Base class for exception handlers determining their ability to handle an exception by its class name and optional
implementation of
AbstractUiExceptionHandler.canHandle(String, String, Throwable) method.An abstract class for binding a UI component with URL query parameters.
Base class for URL query binder providers.
This event is used to notify listeners about user invalidation: when the user has been deleted or disabled.
Main class for validators.
Abstract implementation of
ValueBinding.AbstractValueComponentDelegate<C extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasValue<?,V>,T,V>
Source contains all attributes for displaying features.
Interface to be implemented by sources that should provide overlaps attribute management.
Interface to be implemented by sources that should provide useSpatialIndex attribute management.
Interface to be implemented by sources that should provide all attributes from
AbstractVectorSource.Provides a fluent interface to configure navigation parameters and navigate to a
View.Abstract base class that partially implements the
ViewSettings interface
and provides common functionality related to managing settings for a specific View.Base class for component type for visual encoding.
The layout relationship between the graphical elements for pieces and their labels.
Controller for
AbstractVisualMap.VisualMapController.inRange and AbstractVisualMap.VisualMapController.outOfRange properties.A generic abstract builder class for constructing dialog windows with specific configurations and listeners.
Abstract base class for processing and constructing
DialogWindow instances
using DialogWindowBuilder.Base source for loading tiled images using XYZ format.
Interface to be implemented by sources that should provide max zoom management.
Interface to be implemented by sources that should provide min zoom management.
Interface to be implemented by sources that should provide tileSize management.
Interface to be implemented by sources that should provide all attributes from
AbstractXyzSource.Provides the ability to store authorities on a
UserDetailsDeprecated, for removal: This API element is subject to removal in a future version.
Base interface of classes that make authorization decisions.
Marker interface for classes defining authorization points.
Exception that is raised on attempt to violate a security constraint.
Handles AccessDeniedExceptionHandler that can be thrown by checking access to the dialog.
Helps to track access control restrictions of the current user.
Web-element wrapper for accordion.
Accordion panel web-element wrapper.
The
Action interface abstracts away a function from a visual component.ActionBinder<H extends com.vaadin.flow.component.Component>
Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated, for removal: This API element is subject to removal in a future version.
Helper class that checks whether handlers set for an action are appropriate for the given open mode.
Interface to be implemented by UI components or their sub-parts that have an action.
Represents an item in a dropdown button that is associated with an
Action.Event sent when the
Action is performed.Factory to create actions declared as
ActionType.Allows to sort the list of
ActionsConfiguration in the same order as Jmix modules containing the actions
have been sorted.ActionsHolderBinding<H extends com.vaadin.flow.component.Component,A extends Action,C extends com.vaadin.flow.component.Component>
Deprecated, for removal: This API element is subject to removal in a future version.
ActionsHolderBindingImpl<H extends com.vaadin.flow.component.Component,A extends Action,C extends com.vaadin.flow.component.Component>
Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated, for removal: This API element is subject to removal in a future version.
Implementation of the
Actions interface that manages the creation and registration
of action types annotated with ActionType.Represents a specific type of
UserMenuItem that is associated with an Action.Set of variants applicable to
Action.An event listener that publishes a Spring application event when an activity is completed.
An event listener that publishes a Spring application event when an activity is started.
A number format that is used when the entity attribute has the
NumberFormat annotation.Defines additional business day in annotated business calendar (see
BusinessCalendar).Gathers information about additional business days for annotated business calendar.
Provides the additional criteria for the query.
Implementations of the interface are responsible for constructing a global
AuthenticationManager.Interface to be implemented by actions which may adjust
their 'enabled' state according to the view read-only mode.
Interface for listeners notified after transaction completion.
Defines the contract for handling of entities after they have been deleted or marked as deleted in DB.
Defines the contract for handling entities after they have been inserted into DB.
Defines the contract for handling of entities after they have been updated in DB.
A delegate component responsible for performing data aggregation operations.
Defines methods for performing aggregation operations on a collection of items.
Constructor for an object which will aggregate results per cell
(see documentation).
POJO to store all information needed to create aggregation in
DataGrid.Represents the type of aggregation to be performed.
An enum with predefined aggregations.
Class that is responsible for registering and managing aggregation strategies for various data types.
Custom aggregation strategy for
DataGrid component.The horizontal align of the component.
This interface should be implemented by any bean which loads all entities for json or excel export.
Visitor is passed to
AllEntitiesLoader to export loaded entityGives access to the all entities loader with current pagination strategy
set in application.properties
GridExportProperties.getExportAllPaginationStrategy()Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated, for removal: This API element is subject to removal in a future version.
The angle axis in Polar Coordinate.
Helper class that used to build
BusinessCalendar from class annotated with BusinessCalendar.Provider that builds and returns business calendars from classes annotated with
BusinessCalendar.Bean responsible for parsing, validating annotated report group definition
and creating a model object that can be referenced by annotated reports or used otherwise by the application.
Provides functionality to process index definition interfaces marked with
JmixEntitySearchIndexBean responsible for parsing, validating report definition
and creating a model object that can be used by the application.
Bean that holds report group definitions parsed from annotated classes.
Bean that holds report definitions parsed from annotated classes.
Part of the
AnnotatedReportBuilder.Performs the following tasks:
scanning and importing annotated report definitions
reloading hot-deployed definitions
Part of the
AnnotatedReportBuilder.Role provider that gets roles from classes annotated with
ResourceRole.Role provider that gets row level roles from classes annotated with
RowLevelRole.The
AnnotationLockDescriptorProvider creates and collects
LockDescriptor objects for locks annotated by PessimisticLock
annotation from data model objects.Deprecated, for removal: This API element is subject to removal in a future version.
Interface provides a
RequestMatcher for anonymous endpoints that will be processed by the
CompositeResourceServerRequestMatcherProviderImpl.Provides a list of anonymous URL patterns that will be used for building the
RequestMatcher by the
AnonymousUrlPatternsRequestMatcherProviderAn implementation of
AnonymousRequestMatcherProvider that collects anonymous URL patterns from multiple
AnonymousUrlPatternsProviders and builds the RequestMatcher from all collected URL patterns.Class that encapsulates logic of
SearchStrategy that searches documents
with at least one field matches at least one input word.Class that encapsulates logic of
SearchStrategy that searches documents
with at least one field matches at least one input word.JSON representation
{"ms-word": {
"name": "Microsoft Word",
"protocols": {
"default": "ms-word:ofe%7Cu%7C",
"read-only": "ms-word:ofv%7Cu%7C"}
"extensions": ["docx", "doc", "txt"]}}
Controls how
AccessConstraints are used by JmixDataRepository.An implementation of the
AuthenticatedUrlPatternsProvider and the AnonymousUrlPatternsProvider that
gets URL patterns from application properties:
For authenticated URL patterns the class uses the jmix.resource-server.authenticated-url-patterns property
For anonymous URL patterns the class uses the jmix.resource-server.anonymous-url-patterns property
A default value.
A boolean default value.
A double default value.
An int default value.
A long default value.
Base class for entities that present application settings.
Common style of area.
Strategy interface to Resolves method parameters by delegating to a list of registered
MethodArgumentResolvers.Aria is options for the Accessible Rich Internet Applications Suite,
which is dedicated to making web content and web applications accessible.
It is turned off by default and needs to be turned on by setting
More detailed information is provided in the documentation.
It is turned off by default and needs to be turned on by setting
Aria.setEnabled(Boolean) to true.More detailed information is provided in the documentation.
Decal patterns configuration component.
A component which contains the description of the chart.
Data-related configuration component.
A component for the overall description of the chart.
Series-related configuration component.
Base component for the description labels.
The description component used when the chart contains only multiple series.
The description component used when the chart contains only one series.
Event fired after resource server (registered by Authorization Server add-on) API controller call.
Event fired before resource server (registered by Authorization Server add-on) API call.
The purpose of the filter is to throw before- and after- events for resource server API invocations.
AssignDropdownButtonActionInitTask<C extends com.vaadin.flow.component.Component & DropdownButtonComponent>
An object describing changes in entity attributes.
INTERNAL.
Provides information about changes in entity attributes.
Provides components for attribute fields.
A helper class for handling JMX attribute types and values.
Class is used to display the attributes list in the
EntityAttributeResourcePolicyModelCreateView screen.Used for current time conversion from
Date to CreatedDate, LastModifiedDate and DeletedDate field types.Default implementation to support common types.
Provides information about current user for audit purposes -
Creatable, Updatable, SoftDelete entities and for Entity Log.
Class contains authentication information.
Class that contains result of
AuthDetails validation.Interface to be implemented by custom validators of
AuthDetails.Annotation for bean methods which require authentication, i.e.
Interface provides a
RequestMatcher for authenticated endpoints that will be processed by the
CompositeResourceServerRequestMatcherProviderImpl.Provides a list of authenticated URL patterns that will be used for building the
RequestMatcher by the
AuthenticatedUrlPatternsRequestMatcherProviderAn implementation of
AuthenticatedRequestMatcherProvider that collects authenticated URL patterns from
multiple AuthenticatedUrlPatternsProviders and builds the RequestMatcher from all collected URL
patterns.A resolver that provides
Locale if current authentication does not contain it.Interface is responsible for providing an instance of global
AuthenticationManager.Strategy for resolving a principal from the authentication.
Strategy for accessing root authentication from wrapped authentication in the current security context.
Token introspector that queries the backing store of tokens (authorization service) and fills the authenticated
principal authorities with proper roles depending on authorization grant type:
For AUTHORIZATION_CODE grant type, roles of authenticated user are used
For CLIENT_CREDENTIALS grant type, roles specified for the client in the properties file are used
For PASSWORD grant type, roles of authenticated user are used
Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated, for removal: This API element is subject to removal in a future version.
use
AuthenticatedUrlPatternsProvider and AnonymousUrlPatternsProviderA
AuthenticationPrincipalResolver that makes the CurrentAuthentication.getUser() method return an
instance of the actual user class (usually a JPA entity defined in the application) if authenticated using access
token.Class stores Jmix-specific settings of Authorization Server client.
One of the field-mapping annotation.
Strategy that automatically maps properties the most common way.
Factory to autowire fields/setters and additional dependencies to UI components using
DependencyInjectorHelper class for component dependencies autowiring.
Specifies set of resource roles that can launch the defined report in certain views and actions.
Defines in which views the defined report will be available when invoking standard reporting actions
(from the io.jmix.reportsflowui.action package).
Options component related to axis label.
Options component related to axis line.
The global option for
axisPointer.Options component related to axis tick.
Type of axis.
Background task for execute by
BackgroundWorker.Listener of the task life cycle events, complementary to the tasks own methods:
BackgroundTask.progress(List), BackgroundTask.done(Object),
BackgroundTask.canceled().A default implementation of the
BackgroundTask.ProgressListener interface with empty method bodies.Task handler for
BackgroundTask.Manages background tasks within a Vaadin application session, allowing tasks to be added, removed,
or all tasks to be canceled.
Event is published if the task does not handle timeout in
BackgroundTask.handleTimeoutException().Event is published if the
BackgroundTask.done(Object) throws an exception and executor
cannot handle it.Interface responsible for managing background task lifecycles such as starting, managing,
removing, and terminating tasks.
Implementation of
BackgroundTaskWatchDog for BackgroundWorker.Configures and schedules the periodic task for cleaning up expired or inactive background tasks.
Entry point to
BackgroundTask execution functionality.Implementation of
BackgroundWorker.Defines a band - element of the report data structure.
Bar chart shows different data through the height of a bar, which is used in rectangular coordinate
with at least 1 category axis.
Base component for bar elements.
Background style of each bar.
Component to configure the blur state.
Component to configure the emphasis state.
Item style of bar.
Configuration component of label guideline.
Component to configure the selection state.
Base implementation of
Action.Base class for chart event detail.
ClaimsRolesMapper that can be used as super-class for your own ClaimsRolesMapper implementations.Root interface of collection loaders.
Base implementation of sorting collection containers.
Base role provider that gets resource roles/row level roles from the database.
Base interface for date intervals.
Type of date interval.
Jmix implementation that does not have corresponding class in OpenLayer.
Used by enhancing process.
Provides non-platform-specific functionality.
Class contains information about the current cell value and cell value of parent group columns.
Base implementation of
GroupPropertyDescriptor.Base class for layers with vector data that should be rendered as a heatmap.
Interface to be implemented by layers that should provide all attributes from
BaseHeatmapLayer.Interface to be implemented by layers that should provide "blur" attribute management.
Interface to be implemented by layers that should provide "gradient" attribute management.
Interface to be implemented by layers that should provide "maxWeight" management.
Interface to be implemented by layers that should provide "radius" attribute management.
Interface to be implemented by layers that should provide "weight-property" management.
Base class for layers that works with server-rendered images that are available for arbitrary
extents and resolutions.
Abstract implementation of options for server-rendered images.
Contains non-platform-specific operations.
Class provides logic of index settings and analysis configuration.
Class is responsible for the transforming search clients' specific JSonp format to Jackson's ObjectNode.
Abstract implementation of options for each layer.
Abstract class implements the
OidcUserMapper and may be used for creating your own mappers.Base class for layers with sources that provide pre-rendered, tiled images in grids that are organized by zoom
levels for specific resolutions.
Options for layer sources that provide pre-rendered, tiled images in grids that are organized
by zoom levels for specific resolutions.
Interface to be implemented by layers that should provide "preload" attribute management.
Abstract implementation of options for layer sources that provide pre-rendered, tiled images in grids that are
organized by zoom levels for specific resolutions.
Base class for layers with vector data that is rendered client-side.
Interface to be implemented by layers that should provide "background" attribute management.
Options for layer that renders vector data client-side.
Interface to be implemented by layers that should provide "declutter" attribute management.
Interface to be implemented by layers that should provide "render-buffer" attribute management.
Interface to be implemented by layers that should provide "updateWhileAnimating" attribute management.
Interface to be implemented by layers that should provide "updateWhileInteracting" attribute management.
Abstract implementation of options for vector data that is rendered client-side, as vectors.
Allows resolving the current
Locale as method argument.Validator that applies JSR 303 rules for
HasValue instance.Defines the contract for handling entities right before they are attached to an EntityManager on merge operation.
Interface for listeners notified before transaction commit.
Defines the contract for handling of entities before they have been deleted or
marked as deleted in DB.
Defines the contract for handling entities right before they are detached from an EntityManager
on transaction commit.
Defines the contract for handling entities before they have been inserted into DB.
Allows to customize view right before navigation occurs.
Defines the contract for handling of entities before they have been updated in DB.
Implementation of
Aggregation intended for aggregating BigDecimal values.Implementation of
Aggregation intended for aggregating BigInteger values.Data binding state.
Handle images with format string: ${bitmap:100x100}
The range of fade out when focus is enabled.
ImportBeanDefinitionRegistrar for Jmix data repositories autoconfigurationA bootstrap connector which establishes a connection to an OOo server.
A Bootstrap Connector which uses a socket to connect to an OOo server.
Boxplot is a convenient way of graphically depicting groups of numerical data through their quartiles.
Base component for boxplot elements.
Component to configure the blur state.
Component to configure the emphasis state.
Component to configure the selection state.
Class adds a
View.QueryParametersChangeEvent listener when navigating to the BPM process
form view.Adapter between Flowable
BusinessCalendar and Jmix BusinessCalendar.Interface for a BPMN modeler component that allows modeling and interaction with BPMN diagrams.
Interface for a BPMN viewer component that allows visualization and interaction with BPMN diagrams.
Helper class for calculating triggering date for
TimerEventDefinition
in case of using repeating intervals and non-default Flowable business calendar.Additional Flowable Engine Configuration for Jmix BPM Add-on
Configuration properties for BPM Add-on UI.
This BPMN parse handler handles the case when a UserTask is located inside a lane.
Validator checks that UserTask due date duration is not defined in days, weeks, months or years when a business
calendar is also selected.
Helper class to manage filepath breadcrumbs
Provides parent document list for forming e.g.
Brush is an area-selecting component, with which user can select part of series from a chart to display in detail.
Links interaction between selected items in different series.
Brush selecting mode.
Mode for brush selecting.
Brush font style.
Type of brush.
Index of item which can use brush selecting.
Enum for assigns which of the series can use brush selecting.
Update type for brush selecting event.
Buttons in toolbox that is related to brush includes.
A tool feature for brush-selecting.
Buttons in toolbox that is related to brush includes.
A component for icon path for each icon in brush toolbox.
A component for title for each icon in brush toolbox.
Class is responsible for the brute-force protection on user authentication.
Represents a value source that provides buffering capabilities for reading and
writing property values.
Interface that provides buffering capabilities to a data unit.
Standard action for changing attribute values for several entity instances at once.
A builder that creates a new
BulkEditView with defined parameters.A bean that creates an instance of
BulkEditorBuilder.Indicates that annotated interface is a "Business Calendar".
Defines API to operate with date and time in terms of "business hours".
Allows to detect all classes that have annotation
BusinessCalendar.Non-persistent entity used to display business calendars in UI
Interface must be implemented by classes that provide business calendars from a particular source type.
Allows registering inside default Flowable
BusinessCalendarManager
all business calendars from Business Calendar add-on.Defines convenient methods to fetch configured in the system business calendars.
Helper that provides information about registered business calendars into screen fragments.
Presents business day with configured working interval.
INTERNAL.
Web-element wrapper for button.
Interface for web-element wrappers that have a
By selector.A data provider implementation of
DownloadDataProvider designed to supply data from a byte array.Resolves method parameters by delegating to a list of registered
MethodArgumentResolvers.Used for additional cache operation like iterations over cache entries.
Implementation of
LoadedPropertiesInfo that caches information about loaded properties to avoid
expensive operations for the same instance and property.A business hours entry.
Base interface of data providers in
FullCalendar.Base class for simple data retrievers.
INTERNAL.
Base interface for display modes in
JmixFullCalendar.Supported component's display modes.
A time based object.
The base interface of event in
FullCalendar.INTERNAL.
Interface to be implemented by data providers that should load items by request.
A fetch context that is used for loading events.
INTERNAL.
MergePolicy that removes non-persistent versions if document was changed during editing on version management screen.
MergePolicy that removes persistent and saves new versions if document was changed during editing on version management screen.
A candlestick chart is a style of financial chart used to describe price movements
of a security, derivative or currency.
CandlestickSeries.AbstractCandlestickElement<T extends CandlestickSeries.AbstractCandlestickElement<T>>
Base component for candlestick elements.
Component to configure the blur state.
Component to configure the emphasis state.
Item style of candlestick.
Component to configure the selection state.
REST controller that is used for getting an information about REST capabilities.
Interface to be implemented by entities which can be separated by categories and hence have several sets of
dynamic attributes.
Event fired when a cell in the Grid is focused.
An enum representing the different sections of a grid.
ChangePasswordAction<E extends org.springframework.security.core.userdetails.UserDetails>
Interface of views that can contain unsaved changes.
An optional interface of
CloseActions used in views that may have unsaved changes on closing.Chart is a component for showing data in graphical form.
Event fired after clicking on chart series elements.
Base class for data-aware chart options.
Event fired after the chart data range is zoomed .
Event fired after double-clicking on chart series elements.
Event fired when render finished, that is, when animation finished and progressive rendering finished too.
Event fired when switch of the brush.
Event fired if the mouse cursor moves outside the component.
An event that is fired when item set is changed.
Event fired after inverting the choice of legend.
Event fired after scrolling the scrollable legend.
Event fired after selecting all selectors.
Event will be fired when users toggle legend selector in legend component.
Event fired when magic type in a toolbox changes.
Event is fired after the user presses the click, regardless of whether releases it or not.
Event is fired when the user moves the cursor.
Event is fired after the user moves the cursor out of the chart series element.
Event is fired after the user hovers the cursor over an element of the chart series.
Event if fired after the user releases click.
Base class for all chart options objects that are to be serialized.
Basic chart options.
Type of compositing operation to apply when drawing a new shape.
State switching animation configurations.
Event is fired every time a component is rendered on the client-side.
Event is fired after chart options resets.
Serializes options and data for the
Chart into JSON for subsequent sending it to the client-side.For internal use only
Web-element wrapper for checkbox.
Web-element wrapper for checkbox group.
Implementation of
ValueBinding for working with checkbox components.Condition for checking the checked items of
CheckboxGroup web-element wrapper.Condition for checking the contained checked items of
CheckboxGroup web-element wrapper.Condition for checking items count of
CheckboxGroup web-element wrapper.Circle style for vector features.
Mapper of claims received from the OpenID Provider into Jmix resource roles and row-level roles.
Loads classes taking into account hot-deploy feature.
Event fired when the user toggles the selection state of an item on the
client-side.
Marker interface for objects that describe how a
View was closed.Closes all tabs.
Closes all tabs except the selected (trigger) tab.
Closes the selected (trigger) tab.
Base event that can be extended by specific event implementation
to publish events to all application instances in a cluster.
Provides
SubscribableChannel to pass and handle cluster application events.A component that allows to publish application events to application instances of a cluster
Source to cluster vector data.
Web-element wrapper for code editor.
Class that represents syntax highlight mode.
Class that represents color theme preset of
JmixCodeEditor.Provides validation support for the
JmixCodeEditor component.Describes the type of collection change event.
Container that holds a collection of entity instances.
Event sent on changes in the container items collection - adding, removing, replacing elements.
Implementation of the
CollectionContainer interface, which manages a collection of entities and provides
functionality for modifying and interacting with the collection.Standard implementation of sorting
CollectionContainers.Collection formatter to be used in view descriptors and controllers.
Enum describes the policy of processing collection members when importing the entity with the
EntityImportPlanLoader of entity collections.
Event sent after successful loading of entities, merging them into
DataContext and setting to
the container.Event sent before loading entities.
Implementation of the
CollectionLoader interface used for loading entities into a CollectionContainer.Container that holds a collection of entity instances which is a collection property of another entity.
Implementation of the
CollectionPropertyContainer interface that manages a collection of entities
as a property of a master entity.Standard implementation of sorting
CollectionPropertyContainers.Color selection component.
The policy to take color from
JmixChart.getColorPalette().Renderer for columns that doesn't use a renderer function for rendering its
contents (only the value from the object model).
Constants for the rendering mode of columns.
Event fired when the columns in the Grid are reordered.
Event fired when a Grid column is resized by the user.
A component that allows to group columns in a
GroupDataGrid.An event is fired when a column is dropped into a drop area of the
ColumnsGrouper component.Defines drop location within the
ColumnsGrouper.Component representing a column in the
ColumnsGrouper.Event fired when the action button of a
ColumnsGrouperItem is clicked.Columns that will be used for export.
Constants for the text alignment of columns.
Web-element wrapper for combobox.
Web-element wrapper for combobox overlay.
Combo Box Picker allows the user to choose a value from a filterable list of options
presented in an overlay.
ComboButton is a UI component that provides a combination of a button and a dropdown menu,
allowing users to trigger an action or open a menu of options.
Web-element wrapper for combo button.
Provides support for associating an
Action with a ComboButton.Used to provide a description for data model entities and their attributes.
Common implementation of
OrderBasedEntityIdsLoader.ComponentActionBinder<C extends com.vaadin.flow.component.Component>
Deprecated, for removal: This API element is subject to removal in a future version.
ComponentActionsHolderBinder<C extends com.vaadin.flow.component.Component>
Deprecated, for removal: This API element is subject to removal in a future version.
ComponentActionsHolderUnbinder<C extends com.vaadin.flow.component.Component>
Deprecated, for removal: This API element is subject to removal in a future version.
ComponentActionUnbinder<C extends com.vaadin.flow.component.Component>
Deprecated, for removal: This API element is subject to removal in a future version.
SPI interface for
JComponents factory.An interface for component containers that provides methods for managing and interacting with child components
within a container.
Contains information for
ComponentGenerationStrategy when creating
components using UiComponentsGenerator.A strategy for creating FlowUi components by
UiComponentsGenerator.Represents an item in a dropdown button that can display a custom component.
ComponentLoader<T extends com.vaadin.flow.component.Component>
Defines the contract for loading and initializing UI components from XML descriptors.
AutowireTasks are used to perform autowiring of nested fragments in a view.
Represents a context for loading and initializing UI components in
View.Represents a context for loading and initializing UI components.
Represents a context for loading and initializing UI components in
Fragment.InitTasks are used to perform deferred initialization of visual components.
Registers new component loader or override a UI component in the framework.
Builds registration object that is used for adding new component loader or overriding UI components in the
framework.
ComponentRootLoader<T extends com.vaadin.flow.component.Component>
INTERNAL
Base interface for component settings registration.
ComponentShortcutActionBinder<C extends com.vaadin.flow.component.Component>
Deprecated, for removal: This API element is subject to removal in a future version.
ComponentShortcutActionsHolderBinder<C extends com.vaadin.flow.component.Component>
Deprecated, for removal: This API element is subject to removal in a future version.
Provides shortcut aliases for UI component-related actions.
Represents a user menu item that can contain a custom UI
Component as its content.Utility class working with Vaadin UI components.
Represents a validation exception that is specifically related to a UI
Component.Abstract class for composite UI components: layouts, views, etc.
Deprecated, for removal: This API element is subject to removal in a future version.
Interface provides a
RequestMatcher that will be used a security matcher for the resource server
configuration.A default implementation of
CompositeResourceServerRequestMatcherProvider that combines multiple
AuthenticatedRequestMatcherProviders and AnonymousRequestMatcherProviders using an OR condition.An implementation of
UserRepository that compose all UserRepositorys
registered in an application and delegates operations to them.A specialized
ValidationException used to represent a collection
of individual validation violations.Represents a cause of a validation violation, providing detailed
information about a specific validation error.
Marks a reference as composition.
The tree of
Conditions represents an optional part of a query that is added if the corresponding parameters
are present.Modifies parts of JPQL query
Modifies JPQL query according to the tree of conditions.
Utility class to build
Condition by Spring Data repositories PartTreeLoads the tree of
Conditions from XML.A configuration is a set of filter components.
The container of the two independent index configuration comparison result parts.
Handles ConstraintViolationException that can be thrown by bean validation on persistence layer.
Interface for container web-elements wrappers that have a child web-elements.
Data provider that loads entities from containers.
Data provider bound to the
CollectionContainer for a Chart component.A data provider implementation that connects to a
CollectionContainer.Represents a data unit connected to a
CollectionContainer.Data provider bound to the
CollectionContainer for a Kanban component.Data provider bound to the
CollectionContainer for a PivotTable component.A specialized implementation of
ContainerDataGridItems designed to handle hierarchical data structures.Provides a value source implementation powered by an
InstanceContainer.A provider of
ValueSource instances based on a given InstanceContainer.Handle tags in format strings
Resolves method parameters by delegating to a list of registered in Spring context
MethodArgumentResolvers.Visual map component for displaying data in continuous form.
More detailed information is provided in the documentation.
More detailed information is provided in the documentation.
Exception that can be thrown during value conversion methods of UI components.
This filter is used for cookie authentication method.
Is used for 'cookie' authentication method.
Manages both types of tokens (URl, Cookie) being used for cookie auth method.
Spring security authentication token that is used to perform authentication request
via
CookieAuthenticationProvider.DTO for cookie-token
Manages cookie-token objects
DTO for URL-token (cookie auth)
Manages URL-token objects
A class for describing coordinates in numerical and percentage representation.
The coordinate used in the series.
Creates copies of objects.
Interface to be implemented by entities having a state which is not reflected in metadata.
Configuration of the core module.
This security configuration can be used in test or simple projects, for example:
CORS settings used by default
CorsConfigurationSource provided by Jmix core
module auto-configuration.Implementation of
AbstractAggregation that provides the foundation
for performing aggregation operations by counting the number of items within a collection.Action opens create notification dialog.
Creates HTML from a list of
CreditsItem objects.Carries information about third-party software.
Provides information about third-party software by loading
credits.xml files of Jmix modules.Crockford's Base32 encoding of UUID values.
Defines cron-based holiday in annotated business calendar (see
BusinessCalendar).Presents arbitrary holiday which can be expressed via quartz cron expression.
Describes all Misfire Instruction options available for Quartz
CronTrigger.INTERNAL.
Class provides helper methods to work with
DataSet.Extraction controller for
BandOrientation.CROSS orientation.Checks access to entity operations based on resource policies.
Defines an authorization point for entity operations.
Stores metadata for
JmixDataRepository methods.Provides
CrudMethodMetadata for current invoked methodRepositoryProxyPostProcessor to add interceptor designated for determining and storing CrudMethodMetadata
information for currently invoked JmixDataRepository method.Defines CurrencyField currency label position.
Indicates that a field which is marked by this annotation contains currency value
Provides information about the currently authenticated user.
Takes query parameter values from the locale of the current authentication.
INTERNAL.
Takes query parameter values from the currently authenticated (or substituted) user object.
Interface for obtaining the current user's roles.
Interface is used to get the information about current user substitution
Provides effective UI component policies for the current user.
Invalidates the cache of the
CurrentUserUiComponentPolicies bean when the user is substituted.The default implementation of the
CurrentUserUiComponentPolicies interface.Custom calendar display mode properties.
Apply custom style to target cell
Contains UI component loaders from add-ons and project configurations.
Registers external UI components or component loaders that should be used by the framework.
DTO class describes a date interval with a custom date range.
Converter for parsing and formatting
CustomDateInterval in a specific string representation.Input parameter for a function to get a custom value of property.
Mapping for entity property that has a custom value calculated by specified function.
This interface may be implemented if you need custom formatting logic, not covered by and provided formatter
Example: you need to merge pdfs created by another reports
Determines how a custom report generation is defined and invoked.
Defines parameters of the custom report template as part of the
TemplateDef definition.Custom implementation of the result field formatting.
The event that is fired when a user inputs value manually.
Utility bean that provides typical data aware operations with UI components.
Business calendar provider that fetches business calendars from database.
Role provider that gets resource roles from the database from the
ResourceRoleEntity.Role assignment provider that gets role assignments from the database.
Role provider that gets row level roles from the database from the
RowLevelRoleEntity.A
UserSubstitutionProvider that stores UserSubstitution in a database.Describes possible data operations in data providers.
Factory bean for data API components.
Interface for tracking changes in entities loaded to UI.
Event sent when the context detects changes in an entity, a new instance is merged or an entity is removed.
Event sent after saving changes.
Event sent before saving changes.
Gives direct access to collections of modified and removed instances in
DataContext.Standard implementation of
DataContext which saves data to DataManager.Marker interface of
DataContext implementations that can form hierarchies
using DataContext.setParent(DataContext).This class should load data using ReportQuery objects, convert data onto BandData object and build BandData object tree (link children and parent bands)
The default implementation is io.jmix.reports.yarg.reporting.DataExtractorImpl
!Attention! Please make sure if you really need to change this behaviour against default implementation cause it might crash report generation logic
Web-element wrapper for data grid.
Abstract class for data grid cell.
Abstract class for data grid row.
Web-element wrapper for data grid cell.
Web-element wrapper for data grid header cell.
Web-element wrapper for data grid header row.
Web-element wrapper for data grid row.
Event fired when a DataGridColumn visibility is changed.
An editor in a Grid.
This class provides functionality to bind filters in
DataGrid to URL query parameters.A POJO class for storing properties of the
DataGridHeaderFilter's initial state.Provider for binding URL query parameters to
DataGrid filters.A task for initializing and registering a binder of type
DataGridFilterUrlQueryParametersBinder to a UrlQueryParametersFacet.A UI component used for displaying the filter in the column header.
An event fires when the current value of the
PropertyFilter is applied to the loader.Represents a data grid source of items.
An event that is fired when item set is changed.
An event that is fired when selected item is changed.
The DataGridItems that supports sorting.
An event that is fired when value of item property is changed.
Represents settings for a
DataGrid component, such as sorting, column configurations,
and other configuration properties that define the behavior of the data grid.Represents settings for a column of a
DataGrid component,
including its properties such as key, width, visibility, and flexibility.Represents a single sort order configuration used in
DataGrid settings.Binds the settings for instances of
DataGrid.API to import entities from the input data using specified import configuration.
Executes import for a given import configuration and
ImportedData.Base interface for load contexts used in
DataManager.A non-visual component for coordinating data loading operations in a view.
Type of the LIKE clause.
Load trigger.
Implementation of the
DataLoadCoordinator interface.The root interface in the data loaders hierarchy.
Represents the life cycle stages of a
DataLoader.Static info about
DataLoader that will be used as monitoring tags.Utility class working with data loaders.
Thrown when data loader catches internal exception during load
Settings binder for components which support data loading.
Same as
UnconstrainedDataManager but performs authorization of all operations by applying registered
access constraints.INTERNAL.
DataSet component is the recommended way to provide data to a chart.
Source data.
Represents a dataset constraint.
Interface to be implemented by Spring beans that should be used in
SupersetDashboard component.Defines a data set as part of the
BandDef.Annotation marks a delegate method that implements some logic related to a data set
defined in the report definition class.
Class presents factory bean for create
DataSet instance with basic filled attributesWhen running a report, datasets are transformed into lists of rows, where each row contains a map of name-value pairs.
Defines sorting options of a data store.
Interface defining methods for CRUD operations on entities.
INTERNAL.
System role that grants all permissions for DataTools functionality.
System role that grants read-only permissions for Data Tools functionality.
Represents a data type of an entity property.
Convenience bean for locale-dependent conversion of some widely used data types to and from strings.
Registry for
DatatypesController that is used for getting datatypes information.
Represents a data unit responsible for holding and managing data binding state within a UI component.
An event that is fired when DataUnit state is changed.
A source containing geo-objects (entities having a property of a
Geometry type).Deprecated, for removal: This API element is subject to removal in a future version.
An event that is fired when item set has changed.
An event that is fired when value of item property is changed.
DataViewBinding<C extends com.vaadin.flow.component.Component & com.vaadin.flow.data.provider.HasDataView<V,?,?>,V>
Represents a binding between a UI component and a data provider.
DataViewBindingImpl<C extends com.vaadin.flow.component.Component & com.vaadin.flow.data.provider.HasDataView<V,?,?>,V>
Implementation of the
DataViewBinding interface that binds a specific
component and data provider.DataViewDelegate<C extends com.vaadin.flow.component.Component & com.vaadin.flow.data.provider.HasDataView<V,?,?> & com.vaadin.flow.data.provider.HasListDataView<V,?> & SupportsDataProvider<V>,V>
A tool feature for zooming, which only supports rectangular coordinate by now.
A component for zooming and restore icon path.
A component for restored and zoomed title text.
Type of data zoom component.
Implementation of
Aggregation intended for aggregating Date values.A query macro handler that processes the `@dateBetween` macro.
INTERNAL.
The event is fired when a day cell or time cell is clicked.
DateDatatype works with java.sql.Date but is parameterized with
java.util.Date to avoid problems with casting.DateFormatter formatter to be used in view descriptors and controllers.Utility class for internationalizing date-related information such as month names,
weekday names, short weekday names, and the first day of the week.
Class describes date interval with the following types.
Interface provides methods for parsing/formatting date interval values.
Helper class for date intervals.
Web-element wrapper for date picker.
Picker component for selecting an arbitrary date range.
INTERNAL.
The event is fired after the calendar’s date range has been initially set or changed in some way
and the DOM of component has been updated.
Implementation of
Aggregation intended for aggregating date-time values.Specifies a format pattern for an entity attribute of a date/time type.
Web-element wrapper for date time picker.
Condition for checking date value for web-element wrappers for components that supports date
(e.g.
Describes day cell from day-grid:
CalendarDisplayModes.DAY_GRID_DAY
CalendarDisplayModes.DAY_GRID_WEEK,
CalendarDisplayModes.DAY_GRID_MONTH
CalendarDisplayModes.DAY_GRID_YEAR
INTERNAL.
The context for generating class names that day cell's bottom text will use.
The context for generating text to be displayed at the bottom of the day cell.
The context for generating class names that day cell will use.
Configuration properties of day-grid day display mode
CalendarDisplayModes.DAY_GRID_DAY.Configuration properties of day-grid month display mode
CalendarDisplayModes.DAY_GRID_MONTH.Configuration properties of day-grid week display mode
CalendarDisplayModes.DAY_GRID_WEEK.Configuration properties of day-grid year display mode
CalendarDisplayModes.DAY_GRID_YEAR.The context for generating class names that day header cell will use.
INTERNAL.
INTERNAL.
INTERNAL.
The event is fired when the user clicks on day heading navigation link.
The enum represents day of week with ids that corresponds the order in full calendar component.
The class represents container for
DayOfWeek.The datatype that enables containing days of week in one field.
INTERNAL.
Action is used for editing
DaysOfWeek datatype in ValuePicker field.Interface defining methods of getting some DBMS-specific values.
Factory for obtaining implementations of DBMS-specific objects, particularly
DbmsFeatures,
SequenceSupport and DbTypeConverter.INTERNAL.
Interface defining methods to convert data between Java objects and JDBC params and results depending on the current
DBMS type.
A collection of JDBC helper methods.
Indicates whether a JPA entity is a database view.
Defines DDL code to be generated by tooling for entity attributes.
Container for
Ddl annotations.Settings used by development tools to generate DDL scripts for this entity.
The style of the decal pattern.
DashArray controls the horizontal pattern.
Possible values: If it is of type
Possible values: If it is of type
Decal.DashArray.number, it means that the pattern and the blank space
are of this value respectively.Default
ClaimsRolesMapper implementation that takes OidcUser
role names and transforms roles names to resource and row-level roles using role name prefixes.Default implementation of the
ComponentConfig.Deprecated, for removal: This API element is subject to removal in a future version.
Default extraction context implementation
Default data extraction logic implementation
Default controller factory implementation
Default implementation of
GroupDataGridAdapterFactory.The default implementation of
JmixOidcUser that wraps the OidcUser provided by the OpenID Connect 1.0
Provider and delegates some method invocations to the wrapped OidcUser.A
OidcUserService that is enabled by auto-configuration.Marker interface which indicates that the actual view's route parent
must be the main view returned by
UiProperties.getMainViewId().Interface to be implemented by a bean defining the default conflict resolution policy.
Default User mixin that ignores password.
The default implementation
OidcUserMapper implementation that converts OidcUser into DefaultJmixOidcUser.Default preprocessor factory implementation
Class is used for getting default policy group for the
ResourcePolicy instance.A default implementation of a user interface exception handler in the framework.
Default implementation of
UserEmailResolver.Interface implemented by clients that need to provide a dynamic default value for a input parameter,
or default value for a complex data type that can't be expressed with annotation.
Class contains an info about classes of following types:
org.flowable.engine.delegate.JavaDelegate
org.flowable.engine.delegate.TaskListener
org.flowable.engine.delegate.ExecutionListener
org.flowable.common.engine.api.delegate.event.FlowableEventListener
The class is used for getting a list of class members with
org.flowable.common.engine.api.delegate.Expression type.Delegates data loading operation to an object provided by
ReportQuery.Marked entity field will be used to store information about user deleted entity.
Makes entity soft-delete when placed on field.
This enum defines a behaviour to deal with linked objects in case of soft delete
DENY - throw
DENY - throw
DeletePolicyException when linked object exists
CASCADE - soft delete the linked object
UNLINK - remove link
Exception that is raised on attempt to soft delete an object,
which has linked objects marked with
OnDelete annotation
with DeletePolicy.DENY value.Implementations of the interface are used for wiring of fields/setters and additional dependency
injectors to the UI components.
DependencyInjector.AutowireContext<T extends com.vaadin.flow.component.Composite<?>>
Base injection context interface.
Defines properties that the annotated property depends on.
Defines derived properties
(see documentation).
INTERNAL.
Updates desciptor properties according to requirements.
POJO to store all information needed to process entity descriptor.
Web-element wrapper for details.
Interface of views that display an entity instance and can save changes made by the user.
Facilitates navigation to a detail view of a specific type with additional configuration options.
Defines a detail view purpose: to create a new entity instance or to edit an existing one.
The navigation processor implementation that is responsible for processing navigation
to specific views using a
DetailViewNavigator instance.Provides a fluent interface to configure navigation parameters and navigate to an entity detail
View.The utility class designed to extract the entity class type associated with a
DetailView.Provides a fluent interface to configure and open a details view
in a
DialogWindow.Processes and builds
DialogWindow instances for views using a DetailWindowBuilder.Provides a fluent interface to configure and open a details view with
the specific class in a
DialogWindow.Interface for obtaining the user's device time zone.
Default actions which should be used in
InputDialog.Application event that is sent after the dialog is closed.
Condition for checking the header value for
DialogWindow web-element wrapper.POJO class for storing dialog information.
POJO class for storing dialog information.
Specifies parameters of
DialogWindow.Application event that is sent after the dialog is shown.
A possible outcome of the input dialog with the standard close actions.
Provides fluent interface for configuring and displaying dialogs.
Builder of background task dialog.
Represents Dialog Builders with close setting.
Base class for all Dialog Builders.
Represents Dialog Builders that can be dragged.
Represents Dialog Builders that have a text inside
Paragraph component.Represents Dialog Builders that have a header.
Represents Dialog Builders that have modal setting.
Represents Dialog Builders that have position setting.
Represents Dialog Builders that have size setting.
Represents Dialog Builders that have style setting.
Represents Dialog Builders that have a text inside
Paragraph component as a content.Represents Dialog Builders that have theme setting.
Enum for describing the position of label components in a
InputDialog.Represents Dialog Builders that can be resized.
Implementation of the
Dialogs interface, providing methods for creating different types of dialogs.Wrapper class representing a
View opened as a dialog window.Abstract class for dialog windows.
Wrapper class representing a
View opened as a dialog window.Represents an event that is fired after a dialog window has been closed.
This class represents an event that is triggered after the associated dialog window has been opened.
An interface to be implemented by builders which opens a view in a
DialogWindow.An interface to be implemented by builders which opens a
specific view in a
DialogWindow.Class for adding and removing components to the footer part of a
DialogWindow.Class for adding and removing components to the header part of a
DialogWindow.Provides a fluent interface for opening views in dialog windows.
org.springframework.security.web.authentication.www.DigestAuthUtils
Represents possible preset rendering styles that the event can use.
Class contains information about a calendar's display mode, such as a date range.
INTERNAL.
Document formatter for '.doc' and '.odt' file types
* Document formatter for '.docx' file types
Helper class for XML parsing.
Helper bean for XML parsing with DOM4J.
This class is not thread-safe and should not be accessed concurrently from multiple threads without proper
synchronization.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
Implementation of
Aggregation intended for aggregating Double values.Provides data for
Downloader.Generic interface to download data from the system.
Shows exported data in the web browser or downloads it.
Format of data exported by
Downloader.Represents a dropdown button component.
Web-element wrapper for dropdown button.
Represents a UI component providing functionality for managing dropdown items.
Represents an item that can be included in a dropdown button component.
Represents a click event triggered by a
DropdownButtonItem.Executes import for a given import configuration and
ImportedData.Available policies to process a found duplicate:
Update: an extracted entity not imported, existing one is updated.
Note that transient attributes should be specified after deserialization and before usage
Constants to be used as hints when loading entities by
DataManager.Utility class for manipulating strings in various case formats.
Describes animation types from 'ol/easing'.
Defines an interface for EclipseLink cluster communication
Utility class to provide common functionality related to persistence.
Contains information for a function that returns the column editor component
used by
DataGridEditor.Contains information for a function that returns the column editor component
used by
GroupDataGridEditor.Annotation for detail view controllers which specifies a data container that contains the edited entity.
Interface to be implemented by beans that transform an entity after returning it from a detail view.
An editor in a Grid.
Holds the data for cancel events fired in
Editor.An event listener for a
Grid editor cancel events.Holds the data for close events fired in
Editor.An event listener for a
Grid editor close events.Base class for events fired in
Editor.Implementation of
Editor interface.Holds the data for open events fired in
Editor.An event listener for a
Grid editor open events.Renderer and DataGenerator used by
Grid.Column to control the state of the
editor components.Holds the data for save events fired in
Editor.An event listener for a
Grid editor save events.Grants permissions to add full text search condition to filter
The scatter (bubble) graph with ripple animation.
EffectScatterSeries.AbstractEffectScatterElement<T extends EffectScatterSeries.AbstractEffectScatterElement<T>>
Base component for effect scatter elements.
Component to configure the blur state.
Enum of when to show the effect.
Component to configure the emphasis state.
Configuration of label guideline.
Related configurations component about ripple effect.
The brush type for ripples.
Component to configure the selection state.
Implementation for Elasticsearch
Implementation for Elasticsearch
Implementation for Elasticsearch
Configuration context for Elasticsearch index settings
Base interface for configurers of Elasticsearch index settings.
A Elasticsearch-specific implementation of the
AbstractSearchQueryConfigurerA Elasticsearch-specific extension of the common {link @SearchStrategy} interface
Provides Elasticsearch search strategies
Configuration component of label guideline for elements for series.
Should be used to delete old emails and attachments.
Interface provides methods to load, store and update email message and attachment entities
Provides application with emailing functionality.
Email sending error.
Contains failed addresses and corresponding error messages.
Contains failed addresses and corresponding error messages.
EmailFieldDelegate<C extends com.vaadin.flow.component.textfield.EmailField>
The EmailHeader class stores a name/value pair to represent headers.
Contains email details: list of recipients, from address, subject, body and attachments.
EmailInfo builder.
Notification channel that sends notification by email.
Interface defining methods for management of refresh token used for OAuth2 authentication with SMTP server.
Adapter to javax.mail email sending API.
Used for
Embeddable entities by enhancing processUpdates database mapping to support embedded parameters.
Defines additional parameters for Embedded attributes.
The label configuration component.
The label font style.
Position of the title text.
A class representing an empty data container for
DataGrid items.Marker interface to indicate that the implementing class provides no data.
Empty data provider for a
Kanban component.Empty data provider for a
PivotTable component.An implementation of
TreeDataGridItems and HierarchicalDataProvider that represents
an empty hierarchical data container for TreeDataGrid.Value provider that returns an empty string for passed item.
Annotation to enable data repositories.
Indicates whether to enable restoring of soft deleted entity instances.
Define what is encoded to for each dimension of data.
Chart example:
Chart example:
Defines the position of aggregation row.
Defines the position of aggregation row.
The EnhancedLoginForm is an extension of the LoginForm component that provides
additional functionality such as "Remember Me" checkbox visibility and localization support.
An event that is fired when the user selects another locale.
An event that is fired when "Remember Me" becomes checked and unchecked.
Represents a navigator interface with additional enhancements for managing
list data components and fields.
Keeps progress of async enqueueing process.
Status of session.
Controller that performs CRUD entity operations
Class that executes business logic required by the
EntitiesController.Controller that is used for getting entities metadata.
Class is used by the
EntitiesMetadataController.Interface to be implemented by domain model objects with identifiers.
This exception is raised on attempt to load a deleted object.
Checks access to entity attributes based on resource policies.
Defines an authorization point for entity attributes.
An extension point for the entity import mechanism.
Defines entity attribute resource policy in annotated resource role (see
ResourceRole).Action for
EntityAttributePolicyAn extension point for a mechanism to serialize and deserialize entity to JSON.
Visitor to be submitted to
MetadataTools.traverseAttributes(Object, EntityAttributeVisitor).Base interface for data providers that work with entities, containing property names to retrieve values
for
CalendarEvent entities.Data provider for loading entities by request.
Calendar event that wraps an entity.
A Spring application event that is sent right after an entity is changed in the data store.
Type of the event:
EntityChangedEvent.Type.CREATED, EntityChangedEvent.Type.UPDATED or EntityChangedEvent.Type.DELETED.INTERNAL.
An action responsible for clearing the value of an
EntityPickerComponent.EntityCollectionFieldDelegate<C extends com.vaadin.flow.component.AbstractField<?,Set<T>> & SupportsMetaClass,T,V>
Web-element wrapper for entity combobox.
Represents a set of data items for
DataGrid.Chart data item, which contains an instance of an entity.
Additional parameters for a data set definition of
DataSetType.SINGLE and DataSetType.MULTI types.Represents a data unit that includes information about the metadata class
of an entity contained in the source.
Diff object for Entity Snapshots
Used to clearly identify entity.
Property selection performs as follows:
Property selection performs as follows:
Id property used if it has UUID type and JmixGeneratedValue annotation,
any other UUID @JmixGeneratedValue property chosen if @Id property doesn't satisfy conditions above,
interface isn't applied otherwise.
Interface to be implemented by optimistically locked entities.
Contains information about single entity used when exporting entity collections
Provides methods to extract entities and populate their properties by values from the imported data
Fetches entities by fetch plans by accessing reference attributes.
Allows to load ids of entity instances according to enqueueing session.
Keeps result of ids loading.
An object that contains the following details if an entity import fails:
An instance of
ImportedDataItem
Extracted entity
Error message
Error type: EntityImportErrorType
Bean that is used for exporting a collection of entities and importing them.
Use
EntityImportPlanBuilder for building instances of EntityImportPlan.Builds
EntityImportPlans.Class that is used for building an
EntityImportPlan based on the JSON object that represents an entity.Factory for
EntityImportPlanBuilder.Provides functionality for direct documents indexing.
Interface to be implemented by beans that initialize new entity instances created via
Metadata.create(Class).Determines which component is used to the entity input parameter in UI.
Used by enhancing process
Represents a data unit bound to a collection of entity items.
Event that is fired then item collection is changed.
An interface for entity JSON transformers used by the REST API
This bean allows to register and fire entity listeners.
A Spring application event which is sent when the entity is loaded from the data store.
Logs lifecycle events (create, modify, delete) of JPA entities.
Record containing changed entity attribute.
Record containing information about entity lifecycle event.
An action that sets an entity to the entity picker using the entity lookup view.
A specialized interface for picker components that enables the selection or management
of multiple entities within a collection.
Type of operation on entity.
Represents an action that allows opening a
DetailView for the entity associated with
an EntityPickerComponent.Opens a one-to-one composition entity using the entity detail view.
An ancestor of all constraints that check access to entity operations and attributes
based on the resource policies.
Additional parameters for an input parameter definition of
ParameterType.ENTITY
and ParameterType.ENTITY_LIST types.Web-element wrapper for entity picker.
An interface that represents a picker component for selecting or interacting with entities.
Defines entity resource policy in annotated resource role (see
ResourceRole).Action for
EntityPolicyAPI to populate the entity by property values using property mappings and raw values source.
Event object for
EntityPropertyChangeListener.Interface to track changes in data model objects.
Diff between properties in entity snapshots
Normalizes references between items of a collection.
Allows to restore entities have been soft-deleted previously
A Spring application event which is sent when the entity is saved to the data store.
Provides functionality for searching entities in index.
Class that is used for serialization and deserialization of entities to JSON.
Class is used for storing a collection of entities already processed during the serialization.
An object that configures how to serialize the entity to JSON.
Implementation of
Set<Entity> with convenient methods for getting entities by a prototype instance
or by a class and id.Interface defining methods for creating and getting operations on entity snapshots.
Creates and analyzes entity snapshots.
Class is used for converting
EntitySnapshot objects
into non-persistent EntitySnapshotModel entities which may be
displayed in UIProvides information about entities states.
This class is used in report wizard creator because the wizard requires info about entity attributes
Generates UUID for using as entity identifiers.
A comparison function, which imposes a ordering for entity attribute values.
A specialized
ValueSource that represents a data source tied to an entity instance
and its properties within a data-aware context.An event fired when related entity instance is changed.
Interface to be implemented by enums that serve as entity attribute types.
A data provider that uses an enumeration type as its data source.
INTERNAL.
REST controller that is used for getting an information about enums
A helper class to be used in
EnumClass implementations to convert identifiers to enum values.An event bus for any object.
INTERNAL.
The event is fired when the calendar event is clicked.
INTERNAL.
INTERNAL.
The event is fired when the dragging stops and the event has been moved to a different day or time slot.
EventHub class implementing the event listening model with concrete event classes.
An injector that autowires view methods that are annotated by the
EventListener annotation.INTERNAL.
The event is fired when the user mouses over a calendar event.
INTERNAL.
The event is fired when the user mouses out of a calendar event.
INTERNAL.
INTERNAL.
INTERNAL.
The event is fired when the resizing stops and the calendar event's duration has changed.
Generic Event router with lazily initialized event map.
Calculates the width of a column, based on the values within it.
Calculates the width of a column, based on the values within it.
Action for export a
ListDataComponent content in XLSX format.Use this class to export
DataGrid into Excel format.A class provides a user interface component for displaying an exception dialog
with detailed information about the error.
An interface defines the contract for providing dialogs to handle and display exceptions in the user interface.
Annotation for method that operates on UI thread and can change shared UI state.
Indicates that the annotated program element is considered usable in applications but is unstable.
This job removes all expired cookie-tokens
Annotation must be put on a method of an interface that defines a resource role (see
ResourceRole).Base action for export table content with defined exporter.
Checks access to entity attributes based on resource policies when serializing entities to/from JSON.
Defines an authorization point for entity attributes when serializing entities to/from JSON.
Encapsulates functionality for working with extended entities.
Annotation to mark index definition interfaces.
Class contains data to build mapping and analysis within Extended search functionality.
This interface implementation should presents extraction context dependent state
This interface implementation should create immutable extraction context object
Default data extraction context implementation
This interface implementation should contains data extraction logic
This interface implementation may holding relation between report band orientation and related controller logic
if relation not set, default controller should be returned
Non-visual component of a
View.Interface for Spring Beans providing non-visual components for views.
Factory to create UI facets.
Implementation of the
Facets interface responsible for creating and managing UI facets.Represents an
OperationResult that indicates a failed operation.Default MergePolicy if there are no conflicts during document editing on version management screen.
Abstract class for vector object for geographic features with a geometry.
Interface for features that support adding click listeners.
An event that is fired when feature is clicked.
An event is fired when user makes double click on a feature.
An event is fired after 250 ms to ensure that it is not a double click.
Describes supported features in
JmixMap component.Allows to pass
SupportsItemsFetchCallback.FetchCallback to methods that
suppose CallbackDataProvider.FetchCallback.Specifies how to fetch a referenced entity from the database.
Class to declare a graph of objects that must be retrieved from the database.
Specifies fetch plan name that will be applied to entities on extraction.
Implementation of
EditedEntityTransformer that transforms an entity to ensure it is
fetched with a specified fetch plan, if applicable.Builds
FetchPlans.This exception is raised when you try to get nonexistent fetch plan by entity/name.
Defines a
FetchPlan property.Interface implemented by client to dynamically construct fetch plan for an entity Data Set.
Represents a repository of shared
FetchPlan objects, accessible by names.Implementation of the
FetchPlanRepository.Factory for
FetchPlanBuilder.Class that is used for serialization and deserialization of fetch plan to JSON.
An object that configures how to serialize a fetch plan to JSON.
Updates mapping by setting a correct fetch type - lazy or eager.
Base interface for processors of field-mapping annotations.
Contains configuration of index field.
Maps some metamodel property to configuration of index field.
Marker annotation for field-mapping annotations
Base interface for mapping strategy.
Implementation of
ValueBinding that binds a field component
to its corresponding ValueSource.REST API controller that is used for downloading files
A custom exception handler that handles
FileStorageException.A reference pointing to a file located in
FileStorage.Data provider for FileDescriptor
Interface of a component to store and load files defined by file references.
Provides access to all registered file storage beans of the application.
Defines when file will be placed into FileStorage.
This exception can occur while uploading/downloading files using
FileTransferService.A service for uploading and downloading files to/from
FileStorages.REST API controller that is used for uploading files
FileUploadFailedEvent<C extends com.vaadin.flow.component.Component>
Event is fired when
FailedEvent of Upload is occurred.FileUploadFileRejectedEvent<C extends com.vaadin.flow.component.Component>
Event is fired when
FileRejectedEvent of Upload is occurred.FileUploadFinishedEvent<C extends com.vaadin.flow.component.Component>
Event is fired when
FinishedEvent of Upload is occurred.FileUploadProgressEvent<C extends com.vaadin.flow.component.Component>
Event is fired when
ProgressUpdateEvent of Upload is occurred.FileUploadStartedEvent<C extends com.vaadin.flow.component.Component>
Event is fired when
StartedEvent of Upload is occurred.FileUploadSucceededEvent<C extends com.vaadin.flow.component.Component>
Event is fired when
SucceededEvent of Upload is occurred.Deprecated, for removal: This API element is subject to removal in a future version.
Use
FileTypesHelper instead.Fill style for vector features.
Component that can be used for filtering entities returned by the
DataLoader.Registers a UI filter component in the framework.
Builds registration object that is used for adding or overriding UI filter components in the framework
Registers UI filter components that should be used by the framework.
Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated, for removal: This API element is subject to removal in a future version.
Interface to be implemented by beans that store
FilterConfigurationModel in a persistent storage.Provides support for parsing and serializing URL query parameters for filtering data.
Describes options for
GeoMap.fit(FitOptions) method.Defines holiday for specific date in annotated business calendar (see
BusinessCalendar).Presents holiday for specific date.
Defines holiday that has the same date independent of year (like "4th of July") in annotated business calendar (see
BusinessCalendar).Presents holiday that occurs every year in the same date.
Used in Studio.
Deprecated, for removal: This API element is subject to removal in a future version.
FlowuiVaadinWebSecurity is used instead.Provides default Vaadin and Jmix FlowUI security to the project.
Class is used to run a report using various additional criteria:
Use the
Report entity or report code
ReportTemplate entity or template code: if none of these fields is set, the default template is used.
Output type
Output name pattern
Input parameters
Use the
ReportRunner bean to obtain an instance of the FluentReportRunner.Class is used to run a report using various additional criteria:
Use the
Report entity or report code
ReportTemplate entity or template code: if none of these fields is set, the default template is used.
Output type
Output name pattern
Input parameters
Screen: screen or screen fragment from which the report runs
Show a dialog to input the report parameters (defined by ParametersDialogShowMode)
Run a report synchronously or in the background (by default, a report runs synchronously)
Use the
UiReportRunner bean to obtain an instance of the FluentUiReportRunner.Fade out type of other data to focus the highlighted.
Common predefined font style.
One row of
FooterRow.FooterCells in a Grid.A footer cell in a Grid.
Localized format strings container.
Registry for
FormatStringsA functional interface for formatting component value to a string.
The object is single input parameter for formatter constructor
If you need you formatter be created by factory - it should accept this object as constructor parameter
Specific bean for loading formatters.
A fragment encapsulates a
Component tree to allow creation of new
components by composing existing components.The event that is fired after the fragment and all its declaratively
defined inner components are created and fully initialized.
Represents an abstract action that operates on a specific
Fragment.Class describes autowire context that is used to autowire dependencies in
Fragment.A special injector that autowired click listener methods that are annotated by the
Subscribe annotation.Interface defining methods for interacting with data API elements of a
Fragment.Implementation of the
FragmentData interface providing methods
to manage fragment-specific data API elements.Specifies a string value that is a file path to an xml descriptor
that can be used for a
Fragment initialization.An injector that autowires a fields and setters methods that are annotated by the
ViewComponent annotation
in the Fragment.An injection that autowired methods that are annotated by the
Install annotation.Marker interface for classes that can be parents of fragments,
i.e.
Base class for
Fragment components that will be used as ComponentRenderer for components
that support renderers.Factory for creating
Fragments.Implementation of the
Fragments interface responsible for the creation and initialization of
fragments within the UI flow.An injector that autowires method that are annotated by the
Subscribe annotation.An injection that autowires methods that are annotated by the
Supply annotation.Utility class working with Jmix fragment specifics.
UI component for visualizing events in a calendar using various display modes (month, week, etc.).
The context of cell from which context menu is opened.
Component for context menu in
FullCalendar.The event is fired when a context menu has been opened or closed.
The internationalization properties for
FullCalendar component.Menu item of context menu -
FullCalendarContextMenu.INTERNAL.
The sub menu of context menu in
FullCalendar.INTERNAL.
An injection that autowired methods that are annotated by the
Install annotation
for the FullCalendar elements.Contains a logic that substitutes an initial field name with the specific subfields.
A funnel chart is a graphical representation that resembles the shape of a funnel where each segment
gets progressively narrower.
Base component for funnel elements.
Component to configure the blur state.
Component to configure the emphasis state.
The visual guideline style of label.
Component to configure the selection state.
Data sorting type.
Gauge charts use needles to show information as a reading on a dial.
Note: Gauge series is the only series that requires an independent description of data in a
Note: Gauge series is the only series that requires an independent description of data in a
GaugeSeries.data.Base class for gauge text components.
The fixed point of a pointer in a dial.
The related configuration about the axis line of gauge chart.
The style of the axis line of gauge chart.
The tick line style.
Data item to describe series data.
The detail about gauge chart which is used to show data.
Component to configure the emphasis state.
Gauge chart pointer.
Component that used to show current progress.
The style of split line.
Component to configure the title of gauge chart.
A "generic" value, can be used as a base mode for
CustomCalendarDisplayMode, or with
JmixFullCalendar.setVisibleRange(LocalDate, LocalDate).A versatile tool for filtering the data it is bound to.
Event sent when the
Configuration is changed.Event sent when the
Configuration is updated.Action makes the current
FilterConfigurationModel for the GenericFilter the default for the current view.Action to remove current run-time filter configuration.
Action to save changes to current filter configuration.
Action to saves current filter configuration with a new id and name.
Action to save changes to current filter configuration using the values in filter components as default values.
Represents settings for a
GenericFilter component.A settings binder implementation for the
GenericFilter component, handling
the persistence and application of GenericFilterSettings.Support bean that provides helper methods to work with
GenericFilter.A binder class for managing URL query parameters related to a
GenericFilter component.A POJO class for storing configuration of the
GenericFilter's initial state.Provides an implementation of a URL query parameter binder provider for a generic filter component.
A task for initializing and configuring a
GenericFilterUrlQueryParametersBinder
that binds a GenericFilter component to URL query parameters.Describes how generics should be resolved.
Describes how generic value can be resolved.
Describes type from concrete class FQN with type parameters.
Describes type from parent component that should be extracted from XML by tag depth.
Describes type from parent component that should be extracted from XML by tag name.
UI component that displays a geographical data provided by
Layers.Projection registration record.
The class represents map's viewport.
An injector that autowires a fields and setters methods that are annotated by the
ViewComponent annotation
for the GeoMap elements.An injector that autowires method that are annotated by the
Subscribe annotation.Deprecated.
use "property" attribute in "dataVectorSource" XML element instead
Deprecated.
no appropriate alternatives.
Deprecated.
no appropriate alternatives.
Utility class containing methods connected with JTS library.
Interface to be implemented by sources that support clicks on geo-objects.
The event that is fired when geo-object is clicked.
The event is fired when user makes double click.
The event is fired after 250 ms to ensure that it is not a double click.
GrapesJS component is used to create HTML templates using a web editor.
Event is fired at the moment of updating the value of the
GrapesJs template.A block is an object that allows the end user to reuse components.
Builder for
GrapesJsBlock that can be used to create blocks via the Fluent API.The plugin adds the Flexbox block which allows creating easily flexible and responsive columns.
The plugin adds the possibility to embed custom code as a block.
The plugin adds some of the basic form components and blocks which help in working with forms easier.
The preset plugin configures
GrapesJs to be used as a Newsletter Builder with some unique
features and blocks composed specifically for being rendered correctly inside all major email clients.Embeddable plugin for the
GrapesJs component.Registry for
GrapesJsPlugins.The plugin enables custom CSS parser via PostCSS.
Serializes various parameters for the
GrapesJs into JSON for subsequent sending it to the client-side.The plugin adds a new filter built-in style property which can be used for CSS properties like
filter and
backdrop-filter.The plugin adds simple
tabs component as a block for GrapesJs.The plugin adds simple
tooltip component for GrapesJs.The plugin adds the TOAST UI Image Editor on Image Components in
GrapesJs.The DOM event is fired at the moment of updating the
GrapesJs template on the client-side.Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated, for removal: This API element is subject to removal in a future version.
Grid component is used to drawing grid in rectangular coordinate.
Grid is a component for showing tabular data.
A helper base class for creating extensions for the Grid component.
Server-side component for the
<vaadin-grid-column> element.Builder for
DataCommunicator object.Multi-sort priority (visually indicated by numbers in column headers)
controls how columns are added to the sort order, when a column becomes
sorted, or the sort direction of a column is changed.
behavior when parsing nested properties which may contain
null values in the property chainSelection mode representing the built-in selection models in grid.
Callback interface for counting the number of items in a backend
based on a Spring Data Pageable.
Callback interface for fetching a list of items from a backend based
on a Spring Data Pageable.
A support class for managing actions in grids, providing functionality for binding
actions to grid components and displaying them in a context menu.
Array update strategy aware class for Grid.
Data object for
TreeGridArrayUpdater.Server-side component for
<vaadin-context-menu> to be used with
Grid.Event that is fired when a
GridMenuItem is clicked inside a
GridContextMenu.Implementation of generic data view for grid.
Drag end event of
Grid rows.Drag start event of
Grid rows.Drop event that occurs on the
Grid or its rows.Defines drop locations within a Grid row.
Defines the locations within the Grid row where an element can be dropped.
Export actions configuration interface
Represents a customizable grid layout component for displaying data in a grid-based format.
Implementation of generic data view for
JmixGridLayout.Server-side component for the
grid-layout-item element, used to represent individual items
in a JmixGridLayout.Data view implementation for
JmixGridLayout with in-memory list data.Data view implementation for Grid with lazy data fetching.
Data view implementation for Grid with in-memory list data.
Item component used inside
GridContextMenu and GridSubMenu.Deprecated, for removal: This API element is subject to removal in a future version.
A helper class that enhances the behavior of a menu item in the context of a grid or data table
by associating it with an
Action.A wrapper class for encapsulating a grid menu item with associated actions and UI components.
Multiselection model interface for Grid.
State for showing the select all checkbox in the grid's default header
row for the selection column.
Selection model implementation for disabling selection in Grid.
Server side implementation for the flow specific grid selection column.
The server-side interface that controls Grid's selection state.
Single selection model interface for Grid.
Sorting information for
Grid.Helper classes with fluent API for constructing
GridSortOrder lists.API that allows adding content into the sub menus of a
GridContextMenu to create hierarchical menus.Set of theme variants applicable for
vaadin-grid component.Loads data using groovy script
Script should return list of maps
Example:
return [['a':123, 'b':321], ['a':456, 'b':params['param1']]]
Realization of this interface is intended to prepare a map of parameters filled with beans or other objects
GroovyScript validator runs a custom Groovy script.
User access group.
Interface for formatting group cell values.
Represents the context for a group cell in a grouped data grid.
Interface to be implemented by group columns.
The data grid component that supports grouping of data.
Adapter for
GroupDataGrid component.Factory for creating
AbstractGroupDataGridAdapter instances.Provides an adapter for a group grid component.
Represents a column that renderers grouping data by properties.
A renderer that renders a component inside a toggler for each group item.
Hierarchical renderer that wraps another renderer to provide a custom data generator.
A default renderer that renders a readable presentation of a group item inside a toggler.
Event fired when a DataGridColumn visibility is changed.
Interface to be implemented by classes that observe changes in the data provider of a
GroupDataGrid.An editor in a Grid.
A UI component used for displaying the filter in the column header.
An event fires when the current value of the
PropertyFilter is applied to the loader.A UI component used for displaying a button for managing grouping columns in the header of
GroupDataGridColumn in GroupDataGrid.Represents a group data grid source of items.
Event is fired when the group property descriptors count is changed (removed/ added).
Binds the settings for instances of
GroupDataGrid.This component can contain
FilterComponents and can be used for filtering entities
returned by the DataLoader.Represents a group of items in the
GroupListDataComponent.Event fired when the grouping of a
GroupDataGrid changes.Event fired when a row that corresponds to a group item is clicked.
Event fired when a row that corresponds to a group item is double-clicked.
A component that provides grouping functionality for a list of items.
Event fired when a group collapsed.
Event fired when a group expanded.
Represents a property that can be used for grouping.
Describes a property that can be used to group items.
The context provides information about an item and its associated grouping property.
Marker interface for renderers that support grouping.
This class is not thread-safe and should not be accessed concurrently from multiple threads without proper
synchronization.
Exception thrown during the development of UI, such as incorrect view layout markup.
Interface to be implemented by UI components supporting an action.
Defines a set of methods for
JmixUserMenu components where menu items
associated with an Action.Interface to be implemented by UI components containing
Actions.Interface for a web-element wrappers that have an actions to trigger.
A component that has alignment.
Interface to be implemented by UI components that can automatically receive focus when the page is loaded.
An axis that has name.
Predefined location for axis name.
Font text style of axis name.
Base options for each layer that extends
Layer.A component that has border.
Defines a set of methods for
JmixUserMenu components where menu items
can contain UI Component elements.Interface to be implemented by UI components that have an associated content component.
Interface to be implemented by source that can load images by request.
Interface defining methods for interacting with data API elements.
The interface of views that display and may change the instance of an entity.
Interface for enums supporting JSON serialization.
Marker interface for serializing enums.
Interface to be implemented by sources that support feature dragging.
The event is fired when the user finishes dragging a feature.
The event is fired when the user starts dragging a feature.
Interface to be implemented by sources that support feature modification.
The event is fired when a feature is deleted from a source.
The event is fired when a feature modification is completed.
The event is fired when a feature modification is initiated.
Interface to be implemented by features that support modification styles.
Interface to be implemented by sources that support feature selection.
The event is fired when features are selected or deselected.
Interface to be implemented by features that support selection styles.
Interface to be implemented by context menu that works with
FullCalendar.Event is fired when menu item in context menu is clicked.
Interface to be implemented by sources that support geo-object dragging.
The event is fired when the user finishes dragging a geo-object.
The event is fired when the user starts dragging a geo-object.
Interface to be implemented by sources that support geo-object modification.
The event is fired when a geo-object modification is completed.
The event is fired when a geo-object modification is initiated.
Interface to be implemented by sources that support geo-object selection.
The event is fired when items are selected or deselected.
Interface to be implemented by renderers that depend on a
GroupDataGrid.Interface to be implemented by sources that should provide gutter attribute management.
A URL query parameter binder that saves the component's state upon initialization and can restore it.
Interface to be implemented by entities that are not included in static metadata, but can provide a
MetaClass
specifically for each instance.Interface to be implemented by renderers that display items count.
An object that supports
KanbanColumn as internal elements.A component that may have a limit on the number of characters (in Unicode code points) that the user can enter.
A component that has line style.
Style for drawing line endpoints.
Style for joining two line segments where they intersect.
Interface to be implemented by containers that can be loaded by loaders.
Represents an interface defining methods for managing menu items
in a
MainTabSheet context menu.Represents menus that have menu item providers
Represents a contract for managing menu items in user menu components.
Interface defining methods for components that can have
JmixMenuItems inside them.Interface to be implemented by layers that support feature modify styling.
Interface to be implemented by classes that represent application user and that wrap the
OidcUser.A component that has a space around content.
Interface to be implemented by sources that should provide parameters for the WMS request.
Deprecated, for removal: This API element is subject to removal in a future version.
use
HasPlaceholder instead.A component that has position.
Interface that defines behavior for components that can be marked as required.
Interface to be implemented by layers that support feature selection styling.
Interface to be implemented by sources that should provide WMS serverType management.
A component that has shadow.
Interface for actions and UI components that can be performed using shortcuts.
Provides the same functionality as the
Provides the same functionality as the
ClickNotifier.addClickShortcut(Key, KeyModifier...).A series that has stacked values.
The stack strategy type.
Interface to be implemented by layers that support styling of features.
Interface to be implemented by UI components that provide additional
objects for framework as part of component API.
A component that has symbols.
A symbol that can be defined by a predefined type or icon.
Predefined symbol types.
The implementation of additional criteria for multi tenants.
A component that has text.
Defines a set of methods for
JmixUserMenu components where menu items
can contain text and icon.Provides user time zone information.
Mixin interface for components that displays text in a tooltip popup when the mouse is over it.
Represents a data unit that provides the type information of its value.
Interface to be implemented by sources that should provide URL management.
An object having a
ValueSourceProvider.Defines a set of methods for
JmixUserMenu components where menu items
associated with a View.Interface for components that have a
WorkArea component.Defines a contract for components that support working with a
ZoneId.Provides a channel that publishes messages to all application instances in a cluster using Hazelcast topics.
One row of
HeaderRow.HeaderCells in a Grid.A header cell in a Grid.
A source containing geo-objects (entities having a property of a
Geometry type) for HeatmapLayer.Layer for rendering vector data as a heatmap.
Gathers information about holidays for annotated business calendar.
Non-persistent entity used to display holidays of certain business calendar in UI
Represents horizontal menu that can be used for navigation to a view or for invoking a method of a bean
Web-element wrapper for horizontal menu.
HorizontalMenu.AbstractContentMenuItem<T extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasComponents>
Provides base functionality for items that contain text with suffix and prefix components
HorizontalMenu.AbstractMenuItem<T extends com.vaadin.flow.component.Component>
Provides base functionality for horizontal menu items
Represents horizontal menu item that can run some action on click
Represents menu item that can contain other menu items.
Represents a separator
Represents an item which navigates to a view on click
Class is used for hot deployment of BPMN process.
Binds
HtmlContainer with ValueSource, InstanceContainer or CollectionContainer
to show entity property value.Implementation of
HtmlContainerReadonlyDataBinding.Handle HTML with format string: ${html}
Document formatter for '.html' and '.ftl' file types
Icon style for vector features.
Convenient class for methods that receive Id of an entity as a parameter.
Helper class which represent a collection of
IdProvides conversion of
Id to and from the string representation.Can be applied to an attribute of
TemporalType.TIMESTAMP data type to always ignore the user time zone
when displaying and entering values.Exception that is thrown in case of incorrect access to a shared data from a thread that does not own necessary lock.
Exception that is thrown in case of incorrect access to a shared data from a thread that does not own necessary lock.
Handle images with format string: ${image:100x100}
Layer with server-rendered images that are available for arbitrary extents and resolutions.
Options for image layer.
Base class for sources providing a single image.
Source for displaying a single, static image.
Base class for styling icon, circle and shapes.
Source for WMS servers providing single, untiled images.
An object that allows configuring import process of entities from JSON, XML, CSV, XLSX.
Builds an instance of
ImportConfiguration using the following parameters:
Entity class (required): class of entity that will be imported using created import configuration
Input data format (required): xlsx, csv, json or xml.
Property mappings: list of PropertyMapping
Transaction strategy: ImportTransactionStrategy.Represents the result of input data processing that contains:
List of
ImportedDataItems: one imported data item contains the raw values of properties for one entity to import.
Data field names: names of the fields from input data (XLSX, CSV - column names specified in the first row,
JSON - field names from JSON object, XML - tag names).
Parses the data from source and returns an instance of
ImportedData containing list of ImportedDataItem with raw valuesRepresents a source of raw values for properties for one entity to import.
Represents an object in JSON or XML with the following info:
Data field name: for JSON - field name, for XML - tag name
Raw values map: for JSON - raw values of JSON object fields by field names,
for XML: values of child tags by tag names
JSON example:
The "customer" object represents
JSON example:
The "customer" object represents
ImportedObject with data field name = "customer" and two raw values: "name" and "email".Represents an object list in JSON or XML with the following info:
Data field name: for JSON - field name, for XML - tag name
List of
JSON example:
The "items" JSON array represents
ImportedObjects
JSON example:
The "items" JSON array represents
ImportedObjectList with data field name = "items" and two ImportedObjects.An object that contains the following information about the import execution result:
Success: whether entities import is executed successfully or not
List of entity ids that are successfully imported
List of
EntityImportErrors created for not imported entities
Error message
The way how to import the entities:
Single transaction: if any entity import fails, the import process fails
Transaction per entity: if any entity import fails, the import process continues
Transaction per batch: the entities are imported by batches.
Default notification channel.
Interface to be implemented by custom handlers being called
on
InAppNotification saving within InAppNotificationEventListenerThe class to perform business operations with
InAppNotification entity.INTERNAL.
This annotation marks method that provides Indexable Predicate.
Contains configuration of index related to some entity
The comparator that compares both the application's index configuration and the search index state
at the search server.
Provides functionality for enqueuing entity instances and processing queue.
Represents a key for indexing, which can be created from either an entity instance or its identifier.
Provides functionality for index management.
Compares both the mapping from the application's index configuration
and the index state from the search server.
Contains details about all fields
Represents the scope of an index search request, encapsulating the index configuration and a set of fields
that is able for searching.
Class encapsulates logic of both the settings from the application's index configuration
and the settings from the index state from the search server comparing.
Base interface for Index settings configurers.
Holds markers of search indexes availability.
Class encapsulates the logic of receiving the index state from the search engine service.
Interface for resolving parameters for a
PropertyCondition
with PropertyCondition.Operation.IN_INTERVAL operation.Thrown when initialization of internal parts of reporting fails
Example: you have provided wrong database driver class name
The view is initially opened before each test when it is required.
The view is initially opened before each test when it is required.
Stores URL-token objects in in-memory storage
Checks access to entity operations based on row-level policies.
Defines an authorization point for checking access to entity operations by testing predicates.
A wrapper for
InMemoryDataProvider that integrates it into the
DataProviderWrapper framework, enabling in-memory data filtering
using a SerializablePredicate.In-memory implementation of
RegisteredClientRoleAssignmentRepository.RoleAssignmentProvider that stores role assignments in memory.A
UserSubstitutionProvider that stores UserSubstitution in memory.InnerTooltip component.
Contains supported input data formats
Describes result of handler that can be used with
DialogAction in the input dialog.Describes input dialog validation context.
Action can be used in
InputDialog.Describes field that can be used in
InputDialog.Defines an input parameter - parameter passed from the outside when running a defined report
which can be used as conditions in data sets.
Annotation marks a delegate method that implements some logic related to an input parameter
defined in the report definition class.
Inside data zoom functionalities is embedded inside coordinate systems,
enable user to zoom or roam coordinate system by mouse dragging,
mouse move or finger touch (in touch screen).
Annotation for declarative handler methods in UI controllers.
Sets primary subject for injection to target classes.
Deprecated, for removal: This API element is subject to removal in a future version.
unused for FlowUI, legacy from the ClassicUI
The root interface in the data containers hierarchy.
Event sent when the entity instance selected in the container is replaced with another instance or null.
Event sent on changing a property value of the contained entity instance.
Implementation of the
InstanceContainer interface.Loader of a single entity instance.
Event sent after successful loading of an entity instance, merging it into
DataContext and setting to
the container.Event sent before loading an entity instance.
Implementation of the
InstanceLoader interface.Specifies an entity attribute or method to provide an instance name - a human-readable text that represents an entity instance.
Provide instance name and instance name properties.
Container that holds a single instance which is loaded as a property of another entity.
An implementation of the
InstancePropertyContainer interface.Indicates that the annotated program element is considered an internal implementation detail and should
not be used in application code.
This exception is thrown when requesting REST data store with an inline fetch plan but the corresponding
REST API supports only named fetch plans.
This exception is thrown when REST API returns 400 status code on attempt to get access token by refresh token.
Exception thrown if an annotated report or report group definition is invalid.
Event fired when a Grid item is clicked.
Event fired when a Grid item is double clicked.
Interface that defines a contract for handling changes to properties of a particular item.
Interface to be implemented by data providers that should load a list of events.
An event that is fired when item set is changed.
INTERNAL.
Common item style for bordered text.
Same as
AbstractItemStyle but with a decal pattern style.Defines what Java class is handled by the annotated datatype.
Class loader is used for building class instances from ".class" files.
Substitutes variables of a within a string by values.
Factory class for creating and wiring wrappers for Masquerade components.
Utility class that provides the
conditions for checks in web-elements and their wrappers.Interface to provide ability to customize ObjectMapper that is used by JdbcOAuth2AuthorizationService.
Query implementation for Jmix.
Defines the contract for binding mechanisms.
Server-side component for the
<jmix-breadcrumb> element.Represents a click event triggered on a
JmixBreadcrumb component.Server-side component for the
<jmix-breadcrumbs> element.Delegate that handles action set to
JmixButton.Code Editor is a multi-line text area to display and enter source code featured
with code highlighting and optional print margin and gutter with line numbers.
An event fired when the value of a
JmixCodeEditor changes.RepositoryQuery for query methods annotated with @Query.Central Jmix data repository interface.
Accumulates jmix-specific parameters.
Implementation of base repository methods used by application repository beans.
Helper class for
JmixDataRepository.Represents component settings for
Details component.Binder for applying and saving
JmixDetailsSettings to a JmixDetails component.Should be used on an embedded attribute of a DTO entity instead of
Embedded).Empty data provider for a
JmixKanban component.Empty data provider for a
JmixPivotTable component.Indicates that the annotated class is an entity and must be represented in the metadata.
Annotation to mark index definition interfaces.
Map implementation for MapSessionRepository that periodically removes expired sessions.JmixFileStorageUploadField is a component for file upload functionality that integrates with a file storage system.
A component for uploading files with support for displaying the uploaded file name and handling file upload events.
Mostly copied from
FilterBasedLdapUserSearch in order to add JmixFilterBasedLdapUserSearch.searchForUsersBySubstring(java.lang.String) method.INTERNAL.
INTERNAL.
INTERNAL.
Indicates an entity attribute that must be assigned by the framework right after creating an entity instance.
A customizable grid component that extends the Vaadin
Grid and provides
additional capabilities such as handling actions and sub-parts support.A component which allows to manage visibility of data grid columns
Represents an item which allows to toggle column visibility.
A custom implementation of a context menu for a
Grid component that extends
the GridContextMenu functionality and implements the HasSubParts interface.Represents a customizable grid layout component for displaying data in a grid-based format.
Interface that throws exceptions in a Groovy script.
Experimental.
Experimental.
Experimental.
Experimental.
Hazelcast sessions autoconfiguration.
Utility class for Jmix-specific configuration of
HttpSecurity.This annotation should be used on an id attribute if the attribute has no other appropriate annotation
recognized by the framework (such as
Id).Component supports data binding with entity properties.
Set of theme variants applicable for
JmixImage component.A component for managing the number of items displayed per page in a paginated interface.
Converts
Jwt into Authentication.An implementation of an AbstractOAuth2TokenAuthenticationToken representing a Jwt Authentication.
Base component for implementing kanban board.
Hierarchy mode for Kanban cards.
The internationalization properties for
JmixKanban.POJO class for storing mapping of item attributes to properties of Kanban items.
Task positioning mode for Kanban columns.
Base support class for adding actions to the
JmixKanban component.Base interface for
JmixKanban component items element implementation.Event sent on changes in the items collection - adding, removing, replacing elements.
Type of items change.
Serializer for
JmixKanban's propertiesExtension of the default strategy for obtaining user role information from the directory.
GrantedAuthoritiesMapper that maps authorities to
GrantedAuthoritys.Extension of Spring LDAP's LdapTemplate class which adds extra functionality required by Jmix.
Extension of LdapUserSearch interface which adds extra method required by Jmix.
Helper class for building an instance of
SpringLiquibase using the LiquibaseProperties.Describes menu item that should navigate to the view.
JmixLocalVariableTableParameterNameDiscoverer is copy of
org.springframework.core.LocalVariableTableParameterNameDiscoverer
spring's discoverer because it was deprecated and will be removed.Internationalization object for customizing the component UI texts.
A subclass of
LoginI18n.Form that adds additional functionality specific
to the customization of a login form used in the application.Contains the definition for all the CSS utility classes provided by Jmix Lumo.
Containers related classes.
JmixMenuManager<C extends com.vaadin.flow.component.Component,I extends com.vaadin.flow.component.contextmenu.MenuItemBase<?,I,S>,S extends com.vaadin.flow.component.contextmenu.SubMenuBase<?,I,S>>
Common management logic for context menus and sub menus.
Indicates that the
@Configuration class is a main configuration of a Jmix module.Describes a Jmix module which the current application depends on.
Holds the list of
JmixModuleDescriptors.Helps to select a bean that belongs to the lower module in the hierarchy of
@JmixModule dependencies (where
core is on top and an application is at bottom).Scans classpath of all Jmix modules used in the application and detects classes according to
ClasspathScanCandidateDetector beans registered in the Spring context.Sorts
JmixModuleDescriptors using the topological sort algorithm.A
NavigationAccessChecker that checks access to view by the presence of the Vaadin
@AnonymousAllowed annotation on the view controller and by analyzing Jmix resource roles assigned for
the current user.An interface to be implemented by a user Principal that is registered with an OpenID Connect 1.0 Provider.
Mapped superclass to be extended by JPA entity that stores user information.
Marker interface for OidcUserService that is used by auto-configuration.
JmixOraclePlatform for oracle 22 and lower versions.
Defines constants for higher and lower precedence for
Ordered or
annotated with Order beans of the Jmix modules.Parameter extension required to support FetchPlan special parameter.Parameters extension required to support FetchPlan and JmixDataRepositoryContext
special parameters.Base component for implementing pivot table.
Base interface for
JmixPivotTable component items element implementation.Event sent on changes in the items collection - adding, removing, replacing elements.
Type of items change.
Specifies an entity attribute if
JmixEntity.annotatedPropertiesOnly() is set to true.Determines query type and creates
RepositoryQueries for Jmix data repositoriesQueryMethod extension required to support FetchPlan special parameter.ImportBeanDefinitionRegistrar for Jmix data repositories.JmixRepositoryFactoryBean<T extends org.springframework.data.repository.Repository<S,ID>,S,ID extends Serializable>
Represents additional request matcher that will be applied to RequestCache within VaadinDefaultRequestCache.
An area to input text with rich formatting.
The internationalization properties for
JmixRichTextEditor.A set of constants with order values of
SecurityFilterChain used in Jmix
modules.JmixSessionCreatedEvent<S extends org.springframework.session.Session>
Published by the
SessionRepositoryWrapper when an Session is
created by the Spring session repositoryJmixSessionDestroyedEvent<S extends org.springframework.session.Session>
Published by the
SessionRepositoryWrapper before a Session
destroyed by the Spring session repositoryJmixSessionRestoredEvent<S extends org.springframework.session.Session>
Published by the
SessionRepositoryWrapper when an Session is
restored from the Spring session repositorySimplePagination is a component used to load data by pages.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.The map component fires this event to inform the vector or data vector source that the modify start event
has occurred.
INTERNAL.
Deprecated, for removal: This API element is subject to removal in a future version.
workaround for a Vaadin's bug ,
use
Spreadsheet insteadBase
RepositoryQuery class for repository queries constructed by method name.JmixSwitch is an input field representing a binary choice.
An event to mark that the selected tab has changed.
Workaround on Windows OS if you build project using gradle with long class path.
The JmixTimer class provides a server-side component for managing timer-based
execution.
Event that is sent when the timer is stopped by invoking the
JmixTimer.stop() method.Event that is sent after the specified time interval in the
delay attribute
has passed since the timer started.A specialized TreeGrid component that introduces additional capabilities, including
support for actions and sub-parts functionality.
JmixTwinColumn is a customizable UI component designed for selecting multiple items
from one column to another.
Extension starts Vaadin Flow before each test and configures view packages and authentication.
Extension starts Vaadin Flow before each test and configures view packages and authentication.
A custom upload button component that extends the Vaadin
Upload.Contains properties for the upload dialog.
Provides core user information.
A component that displays a user menu as a dropdown.
Represents a component that has an associated
MenuItem.A functional interface representing a renderer that generates a
Component
based on a provided item.Represents an event that is triggered when the user associated with the
JmixUserMenu component changes.Delegate class for managing
UserMenuItem collection.Blank item needed for correct insertion by index.
Workaround on Windows OS if you build project using gradle with long class path.
Listener sets provided class path to "java.class.path" property.
JMX console configuration interface
Interface to provide JMX control functionality for local JMX interfaces.
Custom exception class to handle JMX Control-related exceptions.
Implementation of the
JmxControl interface for managing JMX functionality.Sorts attributes alphabetically by name
Sorts domains alphabetically by name
Sorts mbeans alphabetically by name
Sorts operations alphabetically by name
Uses all instances of
JoinExpressionProvider beans to create and apply additional join criteria to the mapping.Generates additional join expression for entity mappings.
Stores cookie-token objects in database storage
INTERNAL.
Helps to distinguish newly loaded entities (including implicitly loaded) from already existed.
Beans implementing this interface are notified by JPA implementation on their
specific events.
Stores cascaded entities in addition to standard
SaveContext dataCondition that represents JPQL query with "where" and optional "join" sections.
JpqlFilter is a UI component used for filtering entities returned by the
DataLoader.Builds
Query instance to use in DataService.QueryStringProcessor implementation that provides support for abbreviated JPQL queries.Provided query should return usernames instead of users itself, like
Defines JPQL row-level policy in annotated row level role (see
RowLevelRole).Interface to be implemented by a Spring bean to generate sort expression for datatype and LOB properties.
Provides auto-completion suggestions for JPQL queries in the user interface.
Provides bypass of BandData tree.
Utility class that provides the selectors of the
SelenideElement wrappers.The
By selector, which find a web-element by its displayed text.The
By selector, which finds a web-element with the UI_TEST_ID
attribute equals to the simple name of the web-element's wrapper class.The
By selector, which find a web-element by the value of
the UI_TEST_ID attribute.JavaScript function definition.
JavaScript function definition.
JavaScript function definition.
INTERNAL.
Loads data from json string
Uses JsonPath to access necessary parts of json object
Example:
JSON:
{ "store": {
"book": [
{ "category": "reference",
"author": "Nigel Rees",
"title": "Sayings of the Century",
"price": 8.95
},
{ "category": "fiction",
"author": "Evelyn Waugh",
"title": "Sword of Honour",
"price": 12.99,
"isbn": "0-553-21311-3"
}
],
"bicycle": {
"color": "red",
"price": 19.95
}
}
}
Query string:
parameter=param1 $.store.book[*]
We get json string from parameter param1 and select all "book" objects from the "store" object
Additional parameters for a data set definition of
DataSetType.JSON type.Action for export table content as JSON
Use this class to export
DataGrid into JSON format.Custom JSON input provider
for a
DataSetType.JSON data set.Compares two JSON nodes that contains index settings or index mapping in correspondence to such comparison rules.
The interface for transforming search clients' specific JSonp format to Jackson's ObjectNode.
Determines source where JSON for a
DataSetType.JSON data set is obtained.Enum for JSON transformation direction
Kanban represents a kanban board that visually depicts work at various stages of a process using cards
to represent tasks and columns to represent each stage of the process.The server-side implementation of the interface that controls
Kanban's selection state.Support class for adding actions to the
Kanban component.A class representing
JmixKanban column properties.The
KanbanColumn tasks orientation.Event describing a click on a column.
Event describing the collapse of a column.
Event describing double-click on a column.
Event describing the expanding of a column.
Event describing hiding a column.
Serializer for
KanbanColumn.OrientationEvent describing a change in ordering of a column.
Event describing showing a column.
Event describing the dropping of an item card.
Event describing the dragging of an item card.
Base interface for
Kanban component items element implementation.The server-side interface that controls
Kanban's selection state.Serializer for
Kanban's properties.Implementation of a POJO class that describes the settings of the
Kanban component.Implementation of a POJO class that describes the settings of the
KanbanColumn.Kanban component settings registration.Serializer for
StreamResource.A class representing
Note: Sub-columns are not applicable when swimlanes are present.
JmixKanban swimlane properties.Note: Sub-columns are not applicable when swimlanes are present.
Event describing the clicking of an item card.
Event describing the double-clicking of an item card.
For internal use only.
Stores information about key, modifiers and additional settings that describe shortcut combinations.
This loader implements the keyset pagination strategy.
Container for a collection of
KeyValueEntity instances.Implementation of the
KeyValueCollectionContainer interface,
providing functionality for managing a collection of KeyValueEntity instances.Loader of
KeyValueEntity collections.Event sent after successful loading of entities and setting to
the container.
Event sent before loading entities.
Implementation of the
KeyValueCollectionLoader interface, responsible for loading and managing
a collection of key-value pairs into a KeyValueCollectionContainer from a data source.Container for a single
KeyValueEntity instance.Implementation of the
KeyValueContainer interface.Entity that contains a variable set of attributes.
Loads a single instance of
KeyValueEntity.Event sent after successful loading of a KeyValueEntity instance and setting it to
the container.
Event sent before loading a KeyValueEntity instance.
Implementation of the
KeyValueInstanceLoader interface for loading key-value entities.MetaClass for
KeyValueEntity.MetaProperty for
KeyValueEntity.A text label to explain some information about a graphic element, such as value, name etc.
General label for components.
Condition for checking the label value of web-element wrappers for field components.
Component for label position.
Predefined position type.
Base implementation of layer.
Helper class to build select and modify styles maps for layers.
Allows providing mapping between LDAP group name and Jmix role codes.
Extension point for fetching additional user roles for LDAP user.
Implementation of UserRepository that searches for users in LDAP.
An implementation of
AuthenticatedUrlPatternsProvider and AnonymousUrlPatternsProvider that
collects URL patterns from multiple AuthorizedUrlsProviders.Legend component shows symbol, color and name of different series.
Type of legend.
This loader implements limit-offset pagination strategy.
Special label types, are used to label maximum value, minimum value and so on.
Line chart relates all the data points
LineSeries.symbol by broken lines, which is used to show
the trend of data changing.Base component for line elements.
The style of area.
Component to configure the blur state.
Component to configure the emphasis state.
Label component on the end of line.
Component to configure label guide line.
Component to configure the selection state.
Type for maintaining the monotonicity on XAxis or YAxis.
Type of step line.
Polyline feature with predefined
LineStringGeometry.Linestring geometry.
Helper class for styling linestring
Feature.Transforms
LineString datatype into WKT (Well-known Text) representation that persists as a text and vice versa.Common style for the line.
Data provider that fetches events from
List.Data provider for a Chart component in which all items are stored in
List.A component that displays list of items.
Configuration properties of list day display mode
CalendarDisplayModes.LIST_DAY.Defines classes of entity lifecycle listeners
listMenu is a component for displaying a vertical menu with a collapsible drop-down sub-menus.
Web-element wrapper for list menu.
Describes menu item that can contain other menu items.
Describes menu item.
A command executor responsible for handling user interactions with
ListMenu.MenuItem
instances.Set of theme variants applicable for the
ListMenu component.Configuration properties of list month display mode
CalendarDisplayModes.LIST_MONTH.Data provider for a
PivotTable component in which all items are stored in ListFacilitates navigation to a detail view of a specific type with additional configuration options.
The navigation processor implementation that is responsible for processing navigation
to specific views using a
ListViewNavigator instance.Provides a fluent interface to configure navigation parameters and navigate to an entity list
View.Configuration properties of list week display mode
CalendarDisplayModes.LIST_WEEK.Configuration properties of list year display mode
CalendarDisplayModes.LIST_YEAR.Class that defines parameters for loading entities from the database via
DataManager.Class that defines a query to be executed for data loading.
Provides information about properties loaded from data store.
Creates
CachingLoadedPropertiesInfo instances to be used in JPA entities.Marker interface for component loaders.
Utility class contains common methods to apply and process Spring Data repositories special query parameters and annotations.
Facilitates parsing data from XML.
Defines an authorization point for entity attributes in a JPQL query loading scalar values.
Checks access to entity attributes in a JPQL query loading scalar values based on resource policies.
Provides a channel that publishes messages only to owner application instance
which is used in single-instance applications.
Implementation of
Aggregation intended for aggregating LocalDate values.Implementation of
Aggregation intended for aggregating LocalDateTime values.Allows resolving the current
Locale as method argument.POJO class that is supposed to be used as JSON item in
EnhancedLoginForm.The LocaleResolver class transforms locales to strings and vice versa to support messages localization.
INTERNAL!
Supposed to use when showing
Dialog or some View.Encapsulates the context in which a localized task is executed, providing access
to the associated
LocalizedTaskWrapper.Implementation of
Aggregation intended for aggregating LocalTime values.The event that is fired each time the location changes by
RouteSupport bean.The
LockDescriptor contains configuration information about a pessimistic lock.Interface that provides
LockDescriptor objects for LockManager.Describes a pessimistic lock of an object.
A special case of
LockInfo that is returned from LockManager
methods to indicate that locking is not supported for a specified object type.Enum representing the status of a locking operation.
Configuration element of
EntityLog bean.Configuration element of
EntityLog bean.Logical condition (AND, OR) which contains other conditions.
Component which can contain other filter components and can be used for filtering entities
returned by the
DataLoader.LogicalFilterComponent.FilterComponentsChangeEvent<C extends com.vaadin.flow.component.Component & LogicalFilterComponent<C>>
Operation representing corresponding logical filtering condition.
Class that provides authentication via
AuthenticationManager.Filter that sets up MDC (Mapped Diagnostic Context) for each http request.
Implementation of
Aggregation intended for aggregating Long values.A component which can be set as lookup component for a view.
Annotation for lookup view controllers which specifies ID of a UI component to be used for getting a value
returned from the lookup.
Interface representing a multi-select lookup component.
Interface of views that display a list of entities and can return instances selected by the user.
Context object which is passed to the selection validator set by
LookupView.setSelectionValidator(Predicate).Provides a fluent interface to configure and open a lookup view
in a
DialogWindow.Processes and builds
DialogWindow instances for views using a LookupWindowBuilder.Provides a fluent interface to configure and open a lookup view with
the specific class in a
DialogWindow.A tool feature to switch series type on the fly.
Icon for different magic types.
Available series types for conversion.
Title for different magic types.
Component that consists of a set of tabs and the content area.
The class provides support for managing actions within an associated
MainTabSheet component.An event that occurs when a drag-and-drop operation is completed on
a
MainTabSheet component.Defines drop locations within
MainTabSheet.This class is responsible for connecting an
Action to menu items,
handling property changes for actions, and updating the visual or functional
components of the menu item according to the action's state.A wrapper class for handling
MainTabSheet's menu item actions and related UI content.Utility class working with
MainTabSheet's specifics.Set of theme variants applicable for the
MainTabSheet component.Helper class for the main view.
This annotation marks method with manual creation of Mapping Definition
Helper class for
GeoMap dependencies autowiring.An event that is fired when map is clicked.
Data item, which is a set of key-value pairs.
An event is fired when user makes double click on a map.
An event is fired after the map is moved (e.g.
INTERNAL.
Contains information about indexed properties defined within index definition interface
marked with
JmixEntitySearchIndexDescribes details of mapping for entity property or group of properties.
Class encapsulates logic of comparing the mapping's fields that are "leaf" field.
Contains details of single mapped field.
Updates mapping properties according to requirements.
POJO to store all information needed to process entity mappings.
An event is fired after 250 ms to ensure that it is not a double click.
Contains constants that are used to detect type of object during the synchronization
of the
JmixMap component.A variable container wrapper for a variables map.
INTERNAL.
An event is fired after the resolution of map view is changed.
Component that used to mark an area in chart.
Component to configure the blur state.
Component to configure the emphasis state.
Component to configure mark area point.
A class containing a pair of points, left top point and right bottom point of area.
Marker feature with predefined
PointGeometry.Helper class for styling marker
Feature.Mark line in a chart.
Base class for mark line elements.
Component to configure the blur state.
Component to configure data for the mark line.
Component to configure the emphasis state.
Component to configure mark line point.
A class containing a pair of points, start and end.
Mark point in a chart.
Component to configure the blur state.
Component to configure the emphasis state.
Point to display.
The main starting point of Masquerade.
Represents a composite UI component for displaying and invoking
MBean operations.
Web-element wrapper for menu bar overlay.
Holds information about the main menu structure.
Menu item provider for
HorizontalMenuMenu item provider for
JmixListMenuProvides base functionality for menu item providers which use MenuConfig as menu item source
A component which allows to filter items of a menu (for example,
ListMenu)
by their text labels using entered valueFilter mode variants
Set of theme variants applicable for the
MenuFilterField component.Represents generic item of a menu (for example,
ListMenu)Main menu item descriptor.
POJO class to store menu item information.
Represents a parameter associated with a menu item, consisting of
a name and a value.
Represents a property of a
MenuItem within a menu configuration.Represents a command that can be associated with a menu item,
providing a description and the logic to be executed when the command is run.
Provides functionality for creating and managing commands associated with menu items.
Represents menu item source which can be bound to a menu
Menu item collection change event.
Defines menu resource policy in annotated resource role.
Defines options of the
DataContext.merge(Object, MergeOptions) operation.Interface to be implemented by classes for solving conflicts of document versions
if document was changed during editing on version management screen.
Class that provides messages from a message group bound to view controller.
Support class for processing
MessageTemplateParameterLocalization.Support class for resolving JavaClass for
MessageTemplateParameter.Interface to provide a caption of property, for example if the property is a dynamic attribute.
Central interface to work with localized messages.
Controller that returns localized messages
Class that executes business logic required by the
MessagesController.Defines additional basenames for Jmix's
MessageSource.Factory that configures a FreeMarker
Configuration.The generation context that is used in
MessageTemplateParameterGenerationStrategy.Strategy for generating visual components for a
MessageTemplateParameter.The entity is used to display and save localization for
MessageTemplateParameterRole that grants full access to working with message templates.
Interface defining methods for generating messages using templates.
The generator is used to create messages based on a single template and multiple set of parameters.
The generator is used to create messages based on a multiple set of templates and a single map of parameters.
The generator is used to create messages based on a single template and a single map of parameters.
Role that grants minimal permissions to view and generate message templates.
A component that provides access to the MessageTemplates add-on API.
Utility class to provide common functionality related to localized messages.
Marks an annotation as being a meta-annotation for entity classes and attributes.
Metadata object representing an entity.
Central interface to provide metadata-related functionality.
Interface to provide additional properties of MetaClass, e.g.
INTERNAL.
Provides utility methods for changing metadata.
Ancestor of main metadata objects:
MetaClass and MetaPropertyInterface to be implemented by beans in add-ons and applications for processing metadata right after it is built.
Utility class to provide common metadata-related functionality.
INTERNAL
INTERNAL
INTERNAL.
Metadata object representing an entity attribute.
Property type
Object representing a relative path to a property from certain MetaClass
Strategy interface to handle the value returned from the invocation of a
handler method .
Resolves method parameters by delegating to a list of registered
MethodArgumentResolvers.Utility class to provide
Method argument values from MethodArgumentResolverContains
MethodMetadata analyse logic such as ApplyConstraints determination.Minor split lines of axis in the
Grid area.Options component related minor ticks.
Thrown when a report is run for which default template is not defined
Exception thrown when a custom property is used for grouping but no
GroupPropertyDescriptor is found for it
in GroupDataGridItems.INTERNAL.
The context for generating class names for "more" link.
INTERNAL.
INTERNAL.
The event is fired when the user clicks on "more" link.
Groups visible and hidden calendar events by data provider.
Class contains mouse details when the user clicks in a map component.
Class contains mouse details when the user clicks in a map component.
Contains for mouse button that was pressed.
Contains for mouse button that was pressed.
Event is used to inform the assignee details fragment about the modification of the collection from the
multi-instance characteristics fragment.
Multilinestring feature with predefined
MultiLineStringFeature.Linestring geometry.
Transforms
MultiLineString datatype into WKT (Well-known Text) representation that persists as a text and vice versa.Processes texts that have a multiline text as value.
Multi marker feature with predefined
MultiPointGeometry.Configuration properties of multi-month year display mode
CalendarDisplayModes.MULTI_MONTH_YEAR.Annotation for view controllers that specify if the view can be opened multiple times from the main menu.
Multipoint feature with predefined
MultiPointGeometry.Multipoint geometry.
Transforms
MultiPoint datatype into WKT (Well-known Text) representation that persists as a text and vice versa.Multipolygon feature with predefined
MultiPolygonGeometry.Multipolygon geometry.
Transforms
MultiPolygon datatype into WKT (Well-known Text) representation that persists as a text and vice versa.Web-element wrapper for multi-select combobox.
A component that extends the
MultiSelectComboBox to provide additional functionalities,
such as supporting user actions, handling actions, and allowing tooltip titles.Web-element wrapper for multi-select combobox picker.
A view that can change selection mode of its lookup component.
Helper for login screen.
A component that allows selection and management of multiple values.
Web-element wrapper for multi-value picker.
Standard multi value select action for selection the field value.
Interface for a multi-value select view component.
Context class providing parameters required for generating multi-value select components.
An item of the tree in the "My Tasks" screen.
A specialized close action that represents navigation away from a view, potentially checking for unsaved changes
and handling events related to leaving the current view.
Auto-configuration provides a default configurer for Vaadin
NavigationAccessControl.Interface to be implemented by containers that work with entities that are properties of other entities.
Deprecated, for removal: This API element is subject to removal in a future version.
unused
An
Used by enhancing process when
EntityEntry implementation for model objects without identifiers.Used by enhancing process when
JmixEntity does not include any of annotations:
Id
EmbeddedId
JmixId
INTERNAL.
Dummy implementation of
DataContext used for read-only views like entity list views.Empty implementation of the
DataStore interface.INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
INTERNAL.
Thrown when result is expected but there is nothing to return.
This exception is thrown when a specific view cannot be found or is not defined.
Web-element wrapper for notifications.
Theme position of the notification.
Theme enumeration of the notification.
Describes the way of notification sending.
Service that allows to get information about notification channels available in application
Application event that is sent after the notification is closed.
Utility class to simplify initialization of detail views for
InAppNotification entity.Provides methods to create notification dialogs.
POJO class for storing notification information.
POJO class for storing notification information.
Service provides methods to send notifications to users.
Object describes notification (or set of notifications) that should be sent.
Provides Fluent API for NotificationRequest creation.
Condition for checking the notification message of
Notification web-element wrapper.Condition for checking the contained notification message of
Notification web-element wrapper.Application event that is sent after the notification is shown.
Condition for checking the
position of Notification web-element wrapper.Configures and displays popup notifications.
A builder that configures and displays notifications.
Notification type.
Component displays unread
InAppNotification notifications count and opens dialog to read and manage
notifications.An event that is fired when notifications count is changed.
Condition for checking the
theme of Notification web-element wrapper.Condition for checking the title value of
Notification web-element wrapper.Condition for checking the contained title value of
Notification web-element wrapper.Describes type of notification.
Service that allows to register notification types and get information about available ones.
Use for kotlin non-null references to prevent eager instantiation of lazy-loaded fields.
Use for kotlin non-null references to prevent eager instantiation of lazy-loaded fields.
Common placeholders interface for null values.
The context for generating class names for "now" indicator in timed display modes:
CalendarDisplayModes.TIME_GRID_DAY and CalendarDisplayModes.TIME_GRID_WEEK.Used by enhancing process.
Class is used as a default value for attribute of
EntityPolicy and EntityAttributePolicy annotationsClass is used as a default value for attribute of
UiComponentPolicy annotations.Helper class for aggregating numerical values.
Base interface for number type validators which contains all numeric restrictions.
Specifies a format
NumberFormat.pattern() and optional NumberFormat.decimalSeparator() and NumberFormat.groupingSeparator() for
an entity attribute of the Number type.Number formatter to be used in view descriptors and controllers.
Intermediate cache for generated ids of entities with long/integer PK.
Generates ids for entities with long/integer PK using database sequences.
Uses oauth2 access token and cookies to search session id.
Authenticator implementation that uses access token provided by OAuth2TokenProvider.Interface that provides functionality to remove expired tokens.
Attempts to extract an Access Token Request from
HttpServletRequest for the OAuth 2.0 Resource Owner
Password Credentials grant and then converts it to an
OAuth2ResourceOwnerPasswordCredentialsAuthenticationToken used for authenticating the authorization grant.An
AuthenticationProvider implementation for the OAuth 2.0 Resource Owner Password Credentials Grant.An
Authentication implementation used for the OAuth 2.0 Resource Owner Password Credentials Grant.The class configures the token endpoint by registering
OAuth2ResourceOwnerPasswordCredentialsAuthenticationConverter and
OAuth2ResourceOwnerPasswordCredentialsAuthenticationProvider which are required for OAuth 2.0 Resource Owner
Password Credentials grant.Interface defining methods for access/refresh token obtaining.
Helper class that converts objects to strings and vice versa.
Converts parameters from string to object and from object to string
A wrapper around a
List that provides additional functionality for observing changes to the list.Class that allows observation of changes to the set's contents.
Implementation for XInputStream
Proxy stream
Implementation of
Aggregation intended for aggregating OffsetDateTime values.Implementation of
Aggregation intended for aggregating OffsetTime values.Configures FlowUI views protection.
Configures API endpoints (e.g.
Event fired after OIDC resource server API call.
Event is fired before OIDC resource server API call.
A copy of io.jmix.authserver.filter.AsResourceServerEventSecurityFilter.
Interface is responsible for transforming an instance of
OidcUser (from Spring Security) to JmixOidcUser which may be used by Jmix application.Provides Vaadin security to the project.
Implementation of the
DataLoadCoordinator.Trigger interface that triggers data loading
in a DataLoader when the value of a specified UI component changes.This class implements a load trigger for a
DataLoadCoordinator.Marks a link to other entity for specific soft deletion behaviour.
Taken into account by persistence when "this" entity is deleted.
See also
Taken into account by persistence when "this" entity is deleted.
See also
DeletePolicyMarks a link to other entity for specific soft deletion behaviour.
Taken into account by persistence when "linked" entity (which is referenced by the marked field) is deleted.
See also
Taken into account by persistence when "linked" entity (which is referenced by the marked field) is deleted.
See also
DeletePolicyImplementation of the
DataLoadCoordinator.Trigger interface.Starts and stops an OOo server.
This bean generates OpenAPI documentation according to the 3.1 specification.
Bean contains opened
Dialogs in order of opening.Bean contains opened
Dialogs in order of opening.Bean contains opened
Notifications in order of opening.Bean contains opened
Notifications in order of opening.Standard open modes of
Views.Thrown when formatter catches Open/Libre Office internal errors
Implementation for OpenSearch
Implementation for OpenSearch
Configuration context for OpenSearch index settings
Base interface for configurers of OpenSearch index settings.
A OpenSearch-specific implementation of the
AbstractSearchQueryConfigurerA OpenSearch-specific extension of the common {link @SearchStrategy} interface
Provides OpenSearch search strategies
Operation result object.
Represents the possible statuses of an
OperationResult.Handles database OptimisticLockException.
Deprecated, for removal: This API element is subject to removal in a future version.
unused
INTERNAL.
Oracle-specific implementation of
OrderBasedEntityIdsLoader.Class that provides JdbcOAuth2AuthorizationService for Oracle database.
An enum with the orders in which column and row data is provided to the renderer.
Interface to be implemented by some entities that order display can be changed in UI.
Loads data using ordering property.
General orientation of any content.
Band orientation.
Source for the loading tiles from an OpenStreetMap tile server.
Service is used in functional tests
This class is used to store task outcomes results in a process variable.
Class returns a string description of the
OutcomesContainer instance.Enum to define how to display text when it's overflow.
Provides a method for obtaining the base package.
Common space around content.
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.
Interface defining methods for managing pagination when loading entity data.
Implementation of the
PaginationDataLoader interface.Class provides access to protected functionality from
PaginationComponent to support
saving/restoring UI settings when the View contains SettingsFacet.Handles the binding of pagination-related URL query parameters with a
PaginationComponent.A POJO class for storing properties of the
PaginationComponent's initial state.Provides a binder implementation for URL query parameters specifically designed
for pagination components.
A task that initializes and registers a
PaginationUrlQueryParametersBinder for components
capable of handling pagination behavior.ParameterComponentGenerationStrategy.FieldCreator<T extends com.vaadin.flow.component.AbstractField>
A
Datatype that exposes some internal parameters.Modifies JPQL query parameters according to the tree of conditions.
Report parameter for lazy data loading in core module
Validator invoked as part of input parameters validation on the UI.
Options that allow to show a dialog to input the report parameters or not.
Transformer can process input parameter values before they are passed to the reporting engine.
Data type of the report's input parameter.
Interface for implementing a custom input parameter validator.
Utility class for instantiation immutable
Map<String, Object>.Holds current parent document object for documents and collections that are displayed on the screen and performs
ParentDocumentContextHolder.OnParentChangeAction when holding value is changed.Interface that should be implemented in order to handle change context action.
Represents an item of a menu (for example,
ListMenu)
which can contain nested child itemsWeb-element wrapper for password field.
Runs all existing
PasswordValidators and returns the list of validation errors.Contains parameters of password validation.
Exception to be thrown by
PasswordValidator implementations.Interface to be implemented by beans that validate password when it is created or changed for a user.
Controller that is used for getting current user permissions
Class is used for getting current user permissions for the REST API.
Indicates whether to enable pessimistic locking of entity instances.
Class that encapsulates logic of
SearchStrategy that searches documents with at least one field
matches the entire phrase - all input words in provided order.Class that encapsulates logic of
SearchStrategy that searches documents with at least one field
matches the entire phrase - all input words in provided order.Represents a component that facilitates selection or picking of values and provides additional
capabilities such as support for actions, value sources, user-related actions, and DOM element manipulation.
Visual map component for displaying data in discrete form.
Piecewise visualMap component works in one of the three modes: CONTINUOUS-AVERAGE: the series data is continuous and is divided into pieces averagely according to
Piecewise visualMap component works in one of the three modes: CONTINUOUS-AVERAGE: the series data is continuous and is divided into pieces averagely according to
PiecewiseVisualMap.splitNumber.A component that used to customize how to slice continuous data, and some specific view style for some pieces.
The pie chart is mainly used for showing proportion of different categories.
Base component for pie elements.
An animation type for initializing data.
An animation type for updating data.
Component to configure the blur state.
Component to configure the emphasis state.
The style of visual guideline.
A special mode which distinguishes data by radius.
Component to configure the selection state.
Describes pivot table data that is retrieved from the client and used in the
PivotTableExporterIntegration of an open-source Javascript Pivot Table written by Nicolas Kruchten.
Pivot table cell click event sent from the client.
Contains deserialized json data from
PivotTableCellClickEventHelps to convert
PivotDataRow to list with separated cells and provides methods for merging cells.Exports
PivotData to XLS file.Prepare the data
PivotData requested from PivotTable, then export to an XLS file.Base interface for
PivotTable component items element implementation.Class contains properties to set up the PivotTable component.
Base class for all pivot table options objects that are to be serialized.
Describes the PivotTable refresh event.
Contains deserialized json data from
PivotTableRefreshEventPojo class to store pivot table data in the settings facet
Prepares data and builds a view with pivot table component.
Special label types, are used to label maximum value, minimum value and so on.
Point feature with predefined
PointGeometry.Point geometry.
Helper class for styling point
Feature.Transforms
Point datatype into WKT (Well-known Text) representation that persists as a text and vice versa.Polar coordinate which can be used in scatter and line chart.
An granted authority that stores security policies.
Provides all security policies of the current user.
Polygon feature with predefined
PolygonGeometry.Polyline geometry.
Helper class for styling polygon
Feature.Transforms
Polygon datatype into WKT (Well-known Text) representation that persists as a text and vice versa.Event is fired during authentication process to verify the status of the loaded UserDetails
after validation of the credentials takes place.
Verifies the status of the loaded UserDetails after validation of the credentials takes place.
Event is fired during authentication process to verify the status of the loaded UserDetails
before validation of the credentials takes place.
Verifies the status of the loaded UserDetails before validation of the credentials takes place.
Simple static methods to be called at the start of your own methods to verify correct arguments and state.
Base class for predefined date intervals.
Provides access to the
PredefinedDateInterval.Convenient built-in transformations for input parameter values entered by user.
Annotation must be put on a method of an interface that defines a row level role (see
RowLevelRole).This interface implementation should holding relation between name of data loader type (ex: sql)
and custom params preprocessor
if relation not set, implementation should present default params preprocessor
Deprecated, for removal: This API element is subject to removal in a future version.
Annotation for detail view controllers that sets this controller as default detail view for entities
of the specified type.
Annotation for list view controllers that sets this controller as default list view for entities
of the specified type.
Annotation for lookup view controllers that sets this controller as default lookup view for entities
of the specified type.
An event listener that publishes a Spring application event when a process is completed.
Serves as factory for getting ProcessFormContext
Helper class for
FormData methods.Classes that implement the interface are responsible for creation of start and task forms with a particular form type.
Class is responsible for injecting fields into BPM process form:
ProcessFormContext
Process variables
An event listener that publishes a Spring application event when a process is started and
sets an initiator of process into process variables if appropriate property is set.
A process starting builder used in custom process forms.
Chunk approach, optional values:
'sequential': slice data by data index.Projection definition class.
Register new projection in
GeoMap globally in application.Base interface that points that implementation of this interface is root fragment for one of bpmn element(such as Service task, User task etc)
Condition for filtering by entity property.
String constants defining comparison operations.
Explicitly defined datatype that overrides a datatype inferred from the attribute Java type.
A UI component used for filtering entities returned by the
DataLoader.Operation representing corresponding filtering condition.
Operation type representing the required field type for editing
a property value with the given operation.
Event sent when the
operation property is changed.A URL query parameters binder for
PropertyFilter components.A POJO class for storing properties of the
PropertyFilter's initial state.Provides a specific implementation of
UrlQueryParametersBinderProvider
that supports the binding of URL query parameters to PropertyFilter components.A task responsible for initializing a property filter component and binding it
to URL query parameters within the context of a
UrlQueryParametersFacet.Property mapping describes how to map a field from input data with entity property.
An object that contains info to get a result value of an entity property from the raw value
A parser for converting string representation into actual value by
PropertiesLoaderSupportAn object that stores information about the value to be set for an object property.
Property path descriptor.
Loads and resolves shortcut combinations from multiple property sources.
Provide functionality for value extraction from entity instance.
Since current version doesn't support "dead properties",
this method returns "403 Forbidden" when attempting to set any property.
This interface used for proxy wrapping
The builder is for making request to a search engine server for updating the mapping of the index.
Used to set into application properties required property '
org.quartz.jobStore.driverDelegateClass' that
used by Quartz to understand the particular ‘dialects’ of varies database systems.Serves as proxy from Jmix to the Quartz engine for fetch information about jobs and triggers and update them
Controller that is used for operations with predefined JPQL queries
Annotation to specify custom query for Jmix Query methods
Cache that contains queries and a collection of object identifiers
Interface to be implemented by JPQL constant handlers.
Allows to specify query hints for particular repository query.
The interface implementation should provides custom query preprocessing before data loading
Interface to be implemented by JPQL macro handlers.
Interface to be implemented by beans that provide values for query parameters if they are not set explicitly.
Encapsulates invocations of registered
QueryParamValueProviders.Parses JPQL query and returns some information about it.
Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated, for removal: This API element is subject to removal in a future version.
Executes SQL queries with pluggable strategies for handling
ResultSets.Interface to be implemented by beans that pre-process query text before setting it to
LoadContext.Query.Transforms JPQL query
Factory to get
QueryParser and QueryTransformer instances.Coordinate for
RadarSeries.Name options for radar indicators.
Indicator of radar chart, which is used to assign multiple variables(dimensions) in radar chart.
Radar render type.
Radar chart is mainly used to show multi-variable data, such as the analysis
of a football player's varied attributes.
Base component for radar elements.
Component to configure area filling style.
Component to configure the blur state.
Component to configure the emphasis state.
Component to configure the selection state.
Web-element wrapper for radio button group.
Radial axis of polar coordinate.
Object encapsulating common properties of
MetaProperty.Relation type for reference property
Interface for source of extracted raw values
Applies row-level policies to JPQL queries.
Defines an authorization point for modifying JPQL queries by adding JOIN and WHERE clauses.
Interface of views that support read-only mode.
Deprecated, for removal: This API element is subject to removal in a future version.
unused
Interface for views that support read-only state change tracking.
The event is dispatched when a view changes its read-only state.
Bean that encapsulates the default logic of changing views read-only mode.
MergePolicy that puts the new versions after the ones that already exist in the database.
A helper class for redirecting to a view represented by a
Location.Enables working with references to entities without loading them from the database.
A wrapper for the reference ID value returned by
ReferenceIdProvider.getReferenceId(Object, String) method.Enum describes a behavior for references during entities import: missing reference can be ignored
or an exception can be thrown.
Available policies for import of reference property: Create: the reference is always created.
Mapping for reference property that is mapped by multiple data fields from the input data.
Mapping for reference property by one lookup property that has a raw value in the input data.
Utility class to provide common functionality for entities with different type of primary keys
Loads and caches data for a fields and methods that are used for autowiring.
Utility class to simplify work with Java reflection.
Regexp validator checks that String value is matched with specified regular expression.
Immutable property class
A record stores a list resource and rol-level roles assigned to OAuth2 client.
Repository for storing and retrieving
RegisteredClientRoleAssignmentRegular shape style for vector features.
MergePolicy that throw exception if document was changed during editing on version management screen.
Class describes date interval with relative date and time moments
BaseDateInterval.Type.RELATIVE.Operation that can be available for relative date and time moments.
RelativeDateIntervalField allows users to choose relative date interval
from list of options presented in an overlay.
Provides enum values for relative date and time moments.
Responsible for converting relative date interval expressions to
BaseDateInterval objects and vice versa.Deprecated, for removal: This API element is subject to removal in a future version.
Indicates that the annotated interface is a service exposed through the generic REST API.
Interface for customizing the configuration of services available through the REST DataStore.
Service parameters: data store name and remote service name.
Class that provides fluent interface for removing entity instances.
Event sent when the remove operation is cancelled by user in the confirmation dialog.
Event sent after selected entities are removed.
Event sent before selected entities are removed.
Represents the possible operations that can be performed by
RemoveOperation.Remove builder.
An enum with predefined renderers.
Annotation for
FragmentRenderer controllers which specifies a data container that contains the
item for renderer.RendererProvider<R extends com.vaadin.flow.data.renderer.Renderer<?>>
Configuration of renderers.
Container for band definitions, if the report has several bands.
Container for input parameter definitions, if the report has several input parameters.
Container for template definitions, if the report has several templates.
Container for value format definitions, if the report has several of them.
Represents predefined scenarios of trigger execution repeating
Counterpart of
ReplaceEntity.Indicates that the entity extends and replaces some original entity.
Attention! This entity should be detached for correct work.
This interface describes main report object.
A listener for
AsResourceServerBeforeInvocationEvent that checks "reports.rest.enabled" specific policy
for /rest/reports/** requests, managed by resource server of the Authorization Server add-on.This interface describes Band abstraction.
This interface describes a logic which load rows of data using report query, parent band and params
Indicates that marked class is a report definition.
Annotation marks a delegate method that implements some logic related to the report
defined by the current class.
Class wraps ComboBox value change listener and manages its registration.
Generic interface to download report data from the system.
Shows report data in the web browser or downloads it.
Helper that provides grid exporter.
Handles reporting exceptions.
This interface describes a format for certain result field.
This interface describes logic which transform resulting values.
Contains possible filtering conditions when loading reports from
ReportRepository.This interface describes a logic which construct resulting document
This interface describes a factory which spawns formatters.
Thrown when formatter's logic fails
Indicates that marked class is a report group definition.
Contains possible filtering conditions when loading groups from
ReportGroupRepository.Filtering, pagination and sorting options when loading groups from
ReportGroupRepository.Provides unified access to both types of report groups: stored in database and defined in code.
Provides methods to import and export reports
Contains import information about created reports or updated reports
This class is entry point for reporting functionality
Use it to print reports
Base YARG exception
Thrown when report unmarshalling from xml or report validation by xsd fails
Filtering, pagination and sorting options when loading reports from
ReportRepository.This interface describes a factory which spawns data loaders.
A copy of
ReportAsResourceServerBeforeInvocationEventListener that works with OIDC add-on events.This interface describes reporting result object.
Kind of output content produced by the reporting.
This class contains list of supported output types.
This interface describes report input parameter
This interface describes logic which transform input parameters.
This interface describes certain query which load some data.
Provides unified access to both types of reports: stored in database and defined in code.
Class stores the following information required for report running:
The instance of the class may be created using the constructor or using the
Report entity
ReportTemplate entity: if not specified the default template is used
Input parameters
Type of output document
Output name pattern
The instance of the class may be created using the constructor or using the
ReportRunner bean.Interface is used for running reports
Provides fluent interface for opening script editor
Implementation detail.
Role that grants full access to working with reports.
Defines where the report or report group comes from.
Reporting configuration interface.
Role that grants minimal permissions to run reports using REST API.
Role that grants minimal permissions to run reports.
Class to serialize and deserialize reports
Template for
ReportThis interface describes report template document.
Deprecated, for removal: This API element is subject to removal in a future version.
the enum is not used.
Interface contains utility methods for working with report zip archives
Common methods for implementing data loading operations in in-memory repositories.
REST API authentication utility class
Utility class for working with
RequestMatcher required by resource server.Enum representing the strategy for evaluating required dependencies in Studio.
ResetPasswordAction<E extends org.springframework.security.core.userdetails.UserDetails>
Describes a permission to a resource.
Class holds standard values for
ResourcePolicy effect field.Non-persistent entity used to display resource policies in UI
Class stores constants for
ResourcePolicy type field values.Interface for supporting additional resource policy types (e.g.
Class is a container for security resource policies.
Indicates that annotated interface is a "Resource Role".
A data structure that stores role policies grouped by policy type and resource.
Listener is fired when
ResourceRoleEntity or ResourcePolicyEntity is changed.Non-persistent entity used to display resource roles in UI
Event is fired when a
ResourceRole has been changed.Listener invalidates resource roles repository cache when database resource role entity is modified.
Interface must be implemented by classes that provide resource roles from a particular source type.
Central infrastructure interface for loading resources.
Bean validation constraint group used by REST-API for data validation.
A listener for
AsResourceServerBeforeInvocationEvent that checks "rest.enabled" specific permission for
each REST API request, managed by resource server of Authorization Server add-on.Authentication object for authenticating through the REST DataStore
with Resource Owner Password Credentials Grant.Provides authentication for
RestDataStore.Provides information about REST capabilities for a particular REST data store.
DataStore implementation working with entities through generic REST.
Thrown when REST API cannot be accessed.
Indicates that the entity is stored using
RestDataStore and defines relevant parameters.Utility methods for tasks related to RestDataStore.
Creates
StaticLoadedPropertiesInfo instances to be used in entities loaded by REST DataStore.A Spring application event which is sent after the entity is removed from the REST data store.
A Spring application event which is sent after the entity is saved to the REST data store.
File storage implementation that complements
RestDataStore by the ability to store and load files
using the generic REST /files endpoints.Class for REST API search filter JSON parsing
The result of JSON entities filter parsing.
Possible HTTP methods for invoking services through the Generic REST API.
Class is used for loading and storing JSON transformers.
REST API authentication utility class
Exposes a service method through the Generic REST API.
A bean of this type is created in autoconfiguration if the spring-security-oauth2-client dependency is present.
A copy of
RestAsResourceServerBeforeInvocationEventListener that works with OIDC add-on events.A tool feature for restoring a chart options.
Class is used for loading and storing of predefined JPQL queries that are used by the REST API.
Class stores an information about the predefined JPQL query
Class stores an information about the predefined JPQL query parameter
Exposes a service through the Generic REST API.
Class is used for loading and storing an information about service methods that are available for REST API.
Service is used in functional tests
Service is used in functional tests to check public methods accessibility
of the bean that does not implement any interfaces.
Implementations of this interface convert ResultSets into other objects.
Common rich text styles.
Set of theme variants applicable for
JmixRichTextEditor component.User role.
Interface to be implemented by beans that store role assignments in a persistent storage.
Interface to be implemented by classes that provide
RoleAssignment.Repository of
RoleAssignmentUtility class for working with Jmix-related
GrantedAuthority.Class is used for converting
ResourceRole, RowLevelRole objects
into non-persistent ResourceRoleModel, RowLevelRoleModel entities which may be
displayed in UIInterface to be implemented by beans that store roles in a persistent storage.
Interface must be implemented by classes that provide resource/row level roles from a particular source type.
Interface for roles repository.
Different implementations of
RoleRepository delegate working with RoleProvider
to this class.Role type.
Utility bean that facilitates url modifications and generations.
Recalculates row heights depending on the cell values and fonts.
Represents row level policy in-memory predicate.
Defines a constraint that restricts data a user can read or modify.
Non-persistent entity used to display row level policies in UI
Represents row level policy in-memory predicate.
Class is a container for security row level policies.
Indicates that annotated interface is a "Row Level Role".
A data structure that stores row-level role policies grouped by entity name.
Listener is fired when
RowLevelRoleEntity or RowLevelPolicyEntity is changed.Non-persistent entity used to display roles in UI
Event is fired when a
RowLevelRole has been changed.Listener invalidates row-level roles repository cache when database row-level role entity is modified.
Interface must be implemented by classes that provide row level roles from a particular source type.
Standard action for printing reports for a list of entity instances associated with a list component.
Currently running jobs store
Describes parameters necessary for report run
Standard action for running the reports associated with current screen or list component.
Implementation of
UserSubstitutionCandidatePredicate
that allows user to be substituted by user from the same tenant only.The down-sampling strategy used when the data size is much larger than pixel size.
A tool feature for exporting a chart to an image.
Type of the exported image.
Defines collections of entities to be saved or removed, as well as parameters of saving.
Holds entities being saved by
RdbmsStore during a transaction.Object factory for SAXParser object pool.
Scatter (bubble) chart.
Base component for scatter elements.
Component to configure the blur state.
Component to configure the emphasis state.
Component to configure label guide line.
Component to configure the selection state.
Defines scheduled business day in annotated business calendar (see
BusinessCalendar).Gathers information about scheduled business days for annotated business calendar.
Service for calculating description for quartz jobs and triggers based on their data and localized messages.
This interface describes logic which evaluates groovy scripts
Scrollable legend.
The icons of page button.
Contains logic for getting fields of the given index for the request query building.
An interface for implementing common logic for the search request configuration.
A common interface for query building for the single index.
A container of the search request building information.
A result of the SearchContext processing that is set during the search request building.
This class contains methods for getting information for the search request building.
Represents result of search by some text.
Represents single entity instance found in index
Provides additional functionality to work with
SearchResultDecorates CurrentUserSecurityFacade and adds functionality that is necessary for the Search Engine.
Describes the way search context should be processed.
Deprecated, for removal: This API element is subject to removal in a future version.
Formats period in form of: {hours} h {minutes} min {seconds} sec.
Annotation that indicates that annotated element is secret.
Deprecated, for removal: This API element is subject to removal in a future version.
use
io.jmix.uiconstraints.annotation.UiComponentPolicyAction insteadCallback interface which is invoked by the action to determine its enabled state.
Action that changes its
enabled property depending on a selected item in a bound Grid.Provides methods to check permissions of the current user.
Helper class to get/set Authentication in the current
SecurityContext.Deprecated, for removal: This API element is subject to removal in a future version.
the problem solved by this class doesn't appear anymore.
This class exists solely to satisfy code completion of properties defined in
META-INF/additional-spring-configuration-metadata.jsonPredefined security scope constants for UI and REST API.
Stores information about:
data that has been filtered by row level security;
Web-element wrapper for select.
INTERNAL.
INTERNAL.
Condition for checking the selected items of multi-select components web-element wrappers
(e.g.
Condition for checking the contained selected items of multi-select components web-element wrappers
(e.g.
Condition for checking the selected items count of multi-select components web-element wrappers
(e.g.
Selected mode of legend or series, which controls whether series can be toggled displaying by clicking legends.
The event is fired when a date/time selection is made.
Represents an event that is triggered when the selection of an element changes in the BPMN modeler.
Represents an event that is triggered when the selection of an element changes in the BPMN viewer.
Interface to be implemented by UI components that support adding items selection listeners.
An injector that autowires
SelectionListener methods that are annotated by the Subscribe annotation.INTERNAL.
Web-element wrapper for select overlay.
Wrapper component for the
SelenideElement.Entity to store information about sending emails.
The separator between data and data description.
Represents sequence with name, store, start value and increment.
Provides access to the database sequences.
Interface defining methods for managing database sequences.
Helper class needed to deserialize classes with beans
Interface for enums supporting JSON serialization.
The default series type for the chart.
Controller that is used for service method invocations with the REST API
Class that executes business logic required by the
ServicesController.Meta-model entry point.
Interface to work with current session and its attributes.
Holds vaadin sessions for all users
Interface stores internal methods for
Session implementations.Deprecated, for removal: This API element is subject to removal in a future version.
Takes query parameter values from current session attributes set using
SessionData.SessionRepositoryWrapper<S extends org.springframework.session.Session>
SessionsConfiguration<S extends org.springframework.session.Session>
Stores settings for
JmixExpiringSessionMap - a default local Map implementation for
MapSessionRepository that periodically removes expired sessions.Base interface for POJO classes that describe component settings.
Provides ability to save component states when
View is closed and restore them
when it's opened again.Provides information about source component and components that should be managed by facet.
An implementation of the
SettingsFacet interface that provides functionality
for managing and applying settings related to views and their components.Provides methods for collaboration between
SettingsFacet and UrlQueryParametersFacet.Utility class for applying settings to components using the
SettingsFacet.Common style for shadow.
Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated, for removal: This API element is subject to removal in a future version.
ShortcutActionHandler<C extends com.vaadin.flow.component.Component>
Deprecated, for removal: This API element is subject to removal in a future version.
ShortcutActionsHolderBinding<H extends com.vaadin.flow.component.Component,A extends Action,C extends com.vaadin.flow.component.Component>
Deprecated, for removal: This API element is subject to removal in a future version.
ShortcutActionsHolderBindingImpl<H extends com.vaadin.flow.component.Component,A extends Action,C extends com.vaadin.flow.component.Component>
Deprecated, for removal: This API element is subject to removal in a future version.
Provides a mapping between shortcut aliases and their corresponding property values.
System role that grants permissions for the
InfoValue functionality.Standard action for displaying the report execution history.
Jmix action to show
PivotTable component.ShowRoleAssignmentsAction<E extends org.springframework.security.core.userdetails.UserDetails>
ShowUserSubstitutionsAction<E extends org.springframework.security.core.userdetails.UserDetails>
Standard action for displaying the user substitutions.
Exception that is used to interrupt an execution flow without any messages to the user.
Handles exceptions of type
SilentException by suppressing them without notifying the user.Non JPA implementation of calendar event.
Builder for creating
SimpleCalendarEvent.Data item, which contains an instance of any class.
Base class for geometries.
INTERNAL.
Represents settings for a simple pagination component, allowing configuration of pagination properties
such as identifying the settings and defining the number of items per page.
Binder class for managing the settings of
SimplePagination components.Mapping for the simple property of entity.
Describes all Misfire Instruction options available for Quartz
SimpleTrigger.Component which cannot contain other filter component but can be used for filtering entities
returned by the
DataLoader.Class for password change event for a single user (typically, as a result of manual change).
Size validator is applicable for Collections and String values.
Abstract superclass for conditions which have parameters and may be skipped in case of parameter is absent, null
or empty.
Slider type data zoom component provides functions like
data thumbnail, zoom, brush to select, drag to move, click to locate.
The style of data shadow.
Component to configure the highlighted state.
The context for generating class names for labels in time slots in timed display modes:
CalendarDisplayModes.TIME_GRID_DAY and CalendarDisplayModes.TIME_GRID_WEEK.The implementation of additional criterion for soft delete.
Generates expression to support soft delete feature in Jmix.
Modifies mapping to support soft delete feature.
Defines sorting of queries.
Sort direction.
Sort order defines a property and corresponding
Sort.Direction.Interface for sorting data in
CollectionContainers.Factory bean for sorters.
Generates the sort orders when rows are sorted by a column.
Base class for
Layer sources.Interface to be implemented by sources that should provide attributions management.
Interface to be implemented by sources that should provide attributions collapsible management.
Interface to be implemented by sources that should provide projection management.
Interface to be implemented by sources that should provide all attributes from
Source.Interface to be implemented by sources that should provide WrapX management.
Interface to be implemented by sources that support clicks on features.
An event that is fired when feature is clicked.
An event is fired when user makes double click on a feature.
An event is fired after 250 ms to ensure that it is not a double click.
Abstract class for specific conditions.
Interface for checking
Specific Conditions.Utility class for checking
Specific Conditions.An access context to check permissions on arbitrary named functionality.
Defines specific resource policy in annotated resource role (see
ResourceRole).Provides an information about specific policies defined in the application.
Class stores an information about specific security policy that may be used in the application
Split area of axis in
Grid area, not shown by default.Split line of axis in
Grid area.An injector that autowires listener methods that are annotated by the
Subscribe
annotation.SQL (and JPQL also) implementation of params preprocessor
Preprocessor searches params in sql fragment and preparing them for
data linking between query bands, that contains data for vertical and horizontal band distribution.
Loads data from database using sql
You can use aliases for output values
Example:
select login as "Login", password as "Password" from user where create_ts > ${startDate}
${startDate} is alias of the input parameter, which will be passed to the query
Utility class for working with the current stack trace.
The default AddonAuthenticationManagerSupplier supplier that provides AuthenticationManager used by basic
application.
Class returns a collection of "standard" providers that may be used in AuthenticationManagers created in different
security configurations.
A close action implementation used in the base views provided by the framework:
View,
StandardDetailView, StandardListView.Base class of entity detail views.
Event sent after saving the view data context.
Event sent before saving the view data context.
Event sent before the new entity instance is set to edited entity container.
Deprecated, for removal: This API element is subject to removal in a future version.
use
ViewSetupLockEvent instead.Event sent when the view is validated on saving the view data context.
Standard implementation of the
EntityJsonTransformer.Base class of entity list views.
Base class of main views containing
AppLayout.A possible outcome of views extending
StandardDetailView and StandardListView.Deprecated, for removal: This API element is subject to removal in a future version.
The serialization implementation using standard Java serialization and allowing beans to be restored on deserialization
Base class for tabbed mode main view.
Base class of regular views opened either inside
AppLayout or in a DialogWindow.Class that encapsulates logic of
SearchStrategy that searches documents by prefix.Class that encapsulates logic of
SearchStrategy that searches documents by prefix.Synchronizes search indexes on application startup.
Implementation of
LoadedPropertiesInfo that stores names of loaded properties.Specifies a data store name for an entity.
Defines a data store used in the application.
Describes the type of a data store.
Resolves descriptors of data stores
Utility class for accessing registered data store names.
Provides string representations of property values for entities.
Substitutes variables within a string by values.
Stroke style for vector features.
Meta description that describes action.
Meta description that describes group of actions.
Marker interface for API that used by Studio and should not:
Be part of a public API.
Used in the framework.
Description of various child components.
Description of how many times a component class can occur inside the current component.
if
StudioAvailableChildrenInfo.ConditionPolicy.AT_LEAST_ONE then the check must pass according to at least one criterion
(StudioAvailableChildrenInfo.availableTags() OR StudioAvailableChildrenInfo.availableClasses()).Description of how many times a component tag can occur inside the current component.
Meta description that describes component.
Meta description that describes available component conversions.
Meta description for attribute conversion.
Describes non-standard
@io.jmix.flowui.view.Install handlerDescribes non-standard
@io.jmix.core.common.event.Subscription handlerMeta description that describes data component
(like
collection or instance).Meta description that describes specific element for component.
Meta description that describes group of elements.
Description of excluded elements.
Meta description that describes facet.
Stub component for Studio preview use only.
See also
io.jmix.mapsflowui.component.loader.GeoMapLoaderAnnotation marks which elements should be ignored in the Studio.
Preview loader used in Studio.
Vaadin component loader for Studio view designer preview.
Describes properties that included into
<properties></properties> tag.Type of
StudioProperty.Describes
@io.jmix.flowui.view.Supply handlerAnnotation marks which interfaces (classes) should be scanned in the Studio.
Class for styling features.
Annotation for declarative event handler methods in UI controllers.
A registration object for removing an event listener added to a source.
Authentication object used by the user substitution mechanism.
Makes UI-specific preparations to user substitution and performs it using
UserSubstitutionManager
Checks if there are unsaved changes on the current view and shows dialog with options:
Discard changes (close current view, cleanups background tasks, then performs
substitution and navigates to MainView)
Cancel (invokes all cancelActions)
Represents an
OperationResult that indicates a successful operation.Functional interface for creating code completion suggestions for the
JmixCodeEditor component.A class that describes the current state of the client-side of the
JmixCodeEditor component used
to prepare suggestions.Class for single suggestion from
Suggester for JmixCodeEditor component.Service for communicating with Superset API.
The class for configuring cookie management for
HttpClient.The component for showing embedded dashboards from Superset.
Provides Superset tokens management: access token, CSRF token (if is enabled).
The class starts schedule tasks for getting/refreshing access token and CSRF token.
Annotation for declarative supply methods in UI controllers.
An interface for views supporting entity locking functionality.
An interface to be implemented by
ViewNavigator that fires SupportsAfterViewNavigationHandler.AfterViewNavigationEvent.Represents an event that is triggered after navigation to a specific view has occurred.
Defines a contract for components that support the use of a
DataProvider to manage and provide their data.Represents a contract for components or classes that support specifying a datatype.
SupportsEnterPress<C extends com.vaadin.flow.component.Component>
A component that supports Enter key handling.
SupportsEnterPress.EnterPressEvent<C extends com.vaadin.flow.component.Component>
Event when Enter shortcut is detected.
Interface to be implemented by sources that support feature dragging.
Interface to be implemented by sources that support feature modification.
Interface to be implemented by sources that support feature selection.
Represents a component capable of handling a collection of items and providing
filtering functionality based on user input.
Interface to be implemented by UI components supporting value formatting.
Interface to be implemented by components that support handling items
based on a
CollectionContainer.An interface that provides support for setting item options from a specified
EnumClass.A component that supports a callback for fetching items from a back end.
Callback interface for fetching a stream of items from a backend based on a query.
Interface for components that support managing the position of their associated label.
Enum for describing the position of label components.
Provides a contract for components that support working with a
MetaClass.An interface used in describing the responsive layouting behavior of an implementing layout.
A class used in describing the responsive layouting behavior of a component.
Specifies the position of labels relative to their associated components
in a responsive layout.
SupportsStatusChangeHandler<C extends com.vaadin.flow.component.Component>
A component that supports delegation of status changes e.g.
SupportsStatusChangeHandler.StatusContext<C extends com.vaadin.flow.component.Component>
Represents the context of a status change for a specific component.
A component that trims spaces at the beginning and at the end of the entered string.
SupportsTypedValue<C extends com.vaadin.flow.component.Component,E extends com.vaadin.flow.component.HasValue.ValueChangeEvent<P>,V,P>
Interface that defines a contract for components supporting a typed value.
Represents a value change event for components that support typed values.
Interface to be implemented by UI components, which provide an API that pretends
that the action was invoked by the user on the client side.
An interface that provides validation capabilities for components.
Interface defining a component or object that can be associated with a
ValueSource.Represents a binding mechanism that can be suspended and resumed.
Interface defining a contract for objects that support suspendable bindings.
Switch is an input field representing a binary choice, similar to
JmixCheckbox.Implementation of the
OidcUserMapper that not only maps the external user object to the persistent user
entity, but also stores the user and optionally their role assignment to the database.Provides ad-hoc authentication, i.e.
Operation with a result to be used in
SystemAuthenticator.withSystem(AuthenticatedOperation)
and SystemAuthenticator.withUser(String, AuthenticatedOperation).Indicates that annotated entity/field is low-level and should not be available for end-user in various entity/field lists.
Utility class working with the Tabbed Window Mode specifics.
Annotation for view controllers that specify parameters of a view.
Represents available properties of
Views.Interface representing a container for tabbed views, allowing
management of tabs and their associated content.
TabbedViewsContainer.SelectedChangeEvent<C extends com.vaadin.flow.component.Component & TabbedViewsContainer<C>>
An event to mark that the selected tab has changed.
TabbedViewsContainer.TabsCollectionChangeEvent<C extends com.vaadin.flow.component.Component & TabbedViewsContainer<C>>
An event that is fired every time tabs collection is changed.
Defines the type of tab change.
Base class for actions that work with
TabbedViewsContainer.Part of the table template definition.
Part of the table template definition.
Web-element wrapper for tab sheet.
Web-element wrapper for tab sheet tab.
Represents a UI component that acts as a container for
View instances and their associated
ViewBreadcrumbs.Utility class that provides the
By selectors by web-element tag names.Can be used to notify
ViewController about task completion.A user task completion builder used in custom process forms
The TaskExecutor interface provides methods for managing the lifecycle of a background task.
Implementation of the
BackgroundTaskHandler interface, which provides the functionality
to handle and manage the lifecycle of a BackgroundTask.Lifecycle object that is passed to
BackgroundTask.run(TaskLifeCycle) method to allow working thread to
interact with the execution environment.Class is used for building condition expressions for outcomes of multi-instance user tasks.
Class returns a list of sequence flow condition types.
Defines a template - element of the report structure.
Annotation marks a delegate method that implements some logic related to a template
defined in the report definition class.
Type of the engine to be used to process the contents of the text template.
Defines structure of the template with
ReportOutputType.TABLE output.API for uploading files to the temporary storage.
Encapsulates metadata about a file that is temporarily stored.
Listener to be notified about the progress of uploading file into the temporary storage.
Implementation of the
TemporaryStorage interface that provides mechanisms
for temporarily storing files.Facade for managing temporary storage operations.
Implementation of
AuthDetailsValidator - it checks if tenant of user exists.Helper for working with tenant entity.
Marked entity field will be used to store information about user tenant.
Provides the tenant id for user.
Implementation of
TenantProvider based on CurrentAuthentication.Indicates that the annotated field or class is a test component.
The main goal of this class is supporting backward navigation in UI integration tests.
The main goal of this class is supporting backward navigation in UI integration tests.
Mocked servlet context.
Mocked servlet context.
Disables atmosphere because testing server-side
View does not require
connection with client-side.Disables atmosphere because testing server-side
View does not require
connection with client-side.Mocks
HttpServletRequest.Mocks
HttpServletRequest.Indicates that the annotated class is a view wrapper for tests.
The main goal of this class is supporting backward navigation in UI integration tests.
Web-element condition for text area.
Web-element wrapper for text field.
Maps field as analyzed text
Represents a text-based item that can be included in a dropdown button component.
Common font style for text.
Text style for vector features.
Represents a user menu item that contains text and an optional icon.
Watches for the file or sub-directory changes in the given directory.
Indicates that the annotated class contains a definition for the CSS utility
classes so that Studio can suggest them.
Utility class related to theme handling.
Provides thread-local storage for session attributes.
Provides thread-local storage for Vaadin request.
Base class for sources providing images divided into a tile grid.
Layer with sources that provide pre-rendered, tiled images in grids that are organized by zoom levels for
specific resolutions.
Options for tile layer.
Base class for sources providing images divided into a tile grid.
Interface to be implemented by sources that should provide tile cacheSize management.
Interface to be implemented by sources that should provide tile opaque management.
Interface to be implemented by sources that should provide all attributes from
TileSource.Source for tile data from WMS servers.
Implementation of
Aggregation intended for aggregating Time values.TimeDatatype works with java.sql.Time but is parametrized with java.util.Date
to avoid problems with casting.Configuration properties of time-grid day display mode
CalendarDisplayModes.TIME_GRID_DAY.Configuration properties of time-grid week display mode
CalendarDisplayModes.TIME_GRID_WEEK.Web-element wrapper for time picker.
Client-side timer component that fires events at fixed intervals.
Event fired on timer tick.
Event fired on timer stop after
Timer.stop() call.Implementation of the
Timer interface.Global time source interface.
Standard implementation of
TimeSource interface.Base interface for date/time validators which contains all restrictions.
Condition for checking time value for web-element wrappers for components that supports time
(e.g.
A
Datatype that supports correct presentation with timezone.Title component, including main title and subtitle.
Font style for
Title.subtext.The mode for opening the
Title.text or Title.subtext hyperlink on the specified tab.The horizontal align of the component (including
Title.text and Title.subtext).Font style for
Title.text.The vertical align of the component (including
Title.text and Title.subtext).The class is used for converting a list of role codes specified for the client in properties file into the list of
GrantedAuthority.LogoutHandler that tries to get bearer token from the request
and removes related OAuth2Authorization from the token storage.Provides an ability to extract token value from
HttpServletRequest.Toolbox is a group of utility tools, which includes different features.
The base configuration component for each tool in
Toolbox.Tooltip component.
Tooltip order for multiple series.
Render mode for tooltip.
Test HTTP controller that acts as an echo service for distributed tracing headers.
Deprecated, for removal: This API element is subject to removal in a future version.
unused
Represents a specialized type of
DataGridItems designed to handle hierarchical data structures.A component responsible for binding and applying
TreeDataGridSettings to a TreeDataGrid.Array update strategy aware class for TreeGrid.
Annotation for event types that forces
EventHub to unsubscribe listeners for this event type after invocation.Conditions to trigger tooltip.
Implementation of generic data view for
JmixTwinColumn.Data view implementation for
JmixTwinColumn with in-memory list data.Set of theme variants applicable for
JmixTwinColumn component.Abstract typed
MethodArgumentResolver classClass checks UI access permission.
Interface that allows to read/write state of UI from background threads.
Provides
Locale from VaadinSession.getCurrent() instance that should be used if current
authentication is anonymous.Configuration properties for UI asynchronous tasks.
Represents the configuration for an executor service used for handling UI asynchronous tasks.
The class provides methods for executing asynchronous tasks from UI views.
Configuration properties for managing background tasks in the UI.
Bean validation constraint group used by UI for fields validation.
Defines UI component policy in annotated resource role.
Interface for applying UI component policies assigned to the current user to a given view.
Class is responsible for extracting
ResourcePolicy from UiComponentPolicy annotations in the
annotated resource roles.Provides the UI component resource policy type support for the resource role details view.
Utility class for handling UI component policy strings.
Configuration properties for UI components in a Jmix application.
Factory for creating UI components.
Factory to create UI components using
ComponentGenerationStrategy.Implementation of the
UiComponents interface for creating UI components.Utility class working with Jmix UI component specifics.
Class contains constants used in the UI Constraints add-on.
Configuration properties for the UI constraints add-on.
Event listener that applies UI component policies when a view is opened.
Bean validation constraint group used by UI for cross-field validation.
Deprecated, for removal: This API element is subject to removal in a future version.
use
UiCrossFieldChecks insteadUI component class that provides UI for filter's configuration save dialog.
Extends
FilterMetadataTools by providing additional utility functionality for working
with data filtering metadata in the context of UI components.Extends the
EntityAttributeContext class and provides context information
for UI-related operations on entity attributes.Checks access to entity operations based on resource policies.
Defines an authorization context specific to operations on a particular entity.
Sends application events that should be handled in the components (e.g.
Event that should be processed on UI of specific users (or all users if usernames collection is null)
Interface to be implemented by exception handlers
Class responsible for handling exceptions that occur in the UI context.
Helper that provides grid exporter.
Represents an access context for modifying configurations of generic filters in the UI.
Specific operation access context to check whether a user has permission to modify global filter configurations.
Defines an access context for modifying JPQL conditions in a generic filter UI.
An access context to check permissions to import/export entities using Data Tools views.
An access context to check permissions to import/export
MessageTemplates using
import/export actions in MessageTemplateListView.Checks access to UI menu items based on resource policies.
Defines authorization point for UI menu items.
Provides utility methods and constants to facilitate UI monitoring, including measuring and recording the
durations of various UI-related operations and lifecycle events.
Configuration properties for managing navigation-related settings in the UI module.
Configuration properties for the UI module of a Jmix application.
The event that is fired each time a web page is refreshed and the UI state
has been restored from the cached views.
Class stores the information required for report running from UI.
Interface is used for running reports from UI
An access context to check permissions for the
InfoValue functionality.Represents a specific access context for controlling the ability to view detailed exception information
in the UI.
Defines an authorization point for showing
View.The annotation is used for testing Flow UI views on JUnit.
The annotation is used for testing Flow UI views on JUnit.
Fake class.
Fake class.
Deprecated, for removal: This API element is subject to removal in a future version.
unused, use
PropagationExceptionHandler insteadInterface to be implemented by classes for managing application authentication.
Interface to be implemented by classes for managing application authentication.
DevModeServletContextListener starts node tasks using CompletableFuture.
DevModeServletContextListener starts node tasks using CompletableFuture.
Manager for calculating a special static ID attribute for testing.
Implementation of the
UiTestIdManager interface that generates unique static ID attributes
for UI components for testing purposes.Support class for calculating and setting a special static ID attribute for testing.
Utility class for generating and normalizing a UI test ID.
Class provides helper methods for testing.
Class provides helper methods for testing.
Event that is fired for UI when substitutions for a user are changed.
Deprecated, for removal: This API element is subject to removal in a future version.
Use
JmixNavigationAccessChecker instead.Deprecated, for removal: This API element is subject to removal in a future version.
Vaadin introduced new
NavigationAccessControl mechanism.Configuration properties for UI views in the application.
Central interface to provide CRUD functionality for entities.
Handles database unique constraint violations.
Allows configuring how to process a case if the entity with the same values of the particular properties already exists.
Web-element wrapper for unknown element.
Represents the result of an operation with an
UNKNOWN status.INTERNAL.
The event is fired when the current selection is cleared.
Thrown to indicate that the
SpecificCondition is not supported
for the passed SpecificConditionHandler.Thrown when user provides template file not supported by any formatter declared in formatter factory
Thrown when user choose data loader not supported in data loader factory
Defines value of PivotTable's
unusedPropertiesVertical property.Implementation of
InAppNotificationOnSavingHandler that sets tenant of notification
with the value taken from the recipient.Class provides helper methods to work with
JmixUploadI18N.The utility class that is responsible for serializing and deserializing
various data types into string representations suitable for URL parameters.
Interface to be implemented by Spring beans that should load binder for specific component from
UrlQueryParametersFacet XML description.Represents a facet that manages URL query parameters and provides
the ability to bind these parameters to UI components.
An interface to be implemented by an object that binds UI component with query parameters.
An event which is fired when a query parameters binder informs that
its internal state has been changed and it should be reflected on
URL's query parameters.
Implementation of the
UrlQueryParametersFacet interface, which manages
URL query parameters and provides the ability to bind these parameters to UI components.Base class for sources providing tiles divided into a tile grid over HTTP.
Interface to be implemented by sources that should provide URLs management.
Interface to be implemented by sources that should provide all attributes from
UrlTileSource.User
Allows resolving the current authorized
UserDetails as method argument.Extracts from given process definition XML all process variables with UserDetails type.
Instances of this class are set as authentication principal to the security context when resource server API are
accessed
Maps LDAP user to user details obtained from
UserDetailsService.This event is used to notify listeners about user invalidation: when the user has been disabled.
Base interface for user email resolver.
Indicates that an annotated class is a "userGroupListProvider".
Displays information about the current user.
REST controller that is used for getting an information about the current user
Class that is used by the
UserInfoController for getting an information
about the current userIndicates that an annotated class is a "userListProvider".
Interface provides API for some actions with users
A component that displays a user menu as a dropdown.
An abstract base class for actions that can be associated with a specific
JmixUserMenu.Represents an item that can be included in a user menu component.
This interface provides functionality for adding click listeners to user menu items.
Represents a click event triggered by a
UserMenuItem.Represents an interface for menu items that can optionally have a submenu.
Represents a submenu within a user menu.
An interface that provides a contract for loading
UserMenuItem
into a UserMenu.Delegate class for managing
UserMenuItem collection.Set of theme variants applicable for
UserMenuItem component.An action that, depending on the number of substituted users, either opens a lookup view
to select a substituted user or shows a submenu with the substituted users.
An action for switching visual themes in a user menu.
Set of theme variants applicable for
JmixUserMenu component.Non-persistent entity used to display usernames in UI
Base class for user password changed event.
Class for user password reset event.
The entity is used to display and export generated passwords on the
ResetPasswordView.Indicates that an annotated class is a "userProvider".
This event is used to notify listeners about user invalidation: when the user has been removed.
An extended
UserDetailsService defining methods specific to Jmix.Link between users and roles.
Allows to perform push-notification of user UI session.
Provides information about current active user sessions
Provides saving/loading settings using the cache.
Default implementation of the
UserSettingsCache interface, providing caching for user settings.Record for user's UI setting.
Service providing settings functionality for the current user.
Event published after user substituted and new
Authentication is set to current SecurityContext.Class stores user substitution information.
Interface to provide predicate to test the possibility to use some user as substitution based on target user.
Interface is used for getting possible substituted users and for performing the substitution operation.
Interface to be implemented by beans that store
UserSubstitutionModel in a persistent storage.Interface to be implemented by classes that provide
UserSubstitution.Event that is fired when substitutions for a user are changed.
Publishes a
UiUserSubstitutionsChangedEvent for the UI scope.An event listener that publishes a Spring application event when a user task is assigned to a user.
An event listener that publishes a Spring application event when a user task is completed.
An event listener that publishes a Spring application event when a user task is created.
Central interface for working with user task results.
CAUTION: Consider using converters obtained through
UuidMappingInfo.Updates entity mappings to add UUID support even for databases that do not support UUID datatype directly.
Provides static method to create UUIDs.
This event is published when new In-app notification is sent
or read status of existing In-app notification is changed.
Allows to notify active Vaadin sessions.
Describes validation errors.
Exception to be thrown by field validators.
Thrown when data loader met invalid input parameters
Represents a contract for exceptions or objects that are associated
with a specific UI
Component.A functional interface for validating user input or other potentially invalid data.
Specific bean for loading validators.
INTERNAL.
Condition for checking value for web-element wrappers for components that can have a value.
Represents a binding between a UI component and a
ValueSource.Condition for checking contained value for web-element wrappers for components that can have a value.
Defines a value format - element of the report structure.
Annotation marks a delegate method that implements some logic related to a value format
defined in the report definition class.
Class that defines parameters for loading values from the database via
UnconstrainedDataManager.loadValues(ValueLoadContext).Class that defines a query to be executed for loading values.
Utility class to format and parse component paths.
A component that allows the selection and editing of values, with support for custom value input.
Web-element wrapper for value picker.
A support class responsible for managing actions in a value picker component.
Base class for components that allow picking and editing of values with optional custom value support.
Represents a button component that supports integration with actions, handling of
shortcut keys, and customizable visual appearance, including an icon.
Deprecated, for removal: This API element is subject to removal in a future version.
Provides support for associating and managing an
Action with a ValuePickerButton.Data component holding a typed value.
An event that is fired when value of source is changed.
Provides instances of
ValueSource, for instance, for child components.Layer for rendering vector data (e.g.
Options for vector layer.
Source for working with features.
REST controller that is used for getting REST API version
Class that is used by
VersionController for getting REST API versionThe vertical align of the component.
Base class for UI views.
Abstract class for views.
The second (after
View.BeforeCloseEvent) event in the view closing process.The first event in the view closing process.
The second (after
View.InitEvent) event in the view opening process.The first event in the view opening process.
Internal event that is fired after
View.ReadyEvent.An event informing which query parameters the view is opened with.
The last (after
View.BeforeShowEvent) event in the view opening process.An event informs that the state of components that are bounded with the query parameters should be restored.
Implementation of the
ViewActions interface for managing actions associated
with a view in the application.Application event that encapsulates information about a view that has been closed.
Class provides a mechanism for setting/getting attributes that uses
VaadinSession as store.Class describes attributes map that corresponds to a certain view in a browser tab.
Class describes autowire context that is used to autowire dependencies in view.
A wrapper component for
JmixBreadcrumbs that manages a stack of views.Represents the information about a
View and its associated Location.Utility class working with the navigation compatibility specifics.
Provides a fluent interface for opening views.
Deprecated, for removal: This API element is subject to removal in a future version.
Provides a fluent interface to configure navigation parameters and navigate to a
View.A special injector that autowired click listener methods that are annotated by the
Subscribe annotation.Application event that is sent after the view is closed.
Annotation to map a field in a
View to a specific view element, e.g.Class stores information about UI component or action.
Interface for extracting information about UI components from a view XML descriptor.
Represents a container that can hold
views and breadcrumbs,
providing functionality to interact with and manipulate them dynamically.Indicates that the annotated class is a view controller.
Class provides information about view controller.
Configuration that performs ClassPath scanning of
ViewControllers and provides ViewControllerDefinition.Allows to sort the list of
ViewControllersConfiguration in the same order as Jmix modules containing the screens
have been sorted.Utility class providing helper methods related to view controllers.
Interface defining methods for interacting with data API elements of a
View.Implementation of the
ViewData interface.Deprecated, for removal: This API element is subject to removal in a future version.
Use
DataComponentsLoaderSupport insteadIndicates that the annotated
ViewController is linked to an XML template.An injector that autowires a fields and setters methods that are annotated by the
ViewComponent annotation.Interface for managing facets associated with a
View.Implementation of the
ViewFacets interface.Represents metadata information of a view, including the view's unique identifier,
its controller class, and an optional template path.
An injection that autowired methods that are annotated by the
Install annotation.Enum representing the lifecycle phases of a
View.Class is designed for helping navigation in UI integration tests.
The navigation processor implementation that is responsible for processing navigation
to specific views using a
ViewNavigator instance.Utility class that provides support for navigating between views.
Provides a fluent interface to configure navigation parameters and navigate to a
View.Provides a fluent interface for navigating to views.
Application event that is sent after the view is shown.
Interface to be implemented by actions that open a view.
Represents the context used for opening a view in an application.
Standard open modes of
Views.Defines view resource policy in annotated resource role.
Application event that is triggered when a view is ready.
Provides information about all registered views.
Creates UI view instances.
API to create and open views.
A class representing views of a tab.
Grants permissions to view Search Results screen
Base interface for classes that collect component settings from
View.Saves and restores settings for components.
Implementation of
ViewSettingsComponentManager that applies, saves, and manages settings for components
using ViewSettingsComponentRegistry and UserSettingsCache.Provides information for which component registered settings class.
Collects
ComponentSettingsBinder and provides information for which component registered settings class.View settings that uses JSON structure.Represents an event that occurs during the setup of a lock mechanism
for a given view.
A class responsible for creating
View instances based on view ids or view classes.Provides shortcut aliases for view-related actions.
An injector that autowires method that are annotated by the
Subscribe annotation.An injection that autowires methods that are annotated by the
Supply annotation.A tab component designed for use in a
MainTabSheet.Represents the context passed to a close delegate when a
ViewTab is closed.Represents a specific type of
UserMenuItem that is associated with an View.Provides utility methods for validating UI components and JavaBean objects, displaying validation errors,
and supporting dialog interactions in views with unsaved changes.
Callbacks holder for saving or discarding unsaved changes dialog.
Callbacks holder for discarding unsaved changes dialog.
Loads view XML descriptors.
Parses view XML taking into account 'assign' elements.
A functional interface for resolving subfields by the field information
Describes search field information for subfields generating.
Condition for checking visible items for overlay web-element wrappers (inheritors of
AbstractOverlay).Condition for checking contained visible items for overlay web-element wrappers
(inheritors of
AbstractOverlay).Condition for checking the items count for overlay web-element wrappers (inheritors of
AbstractOverlay).INTERNAL.
Component for defining visual channels that will be displayed based on data values that are in the selected range.
Type of component for visual encoding
A weak wrapper for a
Consumer that listens to CollectionContainer.CollectionChangeEvents.Utility class for web browser related functionality.
A convenience annotation that is itself annotated with
@ControllerAdvice
and @ResponseBody.Stores info about cookie is being used as a token for external document editor (MS Word) authentication
Sent after a new
WebdavDocument is persisted to database.Sent after a
WebdavDocument is locked and the WebdavLockDescriptor is already persisted.Service for working with WebdavDocument.
Sent after a
WebdavDocument is unlocked and the WebdavLockDescriptor is already removed.Service for working with document versions.
Controller for working with files as a catalogue structure.
This controller is specific for cookie method of external document editor authentication.
This controller is necessary, because MS Office make OPTIONS
queries to parent of end point URL
Component for cleaning expired locks.
Inspired by
RequestMethodsRequestConditionService for work with persistent links.
Is thrown when a document collection with the same URI already exists.
This configuration must be applied before
StandardSecurityConfigurationNeeded to mark fields in Entity.
Service for getting non-persisted links.
The links store information about the opening application/access mode/filename/document version.
The links store information about the opening application/access mode/filename/document version.
Listener intended for maintaining consistency of WebdavCredentials.
Under the hood it is
CronHoliday, used for more convenient work with weekly holidays, like "Every Sunday" or
"Every Saturday" e.g.Defines weekly holiday in annotated business calendar (see
BusinessCalendar).INTERNAL.
The event is fired when the user clicks on the week number navigation link.
Provides a fluent interface to configure and open a view in a
DialogWindow.Processes and builds
DialogWindow instances for views using a WindowBuilder.WorkArea state.Event that is fired when
WorkArea changed its state.Utility class for converting and mapping values that are used in framework components
into corresponding types used in other components or layouts.
The XAxis in cartesian(rectangular) coordinate.
Document formatter for '.xls' file types
Bounds of region [(x,y) : (x1, y1)]
Cell range at sheet
XlsxFormatter image information DTO
Provides inheritance of screen XML descriptors.
Represents an event that is triggered when the XML schema associated with the BPMN modeler changes.
Deprecated, for removal: This API element is subject to removal in a future version.
XML serialization is the legacy way of storing reports.
Source for tile data with URLs in a set XYZ format that are defined in a URL template.
The YAxis in cartesian(rectangular) coordinate.
TenantIdinstead