com.haulmont.cuba.client

Interface ClientConfig

All Superinterfaces:

Config

public interface ClientConfig
extends Config

Configuration parameters interface used by the WEB and DESKTOP layers.

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getBackgroundTaskTimeoutCheckInterval() Interval for checking timeout of a BackgroundTask.
java.lang.String	getCloseShortcut()
boolean	getCollectionDatasourceDbSortEnabled()
java.lang.String	getCommitShortcut()
java.util.List<java.lang.String>	getConnectionUrlList()
boolean	getCreateActionAddsFirst() Defines default behaviour of CreateAction: whether it will add a new item to the beginning or to the end of datasource's collection.
int	getDynamicAttributesTableColumnMaxTextLength()
java.lang.String	getFileDownloadContext()
java.lang.String	getFileUploadContext()
java.lang.String	getFilterApplyShortcut()
java.lang.String	getFilterSelectShortcut()
boolean	getGenericFilterChecking()
int	getGenericFilterColumnsCount()
java.lang.String	getGenericFilterConditionsLocation()
java.lang.String	getGenericFilterControlsLayout() Returns a template for filter controls layout.
boolean	getGenericFilterManualApplyRequired()
java.lang.String	getGenericFilterMaxResultsOptions() Returns a comma-separated list of values that are used as options for "Show rows" lookup field of generic filter component.
int	getGenericFilterPopupListSize() Returns a number of items to be displayed in popup list near the 'Search' button.
boolean	getGenericFilterTrimParamValues()
boolean	getIgnoreUnfetchedAttributesInTable()
boolean	getLayoutAnalyzerEnabled()
boolean	getLoadObsoleteSettingsForTable()
int	getLookupFieldPageLength()
boolean	getManualScreenSettingsSaving()
int	getMaxUploadSizeMb()
java.lang.String	getNextTabShortcut()
boolean	getPasswordPolicyEnabled()
java.lang.String	getPasswordPolicyRegExp()
java.lang.String	getPickerClearShortcut()
java.lang.String	getPickerLookupShortcut()
java.lang.String	getPickerOpenShortcut()
java.lang.String	getPickerShortcutModifiers()
java.lang.String	getPreviousTabShortcut()
boolean	getRemoteMessagesSearchEnabled()
java.lang.String	getScreenIdsToSaveHistory() List of screen aliases for which saving screen history is enabled.
boolean	getShowIconsForPopupMenuActions()
int	getSuggestionFieldAsyncSearchDelayMs()
java.lang.String	getSupportEmail() Support e-mail.
java.lang.String	getSystemID()
boolean	getSystemInfoScriptsEnabled()
java.lang.String	getTableAddShortcut()
java.lang.String	getTableEditShortcut()
java.lang.String	getTableInsertShortcut()
java.lang.String	getTableRemoveShortcut()
java.util.regex.Pattern	getUniqueConstraintViolationPattern()
boolean	getUseSaveConfirmation()
java.lang.String	getValidationNotificationType() Standard Window validation error notification type.
void	setDynamicAttributesTableColumnMaxTextLength(int maxTextLength)
void	setLookupFieldPageLength(int pageLength)
void	setMaxUploadSizeMb(int value)
void	setSystemInfoScriptsEnabled(boolean enabled)

Method Detail

getConnectionUrlList

java.util.List<java.lang.String> getConnectionUrlList()

Returns:

middleware connection URL list

getFileDownloadContext

java.lang.String getFileDownloadContext()

Returns:

Context of the middleware file download controller.

getFileUploadContext

java.lang.String getFileUploadContext()

Returns:

Context of the middleware file upload controller.

getMaxUploadSizeMb

int getMaxUploadSizeMb()

Returns:

Maximum size of uploaded file in megabytes.

setMaxUploadSizeMb

void setMaxUploadSizeMb(int value)

getUniqueConstraintViolationPattern

java.util.regex.Pattern getUniqueConstraintViolationPattern()

getCollectionDatasourceDbSortEnabled

boolean getCollectionDatasourceDbSortEnabled()

Returns:

Whether to enable sorting of datasource data on DB (using separate SELECT with ORDER BY clause).

getRemoteMessagesSearchEnabled

boolean getRemoteMessagesSearchEnabled()

Returns:

If true, client will try to find missing localized messages on the server.

getScreenIdsToSaveHistory

java.lang.String getScreenIdsToSaveHistory()

List of screen aliases for which saving screen history is enabled.

Obsolete. Recommended way to specify this information is entity annotations in *-metadata.xml

Returns:

comma-separated list of screen aliases

getPasswordPolicyEnabled

boolean getPasswordPolicyEnabled()

Returns:

Whether to enable password policy. If true, all new passwords will be checked for the compliance with cuba.passwordPolicyRegExp

getPasswordPolicyRegExp

java.lang.String getPasswordPolicyRegExp()

Returns:

The regular expression which is used by password policy (see also cuba.passwordPolicyEnabled).

getGenericFilterManualApplyRequired

boolean getGenericFilterManualApplyRequired()

Returns:

If true, all generic filters will require explicit Apply after screen opening. Empty connected table is shown.
If false, the filter will be applied automatically, refreshing the table immediately after the screen opening.

getGenericFilterChecking

boolean getGenericFilterChecking()

Returns:

If true, then check filter conditions (empty or not) before applying filter. If all conditions are empty (no parameters entered), the filter doesn't apply and special message to user is shown.
If false, no checks are performed and the filter applies, refreshing connected table.

getGenericFilterTrimParamValues

boolean getGenericFilterTrimParamValues()

Returns:

