org.opencms.configuration

Class CmsDefaultUserSettings

java.lang.Object

org.opencms.db.CmsUserSettings

org.opencms.configuration.CmsDefaultUserSettings

public class CmsDefaultUserSettings
extends CmsUserSettings

Default user workplace settings, used as default values for worklace settings in the user preferences.

Since:

6.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CmsDefaultUserSettings.CmsPublishRelatedResourcesMode Enumeration class for defining the publish related resources mode.
static class	CmsDefaultUserSettings.SubsitemapCreationMode Enum for the subsitemap creation mode.

Nested classes/interfaces inherited from class org.opencms.db.CmsUserSettings

CmsUserSettings.CmsSearchResultStyle, CmsUserSettings.UploadVariant

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List<java.lang.String>	BUTTON_STYLES_LIST Array list for fast lookup of "button styles".
static CmsDefaultUserSettings	CURRENT_DEFAULT_SETTINGS The current default user settings.
static CmsDefaultUserSettings.CmsPublishRelatedResourcesMode	PUBLISH_RELATED_RESOURCES_MODE_FALSE Constant for the publish related resources mode, checkbox disabled by default.
static CmsDefaultUserSettings.CmsPublishRelatedResourcesMode	PUBLISH_RELATED_RESOURCES_MODE_FORCE Constant for the publish related resources mode, only CmsRole.VFS_MANAGERs may publish resources without publishing the related resources.
static CmsDefaultUserSettings.CmsPublishRelatedResourcesMode	PUBLISH_RELATED_RESOURCES_MODE_TRUE Constant for the publish related resources mode, checkbox enabled by default.
static java.lang.String	PUBLISHBUTTON_SHOW_ALWAYS Publish button appearance: show always.
static java.lang.String	PUBLISHBUTTON_SHOW_AUTO Publish button appearance: show auto (only if user has publish permissions).
static java.lang.String	PUBLISHBUTTON_SHOW_NEVER Publish button appearance: show never.

Fields inherited from class org.opencms.db.CmsUserSettings

ADDITIONAL_INFO_ADDRESS, ADDITIONAL_INFO_CITY, ADDITIONAL_INFO_CONFIRMED_RESOURCES, ADDITIONAL_INFO_COUNTRY, ADDITIONAL_INFO_DEFAULTGROUP, ADDITIONAL_INFO_DESCRIPTION, ADDITIONAL_INFO_EXPLORERSETTINGS, ADDITIONAL_INFO_INSTITUTION, ADDITIONAL_INFO_LAST_PASSWORD_CHANGE, ADDITIONAL_INFO_LAST_USER_DATA_CHECK, ADDITIONAL_INFO_PASSWORD_RESET, ADDITIONAL_INFO_PREFERENCES, ADDITIONAL_INFO_STARTSETTINGS, ADDITIONAL_INFO_TIMEWARP, ADDITIONAL_INFO_UPLOADAPPLET_CLIENTFOLDER, ADDITIONAL_INFO_ZIPCODE, FILELIST_DATE_CREATED, FILELIST_DATE_EXPIRED, FILELIST_DATE_LASTMODIFIED, FILELIST_DATE_RELEASED, FILELIST_LOCKEDBY, FILELIST_NAME, FILELIST_NAVTEXT, FILELIST_PERMISSIONS, FILELIST_SIZE, FILELIST_STATE, FILELIST_TITLE, FILELIST_TYPE, FILELIST_USER_CREATED, FILELIST_USER_LASTMODIFIED, LOGIN_USERAGREEMENT_ACCEPTED, PREF_WORKPLACE_MODE, PREFERENCES, PREFERENCES_ADDITIONAL_PREFIX, SYNC_DESTINATION, SYNC_ENABLED, SYNC_SETTINGS, SYNC_VFS_LIST, WORKPLACE_MODE_NEW, WORKPLACE_MODE_OLD

Constructor Summary

Constructors

Constructor and Description
CmsDefaultUserSettings()

Method Summary

Modifier and Type	Method and Description
void	addPreference(java.lang.String name, java.lang.String value, java.lang.String widget, java.lang.String widgetConfig, java.lang.String niceName, java.lang.String description, java.lang.String ruleRegex, java.lang.String error, java.lang.String tab) Adds a preference.
java.lang.String	getDialogCopyFileModeString() Gets the default copy mode when copying a file of the user.
java.lang.String	getDialogCopyFolderModeString() Gets the default copy mode when copying a folder of the user.
java.lang.String	getDialogDeleteFileModeString() Returns the default setting for file deletion.
java.lang.String	getDialogExpandInheritedPermissionsString() Returns the default setting for expanding inherited permissions in the dialog.
java.lang.String	getDialogExpandUserPermissionsString() Returns the default setting for expanding the users permissions in the dialog.
java.lang.String	getDialogPermissionsInheritOnFolderString() Returns the default setting for inheriting permissions on folders.
java.lang.String	getDialogPublishSiblingsString() Returns the default setting for direct publishing.
java.lang.String	getDialogShowExportSettingsString() Determines if the export settings part of the secure/export dialog should be shown.
java.lang.String	getDialogShowLockString() Determines if the lock dialog should be shown.
java.lang.String	getDirectEditButtonStyleString() Returns a string representation of the direct edit button style.
java.lang.String	getEditorButtonStyleString() Returns a string representation of the editor button style.
java.lang.String	getExplorerButtonStyleString() Returns a string representation of the explorer button style.
java.lang.String	getListAllProjectsString() Returns a string representation of the list all projects flag.
java.util.Map<java.lang.String,I_CmsPreference>	getPreferences() Gets the map of preferences.
CmsDefaultUserSettings.CmsPublishRelatedResourcesMode	getPublishRelatedResources() Returns the publish related resources mode.
java.lang.String	getRestrictExplorerViewString() Returns if the explorer view is restricted to the defined site and folder.
java.lang.String	getShowExplorerFileDateCreated() Gets if the file creation date should be shown in explorer view.
java.lang.String	getShowExplorerFileDateExpired() Gets if the file expired by should be shown in explorer view.
java.lang.String	getShowExplorerFileDateLastModified() Gets if the file last modified date should be shown in explorer view.
java.lang.String	getShowExplorerFileDateReleased() Gets if the file released by should be shown in explorer view.
java.lang.String	getShowExplorerFileLockedBy() Gets if the file locked by should be shown in explorer view.
java.lang.String	getShowExplorerFileNavText() Gets if the file navtext should be shown in explorer view.
java.lang.String	getShowExplorerFilePermissions() Gets if the file permissions should be shown in explorer view.
java.lang.String	getShowExplorerFileSize() Gets if the file size should be shown in explorer view.
java.lang.String	getShowExplorerFileState() Gets if the file state should be shown in explorer view.
java.lang.String	getShowExplorerFileTitle() Gets if the file title should be shown in explorer view.
java.lang.String	getShowExplorerFileType() Gets if the file type should be shown in explorer view.
java.lang.String	getShowExplorerFileUserCreated() Gets if the file creator should be shown in explorer view.
java.lang.String	getShowExplorerFileUserLastModified() Gets if the file last modified by should be shown in explorer view.
java.lang.String	getShowFileUploadButtonString() Returns a string representation of the show file upload button flag.
java.lang.String	getShowPublishNotificationString() Returns a string representation of the publish notification flag.
CmsDefaultUserSettings.SubsitemapCreationMode	getSubsitemapCreationMode() Gets the subsitemap creation mode to use for the sitemap editor.
CmsDefaultUserSettings.SubsitemapCreationMode	getSubsitemapCreationMode(CmsDefaultUserSettings.SubsitemapCreationMode defaultValue) Gets the subsitemap creation mode, or returns a default value given as a parameter if the mode is not set.
java.lang.String	getWorkplaceButtonStyleString() Returns a string representation of the workplace button style.
void	initPreferences(CmsWorkplaceManager wpManager) Initializes the preference configuration.
boolean	isAllowBrokenRelations() Returns if the deletion of relation targets is enabled.
void	setAllowBrokenRelations(java.lang.String allowBrokenRelations) Sets if the deletion of relation targets is enabled.
void	setDialogCopyFileMode(java.lang.String mode) Sets the default copy mode when copying a file of the user.
void	setDialogCopyFolderMode(java.lang.String mode) Sets the default copy mode when copying a folder of the user.
void	setDialogDeleteFileMode(java.lang.String mode) Sets the default setting for file deletion.
void	setDialogExpandInheritedPermissions(java.lang.String dialogExpandInheritedPermissions) Sets the default setting for expanding inherited permissions in the dialog.
void	setDialogExpandUserPermissions(java.lang.String dialogExpandUserPermissions) Sets the default setting for expanding the users permissions in the dialog.
void	setDialogPermissionsInheritOnFolder(java.lang.String dialogPermissionsInheritOnFolder) Sets the default setting for inheriting permissions on folders.
void	setDialogPublishSiblings(java.lang.String mode) Sets the default setting for direct publishing.
void	setDirectEditButtonStyle(java.lang.String buttonstyle) Sets the style of the direct edit buttons of the user.
void	setEditorButtonStyle(java.lang.String buttonstyle) Sets the style of the editor buttons of the user.
void	setExplorerButtonStyle(java.lang.String buttonstyle) Sets the style of the explorer workplace buttons of the user.
void	setExplorerFileEntries(java.lang.String entries) Sets the number of displayed files per page of the user.
void	setListAllProjects(java.lang.String listAllProjects) Sets if all projects should be shown for the user.
void	setLocale(java.lang.String locale) Sets the workplace locale.
void	setNewFolderCreateIndexPage(java.lang.String booleanValue) Digester support method for configuration if the "create index page" checkbox in the new folder dialog should be initially be checked or not.
void	setNewFolderEditProperties(java.lang.String booleanValue) Digester support method for configuration if the "edit properties" checkbox in the new folder dialog should be initially be checked or not.
void	setPublishRelatedResourcesMode(java.lang.String publishRelatedResourcesMode) Sets the publish related resources mode.
void	setRestrictExplorerView(java.lang.String restrict) Sets if the explorer view is restricted to the defined site and folder.
void	setShowExplorerFileDateCreated(java.lang.String show) Sets if the file creation date should be shown in explorer view.
void	setShowExplorerFileDateExpired(java.lang.String show) Sets if the file expire date should be shown in explorer view.
void	setShowExplorerFileDateLastModified(java.lang.String show) Sets if the file last modified date should be shown in explorer view.
void	setShowExplorerFileDateReleased(java.lang.String show) Sets if the file release date should be shown in explorer view.
void	setShowExplorerFileLockedBy(java.lang.String show) Sets if the file locked by should be shown in explorer view.
void	setShowExplorerFileNavText(java.lang.String show) Sets if the file navtext should be shown in explorer view.
void	setShowExplorerFilePermissions(java.lang.String show) Sets if the file permissions should be shown in explorer view.
void	setShowExplorerFileSize(java.lang.String show) Sets if the file size should be shown in explorer view.
void	setShowExplorerFileState(java.lang.String show) Sets if the file state should be shown in explorer view.
void	setShowExplorerFileTitle(java.lang.String show) Sets if the file title should be shown in explorer view.
void	setShowExplorerFileType(java.lang.String show) Sets if the file type should be shown in explorer view.
void	setShowExplorerFileUserCreated(java.lang.String show) Sets if the file creator should be shown in explorer view.
void	setShowExplorerFileUserLastModified(java.lang.String show) Sets if the file last modified by should be shown in explorer view.
void	setShowExportSettingsDialog(java.lang.String mode) Sets if the export part of the secure/export dialog should be shown.
void	setShowFileUploadButton(java.lang.String flag) Controls whether to display a file upload icon or not.
void	setShowLockDialog(java.lang.String mode) Sets if the lock dialog should be shown.
void	setShowPublishNotification(java.lang.String notification) Sets if the publish notification should be shown for the user.
void	setShowUploadTypeDialog(java.lang.String booleanValue) Digester support method for configuration if the resource type selection checkbox should show up when uploading a new file in non-applet mode.
void	setSubsitemapCreationMode(java.lang.String mode) Sets the subsitemap creation mode.
void	setWorkplaceButtonStyle(java.lang.String buttonstyle) Sets the style of the workplace buttons of the user.
void	setWorkplaceSearchViewStyle(java.lang.String viewStyle) Sets the style of the workplace search default view.

Methods inherited from class org.opencms.db.CmsUserSettings

getAdditionalPreference, getAdditionalPreference, getDialogCopyFileMode, getDialogCopyFolderMode, getDialogDeleteFileMode, getDialogExpandInheritedPermissions, getDialogExpandUserPermissions, getDialogPermissionsInheritOnFolder, getDialogPublishSiblings, getDialogShowExportSettings, getDialogShowLock, getDirectEditButtonStyle, getEditorButtonStyle, getEditorSettings, getExplorerButtonStyle, getExplorerFileEntries, getExplorerFileEntryOptions, getExplorerSettings, getListAllProjects, getLocale, getNewFolderCreateIndexPage, getNewFolderEditProperties, getPreferredEditor, getPublishButtonAppearance, getRestrictExplorerView, getShowFileUploadButton, getShowPublishNotification, getShowUploadTypeDialog, getStartFolder, getStartGalleriesSettings, getStartGallery, getStartGallery, getStartProject, getStartSite, getStartView, getSynchronizeSettings, getTimeWarp, getUploadAppletClientFolder, getUploadVariant, getUser, getWorkplaceButtonStyle, getWorkplaceReportType, getWorkplaceSearchIndexName, getWorkplaceSearchViewStyle, init, save, setAdditionalPreference, setAdditionalPreference, setAdditionalPreferencesFrom, setDialogCopyFileMode, setDialogCopyFolderMode, setDialogDeleteFileMode, setDialogExpandInheritedPermissions, setDialogExpandUserPermissions, setDialogPermissionsInheritOnFolder, setDialogPublishSiblings, setDialogShowExportSettings, setDialogShowLock, setDirectEditButtonStyle, setEditorButtonStyle, setEditorSettings, setExplorerButtonStyle, setExplorerFileEntries, setExplorerFileEntryOptions, setExplorerSettings, setListAllProjects, setLocale, setNewFolderCreateIndexPage, setNewFolderEditPropertes, setPreferredEditor, setPublishButtonAppearance, setRestrictExplorerView, setShowExplorerFileDateCreated, setShowExplorerFileDateExpired, setShowExplorerFileDateLastModified, setShowExplorerFileDateReleased, setShowExplorerFileLockedBy, setShowExplorerFileNavText, setShowExplorerFilePermissions, setShowExplorerFileSize, setShowExplorerFileState, setShowExplorerFileTitle, setShowExplorerFileType, setShowExplorerFileUserCreated, setShowExplorerFileUserLastModified, setShowFileUploadButton, setShowPublishNotification, setShowUploadTypeDialog, setStartFolder, setStartGalleriesSetting, setStartGallery, setStartProject, setStartSite, setStartView, setSynchronizeSettings, setTimeWarp, setUploadAppletClientFolder, setUploadVariant, setUploadVariant, setUser, setWorkplaceButtonStyle, setWorkplaceReportType, setWorkplaceSearchIndexName, setWorkplaceSearchViewStyle, showExplorerFileDateCreated, showExplorerFileDateExpired, showExplorerFileDateLastModified, showExplorerFileDateReleased, showExplorerFileLockedBy, showExplorerFileNavText, showExplorerFilePermissions, showExplorerFileSize, showExplorerFileState, showExplorerFileTitle, showExplorerFileType, showExplorerFileUserCreated, showExplorerFileUserLastModified

