|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.db.CmsUserSettings
org.opencms.configuration.CmsDefaultUserSettings
public class CmsDefaultUserSettings
Default user workplace settings, used as default values for worklace settings in the user preferences.
Nested Class Summary | |
---|---|
static class |
CmsDefaultUserSettings.CmsPublishRelatedResourcesMode
Enumeration class for defining the publish related resources mode. |
Nested classes/interfaces inherited from class org.opencms.db.CmsUserSettings |
---|
CmsUserSettings.CmsSearchResultStyle |
Field Summary | |
---|---|
static java.util.List |
BUTTON_STYLES_LIST
Array list for fast lookup of "button styles". |
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_MANAGER s
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. |
Constructor Summary | |
---|---|
CmsDefaultUserSettings()
|
Method Summary | |
---|---|
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. |
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. |
java.lang.String |
getUploadAppletString()
Returns a string representation of the upload Applet flag. |
java.lang.String |
getWorkplaceButtonStyleString()
Returns a string representation of the workplace button style. |
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 |
setUploadApplet(java.lang.String applet)
Sets the usage of the upload applet for the user user. |
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final CmsDefaultUserSettings.CmsPublishRelatedResourcesMode PUBLISH_RELATED_RESOURCES_MODE_FALSE
public static final CmsDefaultUserSettings.CmsPublishRelatedResourcesMode PUBLISH_RELATED_RESOURCES_MODE_FORCE
CmsRole.VFS_MANAGER
s
may publish resources without publishing the related resources.
public static final CmsDefaultUserSettings.CmsPublishRelatedResourcesMode PUBLISH_RELATED_RESOURCES_MODE_TRUE
public static final java.lang.String PUBLISHBUTTON_SHOW_ALWAYS
public static final java.lang.String PUBLISHBUTTON_SHOW_AUTO
public static final java.lang.String PUBLISHBUTTON_SHOW_NEVER
public static final java.util.List BUTTON_STYLES_LIST
Constructor Detail |
---|
public CmsDefaultUserSettings()
Method Detail |
---|
public java.lang.String getDialogCopyFileModeString()
public java.lang.String getDialogCopyFolderModeString()
public java.lang.String getDialogDeleteFileModeString()
public java.lang.String getDialogExpandInheritedPermissionsString()
CmsUserSettings.getDialogExpandInheritedPermissions()
public java.lang.String getDialogExpandUserPermissionsString()
CmsUserSettings.getDialogExpandUserPermissions()
public java.lang.String getDialogPermissionsInheritOnFolderString()
public java.lang.String getDialogPublishSiblingsString()
public java.lang.String getDialogShowExportSettingsString()
public java.lang.String getDialogShowLockString()
public java.lang.String getDirectEditButtonStyleString()
public java.lang.String getEditorButtonStyleString()
public java.lang.String getExplorerButtonStyleString()
public java.lang.String getListAllProjectsString()
CmsUserSettings.getListAllProjects()
public CmsDefaultUserSettings.CmsPublishRelatedResourcesMode getPublishRelatedResources()
public java.lang.String getRestrictExplorerViewString()
public java.lang.String getShowExplorerFileDateCreated()
"true"
if the file creation date should be shown, otherwise "false"
public java.lang.String getShowExplorerFileDateExpired()
"true"
if the file date expired by should be shown, otherwise "false"
public java.lang.String getShowExplorerFileDateLastModified()
"true"
if the file last modified date should be shown, otherwise "false"
public java.lang.String getShowExplorerFileDateReleased()
"true"
if the file date released by should be shown, otherwise "false"
public java.lang.String getShowExplorerFileLockedBy()
"true"
if the file locked by should be shown, otherwise "false"
public java.lang.String getShowExplorerFileNavText()
"true"
if the file navtext should be shown, otherwise "false"
public java.lang.String getShowExplorerFilePermissions()
"true"
if the file permissions should be shown, otherwise "false"
public java.lang.String getShowExplorerFileSize()
"true"
if the file size should be shown, otherwise "false"
public java.lang.String getShowExplorerFileState()
"true"
if the file state should be shown, otherwise "false"
public java.lang.String getShowExplorerFileTitle()
"true"
if the file title should be shown, otherwise "false"
public java.lang.String getShowExplorerFileType()
"true"
if the file type should be shown, otherwise "false"
public java.lang.String getShowExplorerFileUserCreated()
"true"
if the file creator should be shown, otherwise "false"
public java.lang.String getShowExplorerFileUserLastModified()
"true"
if the file last modified by should be shown, otherwise "false"
public java.lang.String getShowFileUploadButtonString()
CmsUserSettings.getShowFileUploadButton()
public java.lang.String getShowPublishNotificationString()
CmsUserSettings.getShowPublishNotification()
public java.lang.String getUploadAppletString()
CmsUserSettings.useUploadApplet()
public java.lang.String getWorkplaceButtonStyleString()
CmsUserSettings.getWorkplaceButtonStyle()
public boolean isAllowBrokenRelations()
true
if the deletion of relation targets is enabled, otherwise false
public void setAllowBrokenRelations(java.lang.String allowBrokenRelations)
allowBrokenRelations
- true
if relation deletion should be enabled, otherwise false
public void setDialogCopyFileMode(java.lang.String mode)
mode
- the default copy mode when copying a file of the userpublic void setDialogCopyFolderMode(java.lang.String mode)
mode
- the default copy mode when copying a folder of the userpublic void setDialogDeleteFileMode(java.lang.String mode)
mode
- the default setting for file deletionpublic void setDialogExpandInheritedPermissions(java.lang.String dialogExpandInheritedPermissions)
dialogExpandInheritedPermissions
- the default setting for expanding inherited permissions in the dialogpublic void setDialogExpandUserPermissions(java.lang.String dialogExpandUserPermissions)
dialogExpandUserPermissions
- the default setting for expanding the users permissions in the dialogpublic void setDialogPermissionsInheritOnFolder(java.lang.String dialogPermissionsInheritOnFolder)
dialogPermissionsInheritOnFolder
- the default setting for inheriting permissions on folderspublic void setDialogPublishSiblings(java.lang.String mode)
mode
- the default setting for direct publishingpublic void setDirectEditButtonStyle(java.lang.String buttonstyle)
buttonstyle
- the style of the direct edit buttons of the userpublic void setEditorButtonStyle(java.lang.String buttonstyle)
buttonstyle
- the style of the editor buttons of the userpublic void setExplorerButtonStyle(java.lang.String buttonstyle)
buttonstyle
- the style of the explorer workplace buttons of the userpublic void setExplorerFileEntries(java.lang.String entries)
entries
- the number of displayed files per page of the userpublic void setListAllProjects(java.lang.String listAllProjects)
listAllProjects
- "true"
or "false"
public void setLocale(java.lang.String locale)
locale
- the workplace language defaultpublic void setNewFolderCreateIndexPage(java.lang.String booleanValue)
The given String
value is interpreted as a Boolean
by the means
of
. Boolean.valueOf(String)
booleanValue
- a String
that is interpred as a Boolean
by the means
of Boolean.valueOf(String)
public void setNewFolderEditProperties(java.lang.String booleanValue)
The given String
value is interpreted as a Boolean
by the means
of
. Boolean.valueOf(String)
booleanValue
- a String
that is interpreted as a Boolean
by the means of Boolean.valueOf(String)
public void setPublishRelatedResourcesMode(java.lang.String publishRelatedResourcesMode)
publishRelatedResourcesMode
- the publish related resources mode to setpublic void setRestrictExplorerView(java.lang.String restrict)
restrict
- true if the explorer view is restricted, otherwise falsepublic void setShowExplorerFileDateCreated(java.lang.String show)
show
- true if the file creation date should be shown, otherwise falsepublic void setShowExplorerFileDateExpired(java.lang.String show)
show
- true if the file expire date should be shown, otherwise falsepublic void setShowExplorerFileDateLastModified(java.lang.String show)
show
- true if the file last modified date should be shown, otherwise falsepublic void setShowExplorerFileDateReleased(java.lang.String show)
show
- true if the file release date should be shown, otherwise falsepublic void setShowExplorerFileLockedBy(java.lang.String show)
show
- true if the file locked by should be shown, otherwise falsepublic void setShowExplorerFileNavText(java.lang.String show)
show
- true if the file locked by should be shown, otherwise falsepublic void setShowExplorerFilePermissions(java.lang.String show)
show
- true if the file permissions should be shown, otherwise falsepublic void setShowExplorerFileSize(java.lang.String show)
show
- true if the file size should be shown, otherwise falsepublic void setShowExplorerFileState(java.lang.String show)
show
- true if the state size should be shown, otherwise falsepublic void setShowExplorerFileTitle(java.lang.String show)
show
- true if the file title should be shown, otherwise falsepublic void setShowExplorerFileType(java.lang.String show)
show
- true if the file type should be shown, otherwise falsepublic void setShowExplorerFileUserCreated(java.lang.String show)
show
- true if the file creator should be shown, otherwise falsepublic void setShowExplorerFileUserLastModified(java.lang.String show)
show
- true if the file last modified by should be shown, otherwise falsepublic void setShowExportSettingsDialog(java.lang.String mode)
mode
- true if the export dialog should be shown, otherwise falsepublic void setShowFileUploadButton(java.lang.String flag)
flag
- "true"
or "false"
to flag the use of the file upload buttonpublic void setShowLockDialog(java.lang.String mode)
mode
- true if the lock dialog should be shown, otherwise falsepublic void setShowPublishNotification(java.lang.String notification)
notification
- "true"
or "false"
to flag the notificationpublic void setShowUploadTypeDialog(java.lang.String booleanValue)
The given String
value is interpreted as a Boolean
by the means
of
. Boolean.valueOf(String)
booleanValue
- a String
that is interpreted as a Boolean
by the means
of Boolean.valueOf(String)
public void setUploadApplet(java.lang.String applet)
applet
- "true"
or "false"
to flag the use of the appletpublic void setWorkplaceButtonStyle(java.lang.String buttonstyle)
buttonstyle
- the style of the workplace buttons of the userpublic void setWorkplaceSearchViewStyle(java.lang.String viewStyle)
viewStyle
- the style of the workplace search default view
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |