org.opencms.workplace.editors
Class CmsDialogElements
java.lang.Object
org.opencms.workplace.CmsWorkplace
org.opencms.workplace.tools.CmsToolDialog
org.opencms.workplace.CmsDialog
org.opencms.workplace.editors.CmsDialogElements
- public class CmsDialogElements
- extends CmsDialog
Provides methods for the editor elements dialog.
The following files use this class:
- /jsp/editors/dialogs/elements.html
- Since:
- 6.0.0
- Version:
- $Revision: 1.20 $
- Author:
- Andreas Zahner
Field Summary |
static int |
ACTION_UPDATE_ELEMENTS
Value for the action: update the elements of the page. |
static java.lang.String |
DIALOG_TYPE
The dialog type. |
static java.lang.String |
DIALOG_UPDATE_ELEMENTS
Request parameter value for the action: update the elements of the page. |
static java.lang.String |
PREFIX_PARAM_BODY
Prefix for the html input field for the body. |
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.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 |
CmsDialogElements(CmsJspActionElement jsp)
Public constructor. |
CmsDialogElements(javax.servlet.jsp.PageContext context,
javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res)
Public constructor with JSP variables. |
Method Summary |
void |
actionUpdateElements()
Updates the enabled/diabled status of all elements of the current page. |
java.lang.String |
buildElementList()
Builds the html String for a form list of all possible page elements. |
java.util.List |
computeElements()
Creates a list of possible elements of a template from the template property "template-elements". |
static java.util.List |
computeElements(CmsObject cms,
CmsXmlPage xmlPage,
java.lang.String xmlPageUri,
java.util.Locale locale)
Creates a list of possible elements of a template from the template property "template-elements"
and the elements available in the provided xmlPage. |
static java.util.List |
computeElements(CmsObject cms,
java.lang.String xmlPageUri,
java.util.Locale locale)
Creates a list of possible elements of a template from the template property "template-elements"
and the elements available in the provided resource file. |
java.lang.String |
getChangeElement()
Returns the element name that has to be changed. |
java.util.Locale |
getElementLocale()
Returns the current element locale. |
java.lang.String |
getParamElementlanguage()
Returns the current element language. |
java.lang.String |
getParamElementname()
Returns the current element name. |
java.lang.String |
getParamTempfile()
Returns the name of the temporary file. |
protected void |
initWorkplaceRequestValues(CmsWorkplaceSettings settings,
javax.servlet.http.HttpServletRequest request)
Analyzes the request for workplace parameters and adjusts the workplace
settings accordingly. |
void |
setParamElementlanguage(java.lang.String elementLanguage)
Sets the current element language. |
void |
setParamElementname(java.lang.String elementName)
Sets the current element name. |
void |
setParamTempfile(java.lang.String fileName)
Sets the name of the temporary file. |
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, htmlStart, 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, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, 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, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, 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 |
ACTION_UPDATE_ELEMENTS
public static final int ACTION_UPDATE_ELEMENTS
- Value for the action: update the elements of the page.
- See Also:
- Constant Field Values
DIALOG_TYPE
public static final java.lang.String DIALOG_TYPE
- The dialog type.
- See Also:
- Constant Field Values
DIALOG_UPDATE_ELEMENTS
public static final java.lang.String DIALOG_UPDATE_ELEMENTS
- Request parameter value for the action: update the elements of the page.
- See Also:
- Constant Field Values
PREFIX_PARAM_BODY
public static final java.lang.String PREFIX_PARAM_BODY
- Prefix for the html input field for the body.
- See Also:
- Constant Field Values
CmsDialogElements
public CmsDialogElements(CmsJspActionElement jsp)
- Public constructor.
- Parameters:
jsp
- an initialized JSP action element
CmsDialogElements
public CmsDialogElements(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
computeElements
public static java.util.List computeElements(CmsObject cms,
CmsXmlPage xmlPage,
java.lang.String xmlPageUri,
java.util.Locale locale)
- Creates a list of possible elements of a template from the template property "template-elements"
and the elements available in the provided xmlPage.
- Parameters:
cms
- the CmsObjectxmlPage
- the resource to read the elements fromxmlPageUri
- the URI of the resouirce to read the template property fromlocale
- the current element locale
- Returns:
- the list of elements in a String array with element name, nice name (if present) and mandatory flag
computeElements
public static java.util.List computeElements(CmsObject cms,
java.lang.String xmlPageUri,
java.util.Locale locale)
- Creates a list of possible elements of a template from the template property "template-elements"
and the elements available in the provided resource file.
- Parameters:
cms
- the CmsObjectxmlPageUri
- the resource to read the elements fromlocale
- the current element locale
- Returns:
- the list of elements in a String array with element name, nice name (if present) and mandatory flag
actionUpdateElements
public void actionUpdateElements()
throws javax.servlet.jsp.JspException
- Updates the enabled/diabled status of all elements of the current page.
- Throws:
javax.servlet.jsp.JspException
- if there is an error including the error page
buildElementList
public java.lang.String buildElementList()
- Builds the html String for a form list of all possible page elements.
- Returns:
- the html String for a form list
computeElements
public java.util.List computeElements()
- Creates a list of possible elements of a template from the template property "template-elements".
- Returns:
- the list of elements in a String array with element name, nice name (if present) and mandatory flag
getChangeElement
public java.lang.String getChangeElement()
- Returns the element name that has to be changed.
- Returns:
- the element name that has to be changed
getElementLocale
public java.util.Locale getElementLocale()
- Returns the current element locale.
- Returns:
- the current element locale
getParamElementlanguage
public java.lang.String getParamElementlanguage()
- Returns the current element language.
- Returns:
- the current element language
getParamElementname
public java.lang.String getParamElementname()
- Returns the current element name.
- Returns:
- the current element name
getParamTempfile
public java.lang.String getParamTempfile()
- Returns the name of the temporary file.
- Returns:
- the name of the temporary file
setParamElementlanguage
public void setParamElementlanguage(java.lang.String elementLanguage)
- Sets the current element language.
- Parameters:
elementLanguage
- the current element language
setParamElementname
public void setParamElementname(java.lang.String elementName)
- Sets the current element name.
- Parameters:
elementName
- the current element name
setParamTempfile
public void setParamTempfile(java.lang.String fileName)
- Sets the name of the temporary file.
- Parameters:
fileName
- the name of the temporary file
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
- See Also:
CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)