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

Version:

$Revision: 1.16 $

Author:

Michael Emmerich, Andreas Zahner

Field Summary

static String[]	BUTTON_STYLES Array of the possible "button styles".
static List	BUTTON_STYLES_LIST Array list for fast lookup of "button styles".
static String[]	FILTER_NAMES Array of the "task startupfilter" nicenames.
static List	FILTER_NAMES_LIST Array list for fast lookup of "task startupfilter" nicenames.
static String[]	FILTER_VALUES Array of the "task startupfilter" values.
static List	FILTER_VALUES_LIST Array list for fast lookup of "task startupfilter" values.

Fields inherited from class org.opencms.db.CmsUserSettings

ADDITIONAL_INFO_CONFIRMED_RESOURCES, ADDITIONAL_INFO_COUNTRY, ADDITIONAL_INFO_DEFAULTGROUP, ADDITIONAL_INFO_EXPLORERSETTINGS, ADDITIONAL_INFO_PREFERENCES, ADDITIONAL_INFO_STARTSETTINGS, ADDITIONAL_INFO_TOWN, ADDITIONAL_INFO_ZIPCODE, FILELIST_DATE_CREATED, FILELIST_DATE_EXPIRED, FILELIST_DATE_LASTMODIFIED, FILELIST_DATE_RELEASED, FILELIST_LOCKEDBY, FILELIST_NAME, FILELIST_PERMISSIONS, FILELIST_SIZE, FILELIST_STATE, FILELIST_TITLE, FILELIST_TYPE, FILELIST_USER_CREATED, FILELIST_USER_LASTMODIFIED

Constructor Summary

CmsDefaultUserSettings()

Method Summary