If true, all generic text filters will trim value.
If false, the text filter will not be trim value.

getGenericFilterColumnsCount

int getGenericFilterColumnsCount()

Returns:

Number of columns with conditions in generic filter UI component.

getGenericFilterConditionsLocation

@Default(value="top")
java.lang.String getGenericFilterConditionsLocation()

Returns:

location of panel with conditions in generic filter component. If top then conditions will be placed above filter control elements or below them if bottom.

getGenericFilterPopupListSize

int getGenericFilterPopupListSize()

Returns a number of items to be displayed in popup list near the 'Search' button. If number of filter entities exceeds this value then 'Show more..' action is added to the popup list. The action will show new dialog window with all possible filter entities for selecting a desired one.

getGenericFilterControlsLayout

@Default(value="[filters_popup] [add_condition] [spacer] [settings | save, save_with_values, save_as, edit, remove, make_default, pin, save_search_folder, save_app_folder, clear_values] [max_results] [fts_switch]")
java.lang.String getGenericFilterControlsLayout()

Returns a template for filter controls layout. Each component has the following format: [component_name | options-comma-separated], e.g. [pin | no-caption, no-icon].

Available component names:

• filters_popup - popup button for selecting a filter entity combined with Search button. When using this component there is no need to add a separate Search button
• filters_lookup - lookup field for selecting a filter entity. Search button should be added as a separate component
• search - search button. Do not add if use filters_popup
• add_condition - button for adding a new condition
• spacer - space between component groups
• settings - settings button. Specify actions names that should be displayed in Settings popup as component options
• max_results - group of components for setting max number of records to be displayed
• fts_switch - checkbox for switching to FTS mode

The following components can be used as options for settings component. They also can be used as independent components if for example you want to display a Pin button:

• save
• save_as
• edit
• remove
• pin
• make_default
• save_search_folder
• save_app_folder

Action components can have the following options:

• no-icon - if an icon shouldn't be displayed on action button. For example: [save | no-icon]
• no-caption - if a caption shouldn't be displayed on action button. For example: [pin | no-caption]

Returns:

a template for filter controls layout

getGenericFilterMaxResultsOptions

@Default(value="NULL, 20, 50, 100, 500, 1000, 5000")
java.lang.String getGenericFilterMaxResultsOptions()

Returns a comma-separated list of values that are used as options for "Show rows" lookup field of generic filter component. Add NULL option to the list if the lookup field should contain an empty value.

getSupportEmail

java.lang.String getSupportEmail()

Support e-mail. Exception report emails are sent to this address.

getSystemID

java.lang.String getSystemID()

Returns:

System ID. Use for identification (support emails).

getTableInsertShortcut

java.lang.String getTableInsertShortcut()

getTableAddShortcut

java.lang.String getTableAddShortcut()

getTableRemoveShortcut

java.lang.String getTableRemoveShortcut()

getTableEditShortcut

java.lang.String getTableEditShortcut()

getCommitShortcut

java.lang.String getCommitShortcut()

getCloseShortcut

java.lang.String getCloseShortcut()

getFilterApplyShortcut

java.lang.String getFilterApplyShortcut()

getFilterSelectShortcut

java.lang.String getFilterSelectShortcut()

getNextTabShortcut

java.lang.String getNextTabShortcut()

getPreviousTabShortcut

java.lang.String getPreviousTabShortcut()

getPickerShortcutModifiers

java.lang.String getPickerShortcutModifiers()

getPickerLookupShortcut

java.lang.String getPickerLookupShortcut()

getPickerOpenShortcut

java.lang.String getPickerOpenShortcut()

getPickerClearShortcut

java.lang.String getPickerClearShortcut()

getUseSaveConfirmation

boolean getUseSaveConfirmation()

getLoadObsoleteSettingsForTable

boolean getLoadObsoleteSettingsForTable()

getLayoutAnalyzerEnabled

boolean getLayoutAnalyzerEnabled()

getSystemInfoScriptsEnabled

boolean getSystemInfoScriptsEnabled()

setSystemInfoScriptsEnabled

void setSystemInfoScriptsEnabled(boolean enabled)

getManualScreenSettingsSaving

boolean getManualScreenSettingsSaving()

getShowIconsForPopupMenuActions

boolean getShowIconsForPopupMenuActions()

getLookupFieldPageLength

int getLookupFieldPageLength()

setLookupFieldPageLength

void setLookupFieldPageLength(int pageLength)

getBackgroundTaskTimeoutCheckInterval

java.lang.Integer getBackgroundTaskTimeoutCheckInterval()

Interval for checking timeout of a BackgroundTask.

Returns:

Timeout in ms

getIgnoreUnfetchedAttributesInTable

boolean getIgnoreUnfetchedAttributesInTable()

Returns:

true if Table will ignore unfetched attribute read errors

getDynamicAttributesTableColumnMaxTextLength

int getDynamicAttributesTableColumnMaxTextLength()

setDynamicAttributesTableColumnMaxTextLength

void setDynamicAttributesTableColumnMaxTextLength(int maxTextLength)

getCreateActionAddsFirst

boolean getCreateActionAddsFirst()

Defines default behaviour of CreateAction: whether it will add a new item to the beginning or to the end of datasource's collection. Affects only standalone datasources, for nested datasources new items are always added to the end.

getSuggestionFieldAsyncSearchDelayMs

int getSuggestionFieldAsyncSearchDelayMs()

getValidationNotificationType

@Default(value="TRAY")
java.lang.String getValidationNotificationType()

Standard Window validation error notification type.

Returns:

one of com.haulmont.cuba.gui.components.Frame.NotificationType values