Class CmsEditProjectDialog

  • All Implemented Interfaces:
    org.opencms.widgets.I_CmsWidgetDialog

    public class CmsEditProjectDialog
    extends CmsWidgetDialog
    Dialog to edit new and existing project in the administration view.

    Since:
    6.0.0
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String KEY_PREFIX
      localized messages Keys prefix.
      protected org.opencms.file.CmsProject m_project
      The project object that is edited on this dialog.
      static java.lang.String[] PAGES
      Defines which pages are valid for this dialog.
      static java.lang.String PARAM_PROJECTID
      Request parameter name for the project id.
      static java.lang.String PARAM_PROJECTNAME
      Request parameter name for the project name.
      • 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
      CmsEditProjectDialog​(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
      Public constructor with JSP variables.
      CmsEditProjectDialog​(org.opencms.jsp.CmsJspActionElement jsp)
      Public constructor with JSP action element.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void actionCommit()
      Commits the edited project to the database.
      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()
      Creates the list of widgets for this dialog.
      java.lang.String getAssignedOu()
      Returns the description of the parent ou.
      java.lang.String getManagerGroup()
      Returns the manager Group name.
      java.lang.String getName()
      Returns the simple name of the project.
      java.lang.String getOufqn()
      Returns the fully qualified name of the organizational unit.
      protected java.lang.String[] getPageArray()
      Returns the allowed pages for this dialog.
      java.lang.String getParamProjectid()
      Returns the project id parameter value.
      java.util.List getResources()
      Returns the list of VFS resources that belong to this project.
      java.lang.String getUserGroup()
      Returns the user Group name.
      protected void initMessages()  
      protected void initProjectObject()
      Initializes the project object to work with depending on the dialog state and request parameters.
      protected void initWorkplaceMembers​(org.opencms.jsp.CmsJspActionElement jsp)
      Overridden to set a custom online help mapping.
      protected void initWorkplaceRequestValues​(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)  
      protected boolean isNewProject()
      Checks if the Project overview has to be displayed.
      void setAssignedOu​(java.lang.String ou)
      Just a setter method needed for the widget dialog.
      void setManagerGroup​(java.lang.String managerGroup)
      Sets the manager Group name.
      void setName​(java.lang.String name)
      Sets the name of the project.
      void setOufqn​(java.lang.String oufqn)
      Sets the fully qualified name of the organizational unit.
      void setParamProjectid​(java.lang.String projectId)
      Sets the project id parameter value.
      void setResources​(java.util.List value)
      Sets the resources of this project.
      void setUserGroup​(java.lang.String userGroup)
      Sets the user Group name.
      protected void validateParamaters()
      Should be overridden for parameter validation.
      • 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 Detail

      • PAGES

        public static final java.lang.String[] PAGES
        Defines which pages are valid for this dialog.
      • m_project

        protected org.opencms.file.CmsProject m_project
        The project object that is edited on this dialog.
    • Constructor Detail

      • CmsEditProjectDialog

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

        Parameters:
        jsp - an initialized JSP action element
      • CmsEditProjectDialog

        public CmsEditProjectDialog​(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

      • getAssignedOu

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

        Returns:
        the description of the parent ou
      • getManagerGroup

        public java.lang.String getManagerGroup()
        Returns the manager Group name.

        Returns:
        the manager Group name
      • getName

        public java.lang.String getName()
        Returns the simple name of the project.

        Returns:
        the simple name of the project
      • getOufqn

        public java.lang.String getOufqn()
        Returns the fully qualified name of the organizational unit.

        Returns:
        the fully qualified name of the organizational unit
      • getParamProjectid

        public java.lang.String getParamProjectid()
        Returns the project id parameter value.

        Returns:
        the project id parameter value
      • getResources

        public java.util.List getResources()
        Returns the list of VFS resources that belong to this project.

        Returns:
        the list of VFS resources that belong to this project
      • getUserGroup

        public java.lang.String getUserGroup()
        Returns the user Group name.

        Returns:
        the user Group name
      • setAssignedOu

        public void setAssignedOu​(java.lang.String ou)
        Just a setter method needed for the widget dialog.

        Parameters:
        ou - ignored
      • setManagerGroup

        public void setManagerGroup​(java.lang.String managerGroup)
        Sets the manager Group name.

        Parameters:
        managerGroup - the manager Group name to set
      • setName

        public void setName​(java.lang.String name)
        Sets the name of the project.

        Parameters:
        name - the name to set
      • setOufqn

        public void setOufqn​(java.lang.String oufqn)
        Sets the fully qualified name of the organizational unit.

        Parameters:
        oufqn - the fully qualified name of the organizational unit to set
      • setParamProjectid

        public void setParamProjectid​(java.lang.String projectId)
        Sets the project id parameter value.

        Parameters:
        projectId - the project id parameter value
      • setResources

        public void setResources​(java.util.List value)
        Sets the resources of this project.

        Parameters:
        value - the project resources to set
      • setUserGroup

        public void setUserGroup​(java.lang.String userGroup)
        Sets the user Group name.

        Parameters:
        userGroup - the user Group name to set
      • createDialogHtml

        protected java.lang.String createDialogHtml​(java.lang.String dialog)
        Description copied from class: CmsWidgetDialog
        Creates the dialog HTML for all defined widgets of the named dialog (page).

        To get a more complex layout variation, you have to overwrite this method in your dialog class.

        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)
        See Also:
        CmsWidgetDialog.createDialogHtml(java.lang.String)
      • initMessages

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

        protected void initProjectObject()
        Initializes the project object to work with depending on the dialog state and request parameters.

        Two initializations of the project object on first dialog call are possible:

        • edit an existing project
        • create a new project
      • initWorkplaceMembers

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

        Overrides:
        initWorkplaceMembers in class org.opencms.workplace.CmsWorkplace
        See Also:
        CmsWorkplace.initWorkplaceMembers(org.opencms.jsp.CmsJspActionElement)
      • 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)
      • isNewProject

        protected boolean isNewProject()
        Checks if the Project overview has to be displayed.

        Returns:
        true if the project overview has to be displayed