|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.db.CmsUserSettings
Object to conveniently access and modify the users workplace settings.
Field Summary | |
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 confirmemed 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_EXPLORERSETTINGS
Key for additional info explorer settings. |
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_TOWN
Deprecated. use ADDITIONAL_INFO_CITY instead |
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_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 filetype 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. |
Constructor Summary | |
CmsUserSettings()
Creates an empty new user settings object. |
|
CmsUserSettings(CmsObject cms)
Creates a user settings object with initialized settings of the current user. |
|
CmsUserSettings(CmsObject cms,
CmsUser user)
Creates a user settings object with initialized settings of the user. |
|
CmsUserSettings(CmsUser user)
Creates a user settings object with initialized settings of the user. |
Method Summary | |
int |
getDialogCopyFileMode()
Gets the default copy mode when copying a file of the user. |
int |
getDialogCopyFolderMode()
Gets the default copy mode when copying a folder of the user. |
int |
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 |
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. |
int |
getExplorerSettings()
Returns the explorer start settings. |
java.util.Locale |
getLocale()
Returns the locale of the user. |
java.lang.String |
getPreferredEditor(java.lang.String resourceType)
Returns the preferred editor for the given resource type of the user. |
CmsUserProjectSettings |
getProjectSettings()
Returns the project Settings. |
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. |
java.lang.String |
getStartFolder()
Returns the start folder of the user. |
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. |
boolean |
getTaskMessageAccepted()
Determines if a message should be sent if the task is accepted. |
boolean |
getTaskMessageCompleted()
Determines if a message should be sent if the task is completed. |
boolean |
getTaskMessageForwarded()
Determines if a message should be sent if the task is forwarded. |
boolean |
getTaskMessageMembers()
Determines if all role members should be informed about the task. |
int |
getTaskMessageValue()
Returns the task messages value for the tasks view. |
boolean |
getTaskShowAllProjects()
Determines if all projects should be shown in tasks view. |
java.lang.String |
getTaskStartupFilter()
Returns the startup filter for the tasks view. |
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. |
void |
init(CmsObject cms,
CmsUser user)
Initializes the user settings with the given users setting parameters. |
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 user object. |
void |
setDialogCopyFileMode(int mode)
Sets the default copy mode when copying a file of the user. |
void |
setDialogCopyFolderMode(int mode)
Sets the default copy mode when copying a folder of the user. |
void |
setDialogDeleteFileMode(int 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 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 |
setExplorerSettings(int settings)
Sets the explorer start settings. |
void |
setLocale(java.util.Locale locale)
Sets the locale of the user. |
void |
setPreferredEditor(java.lang.String resourceType,
java.lang.String editorUri)
Sets the preferred editor for the given resource type of the user. |
void |
setProjectSettings(CmsUserProjectSettings projectSettings)
Sets the project Settings. |
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 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 |
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 |
setStartFolder(java.lang.String folder)
Sets the start folder of the user. |
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 |
setTaskMessageAccepted(boolean message)
Sets if a message should be sent if the task is accepted. |
void |
setTaskMessageCompleted(boolean message)
Sets if a message should be sent if the task is completed. |
void |
setTaskMessageForwarded(boolean message)
Sets if a message should be sent if the task is forwarded. |
void |
setTaskMessageMembers(boolean message)
Sets if all role members should be informed about the task. |
void |
setTaskMessageValue(int value)
Sets the task message values. |
void |
setTaskShowAllProjects(boolean show)
Sets if all projects should be shown in tasks view. |
void |
setTaskStartupFilter(java.lang.String filter)
Sets the startup filter for the tasks view. |
void |
setUser(CmsUser user)
Sets the current user for the settings. |
void |
setUseUploadApplet(boolean use)
Sets if the upload applet should be used. |
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. |
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 |
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. |
boolean |
useUploadApplet()
Determines if the upload applet should be used. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String ADDITIONAL_INFO_CONFIRMED_RESOURCES
public static final java.lang.String ADDITIONAL_INFO_COUNTRY
public static final java.lang.String ADDITIONAL_INFO_DEFAULTGROUP
public static final java.lang.String ADDITIONAL_INFO_EXPLORERSETTINGS
public static final java.lang.String ADDITIONAL_INFO_PREFERENCES
public static final java.lang.String ADDITIONAL_INFO_STARTSETTINGS
public static final java.lang.String ADDITIONAL_INFO_CITY
public static final java.lang.String ADDITIONAL_INFO_TOWN
ADDITIONAL_INFO_CITY
instead
public static final java.lang.String ADDITIONAL_INFO_ZIPCODE
public static final int FILELIST_DATE_CREATED
public static final int FILELIST_DATE_EXPIRED
public static final int FILELIST_DATE_LASTMODIFIED
public static final int FILELIST_DATE_RELEASED
public static final int FILELIST_LOCKEDBY
public static final int FILELIST_NAME
public static final int FILELIST_PERMISSIONS
public static final int FILELIST_SIZE
public static final int FILELIST_STATE
public static final int FILELIST_TITLE
public static final int FILELIST_TYPE
public static final int FILELIST_USER_CREATED
public static final int FILELIST_USER_LASTMODIFIED
Constructor Detail |
public CmsUserSettings()
public CmsUserSettings(CmsObject cms)
cms
- the OpenCms contextpublic CmsUserSettings(CmsObject cms, CmsUser user)
cms
- the OpenCms contextuser
- the OpenCms userpublic CmsUserSettings(CmsUser user)
Some default settings will be unset, if no cms object is given.
user
- the current CmsUserCmsUserSettings(CmsObject, CmsUser)
Method Detail |
public int getDialogCopyFileMode()
public int getDialogCopyFolderMode()
public int getDialogDeleteFileMode()
public boolean getDialogExpandInheritedPermissions()
public boolean getDialogExpandUserPermissions()
public boolean getDialogPermissionsInheritOnFolder()
public boolean getDialogPublishSiblings()
public boolean getDialogShowExportSettings()
public boolean getDialogShowLock()
public int getDirectEditButtonStyle()
public int getEditorButtonStyle()
public java.util.Map getEditorSettings()
public int getExplorerButtonStyle()
public int getExplorerFileEntries()
public int getExplorerSettings()
public java.util.Locale getLocale()
public java.lang.String getPreferredEditor(java.lang.String resourceType)
resourceType
- the resource type
public CmsUserProjectSettings getProjectSettings()
public java.lang.String getPublishButtonAppearance()
public boolean getRestrictExplorerView()
public java.lang.String getStartFolder()
public java.lang.String getStartProject()
public java.lang.String getStartSite()
public java.lang.String getStartView()
public CmsSynchronizeSettings getSynchronizeSettings()
public boolean getTaskMessageAccepted()
public boolean getTaskMessageCompleted()
public boolean getTaskMessageForwarded()
public boolean getTaskMessageMembers()
public int getTaskMessageValue()
public boolean getTaskShowAllProjects()
public java.lang.String getTaskStartupFilter()
public CmsUser getUser()
public int getWorkplaceButtonStyle()
public java.lang.String getWorkplaceReportType()
public void init(CmsObject cms, CmsUser user)
cms
- the OpenCms contextuser
- the current CmsUserpublic void init(CmsUser user)
Some default settings will be unset, if no cms object is given.
user
- the current CmsUserinit(CmsObject, CmsUser)
public void save(CmsObject cms) throws CmsException
If the given CmsObject is null, the additional user infos are only updated in memory and not saved into the database.
cms
- the CmsObject needed to write the user to the db
CmsException
- if user cannot be written to the dbpublic void setDialogCopyFileMode(int mode)
mode
- the default copy mode when copying a file of the userpublic void setDialogCopyFolderMode(int mode)
mode
- the default copy mode when copying a folder of the userpublic void setDialogDeleteFileMode(int mode)
mode
- the default setting for file deletionpublic void setDialogExpandInheritedPermissions(boolean dialogShowInheritedPermissions)
dialogShowInheritedPermissions
- the default setting for expanding inherited permissions in the dialogpublic void setDialogExpandUserPermissions(boolean dialogShowUserPermissions)
dialogShowUserPermissions
- the default setting for expanding the users permissions in the dialogpublic void setDialogPermissionsInheritOnFolder(boolean dialogPermissionsInheritOnFolder)
dialogPermissionsInheritOnFolder
- the default setting for inheriting permissions on folderspublic void setDialogPublishSiblings(boolean publishSiblings)
publishSiblings
- the default setting for direct publishing: true if siblings should be published, otherwise falsepublic void setDialogShowExportSettings(boolean show)
show
- true if the export dialog should be shown, otherwise falsepublic void setDialogShowLock(boolean show)
show
- true if the lock dialog should be shown, otherwise falsepublic void setDirectEditButtonStyle(int style)
style
- the style of the direct edit buttons of the userpublic void setEditorButtonStyle(int style)
style
- the style of the editor buttons of the userpublic void setEditorSettings(java.util.Map settings)
settings
- the editor settings of the userpublic void setExplorerButtonStyle(int style)
style
- the style of the explorer buttons of the userpublic void setExplorerFileEntries(int entries)
entries
- the number of displayed files per page of the userpublic void setExplorerSettings(int settings)
settings
- explorer start settings tu usepublic void setLocale(java.util.Locale locale)
locale
- the locale of the userpublic void setPreferredEditor(java.lang.String resourceType, java.lang.String editorUri)
resourceType
- the resource typeeditorUri
- the editor URIpublic void setProjectSettings(CmsUserProjectSettings projectSettings)
projectSettings
- the project Settings to setpublic void setPublishButtonAppearance(java.lang.String publishButtonAppearance)
publishButtonAppearance
- the appearance of the "publish project" buttonpublic void setRestrictExplorerView(boolean restrict)
restrict
- true if the explorer view is restricted, otherwise falsepublic void setShowExplorerFileDateCreated(boolean show)
show
- true if the file creation date should be shown, otherwise falsepublic void setShowExplorerFileDateExpired(boolean show)
show
- true if the file expire date should be shown, otherwise falsepublic void setShowExplorerFileDateLastModified(boolean show)
show
- true if the file last modified date should be shown, otherwise falsepublic void setShowExplorerFileDateReleased(boolean show)
show
- true if the file release date should be shown, otherwise falsepublic void setShowExplorerFileLockedBy(boolean show)
show
- true if the file locked by should be shown, otherwise falsepublic void setShowExplorerFilePermissions(boolean show)
show
- true if the file permissions should be shown, otherwise falsepublic void setShowExplorerFileSize(boolean show)
show
- true if the file size should be shown, otherwise falsepublic void setShowExplorerFileState(boolean show)
show
- true if the state size should be shown, otherwise falsepublic void setShowExplorerFileTitle(boolean show)
show
- true if the file title should be shown, otherwise falsepublic void setShowExplorerFileType(boolean show)
show
- true if the file type should be shown, otherwise falsepublic void setShowExplorerFileUserCreated(boolean show)
show
- true if the file creator should be shown, otherwise falsepublic void setShowExplorerFileUserLastModified(boolean show)
show
- true if the file last modified by should be shown, otherwise falsepublic void setStartFolder(java.lang.String folder)
folder
- the start folder of the userpublic void setStartProject(java.lang.String project)
project
- the start project id of the userpublic void setStartSite(java.lang.String site)
site
- the start site of the userpublic void setStartView(java.lang.String view)
view
- the current start view of the userpublic void setSynchronizeSettings(CmsSynchronizeSettings synchronizeSettings)
synchronizeSettings
- the (optional) workplace synchronize settings to setpublic void setTaskMessageAccepted(boolean message)
message
- true if a message should be sent if the task is accepted, otherwise falsepublic void setTaskMessageCompleted(boolean message)
message
- true if a message should be sent if the task is completed, otherwise falsepublic void setTaskMessageForwarded(boolean message)
message
- true if a message should be sent if the task is forwarded, otherwise falsepublic void setTaskMessageMembers(boolean message)
message
- true if all role members should be informed about the task, otherwise falsepublic void setTaskMessageValue(int value)
value
- the value of the task messagespublic void setTaskShowAllProjects(boolean show)
show
- true if all projects should be shown in tasks view, otherwise falsepublic void setTaskStartupFilter(java.lang.String filter)
filter
- the startup filter for the tasks viewpublic void setUser(CmsUser user)
user
- the CmsUserpublic void setUseUploadApplet(boolean use)
use
- true if the upload applet should be used, otherwise falsepublic void setWorkplaceButtonStyle(int style)
style
- the style of the workplace buttons of the userpublic void setWorkplaceReportType(java.lang.String type)
type
- the type of the report (simple or extended) of the userpublic boolean showExplorerFileDateCreated()
public boolean showExplorerFileDateExpired()
public boolean showExplorerFileDateLastModified()
public boolean showExplorerFileDateReleased()
public boolean showExplorerFileLockedBy()
public boolean showExplorerFilePermissions()
public boolean showExplorerFileSize()
public boolean showExplorerFileState()
public boolean showExplorerFileTitle()
public boolean showExplorerFileType()
public boolean showExplorerFileUserCreated()
public boolean showExplorerFileUserLastModified()
public boolean useUploadApplet()
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |