Class CmsModulesEditBase
- java.lang.Object
-
- org.opencms.workplace.CmsWorkplace
-
- org.opencms.workplace.tools.CmsToolDialog
-
- org.opencms.workplace.CmsDialog
-
- org.opencms.workplace.CmsWidgetDialog
-
- org.opencms.workplace.tools.modules.CmsModulesEditBase
-
- All Implemented Interfaces:
org.opencms.widgets.I_CmsWidgetDialog
- Direct Known Subclasses:
CmsModulesEdit
,CmsModulesEditParameters
,CmsModulesEditResources
public class CmsModulesEditBase extends CmsWidgetDialog
Base class to edit an exiting module.- Since:
- 6.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
DIALOG_TYPE
The dialog type.static java.lang.String
KEY_PREFIX
localized messages Keys prefix.protected org.opencms.module.CmsModule
m_module
The module object that is edited on this dialog.protected java.lang.String
m_paramModule
Module name.static java.lang.String[]
PAGES
Defines which pages are valid for this dialog.static java.lang.String
PATH_CLASSES
Classes folder within the module.static java.lang.String
PATH_ELEMENTS
Elements folder within the module.static java.lang.String
PATH_FORMATTERS
The formatters folder within the module.static java.lang.String
PATH_LIB
Lib folder within the module.static java.lang.String
PATH_RESOURCES
Resources folder within the module.static java.lang.String
PATH_SCHEMAS
Schemas folder within the module.static java.lang.String
PATH_TEMPLATES
Template folder within the module.-
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 CmsModulesEditBase(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
Public constructor with JSP variables.CmsModulesEditBase(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 module.protected void
defineWidgets()
Creates the list of widgets for this dialog.java.lang.String
getCancelAction()
protected java.lang.String[]
getPageArray()
Returns the allowed pages for this dialog.java.lang.String
getParamModule()
Gets the module parameter.protected void
initMessages()
protected void
initModule()
Initializes the module 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
setParamModule(java.lang.String paramModule)
Sets the module parameter.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, 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, 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
-
-
-
-
Field Detail
-
KEY_PREFIX
public static final java.lang.String KEY_PREFIX
localized messages Keys prefix.- See Also:
- Constant Field Values
-
DIALOG_TYPE
public static final java.lang.String DIALOG_TYPE
The dialog type.- See Also:
- Constant Field Values
-
PAGES
public static final java.lang.String[] PAGES
Defines which pages are valid for this dialog.
-
PATH_CLASSES
public static final java.lang.String PATH_CLASSES
Classes folder within the module.- See Also:
- Constant Field Values
-
PATH_ELEMENTS
public static final java.lang.String PATH_ELEMENTS
Elements folder within the module.- See Also:
- Constant Field Values
-
PATH_LIB
public static final java.lang.String PATH_LIB
Lib folder within the module.- See Also:
- Constant Field Values
-
PATH_RESOURCES
public static final java.lang.String PATH_RESOURCES
Resources folder within the module.- See Also:
- Constant Field Values
-
PATH_SCHEMAS
public static final java.lang.String PATH_SCHEMAS
Schemas folder within the module.- See Also:
- Constant Field Values
-
PATH_TEMPLATES
public static final java.lang.String PATH_TEMPLATES
Template folder within the module.- See Also:
- Constant Field Values
-
PATH_FORMATTERS
public static final java.lang.String PATH_FORMATTERS
The formatters folder within the module.- See Also:
- Constant Field Values
-
m_module
protected org.opencms.module.CmsModule m_module
The module object that is edited on this dialog.
-
m_paramModule
protected java.lang.String m_paramModule
Module name.
-
-
Constructor Detail
-
CmsModulesEditBase
public CmsModulesEditBase(org.opencms.jsp.CmsJspActionElement jsp)
Public constructor with JSP action element.- Parameters:
jsp
- an initialized JSP action element
-
CmsModulesEditBase
public CmsModulesEditBase(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 contextreq
- the JSP requestres
- the JSP response
-
-
Method Detail
-
actionCommit
public void actionCommit()
Commits the edited module.- Specified by:
actionCommit
in classCmsWidgetDialog
-
getCancelAction
public java.lang.String getCancelAction()
- Overrides:
getCancelAction
in classorg.opencms.workplace.CmsDialog
- See Also:
CmsDialog.getCancelAction()
-
getParamModule
public java.lang.String getParamModule()
Gets the module parameter.- Returns:
- the module parameter
-
setParamModule
public void setParamModule(java.lang.String paramModule)
Sets the module parameter.- Parameters:
paramModule
- the module parameter
-
defineWidgets
protected void defineWidgets()
Creates the list of widgets for this dialog.- Specified by:
defineWidgets
in classCmsWidgetDialog
-
getPageArray
protected java.lang.String[] getPageArray()
Description copied from class:CmsWidgetDialog
Returns the allowed pages for this dialog.- Specified by:
getPageArray
in classCmsWidgetDialog
- Returns:
- the allowed pages for this dialog
- See Also:
CmsWidgetDialog.getPageArray()
-
initMessages
protected void initMessages()
- Overrides:
initMessages
in classorg.opencms.workplace.CmsWorkplace
- See Also:
CmsWorkplace.initMessages()
-
initModule
protected void initModule()
Initializes the module 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 classCmsWidgetDialog
- 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 classCmsWidgetDialog
- Throws:
java.lang.Exception
- if the parameters are not valid- See Also:
CmsWidgetDialog.validateParamaters()
-
-