Methods inherited from class java.lang.Object

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

Field Detail

CURRENT_DEFAULT_SETTINGS

public static CmsDefaultUserSettings CURRENT_DEFAULT_SETTINGS

The current default user settings.

PUBLISH_RELATED_RESOURCES_MODE_FALSE

public static final CmsDefaultUserSettings.CmsPublishRelatedResourcesMode PUBLISH_RELATED_RESOURCES_MODE_FALSE

Constant for the publish related resources mode, checkbox disabled by default.

PUBLISH_RELATED_RESOURCES_MODE_FORCE

public static final CmsDefaultUserSettings.CmsPublishRelatedResourcesMode PUBLISH_RELATED_RESOURCES_MODE_FORCE

Constant for the publish related resources mode, only CmsRole.VFS_MANAGERs may publish resources without publishing the related resources.

PUBLISH_RELATED_RESOURCES_MODE_TRUE

public static final CmsDefaultUserSettings.CmsPublishRelatedResourcesMode PUBLISH_RELATED_RESOURCES_MODE_TRUE

Constant for the publish related resources mode, checkbox enabled by default.

PUBLISHBUTTON_SHOW_ALWAYS

public static final java.lang.String PUBLISHBUTTON_SHOW_ALWAYS

Publish button appearance: show always.

See Also:

Constant Field Values

PUBLISHBUTTON_SHOW_AUTO

public static final java.lang.String PUBLISHBUTTON_SHOW_AUTO

Publish button appearance: show auto (only if user has publish permissions).

See Also:

Constant Field Values

PUBLISHBUTTON_SHOW_NEVER

public static final java.lang.String PUBLISHBUTTON_SHOW_NEVER

Publish button appearance: show never.

See Also:

Constant Field Values

BUTTON_STYLES_LIST

public static final java.util.List<java.lang.String> BUTTON_STYLES_LIST

Array list for fast lookup of "button styles".

Constructor Detail

CmsDefaultUserSettings

public CmsDefaultUserSettings()

Method Detail

addPreference

public void addPreference(java.lang.String name,
                          java.lang.String value,
                          java.lang.String widget,
                          java.lang.String widgetConfig,
                          java.lang.String niceName,
                          java.lang.String description,
                          java.lang.String ruleRegex,
                          java.lang.String error,
                          java.lang.String tab)

Adds a preference.

Parameters:

name - the name of the preference

value - the default value

widget - the widget to use for the preference

widgetConfig - the widget configuration

niceName - the nice name of the preference

description - the description of the preference

ruleRegex - the regex used for validation

error - the validation error message

tab - the tab to display the preference on

getDialogCopyFileModeString

public java.lang.String getDialogCopyFileModeString()

Gets the default copy mode when copying a file of the user.

Returns:

the default copy mode when copying a file of the user

getDialogCopyFolderModeString

public java.lang.String getDialogCopyFolderModeString()

Gets the default copy mode when copying a folder of the user.

Returns:

the default copy mode when copying a folder of the user

getDialogDeleteFileModeString

public java.lang.String getDialogDeleteFileModeString()

Returns the default setting for file deletion.

Returns:

the default setting for file deletion

getDialogExpandInheritedPermissionsString

public java.lang.String getDialogExpandInheritedPermissionsString()

Returns the default setting for expanding inherited permissions in the dialog.

Returns:

true if inherited permissions should be expanded, otherwise false

See Also:

CmsUserSettings.getDialogExpandInheritedPermissions()

getDialogExpandUserPermissionsString

public java.lang.String getDialogExpandUserPermissionsString()

Returns the default setting for expanding the users permissions in the dialog.

Returns:

true if the users permissions should be expanded, otherwise false

See Also:

CmsUserSettings.getDialogExpandUserPermissions()

getDialogPermissionsInheritOnFolderString

public java.lang.String getDialogPermissionsInheritOnFolderString()

Returns the default setting for inheriting permissions on folders.

Returns:

true if permissions should be inherited on folders, otherwise false

getDialogPublishSiblingsString

public java.lang.String getDialogPublishSiblingsString()

Returns the default setting for direct publishing.

Returns:

the default setting for direct publishing

getDialogShowExportSettingsString

