Package org.opencms.workplace.tools.accounts

Class CmsUserOverviewDialog

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.CmsUserOverviewDialog
All Implemented Interfaces:
org.opencms.widgets.I_CmsWidgetDialog
public class CmsUserOverviewDialog extends CmsWidgetDialog
Dialog to edit new or existing user in the administration view.

Since:
6.0.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    KEY_PREFIX
    localized messages Keys prefix.
    protected org.opencms.file.CmsUser
    m_user
    The user object that is edited on this dialog.
    static final String[]
    PAGES
    Defines which pages are valid for this dialog.
    static final String
    PARAM_USERID
    Request parameter name for the user id.

    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
    CmsUserOverviewDialog(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
    Public constructor with JSP variables.
    CmsUserOverviewDialog(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.
    String
    actionSwitchUser()
    Calls the switch user method of the SessionManager.
    protected String
    createDialogHtml(String dialog)
    Creates the dialog HTML for all defined widgets of the named dialog (page).
    protected String
    defaultActionHtmlEnd()
    Generates the dialog ending html code.
    protected void
    defineWidgets()
    Creates the list of widgets for this dialog.
    String
    getAssignedOu()
    Returns the description of the parent ou.
    String
    getCreated()
    Returns the creation date.
    String
    getDescription()
    Returns the localized description of the user.
    String
    getLastlogin()
    Returns the last login.
    String
    getName()
    Returns the simple name of the user object.
    protected String[]
    getPageArray()
    Returns the allowed pages for this dialog.
    String
    getParamUserid()
    Returns the user id parameter value.
    protected void
    initMessages()
     
    protected void
    initUserObject()
    Initializes the user object.
    protected void
    initWorkplaceMembers(org.opencms.jsp.CmsJspActionElement jsp)
    Overridden to set a custom online help path.
    boolean
    isSelfManagement()
    Returns the selfManagement.
    void
    setAssignedOu(String assignedOu)
    Setter for widget definition.
    void
    setCreated(String created)
    Sets the creation date.
    void
    setDescription(String description)
    Sets the description of the user.
    void
    setLastlogin(String lastlogin)
    Sets the last login.
    void
    setName(String name)
    Sets the name of the user object.
    void
    setParamUserid(String userId)
    Sets the user id parameter value.
    void
    setSelfManagement(boolean selfManagement)
    Sets the selfManagement.
    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, 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, initWorkplaceRequestValues, 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, 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 Details

  • Constructor Details

    • CmsUserOverviewDialog

      public CmsUserOverviewDialog(org.opencms.jsp.CmsJspActionElement jsp)
      Public constructor with JSP action element.

      Parameters:
      jsp - an initialized JSP action element

    • CmsUserOverviewDialog

      public CmsUserOverviewDialog(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 Details

    • actionCommit

      public void actionCommit()
      Commits the edited user to the db.

      Specified by:
      actionCommit in class CmsWidgetDialog

    • actionSwitchUser

      public String actionSwitchUser() throws org.opencms.main.CmsException
      Calls the switch user method of the SessionManager.

      Returns:
      the direct edit patch
      Throws:
      org.opencms.main.CmsException - if something goes wrong

    • getAssignedOu

      public String getAssignedOu()
      Returns the description of the parent ou.

      Returns:
      the description of the parent ou

    • getCreated

      public String getCreated()
      Returns the creation date.

      Auxiliary Property for better representation.

      Returns:
      the creation date

    • getDescription

      public String getDescription()
      Returns the localized description of the user.

      Returns:
      the localized description of the user

    • getLastlogin

      public String getLastlogin()
      Returns the last login.

      Auxiliary Property for better representation.

      Returns:
      the last login

    • getName

      public String getName()
      Returns the simple name of the user object.

      Returns:
      the simple name of the user object

    • getParamUserid

      public String getParamUserid()
      Returns the user id parameter value.

      Returns:
      the user id parameter value

    • isSelfManagement

      public boolean isSelfManagement()
      Returns the selfManagement.

      Returns:
      the selfManagement

    • setAssignedOu

      public void setAssignedOu(String assignedOu)
      Setter for widget definition.

      Parameters:
      assignedOu - the ou description

    • setCreated

      public void setCreated(String created)
      Sets the creation date.

      Auxiliary Property for better representation.

      Parameters:
      created - the creation date to set

    • setDescription

      public void setDescription(String description)
      Sets the description of the user.

      Parameters:
      description - the user description

    • setLastlogin

      public void setLastlogin(String lastlogin)
      Sets the last login.

      Auxiliary Property for better representation.

      Parameters:
      lastlogin - the last login to set

    • setName

      public void setName(String name)
      Sets the name of the user object.

      Parameters:
      name - the name of the user object

    • setParamUserid

      public void setParamUserid(String userId)
      Sets the user id parameter value.

      Parameters:
      userId - the user id parameter value

    • setSelfManagement

      public void setSelfManagement(boolean selfManagement)
      Sets the selfManagement.

      Parameters:
      selfManagement - the selfManagement to set

    • createDialogHtml

      protected String createDialogHtml(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)

    • defaultActionHtmlEnd

      protected String defaultActionHtmlEnd()
      Description copied from class: CmsWidgetDialog
      Generates the dialog ending html code.

      Overrides:
      defaultActionHtmlEnd in class CmsWidgetDialog
      Returns:
      html code
      See Also:

    • defineWidgets

      protected void defineWidgets()
      Creates the list of widgets for this dialog.

      Specified by:
      defineWidgets in class CmsWidgetDialog

    • getPageArray

      protected 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:

    • initMessages

      protected void initMessages()
      Overrides:
      initMessages in class org.opencms.workplace.CmsWorkplace
      See Also:
      • CmsWorkplace.initMessages()

    • initUserObject

      protected void initUserObject()
      Initializes the user object.

    • initWorkplaceMembers

      protected void initWorkplaceMembers(org.opencms.jsp.CmsJspActionElement jsp)
      Overridden to set a custom online help path.

      Overrides:
      initWorkplaceMembers in class org.opencms.workplace.CmsWorkplace
      See Also:
      • CmsWorkplace.initWorkplaceMembers(org.opencms.jsp.CmsJspActionElement)

    • validateParamaters

      protected void validateParamaters() throws 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:
      Exception - if the parameters are not valid
      See Also: