org.opencms.workplace.commons
Class CmsPreferences

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

public class CmsPreferences
extends CmsTabDialog

Provides methods for the user preferences dialog.

The following files use this class:

Since:
6.0.0
Version:
$Revision: 1.48 $
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 java.lang.String DIALOG_CHPWD
          Request parameter value for the action: change the password.
static java.lang.String DIALOG_RELOAD
          Request parameter value for the action: reload the workplace.
static java.lang.String DIALOG_TYPE
          The dialog type.
static java.lang.String INPUT_DEFAULT
          Request parameter name prefix for the preferred editors.
static java.lang.String INPUT_NONE
          Request parameter name for no settings in start galleries.
static java.lang.String INPUT_PRESELECT
          Request parameter name for global gallery settings.
static java.lang.String PARAM_DIALOGS_COPYFILEMODE
          Request parameter name for the dialog copy file siblings default setting.
static java.lang.String PARAM_DIALOGS_COPYFOLDERMODE
          Request parameter name for the dialog copy folder siblings default setting.
static java.lang.String PARAM_DIALOGS_DELETEFILEMODE
          Request parameter name for the dialog delete file siblings default setting.
static java.lang.String PARAM_DIALOGS_PERMISSIONS_EXPANDINHERITED
          Request parameter name for the dialog permissions show inherited permissions.
static java.lang.String PARAM_DIALOGS_PERMISSIONS_EXPANDUSER
          Request parameter name for the dialog permissions show current users permissions.
static java.lang.String PARAM_DIALOGS_PERMISSIONS_INHERITONFOLDER
          Request parameter name for the dialog permissions default inheritance behavior on folders.
static java.lang.String PARAM_DIALOGS_PUBLISHFILEMODE
          Request parameter name for the dialog publish file siblings default setting.
static java.lang.String PARAM_DIALOGS_SHOWLOCK
          Request parameter name for the dialog show lock.
static java.lang.String PARAM_DIRECTEDIT_BUTTONSTYLE
          Request parameter name for the direct edit button style.
static java.lang.String PARAM_EDITOR_BUTTONSTYLE
          Request parameter name for the editor button style.
static java.lang.String PARAM_EXPLORER_BUTTONSTYLE
          Request parameter name for the explorer button style.
static java.lang.String PARAM_EXPLORER_FILEDATECREATED
          Request parameter name for the explorer file date created.
static java.lang.String PARAM_EXPLORER_FILEDATEEXPIRED
          Request parameter name for the explorer file date expired.
static java.lang.String PARAM_EXPLORER_FILEDATELASTMODIFIED
          Request parameter name for the explorer file date last modified.
static java.lang.String PARAM_EXPLORER_FILEDATERELEASED
          Request parameter name for the explorer file date released.
static java.lang.String PARAM_EXPLORER_FILEENTRIES
          Request parameter name for the explorer file entry number.
static java.lang.String PARAM_EXPLORER_FILELOCKEDBY
          Request parameter name for the explorer file locked by.
static java.lang.String PARAM_EXPLORER_FILENAVTEXT
          Request parameter name for the explorer file navtext.
static java.lang.String PARAM_EXPLORER_FILEPERMISSIONS
          Request parameter name for the explorer file permissions.
static java.lang.String PARAM_EXPLORER_FILESIZE
          Request parameter name for the explorer file size.
static java.lang.String PARAM_EXPLORER_FILESTATE
          Request parameter name for the explorer file state.
static java.lang.String PARAM_EXPLORER_FILETITLE
          Request parameter name for the explorer file title.
static java.lang.String PARAM_EXPLORER_FILETYPE
          Request parameter name for the explorer file type.
static java.lang.String PARAM_EXPLORER_FILEUSERCREATED
          Request parameter name for the explorer file user created.
static java.lang.String PARAM_EXPLORER_FILEUSERLASTMODIFIED
          Request parameter name for the explorer file user last modified.
static java.lang.String PARAM_EXPLORER_SEARCH_RESULT
          Request parameter name for the workplace search result list style.
static java.lang.String PARAM_NEWPASSWORD
          Request parameter name for the new password.
static java.lang.String PARAM_OLDPASSWORD
          Request parameter name for the old password.
static java.lang.String PARAM_PREFERREDEDITOR_PREFIX
          Request parameter name prefix for the preferred editors.
static java.lang.String PARAM_STARTGALLERY_PREFIX
          Request parameter name prefix for the preferred editors.
static java.lang.String PARAM_WORKPLACE_BUTTONSTYLE
          Request parameter name for the workplace button style.
static java.lang.String PARAM_WORKPLACE_FOLDER
          Request parameter name for the workplace start folder.
static java.lang.String PARAM_WORKPLACE_LANGUAGE
          Request parameter name for the workplace language.
static java.lang.String PARAM_WORKPLACE_LISTALLPROJECTS
          Request parameter name for the user language.
static java.lang.String PARAM_WORKPLACE_PROJECT
          Request parameter name for the workplace project.
static java.lang.String PARAM_WORKPLACE_REPORTTYPE
          Request parameter name for the workplace report type.
