CmsPreferences (build_6_0

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.opencms.workplace.commons
Class CmsPreferences

java.lang.Object
  org.opencms.workplace.CmsWorkplace
      org.opencms.workplace.tools.CmsToolDialog
          org.opencms.workplace.CmsDialog
              org.opencms.workplace.CmsTabDialog
                  org.opencms.workplace.commons.CmsPreferences

public class CmsPreferences
extends CmsTabDialog
extends CmsTabDialog

Provides methods for the user preferences dialog.

The following files use this class:

/commons/preferences.jsp

Since:: 6.0.0
Version:: $Revision: 1.27 $
Author:: Andreas Zahner

Field Summary
`static int`	`ACTION_CHPWD` Value for the action: change the password.
`static int`	`ACTION_ERROR` Value for the action: show error screen.
`static int`	`ACTION_RELOAD` Value for the action: reload the workplace.
`static String`	`DIALOG_CHPWD` Request parameter value for the action: change the password.
`static String`	`DIALOG_RELOAD` Request parameter value for the action: reload the workplace.
`static String`	`DIALOG_TYPE` The dialog type.
`static String`	`INPUT_DEFAULT` Request parameter name prefix for the preferred editors.
`static String`	`PARAM_DIALOGS_COPYFILEMODE` Request parameter name for the dialog copy file siblings default setting.
`static String`	`PARAM_DIALOGS_COPYFOLDERMODE` Request parameter name for the dialog copy folder siblings default setting.
`static String`	`PARAM_DIALOGS_DELETEFILEMODE` Request parameter name for the dialog delete file siblings default setting.
`static String`	`PARAM_DIALOGS_PERMISSIONS_EXPANDINHERITED` Request parameter name for the dialog permissions show inherited permissions.
`static String`	`PARAM_DIALOGS_PERMISSIONS_EXPANDUSER` Request parameter name for the dialog permissions show current users permissions.
`static String`	`PARAM_DIALOGS_PERMISSIONS_INHERITONFOLDER` Request parameter name for the dialog permissions default inheritance behaviour on folders.
`static String`	`PARAM_DIALOGS_PUBLISHFILEMODE` Request parameter name for the dialog publish file siblings default setting.
`static String`	`PARAM_DIALOGS_SHOWLOCK` Request parameter name for the dialog show lock.
`static String`	`PARAM_DIRECTEDIT_BUTTONSTYLE` Request parameter name for the direct edit button style.
`static String`	`PARAM_EDITOR_BUTTONSTYLE` Request parameter name for the editor button style.
`static String`	`PARAM_EXPLORER_BUTTONSTYLE` Request parameter name for the explorer button style.
`static String`	`PARAM_EXPLORER_FILEDATECREATED` Request parameter name for the explorer file date created.
`static String`	`PARAM_EXPLORER_FILEDATEEXPIRED` Request parameter name for the explorer file date expired.
`static String`	`PARAM_EXPLORER_FILEDATELASTMODIFIED` Request parameter name for the explorer file date last modified.
`static String`	`PARAM_EXPLORER_FILEDATERELEASED` Request parameter name for the explorer file date released.
`static String`	`PARAM_EXPLORER_FILEENTRIES` Request parameter name for the explorer file entry number.
`static String`	`PARAM_EXPLORER_FILELOCKEDBY` Request parameter name for the explorer file locked by.
`static String`	`PARAM_EXPLORER_FILEPERMISSIONS` Request parameter name for the explorer file permissions.
`static String`	`PARAM_EXPLORER_FILESIZE` Request parameter name for the explorer file size.
`static String`	`PARAM_EXPLORER_FILESTATE` Request parameter name for the explorer file state.
`static String`	`PARAM_EXPLORER_FILETITLE` Request parameter name for the explorer file title.
`static String`	`PARAM_EXPLORER_FILETYPE` Request parameter name for the explorer file type.
`static String`	`PARAM_EXPLORER_FILEUSERCREATED` Request parameter name for the explorer file user created.
`static String`	`PARAM_EXPLORER_FILEUSERLASTMODIFIED` Request parameter name for the explorer file user last modified.
`static String`	`PARAM_NEWPASSWORD` Request parameter name for the new password.
`static String`	`PARAM_OLDPASSWORD` Request parameter name for the old password.
`static String`	`PARAM_PREFERREDEDITOR_PREFIX` Request parameter name prefix for the preferred editors.
`static String`	`PARAM_WORKFLOW_FILTER` Request parameter name for the workflow filter.
`static String`	`PARAM_WORKFLOW_MESSAGEACCEPTED` Request parameter name for the workflow message accepted.
`static String`	`PARAM_WORKFLOW_MESSAGECOMPLETED` Request parameter name for the workflow message completed.
`static String`	`PARAM_WORKFLOW_MESSAGEFORWARDED` Request parameter name for the workflow message forwarded.
`static String`	`PARAM_WORKFLOW_MESSAGEMEMBERS` Request parameter name for the workflow message members.
`static String`	`PARAM_WORKFLOW_SHOWALLPROJECTS` Request parameter name for the workflow show all projects.
`static String`	`PARAM_WORKPLACE_BUTTONSTYLE` Request parameter name for the workplace button style.
`static String`	`PARAM_WORKPLACE_FOLDER` Request parameter name for the workplace start folder.
`static String`	`PARAM_WORKPLACE_LANGUAGE` Request parameter name for the workplace language.
`static String`	`PARAM_WORKPLACE_PROJECT` Request parameter name for the workplace project.
`static String`	`PARAM_WORKPLACE_REPORTTYPE` Request parameter name for the workplace report type.
`static String`	`PARAM_WORKPLACE_RESTRICTEXPLORERVIEW` Request parameter name for the workplace explorer view restriction.
`static String`	`PARAM_WORKPLACE_SITE` Request parameter name for the workplace start site.
`static String`	`PARAM_WORKPLACE_USEUPLOADAPPLET` Request parameter name for the workplace use upload applet.
`static String`	`PARAM_WORKPLACE_VIEW` Request parameter name for the workplace view.

Fields inherited from class org.opencms.workplace.CmsTabDialog
`ACTION_SWITCHTAB, DIALOG_SWITCHTAB, PARAM_SETPRESSED, PARAM_TAB`

Fields inherited from class org.opencms.workplace.CmsDialog
ACTION_CANCEL, ACTION_CLOSEPOPUP, ACTION_CLOSEPOPUP_SAVE, ACTION_CONFIRMED, ACTION_DEFAULT, ACTION_OK, ACTION_REPORT_BEGIN, ACTION_REPORT_END, ACTION_REPORT_UPDATE, ACTION_SET, ACTION_WAIT, ATTRIBUTE_THROWABLE, BUTTON_ADVANCED, BUTTON_BACK, BUTTON_CANCEL, BUTTON_CLOSE, BUTTON_CONTINUE, BUTTON_DETAILS, BUTTON_DISCARD, BUTTON_EDIT, BUTTON_OK, BUTTON_OK_NO_SUBMIT, BUTTON_SET, DIALOG_BACK, DIALOG_CANCEL, DIALOG_CONFIRMED, DIALOG_CONTINUE, DIALOG_INITIAL, DIALOG_OK, DIALOG_SET, DIALOG_WAIT, PARAM_ACTION, PARAM_CLOSELINK, PARAM_DIALOGTYPE, PARAM_ERRORSTACK, PARAM_FILE, PARAM_FRAMENAME, PARAM_ISPOPUP, PARAM_LOCK, PARAM_MESSAGE, PARAM_REDIRECT, PARAM_RESOURCE, PARAM_TARGET, PARAM_THREAD, PARAM_THREAD_HASNEXT, PARAM_TITLE, REPORT_BEGIN, REPORT_END, REPORT_UPDATE

Fields inherited from class org.opencms.workplace.CmsDialog

ACTION_CANCEL, ACTION_CLOSEPOPUP, ACTION_CLOSEPOPUP_SAVE, ACTION_CONFIRMED, ACTION_DEFAULT, ACTION_OK, ACTION_REPORT_BEGIN, ACTION_REPORT_END, ACTION_REPORT_UPDATE, ACTION_SET, ACTION_WAIT, ATTRIBUTE_THROWABLE, BUTTON_ADVANCED, BUTTON_BACK, BUTTON_CANCEL, BUTTON_CLOSE, BUTTON_CONTINUE, BUTTON_DETAILS, BUTTON_DISCARD, BUTTON_EDIT, BUTTON_OK, BUTTON_OK_NO_SUBMIT, BUTTON_SET, DIALOG_BACK, DIALOG_CANCEL, DIALOG_CONFIRMED, DIALOG_CONTINUE, DIALOG_INITIAL, DIALOG_OK, DIALOG_SET, DIALOG_WAIT, PARAM_ACTION, PARAM_CLOSELINK, PARAM_DIALOGTYPE, PARAM_ERRORSTACK, PARAM_FILE, PARAM_FRAMENAME, PARAM_ISPOPUP, PARAM_LOCK, PARAM_MESSAGE, PARAM_REDIRECT, PARAM_RESOURCE, PARAM_TARGET, PARAM_THREAD, PARAM_THREAD_HASNEXT, PARAM_TITLE, REPORT_BEGIN, REPORT_END, REPORT_UPDATE

Fields inherited from class org.opencms.workplace.tools.CmsToolDialog
`PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW`

Fields inherited from class org.opencms.workplace.CmsWorkplace
DEBUG, DEFAULT_LANGUAGE, DEFAULT_LOCALE, DIALOG_PATH_COMMON, FILE_DIALOG_CLOSE, FILE_DIALOG_SCREEN_CONFIRM, FILE_DIALOG_SCREEN_ERROR, FILE_DIALOG_SCREEN_ERRORPAGE, FILE_DIALOG_SCREEN_WAIT, FILE_EXPLORER_FILELIST, FILE_REPORT_OUTPUT, HTML_END, HTML_START, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PATH_DIALOGS, PATH_WORKPLACE, REQUEST_ATTRIBUTE_MULTIPART, REQUEST_ATTRIBUTE_RELOADTREE, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, TEMP_FILE_PREFIX, VFS_DIR_DEFAULTBODIES, VFS_DIR_TEMPLATES, VFS_PATH_COMMONS, VFS_PATH_EDITORS, VFS_PATH_GALLERIES, VFS_PATH_LOCALES, VFS_PATH_MODULES, VFS_PATH_RESOURCES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE

Fields inherited from class org.opencms.workplace.CmsWorkplace

DEBUG, DEFAULT_LANGUAGE, DEFAULT_LOCALE, DIALOG_PATH_COMMON, FILE_DIALOG_CLOSE, FILE_DIALOG_SCREEN_CONFIRM, FILE_DIALOG_SCREEN_ERROR, FILE_DIALOG_SCREEN_ERRORPAGE, FILE_DIALOG_SCREEN_WAIT, FILE_EXPLORER_FILELIST, FILE_REPORT_OUTPUT, HTML_END, HTML_START, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PATH_DIALOGS, PATH_WORKPLACE, REQUEST_ATTRIBUTE_MULTIPART, REQUEST_ATTRIBUTE_RELOADTREE, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, TEMP_FILE_PREFIX, VFS_DIR_DEFAULTBODIES, VFS_DIR_TEMPLATES, VFS_PATH_COMMONS, VFS_PATH_EDITORS, VFS_PATH_GALLERIES, VFS_PATH_LOCALES, VFS_PATH_MODULES, VFS_PATH_RESOURCES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE

Constructor Summary
`CmsPreferences(CmsJspActionElement jsp)` Public constructor with JSP action element.
`CmsPreferences(PageContext context, HttpServletRequest req, HttpServletResponse res)` Public constructor with JSP variables.

Method Summary
`void`	`actionChangePassword()` Performs the change password action.
`void`	`actionSave()` Performs the save operation of the modified user settings.
`String`	`buildSelectCopyFileMode(String htmlAttributes)` Builds the html for the default copy file mode select box.
`String`	`buildSelectCopyFolderMode(String htmlAttributes)` Builds the html for the default copy folder mode select box.
`String`	`buildSelectDeleteFileMode(String htmlAttributes)` Builds the html for the default delete file mode select box.
`String`	`buildSelectDirectEditButtonStyle(String htmlAttributes)` Builds the html for the direct edit button style select box.
`String`	`buildSelectEditorButtonStyle(String htmlAttributes)` Builds the html for the editor button style select box.
`String`	`buildSelectExplorerButtonStyle(String htmlAttributes)` Builds the html for the explorer button style select box.
`String`	`buildSelectExplorerFileEntries(String htmlAttributes)` Builds the html for the explorer number of entries per page select box.
`String`	`buildSelectFilter(String htmlAttributes)` Builds the html for the task startup filter select box.
`String`	`buildSelectLanguage(String htmlAttributes)` Builds the html for the language select box of the start settings.
`String`	`buildSelectPreferredEditors(String htmlAttributes)` Builds the html for the preferred editors select boxes of the editor settings.
`String`	`buildSelectProject(String htmlAttributes)` Builds the html for the project select box of the start settings.
`String`	`buildSelectPublishSiblings(String htmlAttributes)` Builds the html for the default publish siblings mode select box.
`String`	`buildSelectReportType(String htmlAttributes)` Builds the html for the workplace report type select box.
`String`	`buildSelectSite(String htmlAttributes)` Builds the html for the workplace start site select box.
`String`	`buildSelectView(String htmlAttributes)` Returns a html select box filled with the views accessible by the current user.
`String`	`buildSelectWorkplaceButtonStyle(String htmlAttributes)` Builds the html for the workplace button style select box.
`String`	`buildUserInformation()` Builds the html code for the static user information table (tab 4).
`String`	`getParamNewPassword()` Returns the new password value.
`String`	`getParamOldPassword()` Returns the old password value.
`String`	`getParamTabDiCopyFileMode()` Returns the "copy file default" setting.
`String`	`getParamTabDiCopyFolderMode()` Returns the "copy folder default" setting.
`String`	`getParamTabDiDeleteFileMode()` Returns the "delete file default" setting.
`String`	`getParamTabDiPermissionsExpandInherited()` Returns the "expand inherited permissions" default setting.
`String`	`getParamTabDiPermissionsExpandUser()` Returns the "expand current users permissions" default setting.
`String`	`getParamTabDiPermissionsInheritOnFolder()` Returns the "inherit permissions on folders" default setting.
`String`	`getParamTabDiPublishFileMode()` Returns the "publish file siblings default" setting.
`String`	`getParamTabDiShowLock()` Returns the "display lock dialog" setting.
`String`	`getParamTabEdButtonStyle()` Returns the "editor button style" setting.
`String`	`getParamTabEdDirectEditButtonStyle()` Returns the "direct edit button style" setting.
`String`	`getParamTabExButtonStyle()` Returns the "explorer button style" setting.
`String`	`getParamTabExFileDateCreated()` Returns the "display file creation date" setting.
`String`	`getParamTabExFileDateExpired()` Returns the "display file date expired" setting.
`String`	`getParamTabExFileDateLastModified()` Returns the "display file last modification date" setting.
`String`	`getParamTabExFileDateReleased()` Returns the "display file date released" setting.
`String`	`getParamTabExFileEntries()` Returns the "explorer number of entries per page" setting.
`String`	`getParamTabExFileLockedBy()` Returns the "display file locked by" setting.
`String`	`getParamTabExFilePermissions()` Returns the "display file permissions" setting.
`String`	`getParamTabExFileSize()` Returns the "display file size" setting.
`String`	`getParamTabExFileState()` Returns the "display file state" setting.
`String`	`getParamTabExFileTitle()` Returns the "display file title" setting.
`String`	`getParamTabExFileType()` Returns the "display file type" setting.
`String`	`getParamTabExFileUserCreated()` Returns the "display file created by" setting.
`String`	`getParamTabExFileUserLastModified()` Returns the "display file last modified by" setting.
`String`	`getParamTabWfFilter()` Returns the "task startup filter" setting.
`String`	`getParamTabWfMessageAccepted()` Returns the "message when accepted" setting.
`String`	`getParamTabWfMessageCompleted()` Returns the "message when completed" setting.
`String`	`getParamTabWfMessageForwarded()` Returns the "message when forwarded" setting.
`String`	`getParamTabWfMessageMembers()` Returns the "inform all role members" setting.
`String`	`getParamTabWfShowAllProjects()` returns the "show all projects" setting.
`String`	`getParamTabWpButtonStyle()` Returns the "workplace button style" setting.
`String`	`getParamTabWpFolder()` Returns the "start folder" setting.
`String`	`getParamTabWpLanguage()` Returns the start language setting.
`String`	`getParamTabWpProject()` Returns the start project setting.
`String`	`getParamTabWpReportType()` Returns the "workplace report type" setting.
`String`	`getParamTabWpRestrictExplorerView()` Returns the "workplace restrict explorer view" setting.
`String`	`getParamTabWpSite()` Returns the "start site" setting.
`String`	`getParamTabWpUseUploadApplet()` Returns the "use upload applet" setting.
`String`	`getParamTabWpView()` Returns the start view setting.
`List`	`getTabParameterOrder()` Returns the order of the parameter prefixes for each tab.
`List`	`getTabs()` Returns a list with localized Strings representing the names of the tabs.
`protected void`	`initWorkplaceRequestValues(CmsWorkplaceSettings settings, HttpServletRequest request)` Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
`String`	`isChecked(String paramValue)` Helper method to add the "checked" attribute to an input field.
`protected Map`	`paramValues()` Returns the values of all parameter methods of this workplace class instance.
`void`	`setParamNewPassword(String newPwd)` Sets the new password value.
`void`	`setParamOldPassword(String oldPwd)` Sets the old password value.
`void`	`setParamTabDiCopyFileMode(String value)` Sets the "copy file default" setting.
`void`	`setParamTabDiCopyFolderMode(String value)` Sets the "copy folder default" setting.
`void`	`setParamTabDiDeleteFileMode(String value)` Sets the "delete file siblings default" setting.
`void`	`setParamTabDiPermissionsExpandInherited(String value)` Sets the "expand inherited permissions" default setting.
`void`	`setParamTabDiPermissionsExpandUser(String value)` Sets the "expand current users permissions" default setting.
`void`	`setParamTabDiPermissionsInheritOnFolder(String value)` Sets the "inherit permissions on folders" default setting.
`void`	`setParamTabDiPublishFileMode(String value)` Sets the "publish file siblings default" setting.
`void`	`setParamTabDiShowLock(String value)` Sets the "display lock dialog" setting.
`void`	`setParamTabEdButtonStyle(String value)` Sets the "editor button style" setting.
`void`	`setParamTabEdDirectEditButtonStyle(String value)` Sets the "direct edit button style" setting.
`void`	`setParamTabExButtonStyle(String value)` Sets the "explorer button style" setting.
`void`	`setParamTabExFileDateCreated(String value)` Sets the "display file creation date" setting.
`void`	`setParamTabExFileDateExpired(String value)` Sets the "display file expired date" setting.
`void`	`setParamTabExFileDateLastModified(String value)` Sets the "display file last modification date" setting.
`void`	`setParamTabExFileDateReleased(String value)` Sets the "display file released date" setting.
`void`	`setParamTabExFileEntries(String value)` Sets the "explorer number of entries per page" setting.
`void`	`setParamTabExFileLockedBy(String value)` Sets the "display file locked by" setting.
`void`	`setParamTabExFilePermissions(String value)` Sets the "display file permissions" setting.
`void`	`setParamTabExFileSize(String value)` Sets the "display file size" setting.
`void`	`setParamTabExFileState(String value)` Sets the "display file state" setting.
`void`	`setParamTabExFileTitle(String value)` Sets the "display file title" setting.
`void`	`setParamTabExFileType(String value)` Sets the "display file type" setting.
`void`	`setParamTabExFileUserCreated(String value)` Sets the "display file created by" setting.
`void`	`setParamTabExFileUserLastModified(String value)` Sets the "display file last modified by" setting.
`void`	`setParamTabWfFilter(String filter)` Sets the "task startup filter" setting.
`void`	`setParamTabWfMessageAccepted(String value)` Sets the "message when accepted" setting.
`void`	`setParamTabWfMessageCompleted(String value)` Sets the "message when completed" setting.
`void`	`setParamTabWfMessageForwarded(String value)` Sets the "message when forwarded" setting.
`void`	`setParamTabWfMessageMembers(String value)` Sets the "inform all role members" setting.
`void`	`setParamTabWfShowAllProjects(String value)` Sets the "show all projects" setting.
`void`	`setParamTabWpButtonStyle(String value)` Sets the "workplace button style" setting.
`void`	`setParamTabWpFolder(String value)` Sets the "start folder" setting.
`void`	`setParamTabWpLanguage(String value)` Sets the start language setting.
`void`	`setParamTabWpProject(String value)` Sets the start project setting.
`void`	`setParamTabWpReportType(String value)` Sets the "workplace report type" setting.
`void`	`setParamTabWpRestrictExplorerView(String value)` Sets the "workplace restrict explorer view" setting.
`void`	`setParamTabWpSite(String value)` Sets the "start site" setting.
`void`	`setParamTabWpUseUploadApplet(String value)` Sets the "use upload applet" setting.
`void`	`setParamTabWpView(String value)` Sets the start view setting.
`protected void`	`updatePreferences(CmsObject cms, HttpServletRequest req)` Updates the user preferences after changes have been made.

Methods inherited from class org.opencms.workplace.CmsTabDialog
`dialogTabContent, dialogTabContentEnd, dialogTabContentStart, dialogTabContentStart, dialogTabRow, getActiveTab, getActiveTabName, getParamSetPressed, getParamTab, htmlStart, htmlStart, paramsAsHidden, setParamSetPressed, setParamTab`

Methods inherited from class org.opencms.workplace.CmsDialog
actionCloseDialog, appendDelimiter, checkResourcePermissions, checkResourcePermissions, dialog, dialogBlock, dialogBlockEnd, dialogBlockStart, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsHtml, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, dialogRow, dialogRowEnd, dialogRowStart, dialogScriptSubmit, dialogSeparator, dialogSpacer, dialogStart, dialogStart, dialogSubheadline, dialogToggleStart, dialogWhiteBox, dialogWhiteBoxEnd, dialogWhiteBoxStart, getAction, getAdministrationBackLink, getCancelAction, getDialogRealUri, getDialogUri, getOnlineHelpUriCustom, getParamAction, getParamCloseLink, getParamDialogtype, getParamFramename, getParamIsPopup, getParamMessage, getParamRedirect, getParamResource, getParamTitle, getState, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamRedirect, setParamResource, setParamTitle

Methods inherited from class org.opencms.workplace.CmsDialog

actionCloseDialog, appendDelimiter, checkResourcePermissions, checkResourcePermissions, dialog, dialogBlock, dialogBlockEnd, dialogBlockStart, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsHtml, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, dialogRow, dialogRowEnd, dialogRowStart, dialogScriptSubmit, dialogSeparator, dialogSpacer, dialogStart, dialogStart, dialogSubheadline, dialogToggleStart, dialogWhiteBox, dialogWhiteBoxEnd, dialogWhiteBoxStart, getAction, getAdministrationBackLink, getCancelAction, getDialogRealUri, getDialogUri, getOnlineHelpUriCustom, getParamAction, getParamCloseLink, getParamDialogtype, getParamFramename, getParamIsPopup, getParamMessage, getParamRedirect, getParamResource, getParamTitle, getState, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamRedirect, setParamResource, setParamTitle

Methods inherited from class org.opencms.workplace.tools.CmsToolDialog
`dialogTitle, getAdminTool, getCurrentToolPath, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamPath, setParamRoot, setParamStyle, useNewStyle`

Methods inherited from class org.opencms.workplace.CmsWorkplace
addMessages, allParamsAsHidden, allParamsAsRequest, allParamValues, bodyEnd, bodyStart, bodyStart, buildSelect, buildSelect, button, button, buttonBar, buttonBar, buttonBarHorizontalLine, buttonBarLabel, buttonBarLabel, buttonBarLine, buttonBarLineSpacer, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, calendarIncludes, calendarIncludes, calendarInit, calendarInit, checkLock, checkLock, decodeParamValue, fillParamValues, fillParamValues, getBroadcastMessageString, getCalendarDate, getCalendarJavaDateFormat, getCalendarLocalizedTime, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStyleUri, getStyleUri, getStyleUri, htmlEnd, initMessages, initSettings, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, key, key, key, nullToEmpty, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, switchToCurrentProject, switchToTempProject

Methods inherited from class org.opencms.workplace.CmsWorkplace

addMessages, allParamsAsHidden, allParamsAsRequest, allParamValues, bodyEnd, bodyStart, bodyStart, buildSelect, buildSelect, button, button, buttonBar, buttonBar, buttonBarHorizontalLine, buttonBarLabel, buttonBarLabel, buttonBarLine, buttonBarLineSpacer, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, calendarIncludes, calendarIncludes, calendarInit, calendarInit, checkLock, checkLock, decodeParamValue, fillParamValues, fillParamValues, getBroadcastMessageString, getCalendarDate, getCalendarJavaDateFormat, getCalendarLocalizedTime, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStyleUri, getStyleUri, getStyleUri, htmlEnd, initMessages, initSettings, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, key, key, key, nullToEmpty, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, switchToCurrentProject, switchToTempProject

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

ACTION_CHPWD

public static final int ACTION_CHPWD

Value for the action: change the password.

See Also:: Constant Field Values

ACTION_ERROR

public static final int ACTION_ERROR

Value for the action: show error screen.

See Also:: Constant Field Values

ACTION_RELOAD

public static final int ACTION_RELOAD

Value for the action: reload the workplace.

See Also:: Constant Field Values

DIALOG_CHPWD

public static final String DIALOG_CHPWD

Request parameter value for the action: change the password.

See Also:: Constant Field Values

DIALOG_RELOAD

public static final String DIALOG_RELOAD

Request parameter value for the action: reload the workplace.

See Also:: Constant Field Values

DIALOG_TYPE

public static final String DIALOG_TYPE

The dialog type.

See Also:: Constant Field Values

INPUT_DEFAULT

public static final String INPUT_DEFAULT

Request parameter name prefix for the preferred editors.

See Also:: Constant Field Values

PARAM_DIALOGS_COPYFILEMODE

public static final String PARAM_DIALOGS_COPYFILEMODE

Request parameter name for the dialog copy file siblings default setting.

See Also:: Constant Field Values

PARAM_DIALOGS_COPYFOLDERMODE

public static final String PARAM_DIALOGS_COPYFOLDERMODE

Request parameter name for the dialog copy folder siblings default setting.

See Also:: Constant Field Values

PARAM_DIALOGS_DELETEFILEMODE

public static final String PARAM_DIALOGS_DELETEFILEMODE

Request parameter name for the dialog delete file siblings default setting.

See Also:: Constant Field Values

PARAM_DIALOGS_PERMISSIONS_EXPANDINHERITED

public static final String PARAM_DIALOGS_PERMISSIONS_EXPANDINHERITED

Request parameter name for the dialog permissions show inherited permissions.

See Also:: Constant Field Values

PARAM_DIALOGS_PERMISSIONS_EXPANDUSER

public static final String PARAM_DIALOGS_PERMISSIONS_EXPANDUSER

Request parameter name for the dialog permissions show current users permissions.

See Also:: Constant Field Values

PARAM_DIALOGS_PERMISSIONS_INHERITONFOLDER

public static final String PARAM_DIALOGS_PERMISSIONS_INHERITONFOLDER

Request parameter name for the dialog permissions default inheritance behaviour on folders.

See Also:: Constant Field Values

PARAM_DIALOGS_PUBLISHFILEMODE

public static final String PARAM_DIALOGS_PUBLISHFILEMODE

Request parameter name for the dialog publish file siblings default setting.

See Also:: Constant Field Values

PARAM_DIALOGS_SHOWLOCK

public static final String PARAM_DIALOGS_SHOWLOCK

Request parameter name for the dialog show lock.

See Also:: Constant Field Values

PARAM_DIRECTEDIT_BUTTONSTYLE

public static final String PARAM_DIRECTEDIT_BUTTONSTYLE

Request parameter name for the direct edit button style.

See Also:: Constant Field Values

PARAM_EDITOR_BUTTONSTYLE

public static final String PARAM_EDITOR_BUTTONSTYLE

Request parameter name for the editor button style.

See Also:: Constant Field Values

PARAM_EXPLORER_BUTTONSTYLE

public static final String PARAM_EXPLORER_BUTTONSTYLE

Request parameter name for the explorer button style.

See Also:: Constant Field Values

PARAM_EXPLORER_FILEDATECREATED

public static final String PARAM_EXPLORER_FILEDATECREATED

Request parameter name for the explorer file date created.

See Also:: Constant Field Values

PARAM_EXPLORER_FILEDATEEXPIRED

public static final String PARAM_EXPLORER_FILEDATEEXPIRED

Request parameter name for the explorer file date expired.

See Also:: Constant Field Values

PARAM_EXPLORER_FILEDATELASTMODIFIED

public static final String PARAM_EXPLORER_FILEDATELASTMODIFIED

Request parameter name for the explorer file date last modified.

See Also:: Constant Field Values

PARAM_EXPLORER_FILEDATERELEASED

public static final String PARAM_EXPLORER_FILEDATERELEASED

Request parameter name for the explorer file date released.

See Also:: Constant Field Values

PARAM_EXPLORER_FILEENTRIES

public static final String PARAM_EXPLORER_FILEENTRIES

Request parameter name for the explorer file entry number.

See Also:: Constant Field Values

PARAM_EXPLORER_FILELOCKEDBY

public static final String PARAM_EXPLORER_FILELOCKEDBY

Request parameter name for the explorer file locked by.

See Also:: Constant Field Values

PARAM_EXPLORER_FILEPERMISSIONS

public static final String PARAM_EXPLORER_FILEPERMISSIONS

Request parameter name for the explorer file permissions.

See Also:: Constant Field Values

PARAM_EXPLORER_FILESIZE

public static final String PARAM_EXPLORER_FILESIZE

Request parameter name for the explorer file size.

See Also:: Constant Field Values

PARAM_EXPLORER_FILESTATE

public static final String PARAM_EXPLORER_FILESTATE

Request parameter name for the explorer file state.

See Also:: Constant Field Values

PARAM_EXPLORER_FILETITLE

public static final String PARAM_EXPLORER_FILETITLE

Request parameter name for the explorer file title.

See Also:: Constant Field Values

PARAM_EXPLORER_FILETYPE

public static final String PARAM_EXPLORER_FILETYPE

Request parameter name for the explorer file type.

See Also:: Constant Field Values

PARAM_EXPLORER_FILEUSERCREATED

public static final String PARAM_EXPLORER_FILEUSERCREATED

Request parameter name for the explorer file user created.

See Also:: Constant Field Values

PARAM_EXPLORER_FILEUSERLASTMODIFIED

public static final String PARAM_EXPLORER_FILEUSERLASTMODIFIED

Request parameter name for the explorer file user last modified.

See Also:: Constant Field Values

PARAM_NEWPASSWORD

public static final String PARAM_NEWPASSWORD

Request parameter name for the new password.

See Also:: Constant Field Values

PARAM_OLDPASSWORD

public static final String PARAM_OLDPASSWORD

Request parameter name for the old password.

See Also:: Constant Field Values

PARAM_PREFERREDEDITOR_PREFIX

public static final String PARAM_PREFERREDEDITOR_PREFIX

Request parameter name prefix for the preferred editors.

See Also:: Constant Field Values

PARAM_WORKFLOW_FILTER

public static final String PARAM_WORKFLOW_FILTER

Request parameter name for the workflow filter.

See Also:: Constant Field Values

PARAM_WORKFLOW_MESSAGEACCEPTED

public static final String PARAM_WORKFLOW_MESSAGEACCEPTED

Request parameter name for the workflow message accepted.

See Also:: Constant Field Values

PARAM_WORKFLOW_MESSAGECOMPLETED

public static final String PARAM_WORKFLOW_MESSAGECOMPLETED

Request parameter name for the workflow message completed.

See Also:: Constant Field Values

PARAM_WORKFLOW_MESSAGEFORWARDED

public static final String PARAM_WORKFLOW_MESSAGEFORWARDED

Request parameter name for the workflow message forwarded.

See Also:: Constant Field Values

PARAM_WORKFLOW_MESSAGEMEMBERS

public static final String PARAM_WORKFLOW_MESSAGEMEMBERS

Request parameter name for the workflow message members.

See Also:: Constant Field Values

PARAM_WORKFLOW_SHOWALLPROJECTS

public static final String PARAM_WORKFLOW_SHOWALLPROJECTS

Request parameter name for the workflow show all projects.

See Also:: Constant Field Values

PARAM_WORKPLACE_BUTTONSTYLE

public static final String PARAM_WORKPLACE_BUTTONSTYLE

Request parameter name for the workplace button style.

See Also:: Constant Field Values

PARAM_WORKPLACE_FOLDER

public static final String PARAM_WORKPLACE_FOLDER

Request parameter name for the workplace start folder.

See Also:: Constant Field Values

PARAM_WORKPLACE_LANGUAGE

public static final String PARAM_WORKPLACE_LANGUAGE

Request parameter name for the workplace language.

See Also:: Constant Field Values

PARAM_WORKPLACE_PROJECT

public static final String PARAM_WORKPLACE_PROJECT

Request parameter name for the workplace project.

See Also:: Constant Field Values

PARAM_WORKPLACE_REPORTTYPE

public static final String PARAM_WORKPLACE_REPORTTYPE

Request parameter name for the workplace report type.

See Also:: Constant Field Values

PARAM_WORKPLACE_RESTRICTEXPLORERVIEW

public static final String PARAM_WORKPLACE_RESTRICTEXPLORERVIEW

Request parameter name for the workplace explorer view restriction.

See Also:: Constant Field Values

PARAM_WORKPLACE_SITE

public static final String PARAM_WORKPLACE_SITE

Request parameter name for the workplace start site.

See Also:: Constant Field Values

PARAM_WORKPLACE_USEUPLOADAPPLET

public static final String PARAM_WORKPLACE_USEUPLOADAPPLET

Request parameter name for the workplace use upload applet.

See Also:: Constant Field Values

PARAM_WORKPLACE_VIEW

public static final String PARAM_WORKPLACE_VIEW

Request parameter name for the workplace view.

See Also:: Constant Field Values

Constructor Detail

CmsPreferences

public CmsPreferences(CmsJspActionElement jsp)

Public constructor with JSP action element.

Parameters:: jsp - an initialized JSP action element

CmsPreferences

public CmsPreferences(PageContext context,
                      HttpServletRequest req,
                      HttpServletResponse res)

Public constructor with JSP variables.

Parameters:: context - the JSP page context; req - the JSP request; res - the JSP response

Method Detail

actionChangePassword

public void actionChangePassword()
                          throws JspException

Performs the change password action.

Throws:: JspException - if inclusion of error element fails

actionSave

public void actionSave()

Performs the save operation of the modified user settings.

buildSelectCopyFileMode

public String buildSelectCopyFileMode(String htmlAttributes)

Builds the html for the default copy file mode select box.

Parameters:: htmlAttributes - optional html attributes for the &lgt;select> tag
Returns:: the html for the default copy file mode select box

buildSelectCopyFolderMode

public String buildSelectCopyFolderMode(String htmlAttributes)

Builds the html for the default copy folder mode select box.

Parameters:: htmlAttributes - optional html attributes for the &lgt;select> tag
Returns:: the html for the default copy folder mode select box

buildSelectDeleteFileMode

public String buildSelectDeleteFileMode(String htmlAttributes)

Builds the html for the default delete file mode select box.

Parameters:: htmlAttributes - optional html attributes for the &lgt;select> tag
Returns:: the html for the default delete file mode select box

buildSelectDirectEditButtonStyle

public String buildSelectDirectEditButtonStyle(String htmlAttributes)

Builds the html for the direct edit button style select box.

Parameters:: htmlAttributes - optional html attributes for the &lgt;select> tag
Returns:: the html for the direct edit button style select box

buildSelectEditorButtonStyle

public String buildSelectEditorButtonStyle(String htmlAttributes)

Builds the html for the editor button style select box.

Parameters:: htmlAttributes - optional html attributes for the &lgt;select> tag
Returns:: the html for the editor button style select box

buildSelectExplorerButtonStyle

public String buildSelectExplorerButtonStyle(String htmlAttributes)

Builds the html for the explorer button style select box.

Parameters:: htmlAttributes - optional html attributes for the &lgt;select> tag
Returns:: the html for the explorer button style select box

buildSelectExplorerFileEntries

public String buildSelectExplorerFileEntries(String htmlAttributes)

Builds the html for the explorer number of entries per page select box.

Parameters:: htmlAttributes - optional html attributes for the &lgt;select> tag
Returns:: the html for the explorer number of entries per page select box

buildSelectFilter

public String buildSelectFilter(String htmlAttributes)

Builds the html for the task startup filter select box.

Parameters:: htmlAttributes - optional html attributes for the &lgt;select> tag
Returns:: the html for the task startup filter select box

buildSelectLanguage

public String buildSelectLanguage(String htmlAttributes)

Builds the html for the language select box of the start settings.

Parameters:: htmlAttributes - optional html attributes for the &lgt;select> tag
Returns:: the html for the language select box

buildSelectPreferredEditors

public String buildSelectPreferredEditors(String htmlAttributes)

Builds the html for the preferred editors select boxes of the editor settings.

Parameters:: htmlAttributes - optional html attributes for the &lgt;select> tag
Returns:: the html for the preferred editors select boxes

buildSelectProject

public String buildSelectProject(String htmlAttributes)

Builds the html for the project select box of the start settings.

Parameters:: htmlAttributes - optional html attributes for the &lgt;select> tag
Returns:: the html for the project select box

buildSelectPublishSiblings

public String buildSelectPublishSiblings(String htmlAttributes)

Builds the html for the default publish siblings mode select box.

Parameters:: htmlAttributes - optional html attributes for the &lgt;select> tag
Returns:: the html for the default publish siblings mode select box

buildSelectReportType

public String buildSelectReportType(String htmlAttributes)

Builds the html for the workplace report type select box.

Parameters:: htmlAttributes - optional html attributes for the &lgt;select> tag
Returns:: the html for the workplace report type select box

buildSelectSite

public String buildSelectSite(String htmlAttributes)

Builds the html for the workplace start site select box.

Parameters:: htmlAttributes - optional html attributes for the &lgt;select> tag
Returns:: the html for the workplace start site select box

buildSelectView

public String buildSelectView(String htmlAttributes)

Returns a html select box filled with the views accessible by the current user.

Parameters:: htmlAttributes - attributes that will be inserted into the generated html
Returns:: a html select box filled with the views accessible by the current user

buildSelectWorkplaceButtonStyle

public String buildSelectWorkplaceButtonStyle(String htmlAttributes)

Builds the html for the workplace button style select box.

Parameters:: htmlAttributes - optional html attributes for the &lgt;select> tag
Returns:: the html for the workplace button style select box

buildUserInformation

public String buildUserInformation()

Builds the html code for the static user information table (tab 4).

Returns:: the html code for the static user information table

getParamNewPassword

public String getParamNewPassword()

Returns the new password value.

Returns:: the new password value

getParamOldPassword

public String getParamOldPassword()

Returns the old password value.

Returns:: the old password value

getParamTabDiCopyFileMode

public String getParamTabDiCopyFileMode()

Returns the "copy file default" setting.

Returns:: the "copy file default" setting

getParamTabDiCopyFolderMode

public String getParamTabDiCopyFolderMode()

Returns the "copy folder default" setting.

Returns:: the "copy folder default" setting

getParamTabDiDeleteFileMode

public String getParamTabDiDeleteFileMode()

Returns the "delete file default" setting.

Returns:: the "delete file default" setting

getParamTabDiPermissionsExpandInherited

public String getParamTabDiPermissionsExpandInherited()

Returns the "expand inherited permissions" default setting.

Returns:: the "expand inherited permissions" default setting

getParamTabDiPermissionsExpandUser

public String getParamTabDiPermissionsExpandUser()

Returns the "expand current users permissions" default setting.

Returns:: the "expand current users permissions" default setting

getParamTabDiPermissionsInheritOnFolder

public String getParamTabDiPermissionsInheritOnFolder()

Returns the "inherit permissions on folders" default setting.

Returns:: the "inherit permissions on folders" default setting

getParamTabDiPublishFileMode

public String getParamTabDiPublishFileMode()

Returns the "publish file siblings default" setting.

Returns:: the "publish file siblings default" setting

getParamTabDiShowLock

public String getParamTabDiShowLock()

Returns the "display lock dialog" setting.

Returns:: "true" if the "display lock dialog" input field is checked, otherwise ""

getParamTabEdButtonStyle

public String getParamTabEdButtonStyle()

Returns the "editor button style" setting.

Returns:: the "editor button style" setting

getParamTabEdDirectEditButtonStyle

public String getParamTabEdDirectEditButtonStyle()

Returns the "direct edit button style" setting.

Returns:: the "direct edit button style" setting

getParamTabExButtonStyle

public String getParamTabExButtonStyle()

Returns the "explorer button style" setting.

Returns:: the "explorer button style" setting

getParamTabExFileDateCreated

public String getParamTabExFileDateCreated()

Returns the "display file creation date" setting.

Returns:: "true" if the file creation date input field is checked, otherwise ""

getParamTabExFileDateExpired

public String getParamTabExFileDateExpired()

Returns the "display file date expired" setting.

Returns:: "true" if the file date expired input field is checked, otherwise ""

getParamTabExFileDateLastModified

public String getParamTabExFileDateLastModified()

Returns the "display file last modification date" setting.

Returns:: "true" if the file last modification date input field is checked, otherwise ""

getParamTabExFileDateReleased

public String getParamTabExFileDateReleased()

Returns the "display file date released" setting.

Returns:: "true" if the file date released input field is checked, otherwise ""

getParamTabExFileEntries

public String getParamTabExFileEntries()

Returns the "explorer number of entries per page" setting.

Returns:: the "explorer number of entries per page" setting

getParamTabExFileLockedBy

public String getParamTabExFileLockedBy()

Returns the "display file locked by" setting.

Returns:: "true" if the file locked by input field is checked, otherwise ""

getParamTabExFilePermissions

public String getParamTabExFilePermissions()

Returns the "display file permissions" setting.

Returns:: "true" if the file permissions input field is checked, otherwise ""

getParamTabExFileSize

public String getParamTabExFileSize()

Returns the "display file size" setting.

Returns:: "true" if the file size input field is checked, otherwise ""

getParamTabExFileState

public String getParamTabExFileState()

Returns the "display file state" setting.

Returns:: "true" if the file state input field is checked, otherwise ""

getParamTabExFileTitle

public String getParamTabExFileTitle()

Returns the "display file title" setting.

Returns:: "true" if the file title input field is checked, otherwise ""

getParamTabExFileType

public String getParamTabExFileType()

Returns the "display file type" setting.

Returns:: "true" if the file type input field is checked, otherwise ""

getParamTabExFileUserCreated

public String getParamTabExFileUserCreated()

Returns the "display file created by" setting.

Returns:: "true" if the file created by input field is checked, otherwise ""

getParamTabExFileUserLastModified

public String getParamTabExFileUserLastModified()

Returns the "display file last modified by" setting.

Returns:: "true" if the file last modified by input field is checked, otherwise ""

getParamTabWfFilter

public String getParamTabWfFilter()

Returns the "task startup filter" setting.

Returns:: the "task startup filter" setting

getParamTabWfMessageAccepted

public String getParamTabWfMessageAccepted()

Returns the "message when accepted" setting.

Returns:: the "message when accepted" setting

getParamTabWfMessageCompleted

public String getParamTabWfMessageCompleted()

Returns the "message when completed" setting.

Returns:: the "message when completed" setting

getParamTabWfMessageForwarded

public String getParamTabWfMessageForwarded()

Returns the "message when forwarded" setting.

Returns:: the "message when forwarded" setting

getParamTabWfMessageMembers

public String getParamTabWfMessageMembers()

Returns the "inform all role members" setting.

Returns:: "true" if the "inform all role members" input field is checked, otherwise ""

getParamTabWfShowAllProjects

public String getParamTabWfShowAllProjects()

returns the "show all projects" setting.

Returns:: the "show all projects" setting

getParamTabWpButtonStyle

public String getParamTabWpButtonStyle()

Returns the "workplace button style" setting.

Returns:: the "workplace button style" setting

getParamTabWpFolder

public String getParamTabWpFolder()

Returns the "start folder" setting.

Returns:: the "start folder" setting

getParamTabWpLanguage

public String getParamTabWpLanguage()

Returns the start language setting.

Returns:: the start language setting

getParamTabWpProject

public String getParamTabWpProject()

Returns the start project setting.

Returns:: the start project setting

getParamTabWpReportType

public String getParamTabWpReportType()

Returns the "workplace report type" setting.

Returns:: the "workplace report type" setting

getParamTabWpRestrictExplorerView

public String getParamTabWpRestrictExplorerView()

Returns the "workplace restrict explorer view" setting.

Returns:: the "workplace restrict explorer view" setting

getParamTabWpSite

public String getParamTabWpSite()

Returns the "start site" setting.

Returns:: the "start site" setting

getParamTabWpUseUploadApplet

public String getParamTabWpUseUploadApplet()

Returns the "use upload applet" setting.

Returns:: "true" if the "use upload applet" input is checked, otherwise ""

getParamTabWpView

public String getParamTabWpView()

Returns the start view setting.

Returns:: the start view setting

getTabParameterOrder

public List getTabParameterOrder()

Description copied from class: CmsTabDialog

Returns the order of the parameter prefixes for each tab.

For example, all parameters stored in tab 1 have the prefix "Tab1", i.e. the getter and setter methods must be getParamTab1MyParameterName().

To change the tab order, simply change the order in the String array and in the generated tab list.

Specified by:: getTabParameterOrder in class CmsTabDialog

Returns:: the ordered parameter prefix List
See Also:: CmsTabDialog.getTabParameterOrder()

getTabs

public List getTabs()

Description copied from class: CmsTabDialog

Returns a list with localized Strings representing the names of the tabs.

Specified by:: getTabs in class CmsTabDialog

Returns:: list with localized String for the tabs
See Also:: CmsTabDialog.getTabs()

isChecked

public String isChecked(String paramValue)

Helper method to add the "checked" attribute to an input field.

Parameters:: paramValue - the parameter value, if "true", the "checked" attribute will be returned
Returns:: the "checked" attribute or an empty String

setParamNewPassword

public void setParamNewPassword(String newPwd)

Sets the new password value.

Parameters:: newPwd - the new password value

setParamOldPassword

public void setParamOldPassword(String oldPwd)

Sets the old password value.

Parameters:: oldPwd - the old password value

setParamTabDiCopyFileMode

public void setParamTabDiCopyFileMode(String value)

Sets the "copy file default" setting.

Parameters:: value - the "copy file default" setting

setParamTabDiCopyFolderMode

public void setParamTabDiCopyFolderMode(String value)

Sets the "copy folder default" setting.

Parameters:: value - the "copy folder default" setting

setParamTabDiDeleteFileMode

public void setParamTabDiDeleteFileMode(String value)

Sets the "delete file siblings default" setting.

Parameters:: value - the "delete file siblings default" setting

setParamTabDiPermissionsExpandInherited

public void setParamTabDiPermissionsExpandInherited(String value)

Sets the "expand inherited permissions" default setting.

Parameters:: value - the "expand inherited permissions" default setting

setParamTabDiPermissionsExpandUser

public void setParamTabDiPermissionsExpandUser(String value)

Sets the "expand current users permissions" default setting.

Parameters:: value - the "expand current users permissions" default setting

setParamTabDiPermissionsInheritOnFolder

public void setParamTabDiPermissionsInheritOnFolder(String value)

Sets the "inherit permissions on folders" default setting.

Parameters:: value - the "inherit permissions on folders" default setting

setParamTabDiPublishFileMode

public void setParamTabDiPublishFileMode(String value)

Sets the "publish file siblings default" setting.

Parameters:: value - the "publish file siblings default" setting

setParamTabDiShowLock

public void setParamTabDiShowLock(String value)

Sets the "display lock dialog" setting.

Parameters:: value - "true" to enable the "display lock dialog" setting, all others to disable

setParamTabEdButtonStyle

public void setParamTabEdButtonStyle(String value)

Sets the "editor button style" setting.

Parameters:: value - a String representation of an int value to set the "editor button style" setting

setParamTabEdDirectEditButtonStyle

public void setParamTabEdDirectEditButtonStyle(String value)

Sets the "direct edit button style" setting.

Parameters:: value - a String representation of an int value to set the "direct edit button style" setting

setParamTabExButtonStyle

public void setParamTabExButtonStyle(String value)

Sets the "explorer button style" setting.

Parameters:: value - a String representation of an int value to set the "explorer button style" setting

setParamTabExFileDateCreated

public void setParamTabExFileDateCreated(String value)

Sets the "display file creation date" setting.

Parameters:: value - "true" to enable the "display file creation date" setting, all others to disable

setParamTabExFileDateExpired

public void setParamTabExFileDateExpired(String value)

Sets the "display file expired date" setting.

Parameters:: value - "true" to enable the "display file expired date" setting, all others to disable

setParamTabExFileDateLastModified

public void setParamTabExFileDateLastModified(String value)

Sets the "display file last modification date" setting.

Parameters:: value - "true" to enable the "display file last modification date" setting, all others to disable

setParamTabExFileDateReleased

public void setParamTabExFileDateReleased(String value)

Sets the "display file released date" setting.

Parameters:: value - "true" to enable the "display file released date" setting, all others to disable

setParamTabExFileEntries

public void setParamTabExFileEntries(String value)

Sets the "explorer number of entries per page" setting.

Parameters:: value - a String representation of an int value to set the "number of entries per page" setting

setParamTabExFileLockedBy

public void setParamTabExFileLockedBy(String value)

Sets the "display file locked by" setting.

Parameters:: value - "true" to enable the "display file locked by" setting, all others to disable

setParamTabExFilePermissions

public void setParamTabExFilePermissions(String value)

Sets the "display file permissions" setting.

Parameters:: value - "true" to enable the "display file permissions" setting, all others to disable

setParamTabExFileSize

public void setParamTabExFileSize(String value)

Sets the "display file size" setting.

Parameters:: value - "true" to enable the "display file size" setting, all others to disable

setParamTabExFileState

public void setParamTabExFileState(String value)

Sets the "display file state" setting.

Parameters:: value - "true" to enable the "display file state" setting, all others to disable

setParamTabExFileTitle

public void setParamTabExFileTitle(String value)

Sets the "display file title" setting.

Parameters:: value - "true" to enable the "display file title" setting, all others to disable

setParamTabExFileType

public void setParamTabExFileType(String value)

Sets the "display file type" setting.

Parameters:: value - "true" to enable the "display file type" setting, all others to disable

setParamTabExFileUserCreated

public void setParamTabExFileUserCreated(String value)

Sets the "display file created by" setting.

Parameters:: value - "true" to enable the "display file created by" setting, all others to disable

setParamTabExFileUserLastModified

public void setParamTabExFileUserLastModified(String value)

Sets the "display file last modified by" setting.

Parameters:: value - "true" to enable the "display file last modified by" setting, all others to disable

setParamTabWfFilter

public void setParamTabWfFilter(String filter)

Sets the "task startup filter" setting.

Parameters:: filter - the "task startup filter" setting

setParamTabWfMessageAccepted

public void setParamTabWfMessageAccepted(String value)

Sets the "message when accepted" setting.

Parameters:: value - the "message when accepted" setting

setParamTabWfMessageCompleted

public void setParamTabWfMessageCompleted(String value)

Sets the "message when completed" setting.

Parameters:: value - the "message when completed" setting

setParamTabWfMessageForwarded

public void setParamTabWfMessageForwarded(String value)

Sets the "message when forwarded" setting.

Parameters:: value - the "message when forwarded" setting

setParamTabWfMessageMembers

public void setParamTabWfMessageMembers(String value)

Sets the "inform all role members" setting.

Parameters:: value - "true" to enable the "inform all role members" setting, all others to disable

setParamTabWfShowAllProjects

public void setParamTabWfShowAllProjects(String value)

Sets the "show all projects" setting.

Parameters:: value - the "show all projects" setting

setParamTabWpButtonStyle

public void setParamTabWpButtonStyle(String value)

Sets the "workplace button style" setting.

Parameters:: value - a String representation of an int value to set the "workplace button style" setting

setParamTabWpFolder

public void setParamTabWpFolder(String value)

Sets the "start folder" setting.

Parameters:: value - the start folder to show in the explorer view

setParamTabWpLanguage

public void setParamTabWpLanguage(String value)

Sets the start language setting.

Parameters:: value - the start language setting

setParamTabWpProject

public void setParamTabWpProject(String value)

Sets the start project setting.

Parameters:: value - the start project setting

setParamTabWpReportType

public void setParamTabWpReportType(String value)

Sets the "workplace report type" setting.

Parameters:: value - the "workplace report type" setting

setParamTabWpRestrictExplorerView

public void setParamTabWpRestrictExplorerView(String value)

Sets the "workplace restrict explorer view" setting.

Parameters:: value - the "workplace restrict explorer view" setting

setParamTabWpSite

public void setParamTabWpSite(String value)

Sets the "start site" setting.

Parameters:: value - the start site to show in the explorer view

setParamTabWpUseUploadApplet

public void setParamTabWpUseUploadApplet(String value)

Sets the "use upload applet" setting.

Parameters:: value - "true" to enable the "use upload applet" setting, all others to disable

setParamTabWpView

public void setParamTabWpView(String value)

Sets the start view setting.

Parameters:: value - the start view setting

initWorkplaceRequestValues

protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings,
                                          HttpServletRequest request)