public java.lang.String getDialogShowExportSettingsString()

Determines if the export settings part of the secure/export dialog should be shown.

Returns:

true if the export dialog is shown, otherwise false

getDialogShowLockString

public java.lang.String getDialogShowLockString()

Determines if the lock dialog should be shown.

Returns:

true if the lock dialog is shown, otherwise false

getDirectEditButtonStyleString

public java.lang.String getDirectEditButtonStyleString()

Returns a string representation of the direct edit button style.

Returns:

string representation of the direct edit button style

getEditorButtonStyleString

public java.lang.String getEditorButtonStyleString()

Returns a string representation of the editor button style.

Returns:

string representation of the editor button style

getExplorerButtonStyleString

public java.lang.String getExplorerButtonStyleString()

Returns a string representation of the explorer button style.

Returns:

string representation of the explorer button style

getListAllProjectsString

public java.lang.String getListAllProjectsString()

Returns a string representation of the list all projects flag.

Returns:

string representation of the list all projects flag

See Also:

CmsUserSettings.getListAllProjects()

getPreferences

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

Gets the map of preferences.

Returns:

the map of preferences

getPublishRelatedResources

public CmsDefaultUserSettings.CmsPublishRelatedResourcesMode getPublishRelatedResources()

Returns the publish related resources mode.

Returns:

the publish related resources mode

getRestrictExplorerViewString

public java.lang.String getRestrictExplorerViewString()

Returns if the explorer view is restricted to the defined site and folder.

Returns:

true if the explorer view is restricted, otherwise false

getShowExplorerFileDateCreated

public java.lang.String getShowExplorerFileDateCreated()

Gets if the file creation date should be shown in explorer view.

Returns:

"true" if the file creation date should be shown, otherwise "false"

getShowExplorerFileDateExpired

public java.lang.String getShowExplorerFileDateExpired()

Gets if the file expired by should be shown in explorer view.

Returns:

"true" if the file date expired by should be shown, otherwise "false"

getShowExplorerFileDateLastModified

public java.lang.String getShowExplorerFileDateLastModified()

Gets 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"

getShowExplorerFileDateReleased

public java.lang.String getShowExplorerFileDateReleased()

Gets if the file released by should be shown in explorer view.

Returns:

"true" if the file date released by should be shown, otherwise "false"

getShowExplorerFileLockedBy

public java.lang.String getShowExplorerFileLockedBy()

Gets if the file locked by should be shown in explorer view.

Returns:

"true" if the file locked by should be shown, otherwise "false"

getShowExplorerFileNavText

public java.lang.String getShowExplorerFileNavText()

Gets if the file navtext should be shown in explorer view.

Returns:

"true" if the file navtext should be shown, otherwise "false"

getShowExplorerFilePermissions

public java.lang.String getShowExplorerFilePermissions()

Gets if the file permissions should be shown in explorer view.

Returns:

"true" if the file permissions should be shown, otherwise "false"

getShowExplorerFileSize

public java.lang.String getShowExplorerFileSize()

Gets if the file size should be shown in explorer view.

Returns:

"true" if the file size should be shown, otherwise "false"

getShowExplorerFileState

public java.lang.String getShowExplorerFileState()

Gets if the file state should be shown in explorer view.

Returns:

"true" if the file state should be shown, otherwise "false"

getShowExplorerFileTitle

public java.lang.String getShowExplorerFileTitle()

Gets if the file title should be shown in explorer view.

Returns:

"true" if the file title should be shown, otherwise "false"

getShowExplorerFileType

public java.lang.String getShowExplorerFileType()

Gets if the file type should be shown in explorer view.

Returns:

"true" if the file type should be shown, otherwise "false"

getShowExplorerFileUserCreated

public java.lang.String getShowExplorerFileUserCreated()

Gets if the file creator should be shown in explorer view.

Returns:

"true" if the file creator should be shown, otherwise "false"

getShowExplorerFileUserLastModified

public java.lang.String getShowExplorerFileUserLastModified()

Gets 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"

getShowFileUploadButtonString