static java.lang.String PARAM_WORKPLACE_RESTRICTEXPLORERVIEW
          Request parameter name for the workplace explorer view restriction.
static java.lang.String PARAM_WORKPLACE_SHOWPUBLISHNOTIFICATION
          Request parameter name for the workplace show publish notification.
static java.lang.String PARAM_WORKPLACE_SITE
          Request parameter name for the workplace start site.
static java.lang.String PARAM_WORKPLACE_TIMEWARP
          Request parameter name for the user language.
static java.lang.String PARAM_WORKPLACE_USEUPLOADAPPLET
          Request parameter name for the workplace use upload applet.
static java.lang.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_CONTINUE, ACTION_DEFAULT, ACTION_LOCKS_CONFIRMED, 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_LOCKS_CONFIRMED, 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_ORIGINALPARAMS, PARAM_PREACTIONDONE, 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_BASE, PARAM_FORCE, 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
 
Constructor Summary
CmsPreferences(CmsJspActionElement jsp)
          Public constructor with JSP action element.
CmsPreferences(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.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.
 java.lang.String buildSelectCopyFileMode(java.lang.String htmlAttributes)
          Builds the html for the default copy file mode select box.
 java.lang.String buildSelectCopyFolderMode(java.lang.String htmlAttributes)
          Builds the html for the default copy folder mode select box.
 java.lang.String buildSelectDeleteFileMode(java.lang.String htmlAttributes)
          Builds the html for the default delete file mode select box.
 java.lang.String buildSelectDirectEditButtonStyle(java.lang.String htmlAttributes)
          Builds the html for the direct edit button style select box.
 java.lang.String buildSelectEditorButtonStyle(java.lang.String htmlAttributes)
          Builds the html for the editor button style select box.
 java.lang.String buildSelectExplorerButtonStyle(java.lang.String htmlAttributes)
          Builds the html for the explorer button style select box.
 java.lang.String buildSelectExplorerFileEntries(java.lang.String htmlAttributes)
          Builds the html for the explorer number of entries per page select box.
 java.lang.String buildSelectLanguage(java.lang.String htmlAttributes)
          Builds the html for the language select box of the start settings.
 java.lang.String buildSelectPreferredEditors(java.lang.String htmlAttributes)
          Builds the html for the preferred editors select boxes of the editor settings.
 java.lang.String buildSelectProject(java.lang.String htmlAttributes)
          Builds the html for the project select box of the start settings.
 java.lang.String buildSelectPublishSiblings(java.lang.String htmlAttributes)
          Builds the html for the default publish siblings mode select box.
 java.lang.String buildSelectReportType(java.lang.String htmlAttributes)
          Builds the html for the workplace report type select box.
 java.lang.String buildSelectSite(java.lang.String htmlAttributes)
          Builds the html for the workplace start site select box.
 java.lang.String buildSelectStartGalleries(java.lang.String htmlAttributes)
          Builds the HTML for the start galleries settings as select boxes.
 java.lang.String buildSelectView(java.lang.String htmlAttributes)
          Returns a html select box filled with the views accessible by the current user.
 java.lang.String buildSelectWorkplaceButtonStyle(java.lang.String htmlAttributes)
          Builds the html for the workplace button style select box.
 java.lang.String buildSelectWorkplaceSearchResult(java.lang.String htmlAttributes)
          Builds the html for the workplace search result list type select box.
 java.lang.String buildUserInformation()
          Builds the html code for the static user information table (tab 4).
 java.lang.String calendarIncludes()
          Deprecated. use CmsCalendarWidget.calendarIncludes(java.util.Locale), this is just here so that old JSP still work
 java.lang.String calendarInit(java.lang.String inputFieldId, java.lang.String triggerButtonId, java.lang.String align, boolean singleClick, boolean weekNumbers, boolean mondayFirst, java.lang.String dateStatusFunc, boolean showTime)
          Deprecated. use CmsCalendarWidget.calendarInit(org.opencms.i18n.CmsMessages, String, String, String, boolean, boolean, boolean, String, boolean), this is just here so that old JSP still work
 java.lang.String getParamNewPassword()
          Returns the new password value.
 java.lang.String getParamOldPassword()
          Returns the old password value.
 java.lang.String getParamTabDiCopyFileMode()
          Returns the "copy file default" setting.
 java.lang.String getParamTabDiCopyFolderMode()
          Returns the "copy folder default" setting.
 java.lang.String getParamTabDiDeleteFileMode()
          Returns the "delete file default" setting.
 java.lang.String getParamTabDiPermissionsExpandInherited()
          Returns the "expand inherited permissions" default setting.
 java.lang.String getParamTabDiPermissionsExpandUser()
          Returns the "expand current users permissions" default setting.
 java.lang.String getParamTabDiPermissionsInheritOnFolder()
          Returns the "inherit permissions on folders" default setting.
 java.lang.String getParamTabDiPublishFileMode()
          Returns the "publish file siblings default" setting.
 java.lang.String getParamTabDiShowLock()
          Returns the "display lock dialog" setting.
 java.lang.String getParamTabEdButtonStyle()
          Returns the "editor button style" setting.
 java.lang.String getParamTabEdDirectEditButtonStyle()
          Returns the "direct edit button style" setting.
 java.lang.String getParamTabExButtonStyle()
          Returns the "explorer button style" setting.
 java.lang.String getParamTabExFileDateCreated()
          Returns the "display file creation date" setting.
 java.lang.String getParamTabExFileDateExpired()
          Returns the "display file date expired" setting.
 java.lang.String getParamTabExFileDateLastModified()
          Returns the "display file last modification date" setting.
 java.lang.String getParamTabExFileDateReleased()
          Returns the "display file date released" setting.
 java.lang.String getParamTabExFileEntries()
          Returns the "explorer number of entries per page" setting.
 java.lang.String getParamTabExFileLockedBy()
          Returns the "display file locked by" setting.
 java.lang.String getParamTabExFileNavText()
          Returns the "display navtext" setting.
 java.lang.String getParamTabExFilePermissions()
          Returns the "display file permissions" setting.
 java.lang.String getParamTabExFileSize()
          Returns the "display file size" setting.
 java.lang.String getParamTabExFileState()
          Returns the "display file state" setting.
 java.lang.String getParamTabExFileTitle()
          Returns the "display file title" setting.
 java.lang.String getParamTabExFileType()
          Returns the "display file type" setting.
 java.lang.String getParamTabExFileUserCreated()
          Returns the "display file created by" setting.
 java.lang.String getParamTabExFileUserLastModified()
          Returns the "display file last modified by" setting.
 java.lang.String getParamTabExWorkplaceSearchResult()
          Returns the "workplace search result style" setting.
 java.lang.String getParamTabWpButtonStyle()
          Returns the "workplace button style" setting.
 java.lang.String getParamTabWpFolder()
          Returns the "start folder" setting.
 java.lang.String getParamTabWpLanguage()
          Returns the start language setting.
 java.lang.String getParamTabWpListAllProjects()
          Returns the "list all projects" setting.
 java.lang.String getParamTabWpProject()
          Returns the start project setting.
 java.lang.String getParamTabWpReportType()
          Returns the "workplace report type" setting.
 java.lang.String getParamTabWpRestrictExplorerView()
          Returns the "workplace restrict explorer view" setting.
 java.lang.String getParamTabWpShowPublishNotification()
          Returns the "show publish notification" setting.
 java.lang.String getParamTabWpSite()
          Returns the "start site" setting.
 java.lang.String getParamTabWpTimewarp()
          Get the "user timewparp" setting in form of a formatted date string.
 java.lang.String getParamTabWpUseUploadApplet()
          Returns the "use upload applet" setting.
 java.lang.String getParamTabWpView()
          Returns the start view setting.
 java.util.List getTabParameterOrder()
          Returns the order of the parameter prefixes for each tab.
 java.util.List getTabs()
          Returns a list with localized Strings representing the names of the tabs.
protected  void initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
          Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
 java.lang.String isChecked(java.lang.String paramValue)
          Helper method to add the "checked" attribute to an input field.
protected  java.util.Map paramValues()
          Returns the values of all parameter methods of this workplace class instance.
 void setParamNewPassword(java.lang.String newPwd)
          Sets the new password value.
 void setParamOldPassword(java.lang.String oldPwd)
          Sets the old password value.
 void setParamTabDiCopyFileMode(java.lang.String value)
          Sets the "copy file default" setting.
 void setParamTabDiCopyFolderMode(java.lang.String value)
          Sets the "copy folder default" setting.
 void setParamTabDiDeleteFileMode(java.lang.String value)
          Sets the "delete file siblings default" setting.
 void setParamTabDiPermissionsExpandInherited(java.lang.String value)
          Sets the "expand inherited permissions" default setting.
 void setParamTabDiPermissionsExpandUser(java.lang.String value)
          Sets the "expand current users permissions" default setting.
 void setParamTabDiPermissionsInheritOnFolder(java.lang.String value)
          Sets the "inherit permissions on folders" default setting.
 void setParamTabDiPublishFileMode(java.lang.String value)
          Sets the "publish file siblings default" setting.
 void setParamTabDiShowLock(java.lang.String value)
          Sets the "display lock dialog" setting.
 void setParamTabEdButtonStyle(java.lang.String value)
          Sets the "editor button style" setting.
 void setParamTabEdDirectEditButtonStyle(java.lang.String value)
          Sets the "direct edit button style" setting.
 void setParamTabExButtonStyle(java.lang.String value)
          Sets the "explorer button style" setting.
 void setParamTabExFileDateCreated(java.lang.String value)
          Sets the "display file creation date" setting.
 void setParamTabExFileDateExpired(java.lang.String value)
          Sets the "display file expired date" setting.
 void setParamTabExFileDateLastModified(java.lang.String value)
          Sets the "display file last modification date" setting.
 void setParamTabExFileDateReleased(java.lang.String value)
          Sets the "display file released date" setting.
 void setParamTabExFileEntries(java.lang.String value)
          Sets the "explorer number of entries per page" setting.
 void setParamTabExFileLockedBy(java.lang.String value)
          Sets the "display file locked by" setting.
 void setParamTabExFileNavText(java.lang.String value)
          Sets the "display file navtext" setting.
 void setParamTabExFilePermissions(java.lang.String value)
          Sets the "display file permissions" setting.
 void setParamTabExFileSize(java.lang.String value)
          Sets the "display file size" setting.
 void setParamTabExFileState(java.lang.String value)
          Sets the "display file state" setting.
 void setParamTabExFileTitle(java.lang.String value)
          Sets the "display file title" setting.
 void setParamTabExFileType(java.lang.String value)
          Sets the "display file type" setting.
 void setParamTabExFileUserCreated(java.lang.String value)
          Sets the "display file created by" setting.
 void setParamTabExFileUserLastModified(java.lang.String value)
          Sets the "display file last modified by" setting.
 void setParamTabExWorkplaceSearchResult(java.lang.String style)
          Sets the "workplace search result style".
 void setParamTabWpButtonStyle(java.lang.String value)
          Sets the "workplace button style" setting.
 void setParamTabWpFolder(java.lang.String value)
          Sets the "start folder" setting.
 void setParamTabWpLanguage(java.lang.String value)
          Sets the start language setting.
 void setParamTabWpListAllProjects(java.lang.String value)
          Sets the "list all projects" flag.
 void setParamTabWpProject(java.lang.String value)
          Sets the start project setting.
 void setParamTabWpReportType(java.lang.String value)
          Sets the "workplace report type" setting.
 void setParamTabWpRestrictExplorerView(java.lang.String value)
          Sets the "workplace restrict explorer view" setting.
 void setParamTabWpShowPublishNotification(java.lang.String value)
          Sets the "show publish notification" setting.
 void setParamTabWpSite(java.lang.String value)
          Sets the "start site" setting.
 void setParamTabWpTimeWarp(java.lang.String value)
          Sets the "user timewparp" setting.
 void setParamTabWpUseUploadApplet(java.lang.String value)
          Sets the "use upload applet" setting.
 void setParamTabWpView(java.lang.String value)
          Sets the start view setting.
protected  void updatePreferences(CmsObject cms, javax.servlet.http.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, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockDialog, buildLockDialog, buildLockHeaderBox, checkResourcePermissions, checkResourcePermissions, computeCurrentFolder, dialog, dialogBlock, dialogBlockEnd, dialogBlockStart, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsHtml, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, dialogLockButtons, 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, getParamOriginalParams, getParamPreActionDone, getParamRedirect, getParamResource, getParamTitle, getState, hasCorrectLockstate, hasSiblings, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, isPreEditor, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamResource, setParamTitle
 
Methods inherited from class org.opencms.workplace.tools.CmsToolDialog
dialogTitle, getAdminTool, getCurrentToolPath, getParamBase, getParamForce, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamForce, setParamPath, setParamRoot, setParamStyle, useNewStyle
 
Methods inherited from class org.opencms.workplace.CmsWorkplace
addMessages, addMessages, allParamsAsHidden, allParamsAsRequest, allParamValues, bodyEnd, bodyStart, bodyStart, buildSelect, buildSelect, button, button, buttonBar, buttonBar, buttonBarHorizontalLine, buttonBarLabel, buttonBarLabel, buttonBarLine, buttonBarLineSpacer, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, htmlEnd, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, isTemporaryFileName, key, key, keyDefault, 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 java.lang.String DIALOG_CHPWD
Request parameter value for the action: change the password.

See Also:
Constant Field Values

DIALOG_RELOAD

public static final java.lang.String DIALOG_RELOAD
Request parameter value for the action: reload the workplace.

See Also:
Constant Field Values

DIALOG_TYPE

public static final java.lang.String DIALOG_TYPE
The dialog type.

See Also:
Constant Field Values

INPUT_DEFAULT

public static final java.lang.String INPUT_DEFAULT
Request parameter name prefix for the preferred editors.

See Also:
Constant Field Values

INPUT_NONE

public static final java.lang.String INPUT_NONE
Request parameter name for no settings in start galleries.

See Also:
Constant Field Values

INPUT_PRESELECT

public static final java.lang.String INPUT_PRESELECT
Request parameter name for global gallery settings.

See Also:
Constant Field Values

PARAM_DIALOGS_COPYFILEMODE

public static final java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.String PARAM_DIALOGS_PERMISSIONS_INHERITONFOLDER
Request parameter name for the dialog permissions default inheritance behavior on folders.

See Also:
Constant Field Values

PARAM_DIALOGS_PUBLISHFILEMODE

public static final java.lang.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 java.lang.String PARAM_DIALOGS_SHOWLOCK
Request parameter name for the dialog show lock.

See Also:
Constant Field Values

PARAM_DIRECTEDIT_BUTTONSTYLE

public static final java.lang.String PARAM_DIRECTEDIT_BUTTONSTYLE
Request parameter name for the direct edit button style.

See Also:
Constant Field Values

PARAM_EDITOR_BUTTONSTYLE

public static final java.lang.String PARAM_EDITOR_BUTTONSTYLE
Request parameter name for the editor button style.

See Also:
Constant Field Values

PARAM_EXPLORER_BUTTONSTYLE

public static final java.lang.String PARAM_EXPLORER_BUTTONSTYLE
Request parameter name for the explorer button style.

See Also:
Constant Field Values

PARAM_EXPLORER_FILEDATECREATED

public static final java.lang.String PARAM_EXPLORER_FILEDATECREATED
Request parameter name for the explorer file date created.

See Also:
Constant Field Values

PARAM_EXPLORER_FILEDATEEXPIRED

public static final java.lang.String PARAM_EXPLORER_FILEDATEEXPIRED
Request parameter name for the explorer file date expired.

See Also:
Constant Field Values

PARAM_EXPLORER_FILEDATELASTMODIFIED

public static final java.lang.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 java.lang.String PARAM_EXPLORER_FILEDATERELEASED
Request parameter name for the explorer file date released.

See Also:
Constant Field Values

PARAM_EXPLORER_FILEENTRIES

public static final java.lang.String PARAM_EXPLORER_FILEENTRIES
Request parameter name for the explorer file entry number.

See Also:
Constant Field Values

PARAM_EXPLORER_FILELOCKEDBY

public static final java.lang.String PARAM_EXPLORER_FILELOCKEDBY
Request parameter name for the explorer file locked by.

See Also:
Constant Field Values

PARAM_EXPLORER_FILENAVTEXT

public static final java.lang.String PARAM_EXPLORER_FILENAVTEXT
Request parameter name for the explorer file navtext.

See Also:
Constant Field Values

PARAM_EXPLORER_FILEPERMISSIONS

public static final java.lang.String PARAM_EXPLORER_FILEPERMISSIONS
Request parameter name for the explorer file permissions.

See Also:
Constant Field Values

PARAM_EXPLORER_FILESIZE

public static final java.lang.String PARAM_EXPLORER_FILESIZE
Request parameter name for the explorer file size.

See Also:
Constant Field Values

PARAM_EXPLORER_FILESTATE

public static final java.lang.String PARAM_EXPLORER_FILESTATE
Request parameter name for the explorer file state.

See Also:
Constant Field Values

PARAM_EXPLORER_FILETITLE

public static final java.lang.String PARAM_EXPLORER_FILETITLE
Request parameter name for the explorer file title.

See Also:
Constant Field Values

PARAM_EXPLORER_FILETYPE

public static final java.lang.String PARAM_EXPLORER_FILETYPE
Request parameter name for the explorer file type.

See Also:
Constant Field Values

PARAM_EXPLORER_FILEUSERCREATED

public static final java.lang.String PARAM_EXPLORER_FILEUSERCREATED
Request parameter name for the explorer file user created.

See Also:
Constant Field Values

PARAM_EXPLORER_FILEUSERLASTMODIFIED

public static final java.lang.String PARAM_EXPLORER_FILEUSERLASTMODIFIED
Request parameter name for the explorer file user last modified.

See Also:
Constant Field Values

PARAM_EXPLORER_SEARCH_RESULT

public static final java.lang.String PARAM_EXPLORER_SEARCH_RESULT
Request parameter name for the workplace search result list style.

See Also:
Constant Field Values

PARAM_NEWPASSWORD

public static final java.lang.String PARAM_NEWPASSWORD
Request parameter name for the new password.

See Also:
Constant Field Values

PARAM_OLDPASSWORD

public static final java.lang.String PARAM_OLDPASSWORD
Request parameter name for the old password.

See Also:
Constant Field Values

PARAM_PREFERREDEDITOR_PREFIX

public static final java.lang.String PARAM_PREFERREDEDITOR_PREFIX
Request parameter name prefix for the preferred editors.

See Also:
Constant Field Values

PARAM_STARTGALLERY_PREFIX

public static final java.lang.String PARAM_STARTGALLERY_PREFIX
Request parameter name prefix for the preferred editors.

See Also:
Constant Field Values

PARAM_WORKPLACE_BUTTONSTYLE

public static final java.lang.String PARAM_WORKPLACE_BUTTONSTYLE
Request parameter name for the workplace button style.

See Also:
Constant Field Values

PARAM_WORKPLACE_FOLDER

public static final java.lang.String PARAM_WORKPLACE_FOLDER
Request parameter name for the workplace start folder.

See Also:
Constant Field Values

PARAM_WORKPLACE_LANGUAGE

public static final java.lang.String PARAM_WORKPLACE_LANGUAGE
Request parameter name for the workplace language.

See Also:
Constant Field Values

PARAM_WORKPLACE_LISTALLPROJECTS

public static final java.lang.String PARAM_WORKPLACE_LISTALLPROJECTS
Request parameter name for the user language.

See Also:
Constant Field Values

PARAM_WORKPLACE_PROJECT

public static final java.lang.String PARAM_WORKPLACE_PROJECT
Request parameter name for the workplace project.

See Also:
Constant Field Values

PARAM_WORKPLACE_REPORTTYPE

public static final java.lang.String PARAM_WORKPLACE_REPORTTYPE
Request parameter name for the workplace report type.

See Also:
Constant Field Values

PARAM_WORKPLACE_RESTRICTEXPLORERVIEW

public static final java.lang.String PARAM_WORKPLACE_RESTRICTEXPLORERVIEW
Request parameter name for the workplace explorer view restriction.

See Also:
Constant Field Values

PARAM_WORKPLACE_SHOWPUBLISHNOTIFICATION

public static final java.lang.String PARAM_WORKPLACE_SHOWPUBLISHNOTIFICATION
Request parameter name for the workplace show publish notification.

See Also:
Constant Field Values

PARAM_WORKPLACE_SITE

public static final java.lang.String PARAM_WORKPLACE_SITE
Request parameter name for the workplace start site.

See Also:
Constant Field Values

PARAM_WORKPLACE_TIMEWARP

public static final java.lang.String PARAM_WORKPLACE_TIMEWARP
Request parameter name for the user language.

See Also:
Constant Field Values

PARAM_WORKPLACE_USEUPLOADAPPLET

public static final java.lang.String PARAM_WORKPLACE_USEUPLOADAPPLET
Request parameter name for the workplace use upload applet.

See Also:
Constant Field Values

PARAM_WORKPLACE_VIEW

public static final java.lang.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(javax.servlet.jsp.PageContext context,
                      javax.servlet.http.HttpServletRequest req,
                      javax.servlet.http.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 javax.servlet.jsp.JspException
Performs the change password action.

Throws:
javax.servlet.jsp.JspException - if inclusion of error element fails

actionSave

public void actionSave()
Performs the save operation of the modified user settings.


buildSelectCopyFileMode

public java.lang.String buildSelectCopyFileMode(java.lang.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 java.lang.String buildSelectCopyFolderMode(java.lang.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 java.lang.String buildSelectDeleteFileMode(java.lang.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 java.lang.String buildSelectDirectEditButtonStyle(java.lang.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 java.lang.String buildSelectEditorButtonStyle(java.lang.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 java.lang.String buildSelectExplorerButtonStyle(java.lang.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 java.lang.String buildSelectExplorerFileEntries(java.lang.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

buildSelectLanguage

public java.lang.String buildSelectLanguage(java.lang.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 java.lang.String buildSelectPreferredEditors(java.lang.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 java.lang.String buildSelectProject(java.lang.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 java.lang.String buildSelectPublishSiblings(java.lang.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 java.lang.String buildSelectReportType(java.lang.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 java.lang.String buildSelectSite(java.lang.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

buildSelectStartGalleries

public java.lang.String buildSelectStartGalleries(java.lang.String htmlAttributes)
Builds the HTML for the start galleries settings as select boxes.

Parameters:
htmlAttributes - optional HTML attributes for the &lgt;select> tag
Returns:
the HTML for start galleries select boxes

buildSelectView

public java.lang.String buildSelectView(java.lang.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 java.lang.String buildSelectWorkplaceButtonStyle(java.lang.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

buildSelectWorkplaceSearchResult

public java.lang.String buildSelectWorkplaceSearchResult(java.lang.String htmlAttributes)
Builds the html for the workplace search result list type select box.

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

buildUserInformation

public java.lang.String buildUserInformation()
Builds the html code for the static user information table (tab 4).

Returns:
the html code for the static user information table

calendarIncludes

public java.lang.String calendarIncludes()
Deprecated. use CmsCalendarWidget.calendarIncludes(java.util.Locale), this is just here so that old JSP still work

Creates the HTML JavaScript and stylesheet includes required by the calendar for the head of the page.

Returns:
the necessary HTML code for the js and stylesheet includes

calendarInit

public java.lang.String calendarInit(java.lang.String inputFieldId,
                                     java.lang.String triggerButtonId,
                                     java.lang.String align,
                                     boolean singleClick,
                                     boolean weekNumbers,
                                     boolean mondayFirst,
                                     java.lang.String dateStatusFunc,
                                     boolean showTime)
Deprecated. use CmsCalendarWidget.calendarInit(org.opencms.i18n.CmsMessages, String, String, String, boolean, boolean, boolean, String, boolean), this is just here so that old JSP still work

Generates the HTML to initialize the JavaScript calendar element on the end of a page.

Parameters:
inputFieldId - the ID of the input field where the date is pasted to
triggerButtonId - the ID of the button which triggers the calendar
align - initial position of the calendar popup element
singleClick - if true, a single click selects a date and closes the calendar, otherwise calendar is closed by doubleclick
weekNumbers - show the week numbers in the calendar or not
mondayFirst - show monday as first day of week
dateStatusFunc - name of the function which determines if/how a date should be disabled
showTime - true if the time selector should be shown, otherwise false
Returns:
the HTML code to initialize a calendar poup element

getParamNewPassword

public java.lang.String getParamNewPassword()
Returns the new password value.

Returns:
the new password value

getParamOldPassword

public java.lang.String getParamOldPassword()
Returns the old password value.

Returns:
the old password value

getParamTabDiCopyFileMode

public java.lang.String getParamTabDiCopyFileMode()
Returns the "copy file default" setting.

Returns:
the "copy file default" setting

getParamTabDiCopyFolderMode

public java.lang.String getParamTabDiCopyFolderMode()
Returns the "copy folder default" setting.

Returns:
the "copy folder default" setting

getParamTabDiDeleteFileMode

public java.lang.String getParamTabDiDeleteFileMode()
Returns the "delete file default" setting.

Returns:
the "delete file default" setting

getParamTabDiPermissionsExpandInherited

public java.lang.String getParamTabDiPermissionsExpandInherited()
Returns the "expand inherited permissions" default setting.

Returns:
the "expand inherited permissions" default setting

getParamTabDiPermissionsExpandUser

public java.lang.String getParamTabDiPermissionsExpandUser()
Returns the "expand current users permissions" default setting.

Returns:
the "expand current users permissions" default setting

getParamTabDiPermissionsInheritOnFolder

public java.lang.String getParamTabDiPermissionsInheritOnFolder()
Returns the "inherit permissions on folders" default setting.

Returns:
the "inherit permissions on folders" default setting

getParamTabDiPublishFileMode

public java.lang.String getParamTabDiPublishFileMode()
Returns the "publish file siblings default" setting.

Returns:
the "publish file siblings default" setting

getParamTabDiShowLock

public java.lang.String getParamTabDiShowLock()
Returns the "display lock dialog" setting.

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

getParamTabEdButtonStyle

public java.lang.String getParamTabEdButtonStyle()
Returns the "editor button style" setting.

Returns:
the "editor button style" setting

getParamTabEdDirectEditButtonStyle

public java.lang.String getParamTabEdDirectEditButtonStyle()
Returns the "direct edit button style" setting.

Returns:
the "direct edit button style" setting

getParamTabExButtonStyle

public java.lang.String getParamTabExButtonStyle()
Returns the "explorer button style" setting.

Returns:
the "explorer button style" setting

getParamTabExFileDateCreated

public java.lang.String getParamTabExFileDateCreated()
Returns the "display file creation date" setting.

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

getParamTabExFileDateExpired

public java.lang.String getParamTabExFileDateExpired()
Returns the "display file date expired" setting.

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

getParamTabExFileDateLastModified

public java.lang.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 java.lang.String getParamTabExFileDateReleased()
Returns the "display file date released" setting.

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

getParamTabExFileEntries

public java.lang.String getParamTabExFileEntries()
Returns the "explorer number of entries per page" setting.

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

getParamTabExFileLockedBy

public java.lang.String getParamTabExFileLockedBy()
Returns the "display file locked by" setting.

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

getParamTabExFileNavText

public java.lang.String getParamTabExFileNavText()
Returns the "display navtext" setting.

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

getParamTabExFilePermissions

public java.lang.String getParamTabExFilePermissions()
Returns the "display file permissions" setting.

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

getParamTabExFileSize

public java.lang.String getParamTabExFileSize()
Returns the "display file size" setting.

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

getParamTabExFileState

public java.lang.String getParamTabExFileState()
Returns the "display file state" setting.

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

getParamTabExFileTitle

public java.lang.String getParamTabExFileTitle()
Returns the "display file title" setting.

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

getParamTabExFileType

public java.lang.String getParamTabExFileType()
Returns the "display file type" setting.

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

getParamTabExFileUserCreated

public java.lang.String getParamTabExFileUserCreated()
Returns the "display file created by" setting.

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

getParamTabExFileUserLastModified

public java.lang.String getParamTabExFileUserLastModified()
Returns the "display file last modified by" setting.

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

getParamTabExWorkplaceSearchResult

public java.lang.String getParamTabExWorkplaceSearchResult()
Returns the "workplace search result style" setting.

Returns:
the "workplace search result style" setting

getParamTabWpButtonStyle

public java.lang.String getParamTabWpButtonStyle()
Returns the "workplace button style" setting.

Returns:
the "workplace button style" setting

getParamTabWpFolder

public java.lang.String getParamTabWpFolder()
Returns the "start folder" setting.

Returns:
the "start folder" setting

getParamTabWpLanguage

public java.lang.String getParamTabWpLanguage()
Returns the start language setting.

Returns:
the start language setting

getParamTabWpListAllProjects

public java.lang.String getParamTabWpListAllProjects()
Returns the "list all projects" setting.

Returns:
"true" if the "list all projects" input is checked, otherwise ""

getParamTabWpProject

public java.lang.String getParamTabWpProject()
Returns the start project setting.

Returns:
the start project setting

getParamTabWpReportType

public java.lang.String getParamTabWpReportType()
Returns the "workplace report type" setting.

Returns:
the "workplace report type" setting

getParamTabWpRestrictExplorerView

public java.lang.String getParamTabWpRestrictExplorerView()
Returns the "workplace restrict explorer view" setting.

Returns:
the "workplace restrict explorer view" setting

getParamTabWpShowPublishNotification

public java.lang.String getParamTabWpShowPublishNotification()
Returns the "show publish notification" setting.

Returns:
"true" if the "show publish notification" input is checked, otherwise ""

getParamTabWpSite

public java.lang.String getParamTabWpSite()
Returns the "start site" setting.

Returns:
the "start site" setting

getParamTabWpTimewarp

public java.lang.String getParamTabWpTimewarp()
Get the "user timewparp" setting in form of a formatted date string.

If no timewarp has been chosen, a value "-" will be returned.

Returns:
the "user timewarp" setting in form of a formatted date string

getParamTabWpUseUploadApplet

public java.lang.String getParamTabWpUseUploadApplet()
Returns the "use upload applet" setting.

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

getParamTabWpView

public java.lang.String getParamTabWpView()
Returns the start view setting.

Returns:
the start view setting

getTabParameterOrder

public java.util.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 java.util.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 java.lang.String isChecked(java.lang.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(java.lang.String newPwd)
Sets the new password value.

Parameters:
newPwd - the new password value

setParamOldPassword

public void setParamOldPassword(java.lang.String oldPwd)
Sets the old password value.

Parameters:
oldPwd - the old password value

setParamTabDiCopyFileMode

public void setParamTabDiCopyFileMode(java.lang.String value)
Sets the "copy file default" setting.

Parameters:
value - the "copy file default" setting

setParamTabDiCopyFolderMode

public void setParamTabDiCopyFolderMode(java.lang.String value)
Sets the "copy folder default" setting.

Parameters:
value - the "copy folder default" setting

setParamTabDiDeleteFileMode

public void setParamTabDiDeleteFileMode(java.lang.String value)
Sets the "delete file siblings default" setting.

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

setParamTabDiPermissionsExpandInherited

public void setParamTabDiPermissionsExpandInherited(java.lang.String value)
Sets the "expand inherited permissions" default setting.

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

setParamTabDiPermissionsExpandUser

public void setParamTabDiPermissionsExpandUser(java.lang.String value)
Sets the "expand current users permissions" default setting.

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

setParamTabDiPermissionsInheritOnFolder

public void setParamTabDiPermissionsInheritOnFolder(java.lang.String value)
Sets the "inherit permissions on folders" default setting.

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

setParamTabDiPublishFileMode

public void setParamTabDiPublishFileMode(java.lang.String value)
Sets the "publish file siblings default" setting.

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

setParamTabDiShowLock

public void setParamTabDiShowLock(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.String value)
Sets the "display file locked by" setting.

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

setParamTabExFileNavText

public void setParamTabExFileNavText(java.lang.String value)
Sets the "display file navtext" setting.

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

setParamTabExFilePermissions

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

setParamTabExWorkplaceSearchResult

public void setParamTabExWorkplaceSearchResult(java.lang.String style)
Sets the "workplace search result style".

Parameters:
style - the "workplace search result style" to set

setParamTabWpButtonStyle

public void setParamTabWpButtonStyle(java.lang.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(java.lang.String value)
Sets the "start folder" setting.

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

setParamTabWpLanguage

public void setParamTabWpLanguage(java.lang.String value)
Sets the start language setting.

Parameters:
value - the start language setting

setParamTabWpListAllProjects

public void setParamTabWpListAllProjects(java.lang.String value)
Sets the "list all projects" flag.

Parameters:
value - "true" to enable the "list all project" feature, all others to disable

setParamTabWpProject

public void setParamTabWpProject(java.lang.String value)
Sets the start project setting.

Parameters:
value - the start project setting

setParamTabWpReportType

public void setParamTabWpReportType(java.lang.String value)
Sets the "workplace report type" setting.

Parameters:
value - the "workplace report type" setting

setParamTabWpRestrictExplorerView

public void setParamTabWpRestrictExplorerView(java.lang.String value)
Sets the "workplace restrict explorer view" setting.

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

setParamTabWpShowPublishNotification

public void setParamTabWpShowPublishNotification(java.lang.String value)
Sets the "show publish notification" setting.

Parameters:
value - "true" to enable the "show publish notification" setting, all others to disable

setParamTabWpSite

public void setParamTabWpSite(java.lang.String value)
Sets the "start site" setting.

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

setParamTabWpTimeWarp

public void setParamTabWpTimeWarp(java.lang.String value)
Sets the "user timewparp" setting.

To delete a timewarp setting for the current user, provide "-" as value.

Parameters:
value - a String representation of an date in the formate as required by CmsCalendarWidget.getCalendarDate(org.opencms.i18n.CmsMessages, String, boolean)

setParamTabWpUseUploadApplet

public void setParamTabWpUseUploadApplet(java.lang.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(java.lang.String value)
Sets the start view setting.

Parameters:
value - the start view setting

initWorkplaceRequestValues

protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings,
                                          javax.servlet.http.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 java.util.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,
                                 javax.servlet.http.HttpServletRequest req)
Updates the user preferences after changes have been made.

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