Description copied from class: CmsWorkplace

Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.

Overrides:: initWorkplaceRequestValues in class CmsDialog

Parameters:: settings - the workplace settings; request - the current request
See Also:: CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)

paramValues

protected Map paramValues()

Returns the values of all parameter methods of this workplace class instance.

This overwrites the super method because of the possible dynamic editor selection entries.

Overrides:: paramValues in class CmsWorkplace

Returns:: the values of all parameter methods of this workplace class instance

updatePreferences

protected void updatePreferences(CmsObject cms,
                                 HttpServletRequest req)

Updates the user preferences after changes have been made.

Parameters:: cms - the current cms context; req - the current http request

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.opencms.workplace.commons Class CmsPreferences

ACTION_CHPWD

ACTION_ERROR

ACTION_RELOAD

DIALOG_CHPWD

DIALOG_RELOAD

DIALOG_TYPE

INPUT_DEFAULT

PARAM_DIALOGS_COPYFILEMODE

PARAM_DIALOGS_COPYFOLDERMODE

PARAM_DIALOGS_DELETEFILEMODE

PARAM_DIALOGS_PERMISSIONS_EXPANDINHERITED

PARAM_DIALOGS_PERMISSIONS_EXPANDUSER

PARAM_DIALOGS_PERMISSIONS_INHERITONFOLDER