public java.lang.String getShowFileUploadButtonString()

Returns a string representation of the show file upload button flag.

Returns:

string representation of the show file upload button flag

See Also:

CmsUserSettings.getShowFileUploadButton()

getShowPublishNotificationString

public java.lang.String getShowPublishNotificationString()

Returns a string representation of the publish notification flag.

Returns:

string representation of the publish notification flag

See Also:

CmsUserSettings.getShowPublishNotification()

getSubsitemapCreationMode

public CmsDefaultUserSettings.SubsitemapCreationMode getSubsitemapCreationMode()

Gets the subsitemap creation mode to use for the sitemap editor.

Returns:

the subsitemap creation mode to use for the sitemap editor

getSubsitemapCreationMode

public CmsDefaultUserSettings.SubsitemapCreationMode getSubsitemapCreationMode(CmsDefaultUserSettings.SubsitemapCreationMode defaultValue)

Gets the subsitemap creation mode, or returns a default value given as a parameter if the mode is not set.

Parameters:

defaultValue - the value to return when the subsitemap creation mode is not set

Returns:

the subsitemap creation mode

getWorkplaceButtonStyleString

public java.lang.String getWorkplaceButtonStyleString()

Returns a string representation of the workplace button style.

Returns:

string representation of the workplace button style

See Also:

CmsUserSettings.getWorkplaceButtonStyle()

initPreferences

public void initPreferences(CmsWorkplaceManager wpManager)

Initializes the preference configuration.

Note that this method should only be called once the resource types have been initialized, but after addPreference has been called for all configured preferences.

Parameters:

wpManager - the active workplace manager

isAllowBrokenRelations

public boolean isAllowBrokenRelations()

Returns if the deletion of relation targets is enabled.

Returns:

true if the deletion of relation targets is enabled, otherwise false

setAllowBrokenRelations

public void setAllowBrokenRelations(java.lang.String allowBrokenRelations)

Sets if the deletion of relation targets is enabled.

Parameters:

allowBrokenRelations - true if relation deletion should be enabled, otherwise false

setDialogCopyFileMode

