Class CmsUserSettings
- java.lang.Object
-
- org.opencms.db.CmsUserSettings
-
- Direct Known Subclasses:
CmsDefaultUserSettings
public class CmsUserSettings extends java.lang.Object
Object to conveniently access and modify the users workplace settings.- Since:
- 6.0.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CmsUserSettings.CmsSearchResultStyle
Enumeration class for workplace search result styles.static class
CmsUserSettings.UploadVariant
A enum for the different upload variants.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ADDITIONAL_INFO_ADDRESS
Key for additional info address.static java.lang.String
ADDITIONAL_INFO_CITY
Key for additional info city.static java.lang.String
ADDITIONAL_INFO_CONFIRMED_RESOURCES
Key for additional info of resources that were confirmed by the user.static java.lang.String
ADDITIONAL_INFO_COUNTRY
Key for additional info address.static java.lang.String
ADDITIONAL_INFO_DEFAULTGROUP
Key for additional info default group.static java.lang.String
ADDITIONAL_INFO_DESCRIPTION
Key for additional info address.static java.lang.String
ADDITIONAL_INFO_EXPLORERSETTINGS
Key for additional info explorer settings.static java.lang.String
ADDITIONAL_INFO_INSTITUTION
Key for additional info institution.static java.lang.String
ADDITIONAL_INFO_LAST_PASSWORD_CHANGE
Key for last password change additional info.static java.lang.String
ADDITIONAL_INFO_LAST_USER_DATA_CHECK
Key for last user data check additional info.static java.lang.String
ADDITIONAL_INFO_PASSWORD_RESET
Additional info which indicates, that a password was reset by an admin.static java.lang.String
ADDITIONAL_INFO_PREFERENCES
Key for additional info flags.static java.lang.String
ADDITIONAL_INFO_STARTSETTINGS
Key for additional info start settings.static java.lang.String
ADDITIONAL_INFO_TIMEWARP
Key for additional info time warp.static java.lang.String
ADDITIONAL_INFO_UPLOADAPPLET_CLIENTFOLDER
Key for additional info upload applet client folder path.static java.lang.String
ADDITIONAL_INFO_ZIPCODE
Key for additional info address.static int
FILELIST_DATE_CREATED
Flag for displaying the date created column.static int
FILELIST_DATE_EXPIRED
Flag for displaying the date expired column.static int
FILELIST_DATE_LASTMODIFIED
Flag for displaying the changed column.static int
FILELIST_DATE_RELEASED
Flag for displaying the date released column.static int
FILELIST_LOCKEDBY
Flag for displaying the locked column.static int
FILELIST_NAME
Flag for displaying the name column.static int
FILELIST_NAVTEXT
Flag for displaying the navigation text column.static int
FILELIST_PERMISSIONS
Flag for displaying the access column.static int
FILELIST_SIZE
Flag for displaying the size column.static int
FILELIST_STATE
Flag for displaying the state column.static int
FILELIST_TITLE
Flag for displaying the title column.static int
FILELIST_TYPE
Flag for displaying the file type column.static int
FILELIST_USER_CREATED
Flag for displaying the owner column.static int
FILELIST_USER_LASTMODIFIED
Flag for displaying the user who last modified column.static java.lang.String
LOGIN_USERAGREEMENT_ACCEPTED
Identifier for the login user agreement accepted information.static java.lang.String
PREF_WORKPLACE_MODE
Preference for setting which workplace to open on startup.static java.lang.String
PREFERENCES
Identifier prefix for all keys in the user additional info table.static java.lang.String
PREFERENCES_ADDITIONAL_PREFIX
Prefix for additional info key for user defined preferences.static java.lang.String
SYNC_DESTINATION
Identifier for the synchronize setting key.static java.lang.String
SYNC_ENABLED
Identifier for the synchronize setting key.static java.lang.String
SYNC_SETTINGS
Identifier for the synchronize setting key.static java.lang.String
SYNC_VFS_LIST
Identifier for the synchronize setting key.static java.lang.String
WORKPLACE_MODE_NEW
Preference value for new workplace.static java.lang.String
WORKPLACE_MODE_OLD
Preference value for new workplace.
-
Constructor Summary
Constructors Constructor Description CmsUserSettings()
Creates an empty new user settings object.CmsUserSettings(CmsObject cms)
Creates a user settings object with initialized settings of the current user.CmsUserSettings(CmsUser user)
Creates a user settings object with initialized settings of the user.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getAdditionalPreference(java.lang.String name, boolean useDefault)
Gets the value for a user defined preference.static java.lang.String
getAdditionalPreference(CmsObject cms, java.lang.String key, boolean useDefault)
Gets a configured preference.CmsResource.CmsResourceCopyMode
getDialogCopyFileMode()
Gets the default copy mode when copying a file of the user.CmsResource.CmsResourceCopyMode
getDialogCopyFolderMode()
Gets the default copy mode when copying a folder of the user.CmsResource.CmsResourceDeleteMode
getDialogDeleteFileMode()
Returns the default setting for file deletion.boolean
getDialogExpandInheritedPermissions()
Returns the default setting for expanding inherited permissions in the dialog.boolean
getDialogExpandUserPermissions()
Returns the default setting for expanding the users permissions in the dialog.boolean
getDialogPermissionsInheritOnFolder()
Returns the default setting for inheriting permissions on folders.boolean
getDialogPublishSiblings()
Returns the default setting for direct publishing.boolean
getDialogShowExportSettings()
Determines if the export part of the secure/export dialog should be shown.boolean
getDialogShowLock()
Determines if the lock dialog should be shown.int
getDirectEditButtonStyle()
Returns the style of the direct edit buttons of the user.int
getEditorButtonStyle()
Returns the style of the editor buttons of the user.java.util.Map<java.lang.String,java.lang.String>
getEditorSettings()
Returns the editor settings of the user.int
getExplorerButtonStyle()
Returns the style of the explorer buttons of the user.int
getExplorerFileEntries()
Returns the number of displayed files per page of the user.java.lang.String
getExplorerFileEntryOptions()
Returns the explorerFileEntryOptions.int
getExplorerSettings()
Returns the explorer start settings.boolean
getListAllProjects()
Returns if all projects should be listed or only the ones in the current ou.java.util.Locale
getLocale()
Returns the locale of the user.java.lang.Boolean
getNewFolderCreateIndexPage()
Returns
if the "create index page" check box in the new folder dialog should be initially be checked.Boolean.TRUE
java.lang.Boolean
getNewFolderEditProperties()
Returns
if the "edit properties" check box in the new folder dialog should be initially be checked.Boolean.TRUE
java.lang.String
getPreferredEditor(java.lang.String resourceType)
Returns the preferred editor for the given resource type of the user.java.lang.String
getPublishButtonAppearance()
Returns the appearance of the "publish project" button.boolean
getRestrictExplorerView()
Sets if the explorer view is restricted to the defined site and folder.boolean
getShowFileUploadButton()
Returnstrue
if the file upload button should be shown orfalse
otherwise.boolean
getShowPublishNotification()
Returns if the publish notifications should be shown or not.java.lang.Boolean
getShowUploadTypeDialog()
Returns
if the resource type selection dialog should be shown in the file upload process (non - applet version).Boolean.TRUE
java.lang.String
getStartFolder()
Returns the start folder of the user.java.util.Map<java.lang.String,java.lang.String>
getStartGalleriesSettings()
The start galleries settings of the user.java.lang.String
getStartGallery(java.lang.String galleryType)
Returns the path to the start gallery of the user.java.lang.String
getStartGallery(java.lang.String galleryType, CmsObject cms)
Returns the root site path to the start gallery of the user or the constant CmsPreferences.INPUT_DEFAULT.java.lang.String
getStartProject()
Returns the start project of the user.java.lang.String
getStartSite()
Returns the start site of the user.java.lang.String
getStartView()
Returns the current start view of the user.CmsSynchronizeSettings
getSynchronizeSettings()
Returns the (optional) workplace synchronize settings.long
getTimeWarp()
Returns the current users time warp time, orCmsContextInfo.CURRENT_TIME
if this feature is disabled and the current time is used for each user request.java.lang.String
getUploadAppletClientFolder()
Returns the folder path of the upload applet on the client machine.CmsUserSettings.UploadVariant
getUploadVariant()
Returns the uploadVariant.CmsUser
getUser()
Returns the current user for the settings.int
getWorkplaceButtonStyle()
Returns the style of the workplace buttons of the user.java.lang.String
getWorkplaceReportType()
Returns the type of the report (simple or extended) of the user.java.lang.String
getWorkplaceSearchIndexName()
Returns the name of the search index to use in the workplace.CmsUserSettings.CmsSearchResultStyle
getWorkplaceSearchViewStyle()
Returns the workplace search result list view style.void
init(CmsUser user)
Initializes the user settings with the given users setting parameters.void
save(CmsObject cms)
Saves the changed settings of the user to the usersCmsUser.getAdditionalInfo()
map.void
setAdditionalPreference(java.lang.String name, java.lang.String value)
Sets an additional preference value.static void
setAdditionalPreference(CmsObject cms, java.lang.String key, java.lang.String value)
Sets a configured preference.void
setAdditionalPreferencesFrom(CmsUserSettings userSettings)
Sets this settings object's additional preferences to that of another one.void
setDialogCopyFileMode(CmsResource.CmsResourceCopyMode mode)
Sets the default copy mode when copying a file of the user.void
setDialogCopyFolderMode(CmsResource.CmsResourceCopyMode mode)
Sets the default copy mode when copying a folder of the user.void
setDialogDeleteFileMode(CmsResource.CmsResourceDeleteMode mode)
Sets the default setting for file deletion.void
setDialogExpandInheritedPermissions(boolean dialogShowInheritedPermissions)
Sets the default setting for expanding inherited permissions in the dialog.void
setDialogExpandUserPermissions(boolean dialogShowUserPermissions)
Sets the default setting for expanding the users permissions in the dialog.void
setDialogPermissionsInheritOnFolder(boolean dialogPermissionsInheritOnFolder)
Sets the default setting for inheriting permissions on folders.void
setDialogPublishSiblings(boolean publishSiblings)
Sets the default setting for direct publishing.void
setDialogShowExportSettings(boolean show)
Sets if the export setting part of the secure/export dialog should be shown.void
setDialogShowLock(boolean show)
Sets if the lock dialog should be shown.void
setDirectEditButtonStyle(int style)
Sets the style of the direct edit buttons of the user.void
setEditorButtonStyle(int style)
Sets the style of the editor buttons of the user.void
setEditorSettings(java.util.Map<java.lang.String,java.lang.String> settings)
Sets the editor settings of the user.void
setExplorerButtonStyle(int style)
Sets the style of the explorer buttons of the user.void
setExplorerFileEntries(int entries)
Sets the number of displayed files per page of the user.void
setExplorerFileEntryOptions(java.lang.String explorerFileEntryOptions)
Sets the explorerFileEntryOptions.void
setExplorerSettings(int settings)
Sets the explorer start settings.void
setListAllProjects(boolean listAllProjects)
Sets if all the projects should be shown or not.void
setLocale(java.util.Locale locale)
Sets the locale of the user.void
setNewFolderCreateIndexPage(java.lang.Boolean setting)
Sets if the "create index page" check box in the new folder dialog should be initially be checked or not.void
setNewFolderEditPropertes(java.lang.Boolean setting)
Sets if the "edit properties" check box in the new folder dialog should be initially be checked or not.void
setPreferredEditor(java.lang.String resourceType, java.lang.String editorUri)
Sets the preferred editor for the given resource type of the user.void
setPublishButtonAppearance(java.lang.String publishButtonAppearance)
Sets the appearance of the "publish project" button.void
setRestrictExplorerView(boolean restrict)
Sets if the explorer view is restricted to the defined site and folder.void
setShowExplorerFileDateCreated(boolean show)
Sets if the file creation date should be shown in explorer view.void
setShowExplorerFileDateExpired(boolean show)
Sets if the file expire date should be shown in explorer view.void
setShowExplorerFileDateLastModified(boolean show)
Sets if the file last modified date state should be shown in explorer view.void
setShowExplorerFileDateReleased(boolean show)
Sets if the file release date should be shown in explorer view.void
setShowExplorerFileLockedBy(boolean show)
Sets if the file locked by should be shown in explorer view.void
setShowExplorerFileNavText(boolean show)
Sets if the file navtext should be shown in explorer view.void
setShowExplorerFilePermissions(boolean show)
Sets if the file permissions should be shown in explorer view.void
setShowExplorerFileSize(boolean show)
Sets if the file size should be shown in explorer view.void
setShowExplorerFileState(boolean show)
Sets if the file state should be shown in explorer view.void
setShowExplorerFileTitle(boolean show)
Sets if the file title should be shown in explorer view.void
setShowExplorerFileType(boolean show)
Sets if the file type should be shown in explorer view.void
setShowExplorerFileUserCreated(boolean show)
Sets if the file creator should be shown in explorer view.void
setShowExplorerFileUserLastModified(boolean show)
Sets if the file last modified by should be shown in explorer view.void
setShowFileUploadButton(boolean flag)
Controls whether to display a file upload icon or not.void
setShowPublishNotification(boolean showPublishNotification)
Sets if the publish notifications should be shown or not.void
setShowUploadTypeDialog(java.lang.Boolean showUploadTypeDialog)
Sets if the resource type selection dialog should be shown in the file upload process (non - applet version) or not.void
setStartFolder(java.lang.String folder)
Sets the start folder of the user.void
setStartGalleriesSetting(java.util.Map<java.lang.String,java.lang.String> settings)
Sets the start galleries settings of the user.void
setStartGallery(java.lang.String galleryType, java.lang.String galleryUri)
Sets the path to the start gallery of the user or removes the entry from user settings if no path is null.void
setStartProject(java.lang.String project)
Sets the start project of the user.void
setStartSite(java.lang.String site)
Sets the start site of the user.void
setStartView(java.lang.String view)
Sets the current start view of the user.void
setSynchronizeSettings(CmsSynchronizeSettings synchronizeSettings)
Sets the (optional) workplace synchronize settings.void
setTimeWarp(long timewarp)
Sets the user specific custom "time warp" time.void
setUploadAppletClientFolder(java.lang.String uploadAppletClientFolder)
Sets the folder path of the upload applet on the client machine.void
setUploadVariant(java.lang.String uploadVariant)
Sets the upload variant.void
setUploadVariant(CmsUserSettings.UploadVariant uploadVariant)
Sets the upload variant.void
setUser(CmsUser user)
Sets the current user for the settings.void
setWorkplaceButtonStyle(int style)
Sets the style of the workplace buttons of the user.void
setWorkplaceReportType(java.lang.String type)
Sets the type of the report (simple or extended) of the user.void
setWorkplaceSearchIndexName(java.lang.String workplaceSearchIndexName)
Sets the name of the search index to use in the workplace.void
setWorkplaceSearchViewStyle(CmsUserSettings.CmsSearchResultStyle workplaceSearchViewStyle)
Sets the workplace search result list view style.boolean
showExplorerFileDateCreated()
Determines if the file creation date should be shown in explorer view.boolean
showExplorerFileDateExpired()
Determines if the file date expired should be shown in explorer view.boolean
showExplorerFileDateLastModified()
Determines if the file last modified date should be shown in explorer view.boolean
showExplorerFileDateReleased()
Determines if the file date released should be shown in explorer view.boolean
showExplorerFileLockedBy()
Determines if the file locked by should be shown in explorer view.boolean
showExplorerFileNavText()
Determines if the file navigation text should be shown in explorer view.boolean
showExplorerFilePermissions()
Determines if the file permissions should be shown in explorer view.boolean
showExplorerFileSize()
Determines if the file size should be shown in explorer view.boolean
showExplorerFileState()
Determines if the file state should be shown in explorer view.boolean
showExplorerFileTitle()
Determines if the file title should be shown in explorer view.boolean
showExplorerFileType()
Determines if the file type should be shown in explorer view.boolean
showExplorerFileUserCreated()
Determines if the file creator should be shown in explorer view.boolean
showExplorerFileUserLastModified()
Determines if the file last modified by should be shown in explorer view.
-
-
-
Field Detail
-
ADDITIONAL_INFO_ADDRESS
public static final java.lang.String ADDITIONAL_INFO_ADDRESS
Key for additional info address.- See Also:
- Constant Field Values
-
ADDITIONAL_INFO_CITY
public static final java.lang.String ADDITIONAL_INFO_CITY
Key for additional info city.- See Also:
- Constant Field Values
-
ADDITIONAL_INFO_CONFIRMED_RESOURCES
public static final java.lang.String ADDITIONAL_INFO_CONFIRMED_RESOURCES
Key for additional info of resources that were confirmed by the user.- See Also:
- Constant Field Values
-
ADDITIONAL_INFO_COUNTRY
public static final java.lang.String ADDITIONAL_INFO_COUNTRY
Key for additional info address.- See Also:
- Constant Field Values
-
ADDITIONAL_INFO_DEFAULTGROUP
public static final java.lang.String ADDITIONAL_INFO_DEFAULTGROUP
Key for additional info default group.- See Also:
- Constant Field Values
-
ADDITIONAL_INFO_DESCRIPTION
public static final java.lang.String ADDITIONAL_INFO_DESCRIPTION
Key for additional info address.- See Also:
- Constant Field Values
-
ADDITIONAL_INFO_EXPLORERSETTINGS
public static final java.lang.String ADDITIONAL_INFO_EXPLORERSETTINGS
Key for additional info explorer settings.- See Also:
- Constant Field Values
-
ADDITIONAL_INFO_INSTITUTION
public static final java.lang.String ADDITIONAL_INFO_INSTITUTION
Key for additional info institution.- See Also:
- Constant Field Values
-
ADDITIONAL_INFO_LAST_PASSWORD_CHANGE
public static final java.lang.String ADDITIONAL_INFO_LAST_PASSWORD_CHANGE
Key for last password change additional info.- See Also:
- Constant Field Values
-
ADDITIONAL_INFO_LAST_USER_DATA_CHECK
public static final java.lang.String ADDITIONAL_INFO_LAST_USER_DATA_CHECK
Key for last user data check additional info.- See Also:
- Constant Field Values
-
ADDITIONAL_INFO_PASSWORD_RESET
public static final java.lang.String ADDITIONAL_INFO_PASSWORD_RESET
Additional info which indicates, that a password was reset by an admin.- See Also:
- Constant Field Values
-
ADDITIONAL_INFO_PREFERENCES
public static final java.lang.String ADDITIONAL_INFO_PREFERENCES
Key for additional info flags.- See Also:
- Constant Field Values
-
ADDITIONAL_INFO_STARTSETTINGS
public static final java.lang.String ADDITIONAL_INFO_STARTSETTINGS
Key for additional info start settings.- See Also:
- Constant Field Values
-
ADDITIONAL_INFO_TIMEWARP
public static final java.lang.String ADDITIONAL_INFO_TIMEWARP
Key for additional info time warp.- See Also:
- Constant Field Values
-
ADDITIONAL_INFO_UPLOADAPPLET_CLIENTFOLDER
public static final java.lang.String ADDITIONAL_INFO_UPLOADAPPLET_CLIENTFOLDER
Key for additional info upload applet client folder path.- See Also:
- Constant Field Values
-
ADDITIONAL_INFO_ZIPCODE
public static final java.lang.String ADDITIONAL_INFO_ZIPCODE
Key for additional info address.- See Also:
- Constant Field Values
-
FILELIST_DATE_CREATED
public static final int FILELIST_DATE_CREATED
Flag for displaying the date created column.- See Also:
- Constant Field Values
-
FILELIST_DATE_EXPIRED
public static final int FILELIST_DATE_EXPIRED
Flag for displaying the date expired column.- See Also:
- Constant Field Values
-
FILELIST_DATE_LASTMODIFIED
public static final int FILELIST_DATE_LASTMODIFIED
Flag for displaying the changed column.- See Also:
- Constant Field Values
-
FILELIST_DATE_RELEASED
public static final int FILELIST_DATE_RELEASED
Flag for displaying the date released column.- See Also:
- Constant Field Values
-
FILELIST_LOCKEDBY
public static final int FILELIST_LOCKEDBY
Flag for displaying the locked column.- See Also:
- Constant Field Values
-
FILELIST_NAME
public static final int FILELIST_NAME
Flag for displaying the name column.- See Also:
- Constant Field Values
-
FILELIST_NAVTEXT
public static final int FILELIST_NAVTEXT
Flag for displaying the navigation text column.- See Also:
- Constant Field Values
-
FILELIST_PERMISSIONS
public static final int FILELIST_PERMISSIONS
Flag for displaying the access column.- See Also:
- Constant Field Values
-
FILELIST_SIZE
public static final int FILELIST_SIZE
Flag for displaying the size column.- See Also:
- Constant Field Values
-
FILELIST_STATE
public static final int FILELIST_STATE
Flag for displaying the state column.- See Also:
- Constant Field Values
-
FILELIST_TITLE
public static final int FILELIST_TITLE
Flag for displaying the title column.- See Also:
- Constant Field Values
-
FILELIST_TYPE
public static final int FILELIST_TYPE
Flag for displaying the file type column.- See Also:
- Constant Field Values
-
FILELIST_USER_CREATED
public static final int FILELIST_USER_CREATED
Flag for displaying the owner column.- See Also:
- Constant Field Values
-
FILELIST_USER_LASTMODIFIED
public static final int FILELIST_USER_LASTMODIFIED
Flag for displaying the user who last modified column.- See Also:
- Constant Field Values
-
LOGIN_USERAGREEMENT_ACCEPTED
public static final java.lang.String LOGIN_USERAGREEMENT_ACCEPTED
Identifier for the login user agreement accepted information.- See Also:
- Constant Field Values
-
PREF_WORKPLACE_MODE
public static final java.lang.String PREF_WORKPLACE_MODE
Preference for setting which workplace to open on startup.- See Also:
- Constant Field Values
-
PREFERENCES
public static final java.lang.String PREFERENCES
Identifier prefix for all keys in the user additional info table.- See Also:
- Constant Field Values
-
PREFERENCES_ADDITIONAL_PREFIX
public static final java.lang.String PREFERENCES_ADDITIONAL_PREFIX
Prefix for additional info key for user defined preferences.- See Also:
- Constant Field Values
-
SYNC_DESTINATION
public static final java.lang.String SYNC_DESTINATION
Identifier for the synchronize setting key.- See Also:
- Constant Field Values
-
SYNC_ENABLED
public static final java.lang.String SYNC_ENABLED
Identifier for the synchronize setting key.- See Also:
- Constant Field Values
-
SYNC_SETTINGS
public static final java.lang.String SYNC_SETTINGS
Identifier for the synchronize setting key.- See Also:
- Constant Field Values
-
SYNC_VFS_LIST
public static final java.lang.String SYNC_VFS_LIST
Identifier for the synchronize setting key.- See Also:
- Constant Field Values
-
WORKPLACE_MODE_NEW
public static final java.lang.String WORKPLACE_MODE_NEW
Preference value for new workplace.- See Also:
- Constant Field Values
-
WORKPLACE_MODE_OLD
public static final java.lang.String WORKPLACE_MODE_OLD
Preference value for new workplace.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsUserSettings
public CmsUserSettings()
Creates an empty new user settings object.
-
CmsUserSettings
public CmsUserSettings(CmsObject cms)
Creates a user settings object with initialized settings of the current user.- Parameters:
cms
- the OpenCms context
-
CmsUserSettings
public CmsUserSettings(CmsUser user)
Creates a user settings object with initialized settings of the user.Some default settings will not be set, if no cms object is given.
- Parameters:
user
- the current CmsUser- See Also:
CmsUserSettings(CmsObject)
-
-
Method Detail
-
getAdditionalPreference
public static java.lang.String getAdditionalPreference(CmsObject cms, java.lang.String key, boolean useDefault)
Gets a configured preference.- Parameters:
cms
- the cms contextkey
- the settings keyuseDefault
- true if we want the default value if no value is configured- Returns:
- the preference value
-
setAdditionalPreference
public static void setAdditionalPreference(CmsObject cms, java.lang.String key, java.lang.String value)
Sets a configured preference.- Parameters:
cms
- the Cms contextkey
- the setting namevalue
- the value
-
getAdditionalPreference
public java.lang.String getAdditionalPreference(java.lang.String name, boolean useDefault)
Gets the value for a user defined preference.- Parameters:
name
- the name of the preferenceuseDefault
- true if the default value should be returned in case the preference is not set- Returns:
- the preference value
-
getDialogCopyFileMode
public CmsResource.CmsResourceCopyMode getDialogCopyFileMode()
Gets the default copy mode when copying a file of the user.- Returns:
- the default copy mode when copying a file of the user
-
getDialogCopyFolderMode
public CmsResource.CmsResourceCopyMode getDialogCopyFolderMode()
Gets the default copy mode when copying a folder of the user.- Returns:
- the default copy mode when copying a folder of the user
-
getDialogDeleteFileMode
public CmsResource.CmsResourceDeleteMode getDialogDeleteFileMode()
Returns the default setting for file deletion.- Returns:
- the default setting for file deletion
-
getDialogExpandInheritedPermissions
public boolean getDialogExpandInheritedPermissions()
Returns the default setting for expanding inherited permissions in the dialog.- Returns:
- true if inherited permissions should be expanded, otherwise false
-
getDialogExpandUserPermissions
public boolean getDialogExpandUserPermissions()
Returns the default setting for expanding the users permissions in the dialog.- Returns:
- true if the users permissions should be expanded, otherwise false
-
getDialogPermissionsInheritOnFolder
public boolean getDialogPermissionsInheritOnFolder()
Returns the default setting for inheriting permissions on folders.- Returns:
- true if permissions should be inherited on folders, otherwise false
-
getDialogPublishSiblings
public boolean getDialogPublishSiblings()
Returns the default setting for direct publishing.- Returns:
- the default setting for direct publishing: true if siblings should be published, otherwise false
-
getDialogShowExportSettings
public boolean getDialogShowExportSettings()
Determines if the export part of the secure/export dialog should be shown.- Returns:
- true if the export dialog is shown, otherwise false
-
getDialogShowLock
public boolean getDialogShowLock()
Determines if the lock dialog should be shown.- Returns:
- true if the lock dialog is shown, otherwise false
-
getDirectEditButtonStyle
public int getDirectEditButtonStyle()
Returns the style of the direct edit buttons of the user.- Returns:
- the style of the direct edit buttons of the user
-
getEditorButtonStyle
public int getEditorButtonStyle()
Returns the style of the editor buttons of the user.- Returns:
- the style of the editor buttons of the user
-
getEditorSettings
public java.util.Map<java.lang.String,java.lang.String> getEditorSettings()
Returns the editor settings of the user.- Returns:
- the editor settings of the user
-
getExplorerButtonStyle
public int getExplorerButtonStyle()
Returns the style of the explorer buttons of the user.- Returns:
- the style of the explorer buttons of the user
-
getExplorerFileEntries
public int getExplorerFileEntries()
Returns the number of displayed files per page of the user.- Returns:
- the number of displayed files per page of the user
-
getExplorerFileEntryOptions
public java.lang.String getExplorerFileEntryOptions()
Returns the explorerFileEntryOptions.- Returns:
- the explorerFileEntryOptions
-
getExplorerSettings
public int getExplorerSettings()
Returns the explorer start settings.- Returns:
- the explorer start settings
-
getListAllProjects
public boolean getListAllProjects()
Returns if all projects should be listed or only the ones in the current ou.- Returns:
- true if all projects should be listed, otherwise false
-
getLocale
public java.util.Locale getLocale()
Returns the locale of the user.- Returns:
- the locale of the user
-
getNewFolderCreateIndexPage
public java.lang.Boolean getNewFolderCreateIndexPage()
Returns
if the "create index page" check box in the new folder dialog should be initially be checked.Boolean.TRUE
- Returns:
if the "create index page" check box in the new folder dialog should be initially be checked.Boolean.TRUE
-
getNewFolderEditProperties
public java.lang.Boolean getNewFolderEditProperties()
Returns
if the "edit properties" check box in the new folder dialog should be initially be checked.Boolean.TRUE
- Returns:
if the "edit properties" check box in the new folder dialog should be initially be checked.Boolean.TRUE
-
getPreferredEditor
public java.lang.String getPreferredEditor(java.lang.String resourceType)
Returns the preferred editor for the given resource type of the user.- Parameters:
resourceType
- the resource type- Returns:
- the preferred editor for the resource type or null, if not specified
-
getPublishButtonAppearance
public java.lang.String getPublishButtonAppearance()
Returns the appearance of the "publish project" button.This can be either
CmsDefaultUserSettings.PUBLISHBUTTON_SHOW_ALWAYS
,CmsDefaultUserSettings.PUBLISHBUTTON_SHOW_AUTO
orCmsDefaultUserSettings.PUBLISHBUTTON_SHOW_NEVER
.- Returns:
- the appearance of the "publish project" button
-
getRestrictExplorerView
public boolean getRestrictExplorerView()
Sets if the explorer view is restricted to the defined site and folder.- Returns:
- true if the explorer view is restricted, otherwise false
-
getShowFileUploadButton
public boolean getShowFileUploadButton()
Returnstrue
if the file upload button should be shown orfalse
otherwise.- Returns:
- the showFileUpload
-
getShowPublishNotification
public boolean getShowPublishNotification()
Returns if the publish notifications should be shown or not.- Returns:
- true if the publish notifications should be shown, otherwise false
-
getShowUploadTypeDialog
public java.lang.Boolean getShowUploadTypeDialog()
Returns
if the resource type selection dialog should be shown in the file upload process (non - applet version).Boolean.TRUE
- Returns:
if the resource type selection dialog should be shown in the file upload process (non - applet version).Boolean.TRUE
-
getStartFolder
public java.lang.String getStartFolder()
Returns the start folder of the user.- Returns:
- the start folder of the user
-
getStartGalleriesSettings
public java.util.Map<java.lang.String,java.lang.String> getStartGalleriesSettings()
The start galleries settings of the user.- Returns:
- the start galleries settings of the user
-
getStartGallery
public java.lang.String getStartGallery(java.lang.String galleryType)
Returns the path to the start gallery of the user.- Parameters:
galleryType
- the type of the gallery- Returns:
- the path to the start gallery or null, if no key
-
getStartGallery
public java.lang.String getStartGallery(java.lang.String galleryType, CmsObject cms)
Returns the root site path to the start gallery of the user or the constant CmsPreferences.INPUT_DEFAULT.- Parameters:
galleryType
- the type of the gallerycms
- Cms object- Returns:
- the root site path to the start gallery or the default key, null if "not set"
-
getStartProject
public java.lang.String getStartProject()
Returns the start project of the user.- Returns:
- the start project of the user
-
getStartSite
public java.lang.String getStartSite()
Returns the start site of the user.- Returns:
- the start site of the user
-
getStartView
public java.lang.String getStartView()
Returns the current start view of the user.- Returns:
- the current start view of the user
-
getSynchronizeSettings
public CmsSynchronizeSettings getSynchronizeSettings()
Returns the (optional) workplace synchronize settings.- Returns:
- the (optional) workplace synchronize settings
-
getTimeWarp
public long getTimeWarp()
Returns the current users time warp time, orCmsContextInfo.CURRENT_TIME
if this feature is disabled and the current time is used for each user request.- Returns:
- the current users time warp time, or
CmsContextInfo.CURRENT_TIME
if this feature is disabled
-
getUploadAppletClientFolder
public java.lang.String getUploadAppletClientFolder()
Returns the folder path of the upload applet on the client machine.- Returns:
- the folder path of the upload applet on the client machine
-
getUploadVariant
public CmsUserSettings.UploadVariant getUploadVariant()
Returns the uploadVariant.- Returns:
- the uploadVariant
-
getWorkplaceButtonStyle
public int getWorkplaceButtonStyle()
Returns the style of the workplace buttons of the user.- Returns:
- the style of the workplace buttons of the user
-
getWorkplaceReportType
public java.lang.String getWorkplaceReportType()
Returns the type of the report (simple or extended) of the user.- Returns:
- the type of the report (simple or extended) of the user
-
getWorkplaceSearchIndexName
public java.lang.String getWorkplaceSearchIndexName()
Returns the name of the search index to use in the workplace.- Returns:
- the name of the search index to use in the workplace
-
getWorkplaceSearchViewStyle
public CmsUserSettings.CmsSearchResultStyle getWorkplaceSearchViewStyle()
Returns the workplace search result list view style.- Returns:
- the workplace search result list view style
-
init
public void init(CmsUser user)
Initializes the user settings with the given users setting parameters.- Parameters:
user
- the current CmsUser
-
save
public void save(CmsObject cms) throws CmsException
Saves the changed settings of the user to the usersCmsUser.getAdditionalInfo()
map.If the given CmsObject is
null
, the additional user infos are only updated in memory and not saved into the database.- Parameters:
cms
- the CmsObject needed to write the user to the db- Throws:
CmsException
- if user cannot be written to the db
-
setAdditionalPreference
public void setAdditionalPreference(java.lang.String name, java.lang.String value)
Sets an additional preference value.- Parameters:
name
- the additional preference namevalue
- the preference value
-
setAdditionalPreferencesFrom
public void setAdditionalPreferencesFrom(CmsUserSettings userSettings)
Sets this settings object's additional preferences to that of another one.- Parameters:
userSettings
- the user settings
-
setDialogCopyFileMode
public void setDialogCopyFileMode(CmsResource.CmsResourceCopyMode mode)
Sets the default copy mode when copying a file of the user.- Parameters:
mode
- the default copy mode when copying a file of the user
-
setDialogCopyFolderMode
public void setDialogCopyFolderMode(CmsResource.CmsResourceCopyMode mode)
Sets the default copy mode when copying a folder of the user.- Parameters:
mode
- the default copy mode when copying a folder of the user
-
setDialogDeleteFileMode
public void setDialogDeleteFileMode(CmsResource.CmsResourceDeleteMode mode)
Sets the default setting for file deletion.- Parameters:
mode
- the default setting for file deletion
-
setDialogExpandInheritedPermissions
public void setDialogExpandInheritedPermissions(boolean dialogShowInheritedPermissions)
Sets the default setting for expanding inherited permissions in the dialog.- Parameters:
dialogShowInheritedPermissions
- the default setting for expanding inherited permissions in the dialog
-
setDialogExpandUserPermissions
public void setDialogExpandUserPermissions(boolean dialogShowUserPermissions)
Sets the default setting for expanding the users permissions in the dialog.- Parameters:
dialogShowUserPermissions
- the default setting for expanding the users permissions in the dialog
-
setDialogPermissionsInheritOnFolder
public void setDialogPermissionsInheritOnFolder(boolean dialogPermissionsInheritOnFolder)
Sets the default setting for inheriting permissions on folders.- Parameters:
dialogPermissionsInheritOnFolder
- the default setting for inheriting permissions on folders
-
setDialogPublishSiblings
public void setDialogPublishSiblings(boolean publishSiblings)
Sets the default setting for direct publishing.- Parameters:
publishSiblings
- the default setting for direct publishing: true if siblings should be published, otherwise false
-
setDialogShowExportSettings
public void setDialogShowExportSettings(boolean show)
Sets if the export setting part of the secure/export dialog should be shown.- Parameters:
show
- true if the export dialog should be shown, otherwise false
-
setDialogShowLock
public void setDialogShowLock(boolean show)
Sets if the lock dialog should be shown.- Parameters:
show
- true if the lock dialog should be shown, otherwise false
-
setDirectEditButtonStyle
public void setDirectEditButtonStyle(int style)
Sets the style of the direct edit buttons of the user.- Parameters:
style
- the style of the direct edit buttons of the user
-
setEditorButtonStyle
public void setEditorButtonStyle(int style)
Sets the style of the editor buttons of the user.- Parameters:
style
- the style of the editor buttons of the user
-
setEditorSettings
public void setEditorSettings(java.util.Map<java.lang.String,java.lang.String> settings)
Sets the editor settings of the user.- Parameters:
settings
- the editor settings of the user
-
setExplorerButtonStyle
public void setExplorerButtonStyle(int style)
Sets the style of the explorer buttons of the user.- Parameters:
style
- the style of the explorer buttons of the user
-
setExplorerFileEntries
public void setExplorerFileEntries(int entries)
Sets the number of displayed files per page of the user.- Parameters:
entries
- the number of displayed files per page of the user
-
setExplorerFileEntryOptions
public void setExplorerFileEntryOptions(java.lang.String explorerFileEntryOptions)
Sets the explorerFileEntryOptions.- Parameters:
explorerFileEntryOptions
- the explorerFileEntryOptions to set
-
setExplorerSettings
public void setExplorerSettings(int settings)
Sets the explorer start settings.- Parameters:
settings
- explorer start settings to use
-
setListAllProjects
public void setListAllProjects(boolean listAllProjects)
Sets if all the projects should be shown or not.- Parameters:
listAllProjects
- true if all the projects should be shown, otherwise false
-
setLocale
public void setLocale(java.util.Locale locale)
Sets the locale of the user.- Parameters:
locale
- the locale of the user
-
setNewFolderCreateIndexPage
public void setNewFolderCreateIndexPage(java.lang.Boolean setting)
Sets if the "create index page" check box in the new folder dialog should be initially be checked or not.- Parameters:
setting
- if the "create index page" check box in the new folder dialog should be initially be checked or not.
-
setNewFolderEditPropertes
public void setNewFolderEditPropertes(java.lang.Boolean setting)
Sets if the "edit properties" check box in the new folder dialog should be initially be checked or not.- Parameters:
setting
- if the "edit properties" check box in the new folder dialog should be initially be checked or not.
-
setPreferredEditor
public void setPreferredEditor(java.lang.String resourceType, java.lang.String editorUri)
Sets the preferred editor for the given resource type of the user.- Parameters:
resourceType
- the resource typeeditorUri
- the editor URI
-
setPublishButtonAppearance
public void setPublishButtonAppearance(java.lang.String publishButtonAppearance)
Sets the appearance of the "publish project" button.Allowed values are either
CmsDefaultUserSettings.PUBLISHBUTTON_SHOW_ALWAYS
,CmsDefaultUserSettings.PUBLISHBUTTON_SHOW_AUTO
orCmsDefaultUserSettings.PUBLISHBUTTON_SHOW_NEVER
.- Parameters:
publishButtonAppearance
- the appearance of the "publish project" button
-
setRestrictExplorerView
public void setRestrictExplorerView(boolean restrict)
Sets if the explorer view is restricted to the defined site and folder.- Parameters:
restrict
- true if the explorer view is restricted, otherwise false
-
setShowExplorerFileDateCreated
public void setShowExplorerFileDateCreated(boolean show)
Sets if the file creation date should be shown in explorer view.- Parameters:
show
- true if the file creation date should be shown, otherwise false
-
setShowExplorerFileDateExpired
public void setShowExplorerFileDateExpired(boolean show)
Sets if the file expire date should be shown in explorer view.- Parameters:
show
- true if the file expire date should be shown, otherwise false
-
setShowExplorerFileDateLastModified
public void setShowExplorerFileDateLastModified(boolean show)
Sets if the file last modified date state should be shown in explorer view.- Parameters:
show
- true if the file last modified date should be shown, otherwise false
-
setShowExplorerFileDateReleased
public void setShowExplorerFileDateReleased(boolean show)
Sets if the file release date should be shown in explorer view.- Parameters:
show
- true if the file release date should be shown, otherwise false
-
setShowExplorerFileLockedBy
public void setShowExplorerFileLockedBy(boolean show)
Sets if the file locked by should be shown in explorer view.- Parameters:
show
- true if the file locked by should be shown, otherwise false
-
setShowExplorerFileNavText
public void setShowExplorerFileNavText(boolean show)
Sets if the file navtext should be shown in explorer view.- Parameters:
show
- true if the file navtext should be shown, otherwise false
-
setShowExplorerFilePermissions
public void setShowExplorerFilePermissions(boolean show)
Sets if the file permissions should be shown in explorer view.- Parameters:
show
- true if the file permissions should be shown, otherwise false
-
setShowExplorerFileSize
public void setShowExplorerFileSize(boolean show)
Sets if the file size should be shown in explorer view.- Parameters:
show
- true if the file size should be shown, otherwise false
-
setShowExplorerFileState
public void setShowExplorerFileState(boolean show)
Sets if the file state should be shown in explorer view.- Parameters:
show
- true if the state size should be shown, otherwise false
-
setShowExplorerFileTitle
public void setShowExplorerFileTitle(boolean show)
Sets if the file title should be shown in explorer view.- Parameters:
show
- true if the file title should be shown, otherwise false
-
setShowExplorerFileType
public void setShowExplorerFileType(boolean show)
Sets if the file type should be shown in explorer view.- Parameters:
show
- true if the file type should be shown, otherwise false
-
setShowExplorerFileUserCreated
public void setShowExplorerFileUserCreated(boolean show)
Sets if the file creator should be shown in explorer view.- Parameters:
show
- true if the file creator should be shown, otherwise false
-
setShowExplorerFileUserLastModified
public void setShowExplorerFileUserLastModified(boolean show)
Sets if the file last modified by should be shown in explorer view.- Parameters:
show
- true if the file last modified by should be shown, otherwise false
-
setShowFileUploadButton
public void setShowFileUploadButton(boolean flag)
Controls whether to display a file upload icon or not.- Parameters:
flag
-true
orfalse
to flag the use of the file upload button
-
setShowPublishNotification
public void setShowPublishNotification(boolean showPublishNotification)
Sets if the publish notifications should be shown or not.- Parameters:
showPublishNotification
- true if the publish notifications should be shown, otherwise false
-
setShowUploadTypeDialog
public void setShowUploadTypeDialog(java.lang.Boolean showUploadTypeDialog)
Sets if the resource type selection dialog should be shown in the file upload process (non - applet version) or not.- Parameters:
showUploadTypeDialog
- if the resource type selection dialog should be shown in the file upload process (non - applet version)
-
setStartFolder
public void setStartFolder(java.lang.String folder)
Sets the start folder of the user.- Parameters:
folder
- the start folder of the user
-
setStartGalleriesSetting
public void setStartGalleriesSetting(java.util.Map<java.lang.String,java.lang.String> settings)
Sets the start galleries settings of the user.- Parameters:
settings
- the start galleries setting of the user
-
setStartGallery
public void setStartGallery(java.lang.String galleryType, java.lang.String galleryUri)
Sets the path to the start gallery of the user or removes the entry from user settings if no path is null.- Parameters:
galleryType
- the type of the gallerygalleryUri
- the gallery URI
-
setStartProject
public void setStartProject(java.lang.String project)
Sets the start project of the user.- Parameters:
project
- the start project name of the user
-
setStartSite
public void setStartSite(java.lang.String site)
Sets the start site of the user.- Parameters:
site
- the start site of the user
-
setStartView
public void setStartView(java.lang.String view)
Sets the current start view of the user.- Parameters:
view
- the current start view of the user
-
setSynchronizeSettings
public void setSynchronizeSettings(CmsSynchronizeSettings synchronizeSettings)
Sets the (optional) workplace synchronize settings.- Parameters:
synchronizeSettings
- the (optional) workplace synchronize settings to set
-
setTimeWarp
public void setTimeWarp(long timewarp)
Sets the user specific custom "time warp" time.Use
CmsContextInfo.CURRENT_TIME
to disable this feature, ie. enable the current time for each new request.If this value is set, auto time warping will be disabled: Clicking on a resource that has not been released at the given time or is already expired at the given time will not be shown - an error message will pop up ("out of time window").
- Parameters:
timewarp
- the time warp time to set
-
setUploadAppletClientFolder
public void setUploadAppletClientFolder(java.lang.String uploadAppletClientFolder)
Sets the folder path of the upload applet on the client machine.- Parameters:
uploadAppletClientFolder
- the folder path of the upload applet on the client machine
-
setUploadVariant
public void setUploadVariant(java.lang.String uploadVariant)
Sets the upload variant.- Parameters:
uploadVariant
- the upload variant as String
-
setUploadVariant
public void setUploadVariant(CmsUserSettings.UploadVariant uploadVariant)
Sets the upload variant.- Parameters:
uploadVariant
- the upload variant
-
setUser
public void setUser(CmsUser user)
Sets the current user for the settings.- Parameters:
user
- the CmsUser
-
setWorkplaceButtonStyle
public void setWorkplaceButtonStyle(int style)
Sets the style of the workplace buttons of the user.- Parameters:
style
- the style of the workplace buttons of the user
-
setWorkplaceReportType
public void setWorkplaceReportType(java.lang.String type)
Sets the type of the report (simple or extended) of the user.- Parameters:
type
- the type of the report (simple or extended) of the user
-
setWorkplaceSearchIndexName
public void setWorkplaceSearchIndexName(java.lang.String workplaceSearchIndexName)
Sets the name of the search index to use in the workplace.- Parameters:
workplaceSearchIndexName
- the name of the search index to use in the workplace to set
-
setWorkplaceSearchViewStyle
public void setWorkplaceSearchViewStyle(CmsUserSettings.CmsSearchResultStyle workplaceSearchViewStyle)
Sets the workplace search result list view style.- Parameters:
workplaceSearchViewStyle
- the workplace search result list view style to set
-
showExplorerFileDateCreated
public boolean showExplorerFileDateCreated()
Determines if the file creation date should be shown in explorer view.- Returns:
- true if the file creation date should be shown, otherwise false
-
showExplorerFileDateExpired
public boolean showExplorerFileDateExpired()
Determines if the file date expired should be shown in explorer view.- Returns:
- true if the file date expired should be shown, otherwise false
-
showExplorerFileDateLastModified
public boolean showExplorerFileDateLastModified()
Determines if the file last modified date should be shown in explorer view.- Returns:
- true if the file last modified date should be shown, otherwise false
-
showExplorerFileDateReleased
public boolean showExplorerFileDateReleased()
Determines if the file date released should be shown in explorer view.- Returns:
- true if the file date released should be shown, otherwise false
-
showExplorerFileLockedBy
public boolean showExplorerFileLockedBy()
Determines if the file locked by should be shown in explorer view.- Returns:
- true if the file locked by should be shown, otherwise false
-
showExplorerFileNavText
public boolean showExplorerFileNavText()
Determines if the file navigation text should be shown in explorer view.- Returns:
- true if the file navigation text should be shown, otherwise false
-
showExplorerFilePermissions
public boolean showExplorerFilePermissions()
Determines if the file permissions should be shown in explorer view.- Returns:
- true if the file permissions should be shown, otherwise false
-
showExplorerFileSize
public boolean showExplorerFileSize()
Determines if the file size should be shown in explorer view.- Returns:
- true if the file size should be shown, otherwise false
-
showExplorerFileState
public boolean showExplorerFileState()
Determines if the file state should be shown in explorer view.- Returns:
- true if the file state should be shown, otherwise false
-
showExplorerFileTitle
public boolean showExplorerFileTitle()
Determines if the file title should be shown in explorer view.- Returns:
- true if the file title should be shown, otherwise false
-
showExplorerFileType
public boolean showExplorerFileType()
Determines if the file type should be shown in explorer view.- Returns:
- true if the file type should be shown, otherwise false
-
showExplorerFileUserCreated
public boolean showExplorerFileUserCreated()
Determines if the file creator should be shown in explorer view.- Returns:
- true if the file creator should be shown, otherwise false
-
showExplorerFileUserLastModified
public boolean showExplorerFileUserLastModified()
Determines if the file last modified by should be shown in explorer view.- Returns:
- true if the file last modified by should be shown, otherwise false
-
-