PARAM_DIALOGS_PUBLISHFILEMODE

PARAM_DIALOGS_SHOWLOCK

PARAM_DIRECTEDIT_BUTTONSTYLE

PARAM_EDITOR_BUTTONSTYLE

PARAM_EXPLORER_BUTTONSTYLE

PARAM_EXPLORER_FILEDATECREATED

PARAM_EXPLORER_FILEDATEEXPIRED

PARAM_EXPLORER_FILEDATELASTMODIFIED

PARAM_EXPLORER_FILEDATERELEASED

PARAM_EXPLORER_FILEENTRIES

PARAM_EXPLORER_FILELOCKEDBY

PARAM_EXPLORER_FILEPERMISSIONS

PARAM_EXPLORER_FILESIZE

PARAM_EXPLORER_FILESTATE

PARAM_EXPLORER_FILETITLE

PARAM_EXPLORER_FILETYPE

PARAM_EXPLORER_FILEUSERCREATED

PARAM_EXPLORER_FILEUSERLASTMODIFIED

PARAM_NEWPASSWORD

PARAM_OLDPASSWORD

PARAM_PREFERREDEDITOR_PREFIX

PARAM_WORKFLOW_FILTER

PARAM_WORKFLOW_MESSAGEACCEPTED

PARAM_WORKFLOW_MESSAGECOMPLETED

