com.haulmont.cuba.desktop

Interface DesktopConfig

All Superinterfaces:

Config

public interface DesktopConfig
extends Config

Desktop UI configuration parameters.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.Integer>	getAvailableFontSizes()
java.lang.String	getLoginDialogDefaultPassword()
java.lang.String	getLoginDialogDefaultUser()
int	getMainTabCaptionLength()
java.lang.String	getResourceLocations() List of root directories where resources (icons, images, theme config) are located.
int	getSearchFieldAsyncTimeoutMs() Deprecated. Use ClientConfig.getSuggestionFieldAsyncSearchDelayMs() instead
int	getSessionMessagesIntervalSec()
java.lang.String	getShowTooltipShortcut()
java.lang.String	getTheme() Desktop theme name.
java.lang.String	getWindowIcon()
boolean	isDialogNotificationsEnabled()
boolean	isUseServerTime()
boolean	isUseServerTimeZone()

Method Detail

getResourceLocations

@Default(value="com/haulmont/cuba/desktop/res")
java.lang.String getResourceLocations()

List of root directories where resources (icons, images, theme config) are located. Resources are local to each desktop theme. For each root directory must exist subdirectory with name of current theme.

Returns:

list of root resource directories

getMainTabCaptionLength

int getMainTabCaptionLength()

getWindowIcon

java.lang.String getWindowIcon()

getTheme

@Default(value="nimbus")
java.lang.String getTheme()

Desktop theme name. Theme configuration file is located as ${resourceLocation}/${themeName}/${themeName}.xml.

Returns:

desktop theme name

isDialogNotificationsEnabled

boolean isDialogNotificationsEnabled()

getAvailableFontSizes

@Default(value="6 8 10 12 14 16 18 20 22 24 28 32 36 48 54 60 72")
java.util.List<java.lang.Integer> getAvailableFontSizes()

isUseServerTimeZone

boolean isUseServerTimeZone()

Returns:

true if application should change time zone to that which is used by server

isUseServerTime

boolean isUseServerTime()

Returns:

true if application should synchronize its time source with server time

getSessionMessagesIntervalSec

int getSessionMessagesIntervalSec()

Returns:

Timeout of loading session messages from server in seconds

getSearchFieldAsyncTimeoutMs

int getSearchFieldAsyncTimeoutMs()

Deprecated. Use ClientConfig.getSuggestionFieldAsyncSearchDelayMs() instead

getLoginDialogDefaultUser

@Default(value="admin")
java.lang.String getLoginDialogDefaultUser()

Returns:

Default user login to set in the login dialog.

getLoginDialogDefaultPassword

@Default(value="admin")
java.lang.String getLoginDialogDefaultPassword()

Returns:

Default user password to set in the login dialog.

getShowTooltipShortcut

java.lang.String getShowTooltipShortcut()