public void setDialogCopyFileMode(java.lang.String 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(java.lang.String 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(java.lang.String mode)

Sets the default setting for file deletion.

Parameters:

mode - the default setting for file deletion

setDialogExpandInheritedPermissions

public void setDialogExpandInheritedPermissions(java.lang.String dialogExpandInheritedPermissions)

Sets the default setting for expanding inherited permissions in the dialog.

Parameters:

dialogExpandInheritedPermissions - the default setting for expanding inherited permissions in the dialog

setDialogExpandUserPermissions

public void setDialogExpandUserPermissions(java.lang.String dialogExpandUserPermissions)

Sets the default setting for expanding the users permissions in the dialog.

Parameters:

dialogExpandUserPermissions - the default setting for expanding the users permissions in the dialog

setDialogPermissionsInheritOnFolder

public void setDialogPermissionsInheritOnFolder(java.lang.String dialogPermissionsInheritOnFolder)

Sets the default setting for inheriting permissions on folders.

Parameters:

dialogPermissionsInheritOnFolder - the default setting for inheriting permissions on folders

setDialogPublishSiblings

public void setDialogPublishSiblings(java.lang.String mode)

Sets the default setting for direct publishing.

Parameters:

mode - the default setting for direct publishing

setDirectEditButtonStyle

public void setDirectEditButtonStyle(java.lang.String buttonstyle)

Sets the style of the direct edit buttons of the user.

Parameters:

buttonstyle - the style of the direct edit buttons of the user

setEditorButtonStyle

public void setEditorButtonStyle(java.lang.String buttonstyle)

Sets the style of the editor buttons of the user.

Parameters:

buttonstyle - the style of the editor buttons of the user

setExplorerButtonStyle

public void setExplorerButtonStyle(java.lang.String buttonstyle)

Sets the style of the explorer workplace buttons of the user.

Parameters:

buttonstyle - the style of the explorer workplace buttons of the user

setExplorerFileEntries

public void setExplorerFileEntries(java.lang.String entries)

Sets the number of displayed files per page of the user.

Parameters:

entries - the number of displayed files per page of the user

setListAllProjects

public void setListAllProjects(java.lang.String listAllProjects)

Sets if all projects should be shown for the user.

Parameters:

listAllProjects - "true" or "false"

setLocale

public void setLocale(java.lang.String locale)

Sets the workplace locale.

Parameters:

locale - the workplace language default

setNewFolderCreateIndexPage

public void setNewFolderCreateIndexPage(java.lang.String booleanValue)

Digester support method for configuration if the "create index page" checkbox in the new folder dialog should be initially be checked or not.

The given String value is interpreted as a Boolean by the means of Boolean.valueOf(String).

Parameters:

booleanValue - a String that is interpred as a Boolean by the means of Boolean.valueOf(String)

setNewFolderEditProperties

public void setNewFolderEditProperties(java.lang.String booleanValue)

Digester support method for configuration if the "edit properties" checkbox in the new folder dialog should be initially be checked or not.

The given String value is interpreted as a Boolean by the means of Boolean.valueOf(String).

Parameters:

booleanValue - a String that is interpreted as a Boolean by the means of Boolean.valueOf(String)

setPublishRelatedResourcesMode

public void setPublishRelatedResourcesMode(java.lang.String publishRelatedResourcesMode)

Sets the publish related resources mode.

Parameters:

publishRelatedResourcesMode - the publish related resources mode to set

setRestrictExplorerView

public void setRestrictExplorerView(java.lang.String 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(java.lang.String 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(java.lang.String 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(java.lang.String show)

Sets if the file last modified date should be shown in explorer view.

Parameters:

show - true if the file last modified date should be shown, otherwise false

setShowExplorerFileDateReleased

public void setShowExplorerFileDateReleased(java.lang.String 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(java.lang.String 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(java.lang.String show)

Sets if the file navtext should be shown in explorer view.

Parameters:

show - true if the file locked by should be shown, otherwise false

setShowExplorerFilePermissions

public void setShowExplorerFilePermissions(java.lang.String 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(java.lang.String 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(java.lang.String 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(java.lang.String 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(java.lang.String 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(java.lang.String 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(java.lang.String 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

setShowExportSettingsDialog

public void setShowExportSettingsDialog(java.lang.String mode)

Sets if the export part of the secure/export dialog should be shown.

Parameters:

mode - true if the export dialog should be shown, otherwise false

setShowFileUploadButton

public void setShowFileUploadButton(java.lang.String flag)

Controls whether to display a file upload icon or not.

Parameters:

flag - "true" or "false" to flag the use of the file upload button

setShowLockDialog

public void setShowLockDialog(java.lang.String mode)

Sets if the lock dialog should be shown.

Parameters:

mode - true if the lock dialog should be shown, otherwise false

setShowPublishNotification

public void setShowPublishNotification(java.lang.String notification)

Sets if the publish notification should be shown for the user.

Parameters:

notification - "true" or "false" to flag the notification

setShowUploadTypeDialog

public void setShowUploadTypeDialog(java.lang.String booleanValue)

Digester support method for configuration if the resource type selection checkbox should show up when uploading a new file in non-applet mode.

The given String value is interpreted as a Boolean by the means of Boolean.valueOf(String).

Parameters:

booleanValue - a String that is interpreted as a Boolean by the means of Boolean.valueOf(String)

setSubsitemapCreationMode

public void setSubsitemapCreationMode(java.lang.String mode)

Sets the subsitemap creation mode.

Parameters:

mode - the string value of the subsitemap creation mode

setWorkplaceButtonStyle

public void setWorkplaceButtonStyle(java.lang.String buttonstyle)

Sets the style of the workplace buttons of the user.

Parameters:

buttonstyle - the style of the workplace buttons of the user

setWorkplaceSearchViewStyle

public void setWorkplaceSearchViewStyle(java.lang.String viewStyle)

Sets the style of the workplace search default view.

Parameters:

viewStyle - the style of the workplace search default view