String	getDialogCopyFileModeString() Gets the default copy mode when copying a file of the user.
String	getDialogCopyFolderModeString() Gets the default copy mode when copying a folder of the user.
String	getDialogDeleteFileModeString() Returns the default setting for file deletion.
String	getDialogExpandInheritedPermissionsString() Returns the default setting for expanding inherited permissions in the dialog.
String	getDialogExpandUserPermissionsString() Returns the default setting for expanding the users permissions in the dialog.
String	getDialogPermissionsInheritOnFolderString() Returns the default setting for inheriting permissions on folders.
String	getDialogPublishSiblingsString() Returns the default setting for direct publishing.
String	getDialogShowExportSettingsString() Determines if the export settings part of the secure/export dialog should be shown.
String	getDialogShowLockString() Determines if the lock dialog should be shown.
String	getDirectEditButtonStyleString() Returns a string representation of the direct edit button style.
String	getEditorButtonStyleString() Returns a string representation of the editor button style.
String	getExplorerButtonStyleString() Returns a string representation of the explorer button style.
String	getRestrictExplorerViewString() Returns if the explorer view is restricted to the defined site and folder.
String	getShowExplorerFileDateCreated() Gets if the file creation date should be shown in explorer view.
String	getShowExplorerFileDateExpired() Gets if the file expired by should be shown in explorer view.
String	getShowExplorerFileDateLastModified() Gets if the file last modified date should be shown in explorer view.
String	getShowExplorerFileDateReleased() Gets if the file released by should be shown in explorer view.
String	getShowExplorerFileLockedBy() Gets if the file locked by should be shown in explorer view.
String	getShowExplorerFilePermissions() Gets if the file permissions should be shown in explorer view.
String	getShowExplorerFileSize() Gets if the file size should be shown in explorer view.
String	getShowExplorerFileState() Gets if the file state should be shown in explorer view.
String	getShowExplorerFileTitle() Gets if the file title should be shown in explorer view.
String	getShowExplorerFileType() Gets if the file type should be shown in explorer view.
String	getShowExplorerFileUserCreated() Gets if the file creator should be shown in explorer view.
String	getShowExplorerFileUserLastModified() Gets if the file last modified by should be shown in explorer view.
String	getTaskMessageAcceptedString() Determines if a message should be sent if the task is accepted.
String	getTaskMessageCompletedString() Determines if a message should be sent if the task is completed.
String	getTaskMessageForwardedString() Determines if a message should be sent if the task is forwarded.
String	getTaskMessageMembersString() Determines if all role members should be informed about the task.
String	getTaskShowAllProjectsString() Determines if all projects should be shown in tasks view.
String	getTaskStartupFilterDefault() Gets the startup filter for the tasks view.
String	getUploadAppletString() Returns a string representation of the upload Applet flag.
String	getWorkplaceButtonStyleString() Returns a string representation of the workplace button style.
void	setDialogCopyFileMode(String mode) Sets the default copy mode when copying a file of the user.
void	setDialogCopyFolderMode(String mode) Sets the default copy mode when copying a folder of the user.
void	setDialogDeleteFileMode(String mode) Sets the default setting for file deletion.
void	setDialogExpandInheritedPermissions(String dialogExpandInheritedPermissions) Sets the default setting for expanding inherited permissions in the dialog.
void	setDialogExpandUserPermissions(String dialogExpandUserPermissions) Sets the default setting for expanding the users permissions in the dialog.
void	setDialogPermissionsInheritOnFolder(String dialogPermissionsInheritOnFolder) Sets the default setting for inheriting permissions on folders.
void	setDialogPublishSiblings(String mode) Sets the default setting for direct publishing.
void	setDirectEditButtonStyle(String buttonstyle) Sets the style of the direct edit buttons of the user.
void	setEditorButtonStyle(String buttonstyle) Sets the style of the editor buttons of the user.
void	setExplorerButtonStyle(String buttonstyle) Sets the style of the explorer workplace buttons of the user.
void	setExplorerFileEntries(String entries) Sets the number of displayed files per page of the user.
void	setLocale(String locale) Sets the workplace locale.
void	setRestrictExplorerView(String restrict) Sets if the explorer view is restricted to the defined site and folder.
void	setShowExplorerFileDateCreated(String show) Sets if the file creation date should be shown in explorer view.
void	setShowExplorerFileDateExpired(String show) Sets if the file expire date should be shown in explorer view.
void	setShowExplorerFileDateLastModified(String show) Sets if the file last modified date should be shown in explorer view.
void	setShowExplorerFileDateReleased(String show) Sets if the file release date should be shown in explorer view.
void	setShowExplorerFileLockedBy(String show) Sets if the file locked by should be shown in explorer view.
void	setShowExplorerFilePermissions(String show) Sets if the file permissions should be shown in explorer view.
void	setShowExplorerFileSize(String show) Sets if the file size should be shown in explorer view.
void	setShowExplorerFileState(String show) Sets if the file state should be shown in explorer view.
void	setShowExplorerFileTitle(String show) Sets if the file title should be shown in explorer view.
void	setShowExplorerFileType(String show) Sets if the file type should be shown in explorer view.
void	setShowExplorerFileUserCreated(String show) Sets if the file creator should be shown in explorer view.
void	setShowExplorerFileUserLastModified(String show) Sets if the file last modified by should be shown in explorer view.
void	setShowExportSettingsDialog(String mode) Sets if the export part of the secure/export dialog should be shown.
void	setShowLockDialog(String mode) Sets if the lock dialog should be shown.
void	setTaskMessageAccepted(String mode) Sets if a message should be sent if the task is accepted.
void	setTaskMessageCompleted(String mode) Sets if a message should be sent if the task is completed.
void	setTaskMessageForwarded(String mode) Sets if a message should be sent if the task is forwarded.
void	setTaskMessageMembers(String mode) Sets if all role members should be informed about the task.
void	setTaskShowAllProjects(String mode) Sets if all projects should be shown in tasks view.
void	setTaskStartupFilterDefault(String filter) Sets the startup filter for the tasks view.
void	setUploadApplet(String applet) Sets the usage of the upload applet for the user user.
void	setWorkplaceButtonStyle(String buttonstyle) Sets the style of the workplace buttons of the user.

Methods inherited from class org.opencms.db.CmsUserSettings

getDialogCopyFileMode, getDialogCopyFolderMode, getDialogDeleteFileMode, getDialogExpandInheritedPermissions, getDialogExpandUserPermissions, getDialogPermissionsInheritOnFolder, getDialogPublishSiblings, getDialogShowExportSettings, getDialogShowLock, getDirectEditButtonStyle, getEditorButtonStyle, getEditorSettings, getExplorerButtonStyle, getExplorerFileEntries, getExplorerSettings, getLocale, getPreferredEditor, getProjectSettings, getRestrictExplorerView, getStartFolder, getStartProject, getStartSite, getStartView, getSynchronizeSettings, getTaskMessageAccepted, getTaskMessageCompleted, getTaskMessageForwarded, getTaskMessageMembers, getTaskMessageValue, getTaskShowAllProjects, getTaskStartupFilter, getUser, getWorkplaceButtonStyle, getWorkplaceReportType, init, init, save, setDialogCopyFileMode, setDialogCopyFolderMode, setDialogDeleteFileMode, setDialogExpandInheritedPermissions, setDialogExpandUserPermissions, setDialogPermissionsInheritOnFolder, setDialogPublishSiblings, setDialogShowExportSettings, setDialogShowLock, setDirectEditButtonStyle, setEditorButtonStyle, setEditorSettings, setExplorerButtonStyle, setExplorerFileEntries, setExplorerSettings, setLocale, setPreferredEditor, setProjectSettings, setRestrictExplorerView, setShowExplorerFileDateCreated, setShowExplorerFileDateExpired, setShowExplorerFileDateLastModified, setShowExplorerFileDateReleased, setShowExplorerFileLockedBy, setShowExplorerFilePermissions, setShowExplorerFileSize, setShowExplorerFileState, setShowExplorerFileTitle, setShowExplorerFileType, setShowExplorerFileUserCreated, setShowExplorerFileUserLastModified, setStartFolder, setStartProject, setStartSite, setStartView, setSynchronizeSettings, setTaskMessageAccepted, setTaskMessageCompleted, setTaskMessageForwarded, setTaskMessageMembers, setTaskMessageValue, setTaskShowAllProjects, setTaskStartupFilter, setUser, setUseUploadApplet, setWorkplaceButtonStyle, setWorkplaceReportType, showExplorerFileDateCreated, showExplorerFileDateExpired, showExplorerFileDateLastModified, showExplorerFileDateReleased, showExplorerFileLockedBy, showExplorerFilePermissions, showExplorerFileSize, showExplorerFileState, showExplorerFileTitle, showExplorerFileType, showExplorerFileUserCreated, showExplorerFileUserLastModified, useUploadApplet

Methods inherited from class java.lang.Object

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

Field Detail

BUTTON_STYLES

public static final String[] BUTTON_STYLES

Array of the possible "button styles".

BUTTON_STYLES_LIST

public static final List BUTTON_STYLES_LIST

Array list for fast lookup of "button styles".

FILTER_NAMES

public static final String[] FILTER_NAMES

Array of the "task startupfilter" nicenames.

FILTER_NAMES_LIST

public static final List FILTER_NAMES_LIST

Array list for fast lookup of "task startupfilter" nicenames.

FILTER_VALUES

public static final String[] FILTER_VALUES

Array of the "task startupfilter" values.

FILTER_VALUES_LIST

public static final List FILTER_VALUES_LIST

Array list for fast lookup of "task startupfilter" values.

Constructor Detail

CmsDefaultUserSettings

public CmsDefaultUserSettings()

Method Detail

getDialogCopyFileModeString

public 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 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 String getDialogDeleteFileModeString()

Returns the default setting for file deletion.

Returns:

the default setting for file deletion

getDialogExpandInheritedPermissionsString

public String getDialogExpandInheritedPermissionsString()

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

Returns:

true if inherited permissions should be expanded, otherwise false

getDialogExpandUserPermissionsString

public 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

getDialogPermissionsInheritOnFolderString

public String getDialogPermissionsInheritOnFolderString()

Returns the default setting for inheriting permissions on folders.

Returns:

true if permissions should be inherited on folders, otherwise false

getDialogPublishSiblingsString

public String getDialogPublishSiblingsString()

Returns the default setting for direct publishing.

Returns:

the default setting for direct publishing

getDialogShowExportSettingsString

public 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 String getDialogShowLockString()

Determines if the lock dialog should be shown.

Returns:

true if the lock dialog is shown, otherwise false

getDirectEditButtonStyleString

public String getDirectEditButtonStyleString()

Returns a string representation of the direct edit button style.

Returns:

string representation of the direct edit button style

getEditorButtonStyleString

public String getEditorButtonStyleString()

