io.jmix.ui

Class UiComponentProperties

java.lang.Object

io.jmix.ui.UiComponentProperties

@ConfigurationProperties(prefix="jmix.ui.component")
 @ConstructorBinding
public class UiComponentProperties
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description

UiComponentProperties(boolean htmlSanitizerEnabled, int uploadFieldMaxUploadSizeMb, java.lang.String tableInsertShortcut, java.lang.String tableAddShortcut, java.lang.String tableRemoveShortcut, java.lang.String tableEditShortcut, java.lang.String tableViewShortcut, int tablePageLength, double tableCacheRate, java.lang.String pickerShortcutModifiers, java.lang.String pickerLookupShortcut, java.lang.String pickerOpenShortcut, java.lang.String pickerClearShortcut, int comboBoxPageLength, java.lang.String mainTabSheetNextTabShortcut, java.lang.String mainTabSheetPreviousTabShortcut, MainTabSheetMode mainTabSheetMode, ManagedMainTabSheetMode managedMainTabSheetMode, java.util.List<java.lang.Integer> paginationItemsPerPageOptions, java.util.Map<java.lang.String,java.lang.String> entityFieldType, java.util.Map<java.lang.String,java.util.List<java.lang.String>> entityFieldActions, boolean filterAutoApply, int filterPropertiesHierarchyDepth, int filterColumnsCount, boolean filterShowConfigurationIdField)

Method Summary

Modifier and Type	Method and Description
int	getComboBoxPageLength()
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getEntityFieldActions()
java.util.Map<java.lang.String,java.lang.String>	getEntityFieldType()
int	getFilterColumnsCount()
int	getFilterPropertiesHierarchyDepth()
MainTabSheetMode	getMainTabSheetMode() Sets whether default JmixMainTabSheet or JmixManagedTabSheet will be used in AppWorkArea.
java.lang.String	getMainTabSheetNextTabShortcut()
java.lang.String	getMainTabSheetPreviousTabShortcut()
ManagedMainTabSheetMode	getManagedMainTabSheetMode() Sets how the managed main TabSheet switches its tabs: hides or unloads them.
java.util.List<java.lang.Integer>	getPaginationItemsPerPageOptions()
java.lang.String	getPickerClearShortcut()
java.lang.String	getPickerLookupShortcut()
java.lang.String	getPickerOpenShortcut()
java.lang.String	getPickerShortcutModifiers()
java.lang.String	getTableAddShortcut()
double	getTableCacheRate() This property adjusts a possible caching mechanism of table implementation.
java.lang.String	getTableEditShortcut()
java.lang.String	getTableInsertShortcut()
int	getTablePageLength() Sets the page length for Table implementation - count of rows for first rendering of Table.
java.lang.String	getTableRemoveShortcut()
java.lang.String	getTableViewShortcut()
int	getUploadFieldMaxUploadSizeMb()
boolean	isFilterAutoApply()
boolean	isFilterShowConfigurationIdField()
boolean	isHtmlSanitizerEnabled() Defines whether to sanitize the value of components using HtmlSanitizer to prevent Cross-site Scripting (XSS) in HTML context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UiComponentProperties

public UiComponentProperties(@DefaultValue(value="true")
                             boolean htmlSanitizerEnabled,
                             @DefaultValue(value="20")
                             int uploadFieldMaxUploadSizeMb,
                             @DefaultValue(value="CTRL-BACKSLASH")
                             java.lang.String tableInsertShortcut,
                             @DefaultValue(value="CTRL-ALT-BACKSLASH")
                             java.lang.String tableAddShortcut,
                             @DefaultValue(value="CTRL-DELETE")
                             java.lang.String tableRemoveShortcut,
                             @DefaultValue(value="ENTER")
                             java.lang.String tableEditShortcut,
                             @DefaultValue(value="ENTER")
                             java.lang.String tableViewShortcut,
                             @DefaultValue(value="15")
                             int tablePageLength,
                             @DefaultValue(value="2")
                             double tableCacheRate,
                             @DefaultValue(value="CTRL-ALT")
                             java.lang.String pickerShortcutModifiers,
                             @DefaultValue(value="CTRL-ALT-L")
                             java.lang.String pickerLookupShortcut,
                             @DefaultValue(value="CTRL-ALT-O")
                             java.lang.String pickerOpenShortcut,
                             @DefaultValue(value="CTRL-ALT-C")
                             java.lang.String pickerClearShortcut,
                             @DefaultValue(value="10")
                             int comboBoxPageLength,
                             @DefaultValue(value="CTRL-SHIFT-PAGE_DOWN")
                             java.lang.String mainTabSheetNextTabShortcut,
                             @DefaultValue(value="CTRL-SHIFT-PAGE_UP")
                             java.lang.String mainTabSheetPreviousTabShortcut,
                             @DefaultValue(value="DEFAULT")
                             MainTabSheetMode mainTabSheetMode,
                             @DefaultValue(value="HIDE_TABS")
                             ManagedMainTabSheetMode managedMainTabSheetMode,
                             @DefaultValue(value={"20","50","100","500","1000","5000"})
                             java.util.List<java.lang.Integer> paginationItemsPerPageOptions,
                             @Nullable
                             java.util.Map<java.lang.String,java.lang.String> entityFieldType,
                             @Nullable
                             java.util.Map<java.lang.String,java.util.List<java.lang.String>> entityFieldActions,
                             @DefaultValue(value="true")
                             boolean filterAutoApply,
                             @DefaultValue(value="2")
                             int filterPropertiesHierarchyDepth,
                             @DefaultValue(value="3")
                             int filterColumnsCount,
                             @DefaultValue(value="false")
                             boolean filterShowConfigurationIdField)

