Package org.opencms.workplace.tools.accounts

Class CmsEditUserAddInfoDialog

java.lang.Object

org.opencms.workplace.CmsWorkplace

org.opencms.workplace.tools.CmsToolDialog

org.opencms.workplace.CmsDialog

org.opencms.workplace.CmsWidgetDialog

org.opencms.workplace.tools.accounts.CmsEditUserAddInfoDialog

All Implemented Interfaces:

org.opencms.widgets.I_CmsWidgetDialog

public class CmsEditUserAddInfoDialog
extends CmsWidgetDialog

Dialog to edit the users additional info in the administration view.

Since:

6.5.6

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	KEY_PREFIX	localized messages Keys prefix.
protected java.util.List<CmsUserAddInfoBean>	m_addInfoList	The additional information.
protected org.opencms.file.CmsUser	m_user	The user object that is edited on this dialog.
static java.lang.String[]	PAGES	Defines which pages are valid for this dialog.

Fields inherited from class org.opencms.workplace.CmsWidgetDialog

ACTION_ELEMENT_ADD, ACTION_ELEMENT_REMOVE, ACTION_ERROR, ACTION_SAVE, DIALOG_SAVE, EDITOR_ACTION_ELEMENT_ADD, EDITOR_ACTION_ELEMENT_REMOVE, HIDDEN_PARAM_PREFIX, m_commitErrors, m_dialogObject, m_pages, m_paramPage, m_validationErrorList, m_widgetParamValues, m_widgets

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_ACTION_VALUE_FOR_CHANGED_INDEX, 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_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW

Fields inherited from class org.opencms.workplace.CmsWorkplace

DEBUG, DEFAULT_DATE_STRING, 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, INPUT_DEFAULT, INPUT_NONE, JSP_WORKPLACE_URI, PARAM_DIRECTPUBLISH, PARAM_MODELFILE, PARAM_NEWRESOURCETYPE, PARAM_PUBLISHSIBLINGS, PARAM_RELATEDRESOURCES, PARAM_RESOURCELIST, PARAM_SUBRESOURCES, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PARAM_WP_START, PARAM_WP_VIEW, PATH_DIALOGS, PATH_WORKPLACE, REQUEST_ATTRIBUTE_MULTIPART, REQUEST_ATTRIBUTE_RELOADTREE, RES_PATH_FILETYPES, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, VFS_DIR_DEFAULTBODIES, VFS_DIR_TEMPLATES, VFS_PATH_COMMONS, VFS_PATH_EDITORS, VFS_PATH_GALLERIES, VFS_PATH_LOCALES, VFS_PATH_MODELDIALOG, VFS_PATH_MODULES, VFS_PATH_NEWRESOURCEDIALOG, VFS_PATH_RESOURCES, VFS_PATH_SITES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_ADMIN, VIEW_DIRECT_EDIT, VIEW_EXPLORER, VIEW_GALLERY, VIEW_LIST, VIEW_WORKPLACE

Constructor Summary

Constructors

Constructor	Description
CmsEditUserAddInfoDialog(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)	Public constructor with JSP variables.
CmsEditUserAddInfoDialog(org.opencms.jsp.CmsJspActionElement jsp)	Public constructor with JSP action element.

Method Summary

Modifier and Type	Method	Description
void	actionCommit()	Commits the edited user to the db.
protected java.lang.String	createDialogHtml(java.lang.String dialog)	Creates the dialog HTML for all defined widgets of the named dialog (page).
protected void	defineWidgets()	Defines the list of parameters for this dialog.
java.util.SortedMap<java.lang.String,java.lang.Object>	getInfo()	Returns the additional info map.
protected java.lang.String[]	getPageArray()	Returns the allowed pages for this dialog.
java.lang.String	getParamEditall()	Returns the edit all flag parameter value.
java.lang.String	getParamUserid()	Returns the user id parameter value.
java.util.SortedMap<java.lang.String,java.lang.Object>	getReadonly()	Returns the read only add info.
protected void	initMessages()
protected void	initUserObject()	Initializes the additional info bean to work with, depending on the dialog state and request parameters.
protected void	initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
void	setInfo(java.util.SortedMap<java.lang.String,java.lang.Object> addInfo)	Sets the modified additional information.
void	setParamEditall(java.lang.String editAll)	Sets the edit all flag parameter value.
void	setParamUserid(java.lang.String userId)	Sets the user id parameter value.
void	setReadonly(java.util.SortedMap<java.lang.String,java.lang.Object> addInfoReadOnly)	Sets the read only add info.
protected void	validateParamaters()	Should be overridden for parameter validation.

Methods inherited from class org.opencms.workplace.CmsWidgetDialog

actionCancel, actionToggleElement, addCommitError, addWidget, buildAddElement, buildDialogForm, buildRemoveElement, clearDialogObject, closeDialogOnCommit, commitWidgetValues, commitWidgetValues, createDialogHtml, createDialogRowHtml, createDialogRowsHtml, createWidgetBlockEnd, createWidgetBlockStart, createWidgetErrorHeader, createWidgetTableEnd, createWidgetTableStart, defaultActionHtml, defaultActionHtmlContent, defaultActionHtmlEnd, defaultActionHtmlStart, dialogBlockEnd, dialogBlockStart, dialogButtonsCustom, displayDialog, displayDialog, fillWidgetValues, getButtonStyle, getCommitErrors, getDialogObject, getDialogTitle, getHelpMessageIds, getPages, getParamElementIndex, getParamElementName, getParameterDefinition, getParameters, getParamPage, getParamValue, getParamValue, getUserAgent, getValidationErrorList, getWidget, getWidgetHtmlEnd, getWidgetIncludes, getWidgetInitCalls, getWidgetInitMethods, getWidgets, hasCommitErrors, hasValidationErrors, paramsAsHidden, setCommitErrors, setDialogObject, setKeyPrefix, setPages, setParamElementIndex, setParamElementName, setParamPage, setValidationErrorList, widgetParamsAsHidden, widgetParamsAsHidden, writeDialog