Returns a string representation of the editor button style.

Returns:

string representation of the editor button style

getExplorerButtonStyleString

public String getExplorerButtonStyleString()

Returns a string representation of the explorer button style.

Returns:

string representation of the explorer button style

getRestrictExplorerViewString

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

getShowExplorerFilePermissions

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

getTaskMessageAcceptedString

public String getTaskMessageAcceptedString()

Determines if a message should be sent if the task is accepted.

Returns:

"true" if a message should be sent if the task is accepted, otherwise "false"

getTaskMessageCompletedString

public String getTaskMessageCompletedString()

Determines if a message should be sent if the task is completed.

Returns:

"true" if a message should be sent if the task is completed, otherwise "false"

getTaskMessageForwardedString

public String getTaskMessageForwardedString()

Determines if a message should be sent if the task is forwarded.

Returns:

"true" if a message should be sent if the task is forwarded, otherwise "false"

getTaskMessageMembersString

public String getTaskMessageMembersString()

Determines if all role members should be informed about the task.

Returns:

"true" if all role members should be informed about the task, otherwise "false"

getTaskShowAllProjectsString

public String getTaskShowAllProjectsString()

Determines if all projects should be shown in tasks view.

Returns:

"true" if all projects should be shown in tasks view, otherwise "false"

getTaskStartupFilterDefault

public String getTaskStartupFilterDefault()

Gets the startup filter for the tasks view.

Returns:

the startup filter for the tasks view

getUploadAppletString

public String getUploadAppletString()

Returns a string representation of the upload Applet flag.

Returns:

string representation of the uploadApplet flag

getWorkplaceButtonStyleString

public String getWorkplaceButtonStyleString()

Returns a string representation of the workplace button style.

Returns:

string representation of the workplace button style

setDialogCopyFileMode

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

Sets the default setting for file deletion.

Parameters:

mode - the default setting for file deletion

setDialogExpandInheritedPermissions

public void setDialogExpandInheritedPermissions(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(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(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(String mode)

Sets the default setting for direct publishing.

Parameters:

mode - the default setting for direct publishing

setDirectEditButtonStyle

public void setDirectEditButtonStyle(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(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(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(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

setLocale

public void setLocale(String locale)

Sets the workplace locale.

Parameters:

locale - the workplace language default

setRestrictExplorerView

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

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

Parameters:

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

setShowExplorerFileLockedBy

public void setShowExplorerFileLockedBy(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

setShowExplorerFilePermissions

public void setShowExplorerFilePermissions(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(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(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(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(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(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(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(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

setShowLockDialog

public void setShowLockDialog(String mode)

Sets if the lock dialog should be shown.

Parameters:

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

setTaskMessageAccepted

public void setTaskMessageAccepted(String mode)

Sets if a message should be sent if the task is accepted.

Parameters:

mode - true if a message should be sent if the task is accepted, otherwise false

setTaskMessageCompleted

public void setTaskMessageCompleted(String mode)

Sets if a message should be sent if the task is completed.

Parameters:

mode - true if a message should be sent if the task is completed, otherwise false

setTaskMessageForwarded

public void setTaskMessageForwarded(String mode)

Sets if a message should be sent if the task is forwarded.

Parameters:

mode - true if a message should be sent if the task is forwarded, otherwise false

setTaskMessageMembers

public void setTaskMessageMembers(String mode)

Sets if all role members should be informed about the task.

Parameters:

mode - true if all role members should be informed about the task, otherwise false

setTaskShowAllProjects

public void setTaskShowAllProjects(String mode)

Sets if all projects should be shown in tasks view.

Parameters:

mode - true if all projects should be shown in tasks view, otherwise false

setTaskStartupFilterDefault

public void setTaskStartupFilterDefault(String filter)

Sets the startup filter for the tasks view.

Parameters:

filter - the startup filter for the tasks view

setUploadApplet

public void setUploadApplet(String applet)

Sets the usage of the upload applet for the user user.

Parameters:

applet - "true" or "false" to flag the use of the applet

setWorkplaceButtonStyle

public void setWorkplaceButtonStyle(String buttonstyle)

Sets the style of the workplace buttons of the user.

Parameters:

buttonstyle - the style of the workplace buttons of the user