Method Detail

getUploadFieldMaxUploadSizeMb

public int getUploadFieldMaxUploadSizeMb()

getTableInsertShortcut

public java.lang.String getTableInsertShortcut()

getTableAddShortcut

public java.lang.String getTableAddShortcut()

getTableRemoveShortcut

public java.lang.String getTableRemoveShortcut()

getTableEditShortcut

public java.lang.String getTableEditShortcut()

getTableViewShortcut

public java.lang.String getTableViewShortcut()

getMainTabSheetNextTabShortcut

public java.lang.String getMainTabSheetNextTabShortcut()

getMainTabSheetPreviousTabShortcut

public java.lang.String getMainTabSheetPreviousTabShortcut()

getPickerShortcutModifiers

public java.lang.String getPickerShortcutModifiers()

getPickerLookupShortcut

public java.lang.String getPickerLookupShortcut()

getPickerOpenShortcut

public java.lang.String getPickerOpenShortcut()

getPickerClearShortcut

public java.lang.String getPickerClearShortcut()

getComboBoxPageLength

public int getComboBoxPageLength()

Returns:

the page length for the suggestion popup of ComboBox component. Setting the page length to 0 will disable suggestion popup paging (all items visible)

getTablePageLength

public int getTablePageLength()

Sets the page length for Table implementation - count of rows for first rendering of Table. After first partial rendering Table will request rest of rows from the server.
Setting page length 0 disables paging.
If Table has fixed height the client side may update the page length automatically the correct value.

getTableCacheRate

public double getTableCacheRate()

This property adjusts a possible caching mechanism of table implementation.
Table component may fetch and render some rows outside visible area. With complex tables (for example containing layouts and components), the client side may become unresponsive. Setting the value lower, UI will become more responsive. With higher values scrolling in client will hit server less frequently.
The amount of cached rows will be cacheRate multiplied with pageLength getTablePageLength() both below and above visible area.

getMainTabSheetMode

public MainTabSheetMode getMainTabSheetMode()

Sets whether default JmixMainTabSheet or JmixManagedTabSheet will be used in AppWorkArea.

getManagedMainTabSheetMode

public ManagedMainTabSheetMode getManagedMainTabSheetMode()

Sets how the managed main TabSheet switches its tabs: hides or unloads them.

isHtmlSanitizerEnabled

public boolean isHtmlSanitizerEnabled()

Defines whether to sanitize the value of components using HtmlSanitizer to prevent Cross-site Scripting (XSS) in HTML context.

getPaginationItemsPerPageOptions

public java.util.List<java.lang.Integer> getPaginationItemsPerPageOptions()

Returns:

options for rows per page ComboBox.

getEntityFieldType

public java.util.Map<java.lang.String,java.lang.String> getEntityFieldType()

getEntityFieldActions

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getEntityFieldActions()

isFilterAutoApply

public boolean isFilterAutoApply()

Returns:

default value for the autoApply attribute of the Filter component

getFilterPropertiesHierarchyDepth

public int getFilterPropertiesHierarchyDepth()

Returns:

a number of nested properties in the AddConditionScreen. I.e. if the depth is 2, then you'll be able to select a property "contractor.city.country", if the value is 3, then "contractor.city.country.name", etc.

getFilterColumnsCount

public int getFilterColumnsCount()

Returns:

the number of columns to be displayed on one row in Filter

isFilterShowConfigurationIdField

public boolean isFilterShowConfigurationIdField()

Returns:

whether field for filter configuration id should be visible in the filter configuration edit screens