Methods inherited from class org.opencms.workplace.CmsDialog

actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockHeaderBox, checkResourcePermissions, checkResourcePermissions, computeCurrentFolder, dialog, dialogBlock, 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, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, isPreEditor, openLaunchpad, openWorkplaceLink, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamResource, setParamTitle

Methods inherited from class org.opencms.workplace.tools.CmsToolDialog

computeUpLevelLink, 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, canEditPermissionsForRoles, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, generateCssStyle, generatePageEndExtended, generatePageEndSimple, generatePageStartExtended, generatePageStartSimple, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStartSiteRoot, getStartSiteRoot, getStaticResourceUri, getStaticResourceUri, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, getWorkplaceExplorerLink, getWorkplaceExplorerLink, getWorkplaceSettings, htmlEnd, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, substituteSiteTitleStatic, switchToCurrentProject, switchToTempProject, updateUserPreferences

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.widgets.I_CmsWidgetDialog

button, buttonBar, buttonBarHorizontalLine, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, dialogHorizontalSpacer, getLocale, getMessages, useNewStyle

Field Detail

KEY_PREFIX

public static final java.lang.String KEY_PREFIX

localized messages Keys prefix.

See Also:

Constant Field Values

PAGES

public static final java.lang.String[] PAGES

Defines which pages are valid for this dialog.

m_addInfoList

protected java.util.List<CmsUserAddInfoBean> m_addInfoList

The additional information.

m_user

protected org.opencms.file.CmsUser m_user

The user object that is edited on this dialog.

Constructor Detail

CmsEditUserAddInfoDialog

public CmsEditUserAddInfoDialog(org.opencms.jsp.CmsJspActionElement jsp)

Public constructor with JSP action element.

Parameters:

jsp - an initialized JSP action element

CmsEditUserAddInfoDialog

public CmsEditUserAddInfoDialog(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

actionCommit

public void actionCommit()

Commits the edited user to the db.

Specified by:

actionCommit in class CmsWidgetDialog

getInfo

public java.util.SortedMap<java.lang.String,java.lang.Object> getInfo()

Returns the additional info map.

Returns:

the additional info map

getParamEditall

public java.lang.String getParamEditall()

Returns the edit all flag parameter value.

Returns:

the edit all flag parameter value

getParamUserid

public java.lang.String getParamUserid()

Returns the user id parameter value.

Returns:

the user id parameter value

getReadonly

public java.util.SortedMap<java.lang.String,java.lang.Object> getReadonly()

Returns the read only add info.

Returns:

the read only add info

setInfo

public void setInfo(java.util.SortedMap<java.lang.String,java.lang.Object> addInfo)

Sets the modified additional information.

Parameters:

addInfo - the additional information to set

setParamEditall

public void setParamEditall(java.lang.String editAll)

Sets the edit all flag parameter value.

Parameters:

editAll - the edit all flag parameter value

setParamUserid

public void setParamUserid(java.lang.String userId)

Sets the user id parameter value.

Parameters:

userId - the user id parameter value to set

setReadonly

public void setReadonly(java.util.SortedMap<java.lang.String,java.lang.Object> addInfoReadOnly)

Sets the read only add info.

Parameters:

addInfoReadOnly - the read only add info to set

createDialogHtml

protected java.lang.String createDialogHtml(java.lang.String dialog)

Creates the dialog HTML for all defined widgets of the named dialog (page).

This overwrites the method from the super class to create a layout variation for the widgets.

Overrides:

createDialogHtml in class CmsWidgetDialog

Parameters:

dialog - the dialog (page) to get the HTML for

Returns:

the dialog HTML for all defined widgets of the named dialog (page)

defineWidgets

protected void defineWidgets()

Description copied from class: CmsWidgetDialog

Defines the list of parameters for this dialog.

Specified by:

defineWidgets in class CmsWidgetDialog

See Also:

A_CmsEditUserDialog.defineWidgets()

getPageArray

protected java.lang.String[] getPageArray()

Description copied from class: CmsWidgetDialog

Returns the allowed pages for this dialog.

Specified by:

getPageArray in class CmsWidgetDialog

Returns:

the allowed pages for this dialog

See Also:

CmsWidgetDialog.getPageArray()

initMessages

protected void initMessages()

Overrides:

initMessages in class org.opencms.workplace.CmsWorkplace

See Also:

CmsWorkplace.initMessages()

initUserObject

protected void initUserObject()

Initializes the additional info bean to work with, depending on the dialog state and request parameters.

initWorkplaceRequestValues

protected void initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings,
                                          javax.servlet.http.HttpServletRequest request)

Overrides:

initWorkplaceRequestValues in class CmsWidgetDialog

See Also:

CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)

validateParamaters

protected void validateParamaters()
                           throws java.lang.Exception

Description copied from class: CmsWidgetDialog

Should be overridden for parameter validation.

The exception is never seen by the user, so it can be just a new Exception().

Overrides:

validateParamaters in class CmsWidgetDialog

Throws:

java.lang.Exception - if the parameters are not valid

See Also:

CmsWidgetDialog.validateParamaters()