All Classes and Interfaces
Class
Description
Abstract class for GUI actions.
AbstractActionBindingImpl<H extends com.vaadin.flow.component.Component,A extends Action,C extends com.vaadin.flow.component.Component>
AbstractActionsHolderComponent<T extends com.vaadin.ui.AbstractComponent & com.vaadin.event.Action.ShortcutNotifier>
Base class for action holders with shortcuts support
AbstractAssignActionInitTask<C extends com.vaadin.flow.component.Component>
Base class for
ValueAxis and CategoryAxis.AbstractBox<T extends com.vaadin.ui.AbstractOrderedLayout>
Base class for charts.
Abstract base class for model classes to be serialized to JSON.
AbstractComboBoxLoader<T extends com.vaadin.flow.component.combobox.ComboBox<?>>
AbstractComponent<T extends com.vaadin.ui.Component>
AbstractComponentDelegate<C extends com.vaadin.flow.component.Component>
AbstractComponentLoader<T extends com.vaadin.flow.component.Component>
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.Contains information about metaclass, data container, loader, fetch plan.
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>
AbstractDateTimeFieldDelegate<C extends com.vaadin.flow.component.AbstractField<?,V>,T extends Comparable,V>
Abstract class for layout drop handlers
AbstractDetailsLoader<C extends com.vaadin.flow.component.details.Details>
Base class for entity aware screen facet providers.
Base class of application events sent on entity operations.
Class containing a basic functionality of standard JSON transformer.
Base class for Vaadin 8 based input components.
Class with basic functionality for processor of some field-mapping annotation.
Base class for
FieldMapper implementations.Defines the visualization of the data in following types: line, column, step line, smoothed line, olhc and
candlestick.
AbstractGridDelegate<C extends com.vaadin.flow.component.grid.Grid<E> & ListDataComponent<E> & HasActions,E,ITEMS extends DataGridItems<E>>
AbstractGridLoader<T extends com.vaadin.flow.component.grid.Grid<?> & EnhancedDataGrid<?> & HasActions>
Contains information about metaClass, data container, loader, fetch plan.
AbstractHtmlComponentLoader<T extends com.vaadin.flow.component.HtmlComponent>
AbstractHtmlContainerLoader<T extends com.vaadin.flow.component.HtmlContainer>
Simplifies join expression generation depending on mapping type.
AbstractLayoutLoader<T extends com.vaadin.flow.component.Component & com.vaadin.flow.component.orderedlayout.ThemableLayout & com.vaadin.flow.component.orderedlayout.FlexComponent>
AbstractLdapUserDetailsSynchronizationStrategy<T extends org.springframework.security.core.userdetails.UserDetails>
A basic implementation of
LdapUserDetailsSynchronizationStrategy, which provides
a general functionality for user synchronization with UserRepository.Defines the legend for the chart.
AbstractLoginFormLoader<C extends com.vaadin.flow.component.login.AbstractLogin>
Base class for actions that should open a screen.
AbstractOrderedLayout<T extends com.vaadin.ui.CssLayout>
Base class for
PropertyValueExtractor implementations.AbstractResourceView<T extends com.vaadin.ui.AbstractEmbedded>
Base class for screen facet providers.
Base class for all search strategies.
Base class for list select components.
See documentation for properties of AmSerialChart JS object.
AbstractShortcutActionBindingImpl<H extends com.vaadin.flow.component.Component,A extends Action,C extends com.vaadin.flow.component.Component>
Base class for SuggestionField components.
Base table exporter class.
Contains information about metaclass, data container, loader, fetch plan.
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.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.This event is used to notify listeners about user invalidation: when the user has been deleted or disabled.
Main class for validators.
Main class for validators.
AbstractValueComponentDelegate<C extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasValue<?,V>,T,V>
Provides the ability to store authorities on a
UserDetailsShould be implemented by the User entity to provide tenant id for current authentication.
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.
Helps to track access control restrictions of the current user.
An accordion is a component similar to a
TabSheet, but with a vertical orientation and the selected component
presented between tabs.SelectedTabChangeEvents are fired when a selected tab is changed.
Tab interface.
An annotation for
AceEditor.AceEditor wraps an Ace code editor inside a TextField-like Vaadin component.
A
Widget containing
GwtAceEditorAce marker.
What to do with the marker when the text changes.
Ace Marker type.
Ace mode defines the language used in the editor.
Ace theme defines the appearance of the editor.
The
Action interface abstracts away a function from a visual component.Event sent when the action is performed.
Interface to be implemented by actions which may adjust
their 'enabled' state according to the screen read-only mode.
Indicates that the action is executable.
Interface to be implemented by actions that have primary state.
Interface defining constraintOperationType and constraintCode options.
An action that can be used as Main TabSheet context menu item.
Interface to be implemented by actions that open a screen.
Indicates that the action can be affected by UI permissions.
Used in dialogs to assign a special visual style for a button representing the action.
ActionBinder<H extends com.vaadin.flow.component.Component>
Component supporting an action.
Factory to create actions declared as
ActionType.Factory to create actions declared as
ActionType.Base interface for actions aware dialog facets.
Immutable POJO that stores dialog action settings.
The event that is fired when
ActionsAwareDialogFacet.DialogAction.actionHandler is triggered.Used in actions that open screens (
EditAction, etc.) to initialize a screen builder.A component containing
Actions.ActionsHolderBinding<H extends com.vaadin.flow.component.Component,A extends Action,C extends com.vaadin.flow.component.Component>
ActionsHolderBindingImpl<H extends com.vaadin.flow.component.Component,A extends Action,C extends com.vaadin.flow.component.Component>
Provides a list of available actions for dashboard layout.
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.Standard action for adding an entity to the list using its lookup screen.
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.
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.
Event fired after an API controller call.
A copy of io.jmix.securityoauth2.event.AfterInvocationEvent.
Event sent to listeners added to the screen using
withAfterCloseListener() method of screen builders.Event sent to listeners added to the screen using
withAfterShowListener() method of screen builders.Defines the contract for handling of entities after they have been updated in DB.
Constructor for an object which will aggregate results per cell
(see documentation).
An enum with predefined aggregations.
Configuration of aggregations.
Custom aggregation strategy for
Table component.Describes
SearchStrategy that searches documents with fields match all input terms in any order.Describes
SearchStrategy that searches documents with at least one field matches all input terms in any order.Allows to configure Elasticsearch analysis elements.
Stages of analysis configuration fluent API
Stages of analyzer configuration fluent API
Gauge chart component.
See documentation for properties of AmAngularGauge JS object.
Helper class that used to build
BusinessCalendar from class annotated with BusinessCalendar.Provider that builds and returns business calendars from classes annotated with
BusinessCalendar.Provides functionality to process index definition interfaces marked with
JmixEntitySearchIndexRole 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.Describes
SearchStrategy that searches documents with at least one field matches at least one input term.Central class of the web application.
Event that is fired after
App initialization.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.Menu item
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.
Work area mode
Work area state
Event that is fired when work area changed its state.
Application event that is sent after selected tab changed in the main TabSheet.
Strategy interface to Resolves method parameters by delegating to a list of registered
MethodArgumentResolvers.AssignDropdownButtonActionInitTask<C extends com.vaadin.flow.component.Component & DropdownButtonComponent>
Component that fires
AttachEvent and DetachEvent events.An object describing changes in entity attributes.
INTERNAL.
Provides information about changes in entity attributes.
Class is used to display the attributes list in the
EntityAttributeResourcePolicyModelCreateView screen.Class is used to display the attributes list in the
EntityAttributeResourcePolicyModelCreate 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 contains authentication information.
Annotation for bean methods which require authentication, i.e.
A resolver that provides
Locale if current authentication does not contain it.Strategy for accessing root authentication from wrapped authentication in the current security context.
A copy of
AuthorizationServerSecurityConfiguration
that doesn't extend WebSecurityConfigurerAdapter.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 of the user with the name equal to the client id are used
Provider used when configuring HTTP web security for API endpoints (like REST, MVC controllers).
One of the field-mapping annotation.
Strategy that automatically maps properties the most common way.
Intercepts HttpRequest and signs it with provided Signer.
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().Task handler for
BackgroundTask.Dialog that indicates progress of the background task, shows progress bar and processed items' message.
Entry point to
BackgroundTask execution functionality.Creates the balloons (tooltips) of the chart, It follows the mouse cursor when you roll-over the data items.
Action that can change its enabled and visible properties depending on the user permissions and current context.
Callback interface which is invoked by the action to determine its enabled state.
ClaimsRolesMapper that can be used as super-class for your own ClaimsRolesMapper implementations.Root interface of collection loaders.
Root interface of collection loaders.
Base implementation of sorting collection containers.
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.
Used by enhancing process.
Base class for all IMAP application events, providing reference for affected
ImapMessageAbstract class implements the
OidcUserMapper and may be used for creating your own mappers.This class is the main entry point to the library.
Allows resolving the current
Locale as method argument.Validator that applies JSR 303 rules for
HasValue instance.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.
Event fired before an API call.
A copy of io.jmix.securityoauth2.event.BeforeInvocationEvent.
Defines the contract for handling of entities before they have been updated in DB.
Data binding instance.
Data binding state.
Data binding state.
ImportBeanDefinitionRegistrar for Jmix data repositories autoconfigurationPerforms checking for all requests which match with: /rest/bpm/process/**, rest/bpm/dmn/**
because they should be available only for
authenticated users with a special
BpmRestAccessContext.POLICY_NAME policy.Adapter between Flowable
BusinessCalendar and Jmix BusinessCalendar.Presents "context" variable that will be accessible during processing notification template, as example:
Represents information about parsed notification template.
Provides methods for fetching configured notification templates that can be used in BPM.
Helper class for calculating triggering date for
TimerEventDefinition
in case of using repeating intervals and non-default Flowable business calendar.A special execution listener that allows sending notification to the certain recipient when a certain activity is reached.
A special task listener that allows sending notifications to the certain recipient when a certain user task is reached.
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.
A component displaying an embedded web page.
Standard values of the attribute allow of iframe HTML element.
Standard values of the attribute referrerpolicy of iframe HTML element.
Standard values of the attribute sandbox of iframe HTML element.
Class is responsible for the brute-force protection on user authentication.
Data aware component that supports buffered write mode.
Standard action for changing attribute values for several entity instances at once.
A builder that creates a new
BulkEditorWindow 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.
Event sent when the button is clicked.
A Renderer that displays a button with a textual caption.
A container that streamlines the use and placement of the components (usually, buttons) for data management in a
components that implement
HasButtonsPanel interface.Provides data for
Downloader 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.
Calendar is used for visualizing events in a calendar using week or month view.
An event object that is fired when the user clicks backward navigation button.
An event object that is fired when the user clicks on a day number of the month.
An event object that is fired when the user clicks on an empty space in the day.
An event object that is fired when the user clicks on an event.
An event object that is fired when the user changes an event position.
An event object that is fired when the user changes an event duration.
An event object that is fired when the user clicks forward navigation button.
An event object that is fired when the user drag-marks day or time cells using mouse.
An event object that is fired when the user clicks on a week number.
Deprecated.
Deprecated.
Use
Consumer insteadMergePolicy 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.
Behaviour of UI component on Studio Screen Designer canvas.
Contains the methods to create
CanvasLayout components.Creates a layout to use in the dashboard editor.
A utility layer of
GeoMap used to display vector geometries
and draw geometries via UI.A common interface for a wrapper encapsulating a vector geometry on the canvas
and providing an API to control it.
A wrapper class encapsulating
Point on the canvas.An event that is fired after click on the point.
An event that is fired after modifying the point (as a result of drag and drop via UI).
An event that is fired after right click on the point.
A wrapper class encapsulating
Polygon on the canvas.An event that is fired after click on the polygon.
An event that is fired after modifying the polygon via UI.
An event that is fired after right click on the polygon.
A wrapper class encapsulating
LineString on the canvas.An event that is fired after click on the polyline.
An event that is fired after modifying the polyline via UI.
An event that is fired after right click on the polyline.
UI representation of
DashboardLayout model on the Dashboard component.Creates a non-editable
CanvasLayout to be added to the Dashboard component.Component shows if CapsLock key is enabled when user inputs password.
Converts
captionProperty XML attribute to item/options caption provider.Indicates that auto case conversion should be used for text input fields bound with marked entity field.
Defines case conversion for text input fields, which support this feature.
Interface to be implemented by entities which can be separated by categories and hence have several sets of
dynamic attributes.
Defines set of properties for all CategoryAxes of
StockPanel.Defines category axis in chart.
ChangePasswordAction<E extends org.springframework.security.core.userdetails.UserDetails>
Interface of views that can contain unsaved changes.
Screen that can contain unsaved changes.
An optional interface of
CloseActions used in views that may have unsaved changes on closing.An optional interface of
CloseActions used in screens that may have unsaved changes on closing.Stages of character filter configuration fluent API
Base interface for all *Chart components.
Describes axis zoom event.
Describes chart click event.
Describes chart click event.
Describes cursor period select event.
Describes cursor zoom event.
Describes graph click event.
Describes graph item click event.
Describes graph item click event.
Describes legend item click event.
Describes legend item click event.
Describes legend item hide event.
Describes legend item show event.
Describes legend marker click event.
Describes the graph roll-out event.
Describes the data item roll-out event.
Describes the graph roll-over event.
Describes the data item roll-over event.
Describes slice click event.
Describes slice pull-in event.
Describes slice pull-out event.
Describes slice click event.
Describes zoom event.
Defines set of properties for chart cursor.
Defines set of properties for chart scrollbar.
The default series type for the chart.
Used for default initialization in
ChartImpl.JmixAmchartsSceneExt#setupDefaults(AbstractChart)
A group of Checkboxes.
A renderer that represents a boolean values as a graphical check box icons.
Component that manages editable property of child components.
Since Spring Boot 2.6 circular references prohibited by default.
Mapper of claims received from the OpenID Provider into Jmix resource roles and row-level roles.
Loads classes taking into account hot-deploy feature.
A resource that is located in classpath.
A renderer for presenting simple plain-text string values as a link with call back handler.
Event that is fired when the text content of the input has been copied to the clipboard.
Marker interface for objects that describe how a
View was closed.Marker interface for objects that describe how a
Screen was closed.Describes the default ways a window was closed.
Application event which is fired when the framework closes all windows.
Is able to collapse (folding).
Type of a collection change event.
Type of a collection change event.
Container that holds a collection of entity instances.
Container that holds a collection of entity instances.
Event sent on changes in the container items collection - adding, removing, replacing elements.
Event sent on changes in the container items collection - adding, removing, replacing elements.
Standard implementation of sorting
CollectionContainers.Standard implementation of sorting
CollectionContainers.Collection formatter to be used in view descriptors and controllers.
Collection formatter to be used in screen descriptors and controllers.
Enum describes the policy of processing collection members when importing the entity with the
EntityImportPlanLoader of entity collections.
Loader of entity collections.
Event sent after successful loading of entities, merging them into
DataContext and setting to
the container.Event sent after successful loading of entities, merging them into
DataContext and setting to
the container.Event sent before loading entities.
Event sent before loading entities.
Container that holds a collection of entity instances which is a collection property of another entity.
Container that holds a collection of entity instances which is a collection property of another entity.
Standard implementation of sorting
CollectionPropertyContainers.Standard implementation of sorting
CollectionPropertyContainers.An enum with the orders in which column data is provided to the renderer.
Defines the number of editor columns in bulk editor.
A filtering dropdown single-select component.
Caption filtering context.
Common implementation of
OrderBasedEntityIdsLoader.Root of the Generic UI components hierarchy.
Component belonging to a frame
Component supporting "editable" state.
Component supporting "focusable" state.
Object having a caption.
Object having a description.
Component having an icon.
Object having an XML descriptor attached.
Component delegating work to some "wrapped" client-specific implementation.
ComponentActionBinder<C extends com.vaadin.flow.component.Component>
ComponentActionsHolderBinder<C extends com.vaadin.flow.component.Component>
ComponentActionsHolderUnbinder<C extends com.vaadin.flow.component.Component>
ComponentActionUnbinder<C extends com.vaadin.flow.component.Component>
A class that describes a component and its area, i.e.
Component which can contain other components.
Visitor used in
ComponentsHelper.walkComponents(HasComponents, ComponentFinder)Contains information for
ComponentGenerationStrategy when creating
components using UiComponentsGenerator.Contains information for
ComponentGenerationStrategy when creating
components using UiComponentsGenerator.A strategy for creating FlowUi components by
UiComponentsGenerator.A strategy for creating UI components by
UiComponentsGenerator.ComponentLoader<T extends com.vaadin.flow.component.Component>
Base interface for loaders which create components by XML definitions.
InitTasks are used to perform deferred initialization of visual components.
Init tasks are used to perform deferred initialization of visual components.
For internal use only.
A class that describes a component and its spanning.
Registers new component loader or override a UI component in the framework.
Registers a UI component in the framework.
Builds registration object that is used for adding new component loader or overriding UI components in the
framework.
Builds registration object that is used for adding or overriding UI components in the framework
A renderer for UI components.
Serves as proxy for get prototype beans via objectFactory
ComponentRootLoader<T extends com.vaadin.flow.component.Component>
INTERNAL
INTERNAL
Base interface for component settings.
Base interface for component settings registration.
Provides information for which component registered settings class.
Collects
ComponentSettingsBinder and provides information for which component registered settings class.Utility class working with GenericUI components.
ComponentShortcutActionBinder<C extends com.vaadin.flow.component.Component>
ComponentShortcutActionsHolderBinder<C extends com.vaadin.flow.component.Component>
Visitor used in
ComponentsHelper.walkComponents(HasComponents, ComponentVisitor)An Event that is fired right before the composite component instance is returned
by
UiComponents bean.Specifies a string value that is a file path to an xml descriptor
that can be used for a
CompositeComponent initialization.An implementation of
UserRepository that compose all UserRepositorys
registered in an application and delegates operations to them.CompositeComponent having a caption.CompositeComponent having a context help.CompositeComponent having a description.CompositeComponent having a HTML caption.CompositeComponent having a HTML description.CompositeComponent having an icon.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.Contains all string constants used by DragDropLayouts
Data provider which contains
CollectionContainer with items.Options based on a data container.
Specifies standard container type for emulation in Studio Screen Designer.
Defines how the client should interpret textual values.
Resolves method parameters by delegating to a list of registered in Spring context
MethodArgumentResolvers.Deprecated.
Implementations of the interface are used for wiring of fields/setters to the view controllers.
Implementations of the interface are used for wiring of fields/setters to the screen controllers.
Class describes injection context that contains view controller and options.
Class describes injection context that contains screen controller and options.
Exception that can be thrown during value conversion methods of UI components.
Exception that can be thrown during value conversion methods of UI components.
Defines a case conversion type.
See documentation for properties of AmCoordinateChart JS object.
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.Standard action for creating an entity instance using its editor screen.
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.
Crockford Base32 encoding implementation that is used to serialize UUID values.
Defines cron-based holiday in annotated business calendar (see
BusinessCalendar).Presents arbitrary holiday which can be expressed via quartz cron expression.
INTERNAL.
Class presents decorator been for add some extra behavior on report band orientation change
Encapsulates a Coordinate Reference System for v-leaflet
Coordinate reference system.
An access context to check permissions on 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.CssLayout is a layout component renders components and their captions into a same DIV element.
The CurrencyField component is intended for displaying currency values.
Defines where the currency label is located.
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.
Interface that encapsulates functionality for reloading the user returned by
CurrentAuthentication and
CurrentUserSubstitution.Interface contains a list of hints supported by
CurrentAuthentication and CurrentUserSubstitutionTakes query parameter values from the currently authenticated (or substituted) user object.
Interface is used to get the information about current user substitution
Creates a cursor for the chart which follows the mouse movements.
Note: set selectWithoutZooming for Cursor to true.
Chart that can show any chart configuration inherited from
AbstractChart.Contains UI component loaders from add-ons and project configurations.
Contains UI component loaders from add-ons and project configurations.
Registers external UI components or component loaders that should be used by the framework.
Registers external UI components that should be used by the framework.
This generation strategy is intended for generating a default field corresponding to a datatype for which other
generation strategies didn't create a field.
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.
The event that is fired when a user inputs value manually.
UI representation of
DashboardModel.The persistent dictionary of the
PersistentDashboardHelper class to create/get info about
DashboardLayout objects.Implementation of this interface can be linked to the dashboard and invoked on every
DashboardEvent.Indicates that an annotated class is a widget type.
Utillity 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.Listener to data provider item change events.
Factory bean for data API components.
Factory bean for data API components.
Interface for tracking changes in entities loaded to UI.
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 when the context detects changes in an entity, a new instance is merged or an entity is removed.
Event sent after committing changes.
Event sent after saving changes.
Event sent before committing changes.
Event sent before saving changes.
Standard implementation of
DataContext which saves data to DataManager.Standard implementation of
DataContext which commits data to DataManager.Non-public interface of
DataContext implementations that can form hierarchies
using DataContext.setParent(DataContext).Non-public interface of
DataContext implementations that can form hierarchies
using DataContext.setParent(DataContext).A grid component for displaying tabular data bound to entity type.
The root class from which all DataGrid editor event state objects shall be derived.
The root class from which all DataGrid event state objects shall be derived.
Defines the position of aggregation row.
A Renderer that displays a button with a textual caption.
A renderer that represents a boolean values as a graphical check box icons.
A renderer for presenting simple plain-text string values as a link with call back handler.
A column in the DataGrid.
An event that is fired when a column's collapsing changes.
Event provided by a column generator
An event that is fired when the columns are reordered.
An event that is fired when a column is resized.
A renderer for UI components.
Context click event fired by a
DataGrid.Class for holding information about a mouse click event.
Enumeration, specifying the content type of a Cell in a DataGrid header or footer.
A renderer for presenting date values.
An event that is fired when the DataGrid editor is closed.
class which stores information that can be used
when creating a component for a
DataGrid editor.An event that is fired before the DataGrid editor is opened.
An event that is fired after the item is updated.
An event that is fired before the item is updated.
Describes empty state link click event.
Represents a footer cell in DataGrid.
Represents a footer row in DataGrid.
A renderer has a DateTimeFormatter.
A renderer has a format string.
A renderer has a locale.
A renderer has a null representation.
Renderer has click listener.
Represents a header cell in DataGrid.
Represents a header row in DataGrid.
A renderer for presenting HTML content.
A renderer that represents
JmixIcon.A renderer for presenting images.
Click event fired by a
DataGridA renderer for presenting LocalDate values.
A renderer for presenting LocalDateTime values.
A renderer for presenting number values.
A renderer that represents a double values as a graphical progress bar.
Marker interface to indicate that the implementing class can be used as a renderer.
Click event fired by a
DataGrid.HasRendererClickListenerEnumeration, specifying the destinations that are supported when scrolling
rows or columns into view.
Event sent when the selection changes.
Describes sorting direction.
An event that is fired when a sort order is changed.
Sort order descriptor.
Base interface for DataGrid header or footer cells.
Base interface for DataGrid header and footer rows.
A renderer for presenting simple plain-text string values.
Factory that generates components for
DataGrid editor.A common interface for providing data for
DataGrid component.An event that is fired when item set is changed.
An event that is fired when item set is changed.
An event that is fired when selected item is changed.
An event that is fired when selected item is changed.
The DataGridItems that supports sorting.
The DataGridItems that supports sorting.
An event that is fired when value of item property is changed.
An event that is fired when value of item property is changed.
DataGridDataProvider delegates event handling to an implementation of this interface.Class provides access to protected functionality from
DataGrid to support
restoring UI settings when the screen contains ScreenSettingsFacet.API to import entities from the input data using specified import configuration.
Executes import for a given import configuration and
ImportedData.Describes data item change event.
Base interface for load contexts used in
DataManager.Controls triggering of data loaders and provides support for automatic linking data loaders to data containers
and visual components.
Type of the LIKE clause.
Type of the LIKE clause.
Load trigger.
Load trigger.
The root interface in the data loaders hierarchy.
The root interface in the data loaders hierarchy.
Utility class working with data loaders.
Utility class working with data loaders.
Settings binder for components which support data loading.
Same as
UnconstrainedDataManager but performs authorization of all operations by applying registered
access constraints.Holds all information about data.
Class presents factory bean for create
DataSet instance with basic filled attributesDataSetSelector is a tool for selecting data set's as main and for comparing with main data set
See documentation for properties of DataSetSelector JS object.
See documentation for properties of DataSetSelector JS object.
Defines sorting options of a data store.
Interface defining methods for CRUD operations on entities.
INTERNAL.
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.
An event that is fired when DataUnit state is changed.
An event that is fired when DataUnit state is changed.
DataViewBinding<C extends com.vaadin.flow.component.Component & com.vaadin.flow.data.provider.HasDataView<V,?,?>,V>
DataViewBindingImpl<C extends com.vaadin.flow.component.Component & com.vaadin.flow.data.provider.HasDataView<V,?,?>,V>
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>
DateDatatype works with java.sql.Date but is parameterized with
java.util.Date to avoid problems with casting.A date entry component, which displays the actual date selector or date with time.
DateFormatter formatter to be used in view descriptors and controllers.Date formatter to be used in screen descriptors and controllers.Class describes date interval with the following types:
BaseDateInterval.Type.LAST
BaseDateInterval.Type.NEXT
Interface provides methods for parsing/formating date interval values.
Date interval editor.
Utility class for date intervals.
A date entry component, which displays the actual date selector inline.
A renderer for presenting date values.
Specifies a format pattern for an entity attribute of a date/time type.
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.
Indicates whether a JPA entity is a database view.
Absolute layout with drag and drop support
Accordion with drag and drop support
CssLayout with drag and drop support
Form layout with support for drag and drop
Grid layout with drag and drop support
Contains the transferable details when dragging from a GridLayout.
Horizontal layout with drag and drop support
Horizontal layout with drag and drop support
Horizontal split panel with drag and drop support
Defines a DDL code to be generated by tooling.
Container for
Ddl annotations.Settings used by development tools to generate DDL scripts for this entity.
Tabsheet with drag and drop support
Vertical layout with drag and drop support
Vertical layout with drag and drop support
Vertical split panel with drag and drop support
DecimalMax validator checks that value must be less than or equal to the specified maximum.
DecimalMin validator checks that value must be greater than or equal to the specified minimum.
Deprecated.
Use installing instance from the controller instead.
A default drop handler for absolute layouts
A default drop handler for an accordion
Default
ClaimsRolesMapper implementation that takes OidcUser
role names and transforms roles names to resource and row-level roles using role name prefixes.Default CSS Layout drop handler
This exception handler comes into play if no other handler in the chain has handled the exception.
Default drop handler for Form layouts
A default drop handler for GridLayout
A default drop handler for horizontal layouts
A default drop handler for horizontal layouts
Defalt drop handler for horizontal split panels
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
FlowuiProperties.getMainViewId().Interface to be implemented by a bean defining the default conflict resolution policy.
The default implementation
OidcUserMapper implementation that converts OidcUser into DefaultJmixOidcUser.A default implementation of
RegisteredClientProvider that creates a single client registration and configures
it using information from the DefaultRegisteredClientProperties.Class is used for getting default policy group for the
ResourcePolicy instance.Class is used for getting default policy group for the
ResourcePolicy instance.Default drop handler for tabsheets
Default implementation of
UserEmailResolver.A default drop handler for vertical layouts
A default drop handler for vertical layouts
Default drop handler for vertical splitpanels
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.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.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.
Handles the expansion and collapsing of the detailsrow.
Interface of views that display an entity instance and can save changes made by the user.
Defines a detail view purpose: to create a new entity instance or to edit an existing one.
Provides a fluent interface to configure navigation parameters and navigate to an entity detail
View.Provides a fluent interface to configure and open a details view
in a
DialogWindow.Provides a fluent interface to configure and open a details view with
the specific class in a
DialogWindow.Class that represents information about the web browser the user is using.
Provides information about the device.
Standard action for option dialogs.
Default actions which should be used in
InputDialog.Specifies parameters of
DialogWindow.Specifies parameters of
DialogWindow if the window is opened as OpenMode.DIALOG.A possible outcome of the input dialog with the standard close actions.
Provides fluent interface for configuring and displaying dialogs.
Utility dialogs API.
Builder of background work dialog.
Represents Dialog Builders with close setting.
Base class for all Dialog Builders.
Base class for all Dialog Builders.
Represents Dialog Builders that can be dragged.
Builder of unhandled exception dialog.
Marker interface for Dialog Builders that have caption.
Represents Dialog Builders that have a text inside
Paragraph component.Marker interface for Dialog Builders that have content mode setting.
Represents Dialog Builders that have a header.
Marker interface for Dialog Builders that have html sanitizer for dialog content.
Marker interface for Dialog Builders that have message.
Represents Dialog Builders that have modal setting.
Marker interface for Dialog Builders that have modal setting.
Represents Dialog Builders that have size setting.
Marker interface for Dialog Builders that have size setting.
Represents Dialog Builders that have style setting.
Marker interface for Dialog Builders that have stylename setting.
Represents Dialog Builders that have a text inside
Paragraph component as a content.Represents Dialog Builders that have theme setting.
Marker interface for Dialog Builders that have window mode for dialog window.
Builder for dialogs with inputs.
Builder of information dialog.
Builder of dialog with option buttons.
Represents Dialog Builders that can be resized.
UI component that represents a dialog window of application.
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.Provides fluent interface for opening views in dialog windows.
org.springframework.security.web.authentication.www.DigestAuthUtils
Digits validator checks that value must be a number within accepted range.
A fully custom lightweight icon for points that uses a
<div> element instead of an image.Helper class for XML parsing.
Helper bean for XML parsing with DOM4J.
INTERNAL.
INTERNAL.
DoubleMax validator checks that value must be greater than or equal to the specified maximum.
Double validator checks that value must be greater than or equal to the specified minimum.
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.Drag caption definition: icon and caption.
Interface that provides custom
DragCaption for a child component.A Filter for disabling dragging for some components in the layout
Grab filter.
Container that has
DragGrabFilter.A panel that can be collapsed to the left hand side.
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.Defines an interface for EclipseLink cluster communication
Utility class to provide common functionality related to persistence.
Component that fires
EditableChangeNotifier.EditableChangeEvent events.Event sent when the
editable property is changed.Standard action for editing an entity instance using its editor screen.
Annotation for detail view controllers which specifies a data container that contains the edited entity.
Annotation for edit screen 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.
Interface to be implemented by beans that transform an entity after returning it from an editor screen.
Editor screen purpose: to create a new entity instance or to edit an existing one.
Editor screen builder that is not aware of concrete screen class.
Editor screen builder that knows the concrete screen class.
Interface for editor screen controllers.
Prepares and shows editor screens.
Grants permissions to add full text search condition to filter
Event triggered when new reply for message arrived
BaseImapEvent.getMessage() references to older messageShould be used to delete old emails and attachments.
Interface provides methods to load, store and update email message and attachment entities
Event triggered when message was deleted
Provides application with emailing functionality.
Email sending error.
Contains failed addresses and corresponding error messages.
Contains failed addresses and corresponding error messages.
Event triggered when any IMAP flag of message was changed,
EmailFlagChangedImapEvent.getChangedFlagsWithNewValue() specifies only modified flags with actual valuesThe EmailHeader class stores a name/value pair to represent headers.
Contains email details: list of recipients, from address, subject, body and attachments.
EmailInfo builder.
Event triggered when IMAP message was moved to different folder
Notification channel that sends notification by email.
Event triggered when IMAP message was marked by
Flags.Flag.SEEN flagAdapter to javax.mail email sending API.
That interface provides abilities of builder pattern to create filled email template
EmailTemplate.That interface provides converting email template
EmailTemplate with report parameters
to Jmix email info EmailInfo.Email validator checks that String value is email or contains multiple emails separated by a semicolon or comma.
Used for
Embeddable entities by enhancing processUpdates database mapping to support embedded parameters.
Defines additional parameters for Embedded attributes.
Marker interface to indicate that the implementing class provides no data.
Marker interface to indicate that the implementing class provides no data.
Annotation to enable data repositories.
Indicates whether to enable restoring of soft deleted entity instances.
Interface defining methods for enhancing
HierarchicalDataProvider behavior.An event that is fired when the user selects another locale.
An event that is fired when "Remember Me" becomes checked and unchecked.
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.
An access context to check permissions on 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).Interface for entity aware screen facets.
An event provider that contains entities.
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.
Standard entity picker action for clearing the field value.
A components that adds to
EntityPicker the ability to select an entity from drop-down list.A common interface for providing data for the
DataGrid component.Chart data item, which contains an instance of an entity.
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.
Provides methods to extract entities and populate their properties by values from the imported data
Fetches entities by fetch plans by accessing reference attributes.
Helps to create and configure
EntityPicker and EntityComboBox components
considering jmix.ui.component.entityFieldType and jmix.ui.component.entityFieldActions properties.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).Used by enhancing process
Event that is fired then item collection is changed.
An interface for entity JSON transformers used by the REST API
Describes editor close event.
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.
Allows to log entity lifecycle events: create, modify, delete.
Record containing changed entity attribute.
Record containing information about entity lifecycle event.
Standard action for setting an entity to the entity picker using the entity lookup screen.
Type of operation on entity.
Standard entity picker action for opening an entity instance in its editor screen.
Standard picker field action for opening an entity instance if it is a one-to-one composition.
Generic UI component designed to select and display an entity instance.
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.
EntitySuggestionField adds to EntityPicker the ability to search an entity by user input.
Interface for table data components bound to entity type.
That class is used in report wizard creator cause that wizard need info about entity attributes
A comparison function, which imposes a ordering for entity attribute values.
A comparison function, which imposes a ordering for entity attribute values.
Data component bound to property of Entity.
An event fired when related entity instance is changed.
An event fired when related entity instance is changed.
Interface to be implemented by enums that serve as entity attribute types.
Options based on an enumeration class.
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.Provides functionality for index management.
EventHub class implementing the event listening model with concrete event classes.
Event identifiers for client-server communication.
Generic Event router with lazily initialized event map.
Calculates the width of a column, based on the values within it.
Action for export table content in XLSX or XLS formats
Use this class to export
Just create an instance of
Table into Excel format
Just create an instance of
ExportAction with withExporter method.This dialog can be used by exception handlers to show an information about error.
Deprecated.
Class that holds the collection of exception handlers and delegates unhandled exception processing to them.
Deprecated.
Standard action for excluding entity instances from the list.
Annotation for method that operates on UI thread and can change shared UI state.
Standard action for displaying the report execution history.
Component container which can expand enclosing components.
Expand direction
Indicates that the annotated program element is considered usable in applications but is unstable.
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.
An access context to check permissions on entity attributes when serializing entities to/from JSON.
Encapsulates functionality for working with extended entities.
Extensions API for
Screen and ScreenFragment.Non-visual component of a
View.Non-visual component of a
Screen or ScreenFragment.Interface for Spring Beans providing non-visual components for views.
Interface for Spring Beans providing non-visual components for screens.
Factory to create UI facets.
Factory to create UI facets.
Default MergePolicy if there are no conflicts during document editing on version management screen.
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.
Builds
FetchPlans.This exception is raised when you try to get nonexistent fetch plan by entity/name.
Defines a
FetchPlan property.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 "fields" - components intended to display and edit value of a certain entity attribute.
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.
Field sorter for bulk editor window.
Data provider for FileDescriptor
REST API controller that is used for downloading files
Component for uploading files from client to server that supports multiple file selection.
Describes queue upload complete event.
A reference pointing to a file located in
FileStorage.A resource that is stored in the server file system.
Interface of a component to store and load files defined by file references.
Provides access to all registered file storage beans of the application.
A resource stored in the FileStorage.
Component for uploading files to file storage.
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
Component for uploading files from client to server.
Generic filter component.
A configuration is a set of filter components.
Event sent when the
Filter.Configuration is changed.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.
Converts between a UI filter component and model classes.
The interface is implemented by generic filter components.
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.
A flow layout arranges components in a directional flow, much like lines of text in a paragraph.
Class checks UI access permission.
Provides
Locale from VaadinSession.getCurrent() instance that should be used if current
authentication is anonymous.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.Provides rpc-methods to save and restore the current focus of the grid.
Point icon (marker) with an inner font-icon.
A multi-column form component.
Caption alignment of form child components.
Localized format strings container.
Registry for
FormatStringsMarker interface to indicate that the implementing class can be used as a formatter.
Marker interface to indicate that the implementing class can be used as a formatter.
Specific bean for loading formatters.
Specific bean for loading formatters.
Reusable part of
Window with separate UI controller.Provides shared functionality for fragment initialization from XML and programmatic creation.
Internal.
Interface defining methods for creation and displaying of reusable screen parts that have their own UI controller.
Root class of UI components having controller.
Encapsulates
ActionsHolder functionality for web frames and windows.Provides access to frame parameters and component values.
Marker interface for UI controllers.
FullTextFilter is a UI component used for filtering entities returned by the
DataLoader by
joining JPQL query results with the data returned from Elasticsearch.An editor that is displayed when a FullTextCondition is added to the
Filter component.Funnel / pyramid chart component.
See documentation for properties of AmFunnelChart JS object.
Validates that date or time in the future or present.
Validates that date or time in the future.
Gantt chart component.
See documentation for properties of AmGanttChart JS object.
Creates an arrow for
AngularGaugeChart chart, multiple can be assigned.Creates an axis for
AngularGaugeChart charts, multiple can be assigned.Creates a band for a specified value range on the
GaugeAxis.An image which can be used in
ImageLayer.UI component that displays a geographical data provided by
Layers.Represents the viewing area of the map.
An event that is fired after click on a map.
An event that is fired after dragging the map.
An event that is fired after adding a layer on a map.
An event that is fired after removing a layer from a map.
An event that is fired after changing the map's viewing area, i.e.
An event that is fired after right click on a map.
An event that is fired after changing the map's selected layer.
An event that is fired after zooming the map.
UI component that displays a geographical data provided by layers.
Indicates that a meta property marked by this annotation contains geo-specific data,
which is used while displaying an entity on a map.
Component used to find MetaProperties having
Geometry annotation
in a given MetaClass.Class representing style parameters for a geometry.
Utility class containing methods connected with JTS library.
Wrapper containing the underlying leaflet component corresponding to the geo-object.
GrapesJS block
GrapesJS plugin
The GrapesJs HTML editor component
The GrapesJs HTML editor component with applied newsletter preset
The GrapesJs HTML editor component with applied webpage preset
See documentation for properties of AmGraph JS Object.
GraphQL API controller that is used for downloading files
Defines GraphQL resource policy in annotated resource role (see
ResourceRole).A layout where the components are laid out on a grid using cell coordinates.
Defines a rectangular area of cells in a GridLayout.
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.
GroupFilter is a UI component that has a
GroupBoxLayout with a ResponsiveGridLayout
as its root element.Class contains information about current cell value and cell value of parent group columns.
Table UI component that supports grouping of rows by property values.
Object that contains information about group aggregation distribution.
Class describes information about group columns for the current row.
Interface defining method for formatting cell value of group columns.
GroupTable column.
Allows to define different styles for table cells.
Creates a horizontal/vertical guideline-/area for
SerialChartModelImpl, XYChartModelImpl and RadarChartModelImpl
charts, automatically adapts it's settings from the axes if none has been specified.An annotation shown at the Ace editor.
Listens to Ace cursor changes.
A text change event received from Ace.
Listens to Ace text changes.
Listens to Ace selection changes.
A GWT adaptation of Ace editor.
An event received from Ace.
Handles key presses.
A command returned by
GwtAceKeyboardHandler#handleKeyboard(JavaScriptObject, int, String, int, JavaScriptObject)
.
{row: int, column: int}
{start:
GwtAcePosition, end: GwtAcePosition{ range:
GwtAceRange, isBackwards: function }Object having a border.
Component having a buttons panel.
Interface to be implemented by
Components that contain other Components.An interface implemented by components that can provide a context help.
Describes context help icon click event.
Component annotated by this interface enables to configure custom error message
when conversion to specified datatype fails.
Container that has
DragCaptionProvider.Event is fired when the user presses the enter key when the text field is on focus.
Interface for UI components that support filter mode.
Describes filter modes that should be used in the field.
Object having a formatter.
Component which can contain other components.
Interface for UI components that support a textual input prompt.
Interface to be implemented by entities that are not included in static metadata, but can provide a
MetaClass
specifically for each instance.A component that is marked with this interface allows to manage caption for component item.
Interface to be implemented by containers that can be loaded by loaders.
Interface to be implemented by containers that can be loaded by loaders.
A class that implements this interface can have indentation between the outer borders and the container content.
Marks the data provider that it uses Entities.
Interface to be implemented by components that enable to configure
min-height and min-width CSS properties.Component which can contain other components and provides access "by-name" to children.
Interface to be implemented by classes that represent application user and that wrap the
OidcUser.A component that is marked with this interface allows to manage caption for options displayed
by this component.
A component that is marked with this interface allows to manage a description for option displayed
by this component.
A component that is marked with this interface allows to manage an icon for option displayed
by this component.
A component that is marked with this interface allows to manage an image for option displayed
by this component.
A component that is marked with this interface allows to manage additional style names for options displayed
by this component.
A class that implements this interface can have indentation outside the border.
Interface to be implemented by components that can display the
Pagination component.An interface implemented by components that can have a required indicator.
A class that implements this interface can have space between child components.
Interface for UI components that provide additional objects for framework as part of component API.
Interface for UI components that provide additional objects for framework as part of component API.
Component having presentations.
The implementation of additional criteria for multi tenants.
Provides user time zone information.
Interface to be implemented by a component that can have validators.
UI component having a value.
Describes value change event.
Data-aware component that supports data binding with
ValueSource.An object having a ValueSourceProvider.
Component container, which shows the subcomponents in the order of their addition (horizontally).
A layer providing a visual representation of data density across a set of geographical points.
Options for a heat map.
Interface defining methods to store and access local copy of opened screens history.
Bean that handles URL history transitions.
Gathers information about holidays for annotated business calendar.
Non-persistent entity used to display holidays of certain business calendar in UI
A client side criterion for determining the horizontal location
Provides HTML5 drops for any connector
Sets DOM and CSS attributes to UI component widgets.
Common CSS property names.
Common DOM attribute names.
A container component with freely designed layout and style.
A renderer for presenting HTML content.
Utility bean that sanitizes a sting of HTML according to the factory's policy to prevent Cross-site Scripting (XSS)
in HTML context.
Marker interface for beans that can provide
Resource by some icon path.A facade bean that is intended for resolving icon resources by the given
iconPath using
all available IconProvider beans.A bean that resolves icon sources for icon sets defined for the project.
Interface for enumerations that represent icon sets.
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.Utility class for handling Iframe components
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.
Image is used to add images to the end/start of trend lines.
The Image component is intended for displaying graphic content.
A
Image.ClickEvent is fired when the user clicks on an Image.Defines image scale mode.
A layer displaying an image over specific bounds of a map.
Custom marker's icon image.
A renderer for presenting images.
Provide operations to load IMAP message attachments
Describes result for test connection operation holding:
mailBox reference
result of operation
supported features
all folders preserving tree structure if test succeeded
An extension point for IMAP events.
Unified IMAP Flag
Standard IMAP Flags
Encapsulates IMAP folder details:
name
full name
tree structure place using children and parent
flag to determine whether this folder can contain messages
Gateway for E-mail servers communication via IMAP protocol
Provides operations for IMAP mailbox (in terms of IMAP it is server) folders (in terms of IMAP it is mailbox) retrieval Messages retrieval Messages modification
Connection details for mailbox are specified in
Provides operations for IMAP mailbox (in terms of IMAP it is server) folders (in terms of IMAP it is mailbox) retrieval Messages retrieval Messages modification
Connection details for mailbox are specified in
ImapMailBox object.Encapsulates IMAP message details:
Folder name
UID
Sender
Recipient lists (to, cc, bcc)
Subject
Body content
Receive date
IMAP metadata flags
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.
Provides
SubscribableChannel to pass and handle cluster messages for InApp notifications.This annotation marks method that provides Indexable Predicate.
Base interface for configurers of Elasticsearch analysis elements (analyzers, normalizers, etc).
Contains configurations of all user-defined analysis elements.
Contains configuration of index related to some entity
Provides functionality for enqueuing entity instances and processing queue.
Contains details about all fields
Allows to configure Elasticsearch index settings.
Base interface for configurers of Elasticsearch index settings.
Holds markers of search indexes availability.
Supports JSON serialization/deserialization for inherited classes
An access context to check permissions on CRUD operations by testing predicates.
RoleAssignmentProvider that stores role assignments in memory.A
UserSubstitutionProvider that stores UserSubstitution in memory.Contains supported input data formats
Event sent to a listener added using
withCloseListener() method of the input dialog builder.Describes result of handler that can be used with
DialogActions in the input dialog.Describes input dialog validation context.
Action can be used in
InputDialog.Describes action performed event from
InputDialogAction.Prepares and shows input dialogs.
Describes field that can be used in
InputDialog.Annotation for declarative handler methods in UI controllers.
Annotation for declarative handler methods in UI controllers.
Sets primary subject for injection to target classes.
Sets primary subject for
Install target classes.The root interface in the data containers hierarchy.
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 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.
Event sent on changing a property value of the contained entity instance.
Loader of a single entity instance.
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 after successful loading of an entity instance, merging it into
DataContext and setting to
the container.Event sent before loading an entity instance.
Event sent before loading an entity instance.
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.
Container that holds a single instance which is loaded as a property of another entity.
Indicates that the annotated program element is considered an internal implementation detail and should
not be used in application code.
Move items in ListComponent up or down.
Standard action that changes enabled property depending on selection of a bound
ListComponent.Defines what Java class is handled by the annotated datatype.
Class loader is used for building class instances from ".class" files.
A JavaScript wrapper.
The type of dependency.
An event that is fired when a method is called by a client-side JavaScript function.
Substitutes variables of a within a string by values.
Substitutes variables of a within a string by values.
Query implementation for Jmix.
CssLayout with separate action manager for shortcuts
RepositoryQuery for query methods annotated with @Query.Central Jmix data repository interface.
Auto-configuration for Jmix data repositories.Implementation of base repository methods used by application repository beans.
An event that is fired before a Grid editor is saved.
An event listener for a
Grid editor before save events.Defines the position of aggregation row.
Receives the events if the user clicks on text in a cell or the 'maxTextLength' is set for column cell.
Marker interface for generated columns which return String value.
An event is fired when the user clicks inside the table cell.
Receives the events when the user clicks on a cell.
Indicates that the annotated class is an entity and must be represented in the metadata.
Annotation to mark index definition interfaces.
Component slot with horizontal layout for caption and component
JmixFileUpload.FailedEvent event is sent when the upload is received, but the reception is interrupted for some
reason.
Receives events when the uploads are finished, but unsuccessful.
Receives events when the file extension is not included in
JmixFileUpload.getPermittedExtensions().Receives events when the file size is greater than
JmixFileUpload.getFileSizeLimit().JmixFileUpload.FinishedEvent is sent when the upload receives a file, regardless of whether the reception was
successful or failed.
Receives the events when the uploads are ready.
FailedEvent that indicates that an input stream could not be obtained.
FailedEvent that indicates that an output stream could not be obtained.
JmixFileUpload.StartedEvent event is sent when the queue upload is finished.
Interface that must be implemented by the upload receivers to provide the JmixFileUpload component an output
stream to write the uploaded data.
JmixFileUpload.StartedEvent event is sent when the upload is started to received.
Receives the events when the upload starts.
JmixFileUpload.SucceededEvent event is sent when the upload is received successfully.
Receives events when the uploads are successfully finished.
Mostly copied from
FilterBasedLdapUserSearch in order to add JmixFilterBasedLdapUserSearch.searchForUsersBySubstring(java.lang.String) method.Indicates an entity attribute that must be assigned by the framework right after creating an entity instance.
Factory that generates components for
JmixGrid editor.Default icon set.
This annotation should be used on an id attribute if the attribute has no other appropriate annotation
recognized by the framework (such as
Id).Converts
Jwt into Authentication.An implementation of an AbstractOAuth2TokenAuthenticationToken representing a Jwt Authentication.
Label widget which supports multiline strings in
ContentMode.TEXT modeExtension of the default strategy for obtaining user role information from the directory.
GrantedAuthoritiesMapper that maps authorities to
RoleGrantedAuthoritys.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.
Describes menu item that should navigate to the view.
Vaadin 7 component.
Vaadin 7 component.
Vaadin 7 component.
Represents a hex character, 0-9a-fA-F.
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>>
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.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.
Defines constants for higher and lower precedence for
Ordered or
annotated with Order beans of the Jmix modules.Ordered layout with Jmix features:
separate action manager for shortcuts
description icon support
Simple placeholder component, used only for styling or showing image
Specifies an entity attribute if
JmixEntity.annotatedPropertiesOnly() is set to true.Determines query type and creates
RepositoryQueries for Jmix data repositoriesImportBeanDefinitionRegistrar for Jmix data repositories.JmixRepositoryFactoryBean<T extends org.springframework.data.repository.Repository<S,ID>,S,ID extends Serializable>
Is used for supporting RowsCount component in compatibility module.
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 repositoryBase
RepositoryQuery class for repository queries constructed by method name.Drag source extension for
Table.Container for
JmixTagLabel.Server RPC for tag label component.
Composite component that combines
JmixTimeField and AM / PM combobox.Immutable POJO to store time in AM/PM format.
Deprecated.
Is used for TokenList from compatibility module.
Deprecated.
Deprecated.
Deprecated.
Enables property placeholders in
Widgetset annotation.Extension starts Vaadin UI before each test and configures screen packages,
main screen id, username to perform authentication.
Provides core user information.
Spring configuration that sets up a
SpringVaadinServlet.Add support for
JmixFileUpload component with XHR upload mechanism.Add ability to redirect to base application URL if we have unparsable path tail
Deprecated.
Dialog window container for
OpenMode.DIALOG windows.Interface to provide JMX control functionality for local JMX interfaces
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.
INTERNAL.
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.
Wraps a JavaScript Date object.
JavaScript function definition.
JavaScript function definition.
Used for default initialization in
ChartImpl.JmixAmchartsSceneExt#setupDefaults(AbstractChart)
Supports the conversion to json for non-persistent objects with types:
DashboardModel,
Widget, ParameterMarker interface for enums supporting JSON serialization.
Marker interface for enums supporting JSON serialization.
Action for export table content as JSON
Use this class to export
Table into JSON format.Enum for JSON transformation direction
Helper methods to convert between JTS geometry types and v-leaflet objects.
Container for a collection of
KeyValueEntity instances.Container for a collection of
KeyValueEntity instances.Loader of
KeyValueEntity collections.Loader of
KeyValueEntity collections.Event sent after successful loading of entities and setting to
the container.
Event sent after successful loading of entities and setting to
the container.
Event sent before loading entities.
Event sent before loading entities.
Container for a single
KeyValueEntity instance.Container for a single
KeyValueEntity instance.Entity that contains a variable set of attributes.
Loads a single instance of
KeyValueEntity.Loads a single instance of
KeyValueEntity.Event sent after successful loading of a KeyValueEntity instance and setting it to
the container.
Event sent after successful loading of a KeyValueEntity instance and setting it to
the container.
Event sent before loading a KeyValueEntity instance.
Event sent before loading a KeyValueEntity instance.
MetaClass for
KeyValueEntity.MetaProperty for
KeyValueEntity.Deprecated.
Creates a label on the chart which can be placed anywhere, multiple can be assigned.
Label component for showing non-editable short texts.
The last filter in the security filters chain.
Base interface for a map's layer.
Event that is fired when some changes has occurred in a layer.
Indicates the type of
Layer (including subtypes)
that LeafletLayerTranslator marked by this annotation can operate with.INTERNAL
Abstract base class for layout based transferable's.
Layout having a mouse click listener.
Event sent when a user clicks mouse inside the layout.
LayoutDragMode specifies how dragging is visualized.
Interface for layout drag sources
A class for drawing circle overlays on a map.
A circle of a fixed size with radius specified in pixels.
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.
INTERNAL:
Helper class providing methods to work with Leaflet components.
Marker interface to be implemented by all server side counterparts for
Leaflets ILayer interface.
Represents an object that contains a
LeafletLayer instance inside it.Event that is fired when some changes has occurred in a leaflet layer holder.
A facade bean intended to translate the given
Layer to LeafletLayerHolder, containing
Leaflet representation of the layer.Component that translates a
Layer of type specified in the LayerTranslator annotation
to LeafletLayerHolder, containing Leaflet representation of the layer.Editing extension for Leaflet vectors.
Extension for LMap to start drawing new vectors.
See documentation for properties of AmLegend JS Object.
Note: set textClickEnabled for Legend to true.
Note: set switchable for Legend to false.
Common settings of legends.
A heat map layer.
Transforms
LineString datatype into WKT (Well-known Text) representation that persists as a text and vice versa.HTML link component.
A button looking like hyperlink.
A component that can display tabular data.
A component that displays list of items.
Data provider in which all items are stored in
List.Defines classes of entity lifecycle listeners
Options based on a simple collection that contains entities.
Describes menu item that can contain other menu items.
Describes menu item.
Options based on a simple collection.
Standard action for printing reports for a list of entity instances associated with a list component.
Provides a fluent interface to configure navigation parameters and navigate to an entity list
View.A Marker displayed on LMap.
Class that defines parameters for loading entities from the database via
DataManager.Class that defines a query to be executed for data loading.
Marker interface for component loaders.
Marker interface for component loaders.
Utility class contains common methods to apply Spring Data repositories special query parameters on
FluentLoader.Facilitates parsing data from XML.
Facilitates parsing data from XML.
A renderer for presenting LocalDate values.
A renderer for presenting 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.
Replicates the same class in LeafletJS:
Some of the geolocation methods for Map take in an options parameter.
latlng LatLng Detected geographical location of the user.
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.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.Operation representing corresponding logical filtering condition.
Class that provides authentication via
AuthenticationManager.Class that provides authentication via
AuthenticationManager.Filter that sets up MDC (Mapped Diagnostic Context) for each http request.
Lookup screen builder that is not aware of concrete screen class.
Lookup screen builder that knows the concrete screen class.
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.
A component which can be set as lookup component for a screen.
Annotation for lookup screen controllers which specifies ID of a UI component to be used for getting a value
returned from the lookup.
Component that fires
LookupComponent.LookupSelectionChangeEvent when lookup selected items set is changed.Interface for lookup screen controllers.
Validation data context.
Prepares and shows lookup screens.
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.Provides a fluent interface to configure and open a lookup view with
the specific class in a
DialogWindow.A layer that uses OSM tiles.
Standalone Popup to be displayed on the map.
Standalone Tooltip to be displayed on the map.
This annotation marks method with manual creation of Mapping Definition
Data item, which is a set of key-value pairs.
Options based on a map that contains entities.
Options based on a map.
Contains information about indexed properties defined within index definition interface
marked with
JmixEntitySearchIndexDescribes details of mapping for entity property or group of properties.
Contains details of single mapped field.
Updates mapping properties according to requirements.
POJO to store all information needed to process entity mappings.
A marker cluster created dynamically in JS by the plugin
RPC fired on cluster click
Masked field component generic interface.
Displays a list of entities on the left and details of the currently selected instance on the right.
Event sent after commit of data context from
MasterDetailScreen.commitEditorChanges() call.Event sent before commit of data context from
MasterDetailScreen.commitEditorChanges() call.Event sent before the new entity instance is set to edited entity container.
Event sent when screen is validated from
MasterDetailScreen.validateAdditionalRules(ValidationErrors) call.Max validator checks that value must be less than or equal to the specified maximum.
Main menu builder.
Holds information about the main menu structure.
GenericUI class holding information about the main menu structure.
Main menu item descriptor.
Main menu item descriptor
Interface for runnable classes of a menu item in menu config.
Defines menu resource policy in annotated resource role.
Defines menu resource policy in annotated resource role.
Defines options of the
DataContext.merge(Object, MergeOptions) operation.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.
Interface that provides messages from a message group bound to screen controller.
Prepares and shows message dialogs.
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.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.
Ancestor of main metadata objects:
MetaClass and MetaPropertyUtility 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.Min validator checks that value must be greater than or equal to the specified minimum.
Simple enum, used for localization.
Class to store mouse event details.
Constants for mouse buttons.
Event is used to inform the assignee details fragment about the modification of the collection from the
multi-instance characteristics fragment.
Annotation for screen controllers that specifies if the screen can be opened multiple times from the main menu.
A base class for screens that create multiple database resource policies (
EntityResourcePolicyModelCreate and
EntityAttributeResourcePolicyModelCreate)List select component.
A screen that can change selection mode of lookup component.
A view that can change selection mode of its lookup component.
Helper for login screen.
An item of the tree in the "My Tasks" screen.
Marker interface for beans that manage whether some route is allowed navigate to or not.
Classes that implement this interface are intended for handling URL navigation.
Immutable object of this class represents some navigation state determined by URL fragment.
NegativeOrZero validator checks that value should be a less than or equal 0.
Negative validator checks that value should be a strictly less than 0.
Interface to be implemented by containers that work with entities that are properties of other entities.
Interface to be implemented by containers that work with entities that are properties of other entities.
Event triggered when new IMAP message arrived
Event triggered when new IMAP message thread was created
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
Dummy implementation of
DataContext used for read-only views like entity list views.Dummy implementation of
DataContext used for read-only screens like entity browsers.Empty implementation of the
DataStore interface.Stages of normalizer configuration fluent API
Raised on attempt to open an unknown screen.
Raised on attempt to open an unknown view.
NotBlank validator checks that value contains at least one non-whitespace character.
NotEmpty validator checks that value is not null and not empty.
Describes the way of notification sending.
Service that allows to get information about notification channels available in application
Prepares and shows notifications.
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.
Configures and displays popup notifications.
Notifications API.
An event that is fired when notification is closed.
A builder that configures and displays notifications.
Notification builder object.
Popup notification type.
Popup notification position.
Notification type.
UI component that shows amount of unread UI notification for current user and allows to check details of them.
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.
NotNull validator checks that value is not null.
Common placeholders interface for null values.
Used by enhancing process.
Marker interface indicating that this container is a temporary stub.
Class is used as a default value for attribute of
EntityPolicy and EntityAttributePolicy annotationsBase interface for number type validators which contains all numeric restrictions.
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.
Number formatter to be used in screen 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.
A renderer for presenting number values.
Uses oauth2 access token and cookies to search session id.
Declares bean definitions used by OAuth authorization services
Event fired after OAuth token revocation.
Event fired when token has been revoked by client before HTTP response is sent.
Configures UI endpoint protection
Configures API endpoints (REST, GraphQL, etc.) protection.
A copy of io.jmix.securityoauth2.impl.LastSecurityFilter.
Interface is responsible for transforming an instance of
OidcUser (from Spring Security) to JmixOidcUser which may be used by Jmix application.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
DeletePolicyThis bean generates OpenAPI documentation according to the 3.1 specification.
Standard launch modes of
Screens.Operation result object.
Operation result object.
Prepares and shows option dialogs.
Options object that can provide items as options for UI components.
UI component having options.
Oracle-specific implementation of
OrderBasedEntityIdsLoader.Interface to be implemented by some entities that order display can be changed in UI.
Loads data using ordering property.
Component which can contain other components and provides indexed access to children.
A tile provider for the OpenStreetMap's Standard tile layer.
Service is used in functional tests
This class is used to store task outcomes results in a process variable.
Component that makes a data binding to load data by pages.
The event that is fired when the user selects another page or clicks on navigation buttons (next, previous, etc).
Base interface for components that make a data binding to load data by pages.
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 after data refresh.
The event that is fired before refreshing the data, when the user clicks next, previous, etc.
The event that is fired before refreshing the data when the user clicks next, previous, etc.
Interface defining methods for managing data loading in
PaginationComponent component.Contains the methods to create a
PaletteButton related to DashboardLayout.Defines set of properties for all StockPanels.
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
Options that allow to show a dialog to input the report parameters or not.
Utility class for instantiation immutable
Map<String, Object>.A field that is used to enter secret text information like passwords.
Runs all existing
PasswordValidators and returns the list of validation errors.Runs all existing
PasswordValidators and returns the list of validation errors.Contains parameters of password validation.
Contains parameters of password validation.
Exception to be thrown by
PasswordValidator implementations.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.
Interface to be implemented by beans that validate password when it is created or changed for a user.
Validates that date or time in the past or present.
Validates that date or time in the past.
Displays date input fields and predefined period buttons.
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.
Describes
SearchStrategy that searches documents with at least one field matches entire phrase - all input terms in provided order.Pie / donut chart component.
See documentation for properties of AmPieChart JS object.
Helps to convert
PivotDataRow to list with separated cells and provides methods for merging cells.Exports
PivotData to XLS file.Helps to retrieve properties from
PivotTable native json.Prepares data and builds a screen with pivot table component.
Describes PivotTable cell click event.
Describes PivotTable refresh event.
Description of PivotTable configuration.
A Point with altitude as a third field.
Class representing style parameters for a point.
Transforms
Point datatype into WKT (Well-known Text) representation that persists as a text and vice versa.An granted authority that stores security policies.
Provides all security policies of the current user.
Class representing style parameters for a polygon.
Transforms
Polygon datatype into WKT (Well-known Text) representation that persists as a text and vice versa.Class representing style parameters for a polyline.
A
Button with a popup.A
Button with a popup.Opening direction for the popup.
Event sent when the visibility of the popup changes.
Defines a listener that can receive a PopupVisibilityEvent when the
visibility of the popup changes.
A component for displaying a two different views to data.
Popup position.
Event sent when the visibility of the popup changes.
Component that displays html content in a popup window on a
GeoMap at a given location.Options for a
PopupWindow.PositiveOrZero validator checks that value should be a greater than or equal to 0.
Positive validator checks that value should be a strictly greater than 0.
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
PredefinedDateIntervals.Deprecated.
The functionality of assigning predefined query parameters has been moved to
QueryParamValueProviders.Annotation must be put on a method of an interface that defines a row level role (see
RowLevelRole).Provides the ability to apply and save presentations for components.
Interface to provide ability to manage lifecycle of component presentations in the screen.
Annotation for detail view controllers that sets this controller as default detail view for entities
of the specified type.
Annotation for edit screen controllers that sets this controller as default editor screen 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 screen controllers that sets this controller as default lookup screen 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
Classes that implement the interface are responsible for creation of start and task forms with a particular form type.
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.
Progress bar is a component that visually displays the progress of some task.
Web realization of progress bar depending on vaadin
ProgressBar component.A renderer that represents a double values as a graphical progress bar.
A collection of properties of arbitrary type, for interoperability with
non-GWT JavaScript libraries.
An exception thrown by the get methods when the key is found but the
value has an unexpected type.
Specifies the behaviour of properties in group.
Defines a property group: list of dependent properties that must be used only together or mutually exclusive.
Condition for filtering by entity property.
String constants defining comparison operations.
Explicitly defined datatype that overrides a datatype inferred from the attribute Java type.
PropertyFilter is 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
ComponentGenerationStrategy used by PropertyFilter UI componentProperty 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
Property path descriptor.
Class provides predefined shortcuts that can be retrieved by alias.
Type of UI component property.
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.
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.
Interface to be implemented by JPQL macro handlers.
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.
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.
Supports functionality that allows queries from previously selected results.
Supports functionality that allows queries from previously selected results.
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.Radar / polar chart component.
See documentation for properties of AmRadarChart JS object.
A group of RadioButtons.
Object encapsulating common properties of
MetaProperty.Relation type for reference property
Base class for raster layers.
Interface for source of extracted raw values
Modifies the query depending on current security constraints.
Interface for screen controllers that support read-only mode.
Interface of views that support read-only mode.
Serializable, unmodifiable collection view for
LinkedMap.Bean that encapsulates the default logic of changing screens read-only mode.
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.
See documentation for properties of AmRectangularChart JS object.
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
Utility class to simplify work with Java reflection.
Standard action for reloading a list of entities from the database.
Regexp validator checks that String value is matched with specified regular expression.
Regexp validator checks that String value is matched with specified regular expression.
Immutable property class
Interface for providing a list of registered clients for OAuth2 authorization server.
MergePolicy that throw exception if document was changed during editing on version management screen.
Builder class creates screen for related entities.
Class describes date interval with relative date and time moments
BaseDateInterval.Type.RELATIVE.Operation that can be available for relative date and time moments.
Provides enum values for relative date and time moments.
A static resource that is served by the application.
Standard action for removing an entity instance from the list and from the database.
Class that provides fluent interface for removing entity instances.
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 when the remove operation is cancelled by user in the confirmation dialog.
Event sent after selected entities are removed.
Event sent after selected entities are removed.
Event sent before selected entities are removed.
Event sent before selected entities are removed.
Remove builder.
Remove builder.
An enum with predefined renderers.
Configuration of renderers.
Counterpart of
ReplaceEntity.Indicates that the entity extends and replaces some original entity.
Attention! This entity should be detached for correct work.
A copy of
ReportBeforeResourceServerApiInvocationEventListener that works with OIDC add-on events.Handles reporting exceptions.
Provides methods to import and export reports
Contains import information about created reports or updated reports
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
Role that grants full access to working with reports.
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
API for report wizard
Template for
ReportInterface contains utility methods for working with report zip archives
REST API authentication utility class
Interface to be implemented by a component that requires a value
ResetPasswordAction<E extends org.springframework.security.core.userdetails.UserDetails>
Resizable text area component.
Represents directions in which textArea can be resized.
Deprecated.
Marker interface to indicate that the implementing class can be used as a resource.
DataProvider for application resources
Describes a permission to a resource.
Class holds standard values for
ResourcePolicy effect field.Non-persistent entity used to display resource policies in UI
Non-persistent entity used to display resource policies in UI
Class stores constants for
ResourcePolicy type field values.Class is a container for security resource policies.
Indicates that annotated interface is a "Resource Role".
Non-persistent entity used to display resource roles in UI
Non-persistent entity used to display resource roles in UI
Interface must be implemented by classes that provide resource roles from a particular source type.
Central infrastructure interface for loading resources.
A copy of
ResourceServerConfiguration
that doesn't extend WebSecurityConfigurerAdapter.A class that implements this interface is intended for viewing different resources, e.g.
Marker interface to indicate that the implementing class supports MIME type setting.
Marker interface to indicate that the implementing class has stream settings (such as cache time, buffer size
or file name).
SourceChangeEvent is fired when a source is changed.
Converts entities to Map<String, Object> response format.
Responsive setting for chart.
A layout where the components are laid out on a grid, based on the Bootstrap's 12 columns grid system.
Represents the default behavior for how flex items are laid out along the cross axis on the current row.
Represents the default behavior for how individual flex item is laid out along the cross axis.
Breakpoint representing minimum viewport widths used in media query ranges.
Interface defining a grid column.
Class containing information about logical columns number that a column occupies.
Container type representing possible basic container styles.
Interface to provide default functionality for grid elements.
Represents the default behavior for how flex items are laid out along the main axis on the current row.
Class containing information about the number of columns by which
to move a column to the right.
Class containing information for controlling the visual order of a column.
Interface defining a grid row.
Class containing information about the number of columns in the row.
ResponsiveGridLayoutImpl.AbstractGridElementImpl<T extends JmixResponsiveGridLayout.AbstractGridElement>
Bean validation constraint group used by REST-API for data validation.
A copy of
RestBeforeInvocationEventListener that works with OIDC add-on events.Class for REST API search filter JSON parsing
The result of JSON entities filter parsing.
Class is used for loading and storing JSON transformers.
REST API authentication utility class
Implementation of the LEditableMap that preserves the drawing mode when returning
from another window (for example, opened in breadcrumbs).
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
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.
A simple RichTextArea to edit HTML format text.
User role.
Interface to be implemented by classes that provide
RoleAssignment.Repository of
RoleAssignmentClass is used for converting
ResourceRole, RowLevelRole objects
into non-persistent ResourceRoleModel, RowLevelRoleModel entities which may be
displayed in UIClass is used for converting
ResourceRole, RowLevelRole objects
into non-persistent ResourceRoleModel, RowLevelRoleModel entities which may be
displayed in UIInterface must be implemented by classes that provide resource/row level roles from a particular source type.
Role type.
UI component that represents a top level window of application.
Registers an annotated class as corresponding to some route.
Utility bean that facilitates url modifications and generations.
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
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".
Non-persistent entity used to display roles in UI
Non-persistent entity used to display roles in UI
Interface must be implemented by classes that provide row level roles from a particular source type.
An enum with the orders in which row data is provided to the renderer.
Responsive rule for chart.
Standard action for running the reports associated with current screen or list component.
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.
Defines scheduled business day in annotated business calendar (see
BusinessCalendar).Gathers information about scheduled business days for annotated business calendar.
Base class for all screen controllers.
Event sent after the screen is closed by its
Screen.close(CloseAction) method and after Screen.AfterDetachEvent.Event sent after the screen is removed from the application UI when it is closed by the user or when the user logs out.
Event sent when the screen controller and all its declaratively defined components are created, dependency
injection is completed, and all components have completed their internal initialization procedures.
Event sent right after the screen is shown, i.e.
Event sent right before the screen is closed by its
Screen.close(CloseAction) method.Event sent right before the screen is shown, i.e.
Event sent when the screen controller and all its declaratively defined components are created, and dependency
injection is completed.
Screen builder that is not aware of concrete screen class.
Screen builder that knows the concrete screen class.
Application event that is sent after the screen is closed,
i.e.
Interface defining methods for interacting with data API elements of a screen.
A class that facilitates adding dependencies such as
CSS, JavaScript, HTML to the current page for screens and fragments.
Prepares and shows screens.
Base class for all fragment controllers.
Event sent when the fragment controller is created, dependency injection is completed, and all components
have completed their internal initialization procedures.
Event sent when the fragment controller is initialized and added to host screen.
Event sent when the fragment controller has been removed from host screen.
Event sent when the fragment controller is created and dependency injection is completed.
A facade bean that is intended for screen navigation using all available
NavigationHandler beans.Application event that is sent after the screen is shown,
i.e.
Marker interface for objects that can be passed as screen parameters to a
Screen.Defines screen resource policy in annotated resource role.
Interface defining methods for creation and displaying of UI screens.
Provides information about opened screens, does not store state.
Represents single tab / window stack in
AppWorkArea.Base interface for screen settings container.
Provides ability to save and apply component settings.
Provides information about source component and its child components.
Class that manages the right order of working
ScreenSettingsFacet and PresentationsFacet.Interface for
Screen.AfterShowEvent handler.Interface for post
Screen.AfterShowEvent handler.Screen settings that use JSON structure for stored settings.
Provides functionality for applying and saving component settings.
Content of each tab of AppWorkArea TabSheet.
Helper bean for working with UI screens.
Callbacks holder for save changes dialog.
Callbacks holder for unsaved changes dialog.
Loads screen XML descriptors.
Parses screen XML taking into account 'assign' elements.
Creates a scrollbar for
SerialChartModelImpl and XYChartModelImpl charts.Component container that shows scrollbars if its content does not fit the viewport.
UI component that performs full text search
Represents result of search by some text.
Represents single entity instance found in index
Provides additional functionality to work with
SearchResultDescribes the way search context should be processed.
Formats period in form of: {hours} h {minutes} min {seconds} sec.
Annotation that indicates that annotated element is secret.
Indicates that the action can be affected by UI permissions.
An
ActionsHolder component that loads and controls permissions on owned actions.Callback 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 ListComponent.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.Predefined security scope constants for Backoffice UI and REST/GraphQL API.
Stores information about:
data that has been filtered by row level security;
Base interface for list components.
The event sent when the user double-clicks mouse on a list item.
Entity to store information about sending emails.
Represents sequence with name, store, start value and increment.
Provides access to the database sequences.
Interface defining methods for managing database sequences.
Serial chart component.
See documentation for properties of AmSerialChart JS object.
Helper class needed to deserialize classes with beans
Base interface for
SerialChart and GanttChart.Describes clickItem event on categories in the CategoryAxis.
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.
Event that is fired on heartbeat requests from a client web browser.
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>
A token enhancer that provides session info details
See documentation for properties of AmCharts JS Object.
Utility class for working with component settings.
Wrapper for
ComponentSettings.Adds Iframe shimming support for layout components.
The ShortcutAction is triggered when the user presses a given key combination.
ShortcutActionHandler<C extends com.vaadin.flow.component.Component>
Keeps track of the ShortcutListeners added to component, and manages the painting and handling as well.
ShortcutActionsHolderBinding<H extends com.vaadin.flow.component.Component,A extends Action,C extends com.vaadin.flow.component.Component>
ShortcutActionsHolderBindingImpl<H extends com.vaadin.flow.component.Component,A extends Action,C extends com.vaadin.flow.component.Component>
Convenient ShortcutListener subclass that accepts lambda handler.
Component having a shortcut listener.
Handles active shortcuts for actions holder (Table or Tree)
Describes shortcut triggered event.
System role that grants permissions for the entity info functionality.
System role that grants permissions for the entity info functionality.
Gets items from
ListComponent and shows them in new screen with pivot table component.Provides two modes for exporting rows from component.
ShowRoleAssignmentsAction<E extends org.springframework.security.core.userdetails.UserDetails>
Side menu component that shows items as collapsible multi level list.
Event that is fired when menu item is selected (screen will be opened).
Menu item
Side menu builder.
Exception that is used to interrupt an execution flow without any messages to the user.
Data item, which contains an instance of any class.
Component that makes a data binding to load data by pages.
Mapping for the simple property of entity.
Describes after value clear event.
Describes before value clear event.
Describes file upload succeeded event when the uploads are successfully finished.
Component which cannot contain other filter component but can be used for filtering entities
returned by the
DataLoader.List select component.
Class for password change event for a single user (typically, as a result of manual change).
An object that describes the size.
Size validator is applicable for Collections and String values.
Size validator is applicable for Collections and String values.
A class for representing a value-unit pair.
Base interface for
PieChart and FunnelChart.See documentation for properties of AmSlicedChart JS object.
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.Interface for sorting data in
CollectionContainers.Factory bean for sorters.
Factory bean for sorters.
Text area component with source code highlighting support.
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
A split panel contains two components and lays them vertically or horizontally.
Specifies SplitPanel docking direction.
Event that indicates a change in SplitPanel's splitter position.
Component that stores a list of custom graphQL operation names.
Utility class for working with the current stack trace.
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.A close action implementation used in the base screens provided by the framework:
Screen,
StandardEditor, StandardLookup.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.
Event sent when the view is validated on saving the view data context.
Base class for editor screens.
Event sent after commit of data context from
StandardEditor.commitChanges() call.Event sent before commit of data context from
StandardEditor.commitChanges() call.Event sent before the new entity instance is set to edited entity container.
Event sent when screen is validated from
StandardEditor.validateAdditionalRules(ValidationErrors) call.Standard implementation of the
EntityJsonTransformer.Base class of entity list views.
Base class for lookup screens.
Base class of main views containing
AppLayout.A possible outcome of views extending
StandardDetailView and StandardListView.A possible outcome of screens extending
StandardEditor and StandardLookup.The serialization implementation using standard Java serialization and allowing beans to be restored on deserialization
Base class of regular views opened either inside
AppLayout or in a DialogWindow.Synchronizes search indexes on application startup.
Stock chart component.
Describes dataset selector event.
Describes StockEvent event.
Describes stock graph event.
Describes stock graph item event.
Describes dataset selector compare event.
Describes dataset selector select event.
Describes dataset selector uncompare event.
Describes period selector change event.
Describes stock chart click event.
Describes stock chart right click event.
Describes StockEvent click event.
Describes StockEvent roll-out event.
Describes StockEvent roll-over event.
Describes stock graph click event.
Describes stock graph item click event.
Describes stock graph item click event.
Describes stock graph item roll-out event.
Describes stock graph item roll-over event.
Describes stock graph roll-out event.
Describes stock graph roll over event.
Describes zoom event.
See documentation for properties of AmStockChart JS object.
StockEvent is object which holds information about event (bullet).
Defines set of properties for all StockEvents.
StockGraph displays graphs on
StockPanel.StockLegend is a legend of
StockPanel.Creates stock panels (charts).
Specifies a data store name for an entity.
Defines a data store used in the application.
Describes the type of a data store.
Utility class for accessing registered data store names.
A resource provided as an
InputStream.Substitutes variables within a string by values.
Substitutes variables within a string by values.
Indicates that the annotated interface should be available in Studio Screen Designer as an action.
Indicates that the annotated method should be shown in Studio Screen Designer
as a nested group of elements of UI component, e.g.
Indicates that the annotated UI component interface should be available in Studio Screen Designer.
Indicates that the annotated interface should be available in Studio Screen Designer as a part of UI Component,
e.g.
Indicates that the annotated method should be shown in Studio Screen Designer
as a nested group of elements of UI component, e.g.
Indicates that the annotated method parameter class provides metadata for Component Inspector of Screen Designer
for the UI component or Facet containing annotated method.
Indicates that the annotated interface should be available in Studio Screen Designer as a non-visual component.
Defines additional XML properties and property groups of a UI component.
Indicates that the annotated method should be shown in Studio Screen Designer as UI component property.
Indicates that the annotated method should be shown in Studio Screen Designer as UI component property.
Type of
StudioProperty.Annotation for declarative event handler methods in UI controllers.
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 screens that have unsaved changes and shows dialog window with options:
Discard changes (and close all windows, cleanups background tasks, then performs
substitution and recreates main window)
Cancel (invokes all cancelActions)
Class for single suggestion for an
AutoCompleteSupport field.A single suggestion.
Extends
AceEditor with suggestion possibility.A filtering dropdown single-select.
Base interface for SuggestionField components.
Event is fired when user pressed ARROW_DOWN key without search action.
Extended version of
SuggestionFieldComponent.SearchExecutor that allows to pass parameters.Custom suggestions search action interface.
Interface to be implemented by a component that supports different caption positions.
Caption position of the component.
Utility interface for components that show only selected child.
Interface to be implemented by a component that supports different values of the number of columns
that will be displayed in one row.
Component container which supports expand ratio of components
SupportsTypedValue<C extends com.vaadin.flow.component.Component,E extends com.vaadin.flow.component.HasValue.ValueChangeEvent<P>,V,P>
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.
Table UI component bound to entity type.
Object that contains information about aggregation distribution.
Allows to handle a group or total aggregation value changes.
The location of the aggregation row.
Table column.
An event is fired when the user clicks inside the table cell that belongs to the current column.
Column alignment.
Event sent every time column collapse state changes.
Allows rendering of an arbitrary
Component inside a table cell.An event that is fired when a columns are reordered by the user.
Describes empty state link click event.
Special component for generated columns which will be rendered as simple text cell.
Deprecated.
Use export action APIs instead.
Deprecated.
Use export action APIs instead.
Row header mode.
Event sent when the selection changes.
Describes sorting direction.
Object that contains information about column sorting.
Allows to define different styles for table cells.
Special aggregation row for
JmixScrollTableWidget and
JmixTreeTableWidgetDeprecated.
To use only for compatibility v7.Table
Table exporter interface.
Describes a context for a column value provider.
A common interface for providing data for
Table component.An event that is fired when item set is changed.
Ordered table items.
An event that is fired when selected item is changed.
Sortable table items.
An event that is fired when value of item property is changed.
Base interface for Presentation entity.
Provide the workflow with presentations (visual settings of a component).
TabSheet component interface.
SelectedTabChangeEvents are fired when a selected tab is changed.
Tab interface.
Handler that overrides the default behavior if
TabSheet.Tab.isClosable() is true and a user clicks the close
button.Tab window UI component.
The field that search and shows selected values as separated tags right in the field.
Enables to handle a user's entered text and add it to a TagField value.
Describes tag click event.
Lookup action for setting entities to the tag picker using the entity lookup screen.
The field that shows selected values as separated closable tags which are placed near to the field.
Describes tag click event.
The interface that marks implementation as
TagPicker's action.Defines position of tags relative to the field.
Can be used to notify
UiController about task completion.A user task completion builder used in custom process forms
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.
WatchDog for
BackgroundWorker.API for uploading files to the temporary storage.
Listener to be notified about the progress of uploading file into the temporary storage.
Helper for working with tenant entity.
Marked entity field will be used to store information about user tenant.
Deprecated.
Provides the current tenant id.
Implementation of
TenantProvider based on CurrentAuthentication.A text field that supports multi line editing.
A component for editing textual data that fits on a single line.
Maps field as analyzed text
Defines case conversion for text input fields,
which implement
TextInputField.CaseConversionSupported interface.EnterPressEvents are fired when the user presses Enter while editing the text content of a field.
TextChangeEvents are fired at the same time when
HasValue.ValueChangeEvents are fired.Different modes how the TextField can trigger
TextInputField.TextChangeEvents.An interface for UI components that provide additional methods for text change handling.
A renderer for presenting simple plain-text string values.
Theme defaults for application UI, components and screens.
A resource located in the current UI theme.
A class representing raster layer based on tiles.
Interface intended to provide reusable settings for a tile layer.
TimeDatatype works with java.sql.Time but is parametrized with java.util.Date
to avoid problems with casting.A time entry component, which displays the actual time.
Defines component time mode (12h AP/PM or 24h).
Client-side timer component that fires events at fixed intervals.
Event fired on timer tick.
Event fired on timer stop after
Timer.stop() call.Global time source interface.
Standard implementation of
TimeSource interface.Base interface for date/time validators which contains all restrictions.
Base interface for date/time validators which contains all restrictions.
A
Datatype that supports correct presentation with timezone.Convenience bean providing some methods for working with time zones.
Creates a title on above the chart, multiple can be assigned.
REST controller that is used for token revocation
Stages of token filter configuration fluent API
Stages of tokenizer configuration fluent API
Bean that is used for access token revocation
Options for a tooltip.
Diff kinda classes to be used internally by the ace editor component,
for transporting between client and server, etc.
Classes to be used internally by the ace editor component,
for transporting between client and server, etc.
A component is intended to display hierarchical structures represented by entities referencing themselves.
An event that is fired when an item is collapsed.
An event that is fired when an item is expanded.
Event sent when the selection changes.
A DataGrid component for displaying hierarchical tabular data.
An event that is fired when an item is collapsed.
An event that is fired when an item is expanded.
A common interface for providing data for the
TreeDataGrid component.An event that is fired when TreeItems item set is changed.
An event that is fired when TreeItems selected item is changed.
An event that is fired when TreeItems value is changed.
A common interface for providing data for
TreeTable component.Creates a trendline for
SerialChartModelImpl and XYChartModelImpl charts which indicates the trend of your data or
covers some different purposes.Annotation for event types that forces
EventHub to unsubscribe listeners for this event type after invocation.A component with two lists: left list for available options, right list for selected values.
Abstract typed
MethodArgumentResolver classInterface that allows to read/write state of UI from background threads.
Bean validation constraint group used by UI for fields validation.
Factory for creating UI components.
Factory to create UI components in client independent manner.
Factory to create UI components using
ComponentGenerationStrategy.Factory to create UI components using
ComponentGenerationStrategy.Indicates that the annotated class is a screen or fragment controller.
Class collects controller dependency injectors and applies them to the screen controller.
Class provides information about screen controller.
Immutable POJO that stores name, value and type of property that will be injected
into UI controller.
Type defines what should be passed to controller property:
some value (String, boolean, etc) or a reference to an object.
Configuration that performs ClassPath scanning of
UiControllers and provides UiControllerDefinition.Class sorts the list of
UiControllersConfiguration in the same order as Jmix modules containing the screens
have been sorted.Internal methods used in Screens and Fragments implementations.
Bean validation constraint group used by UI for cross-field validation.
Bean validation constraint group used by UI for cross-field validation.
Indicates that the annotated
UiController is linked to an XML template.Sends application events that should be handled in the components (e.g.
Interface to be implemented by exception handlers
Interface to be implemented by UI exception handlers defined.
Exception handling context that provides UI infrastructure.
Logger class for UI performance monitoring.
State of subcomponents can be managed by UI permissions.
State of subcomponents can be managed by UI permissions.
Stores id of subcomponent and UI permission value which will be applied to this subcomponent
or ids of subcomponent and its action and UI permission value which will be applied to subcomponent's action.
Possible values of UI permission
Event that is fired on each web page refresh.
Class stores the information required for report running from UI.
Interface is used for running reports from UI
Record for user setting.
Provides saving/loading settings using the cache.
User settings provider.
A screen presentation settings.
The annotation is used for testing Jmix screens on JUnit.
Theme configuration properties class.
Event that is fired for UI when substitutions for a user are changed.
Central interface to provide CRUD functionality for entities.
Key generator that uses random UUID for authentication keys.
Handles database unique constraint violations.
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.
Defines value of PivotTable's
unusedPropertiesVertical property.Drop zone descriptor.
Describes file upload error event.
Base class for UploadField events.
Describes file upload finish event.
Describes file upload start event.
Defines how URL changes should be handled.
This class is intended for serializing entity ids to be used as URL param.
Event sent when browser URL parameters corresponding to opened screen are changed.
A resource that can be loaded from an arbitrary URL.
Interface defining methods for reflecting app state to URL based on currently opened screen.
Provides API to generate routes for screens with optional URL parameters.
Helper for working with URL.
User
A component that combines link to Login screen and authenticated user menu.
To log user actions such as opening of window, closing of window, click on button, select menu item and other.
Allows resolving the current authorized
UserDetails as method argument.Listener that handles different sources of user changes, e.g.
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".
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
Non-persistent entity used to display usernames in UI
Base class for user password changed event.
Class for user password reset event.
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
Service providing current user settings functionality:
an application can save/load some "setting" (plain or XML string) for current user.
Utility bean for work with user settings on web client tier.
Event published after user substituted and new
Authentication is set to current SecurityContext.Class stores user substitution information.
Interface is used for getting possible substituted users and for performing the substitution operation.
Interface to be implemented by classes that provide
UserSubstitution.Event that is fired when substitutions for a user are changed.
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.
Deprecated.
Updates entity mappings to add UUID support even for databases that do not support UUID datatype directly.
Provides static method to create UUIDs.
Configuration properties for Vaadin Spring Boot.
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.
A component which can be validated
Describes validation errors.
Encapsulates errors found during components validation.
Exception to be thrown by field validators.
Exception to be thrown by field validators.
Marker interface to indicate that the implementing class can be used as a validator.
Marker interface to indicate that the implementing class can be used as a validator.
Specific bean for loading validators.
Specific bean for loading validators.
Defines set of properties for all
ValueAxis.Create an axis for
SerialChartModelImpl, RadarChartModelImpl, XYChartModelImpl, charts, multiple can be assigned.Object that holds data binding information for
HasValue UI component.Standard value picker action for clearing the field value.
Exception that can be thrown during value conversion in
Datatype.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.
Utility class to format and parse component paths.
Generic UI component designed to select and display a value of any type.
The event that is fired when a user inputs value manually.
Interface to be implemented by actions intended to be used by ValuePicker.
Data component holding a typed value.
Data component holding a typed value.
An event that is fired when value of source is changed.
An event that is fired when value of source is changed.
Provides instances of
ValueSource, for instance, for child components.Standard values picker action for selection the field value.
Component container, which shows the subcomponents in the order of their addition (vertically).
Client side implementation for
DDAbsoluteLayoutVDDAbstractDropHandler<W extends com.google.gwt.user.client.ui.Widget>
VDDAbstractOrderedLayoutDropHandler<W extends com.vaadin.client.ui.orderedlayout.VAbstractOrderedLayout>
Client side implementation for
DDAccordionClient side implementation for
DDCssLayoutClient side implementation for
DDFormLayoutClient side implementation for
DDGridLayoutClient side implementation for
DDHorizontalLayoutClient side implementation for
DDHorizontalLayoutClient side implementation for
DDHorizontalSplitPanelAn interface for layouts which has separated tab and content from each other
Client side implementation for
DDTabSheetClient side implementation for
DDVerticalLayoutClient side implementation for
DDVerticalLayoutClient side implementation for
DDVerticalSplitPanelUtility class for Drag and Drop operations
A layer containing geo-objects (entities having a property of a
Geometry type.An event that is fired when selected geo-object has changed.
A common interface for providing data for
VectorLayer.An event that is fired when geometry value has changed in some item.
An event that is fired when selected item has changed.
REST controller that is used for getting REST API version
Class that is used by
VersionController for getting REST API versionA client side criterion for determining the vertical location
Layouts which supports drag filters should implement this
Interface for layout which acts as a drag source
Base class for UI 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.
An event informing which query parameters the view is opened with.
The last (after
View.BeforeShowEvent) event in the view opening process.Standard action for opening an editor screen in the read-only mode.
Class provides mechanism for setting/getting attributes that uses
VaadinSession as store.Class describes attributes map that corresponds to a certain view in a browser tab.
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.Interface defining methods for interacting with data API elements of a view.
Indicates that the annotated
ViewController is linked to an XML template.Provides a fluent interface to configure navigation parameters and navigate to a
View.Provides fluent interface for navigating to views.
Interface to be implemented by actions that open a view.
Defines view resource policy in annotated resource role.
Provides information about all registered views.
Creates UI view instances.
Grants permissions to view Search Results screen
Callbacks holder for save changes dialog.
Callbacks holder for unsaved changes dialog.
Loads view XML descriptors.
Parses view XML taking into account 'assign' elements.
Mouse handler for starting component drag operations
A listener to listen for drag start events
Web implementation of
BackgroundWorkerUtility bean to provide common functionality related to web browser.
A convenience annotation that is itself annotated with
@ControllerAdvice
and @ResponseBody.Service for working with WebdavDocument.
Service for working with document versions.
Controller for working with files as a catalogue structure.
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.
This annotation enables to declare web resource dependencies for the annotated
ClientConnector.Event that is fired when HTTP session is expired.
Event that is fired on the first request processing of the VaadinSession.
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).Scanning the project for use classes with the annotation
Widget and
provides information WidgetTypeInfo about these classesPersistent widget template.
Contains values of annotation
DashboardWidgetRepresents an independent window of application.
Event sent right before the window is closed by an external (relative to the window content) action,
like the button in the window tab or by the Esc keyboard shortcut.
Marker interface for all window close types, which describes the way a window was closed.
Represents a window that can be committed on close.
Defines how the managed main TabSheet switches a tab with the given window: hides or unloads its content.
Window having a user indicator.
Window having a work area.
Provides a fluent interface to configure and open a view in a
DialogWindow.GenericUI class holding information about all registered in
screens.xml screens.Provides access to window parameters and component values.
Internal.
Screen's registration information.
Type of registered controller.
Window modes
Identifies injectable fields in screen controllers, value for field comes from screen parameters
A class containing information about WMS service along with parameters
needed for GetMap operation requests to download tiles.
Convenient class for methods that converts values from Vaadin to Jmix instances and vice versa.
Provides inheritance of screen XML descriptors.
XY chart component.
See documentation for properties of AmXYChart JS object.
Consumerinstead