PARAM_WORKFLOW_MESSAGEFORWARDED

PARAM_WORKFLOW_MESSAGEMEMBERS

PARAM_WORKFLOW_SHOWALLPROJECTS

PARAM_WORKPLACE_BUTTONSTYLE

PARAM_WORKPLACE_FOLDER

PARAM_WORKPLACE_LANGUAGE

PARAM_WORKPLACE_PROJECT

PARAM_WORKPLACE_REPORTTYPE

PARAM_WORKPLACE_RESTRICTEXPLORERVIEW

PARAM_WORKPLACE_SITE

PARAM_WORKPLACE_USEUPLOADAPPLET

PARAM_WORKPLACE_VIEW

CmsPreferences

CmsPreferences

actionChangePassword

actionSave

buildSelectCopyFileMode

buildSelectCopyFolderMode

buildSelectDeleteFileMode

buildSelectDirectEditButtonStyle

buildSelectEditorButtonStyle

buildSelectExplorerButtonStyle

buildSelectExplorerFileEntries

buildSelectFilter

buildSelectLanguage

buildSelectPreferredEditors

buildSelectProject

buildSelectPublishSiblings

buildSelectReportType

buildSelectSite

buildSelectView

buildSelectWorkplaceButtonStyle

buildUserInformation

getParamNewPassword

getParamOldPassword

getParamTabDiCopyFileMode

getParamTabDiCopyFolderMode

getParamTabDiDeleteFileMode

getParamTabDiPermissionsExpandInherited

getParamTabDiPermissionsExpandUser

getParamTabDiPermissionsInheritOnFolder

getParamTabDiPublishFileMode

org.opencms.workplace.commons
Class CmsPreferences