org.opencms.workplace.explorer

类 CmsNewResourceXmlPage

java.lang.Object

org.opencms.workplace.CmsWorkplace

org.opencms.workplace.tools.CmsToolDialog

org.opencms.workplace.CmsDialog

org.opencms.workplace.list.A_CmsListDialog

org.opencms.workplace.list.A_CmsListResourceTypeDialog

org.opencms.workplace.explorer.CmsNewResource

org.opencms.workplace.explorer.CmsNewResourceXmlPage

public class CmsNewResourceXmlPage
extends CmsNewResource

The new resource page dialog handles the creation of an xml page.

The following files use this class:

• /commons/newresource_xmlpage.jsp

从以下版本开始:

6.0.0

属性概要

从类继承的属性 org.opencms.workplace.explorer.CmsNewResource

computeNewTitleProperty

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	PARAM_BODYFILE Request parameter name for the selected body.
static java.lang.String	PARAM_SUFFIXCHECK Request parameter name for the suffix check.
static java.lang.String	PARAM_TEMPLATE Request parameter name for the selected template.

从类继承的字段 org.opencms.workplace.explorer.CmsNewResource

ACTION_NEWFORM, ACTION_SUBMITFORM, BUTTON_NEXT, DEFAULT_SUFFIX, DELIM_PROPERTYVALUES, DIALOG_ADVANCED, DIALOG_NEWFORM, DIALOG_SUBMITFORM, DIALOG_TYPE, LIST_COLUMN_URI, PARAM_APPENDSUFFIXHTML, PARAM_CURRENTFOLDER, PARAM_NEWFORMURI, PARAM_NEWRESOURCEEDITPROPS, PARAM_NEWRESOURCETYPE, PARAM_NEWRESOURCEURI, SESSION_ATTR_ADVANCED, SESSION_ATTR_PAGE, VALUE_DEFAULT

从类继承的字段 org.opencms.workplace.list.A_CmsListResourceTypeDialog

LIST_ACTION_SEL, LIST_COLUMN_ICON, LIST_COLUMN_NAME, LIST_COLUMN_SELECT, LIST_DETAIL_DESCRIPTION, LIST_ID, PARAM_SELECTED_TYPE

从类继承的字段 org.opencms.workplace.list.A_CmsListDialog

ACTION_LIST_INDEPENDENT_ACTION, ACTION_LIST_MULTI_ACTION, ACTION_LIST_SEARCH, ACTION_LIST_SELECT_PAGE, ACTION_LIST_SINGLE_ACTION, ACTION_LIST_SORT, ICON_ACTIVE, ICON_ADD, ICON_DELETE, ICON_DETAILS_HIDE, ICON_DETAILS_SHOW, ICON_DISABLED, ICON_INACTIVE, ICON_MINUS, ICON_MULTI_ACTIVATE, ICON_MULTI_ADD, ICON_MULTI_DEACTIVATE, ICON_MULTI_DELETE, ICON_MULTI_MINUS, LIST_INDEPENDENT_ACTION, LIST_MULTI_ACTION, LIST_SEARCH, LIST_SELECT_PAGE, LIST_SINGLE_ACTION, LIST_SORT, m_lazy, PARAM_FORMNAME, PARAM_LIST_ACTION, PARAM_PAGE, PARAM_SEARCH_FILTER, PARAM_SEL_ITEMS, PARAM_SORT_COL

从类继承的字段 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

从类继承的字段 org.opencms.workplace.tools.CmsToolDialog

PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW

从类继承的字段 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, 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_MODULES, VFS_PATH_RESOURCES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_DIRECT_EDIT, VIEW_WORKPLACE

构造器概要

构造器

构造器和说明
CmsNewResourceXmlPage(CmsJspActionElement jsp) Public constructor with JSP action element.
CmsNewResourceXmlPage(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Public constructor with JSP variables.

方法概要

方法

限定符和类型	方法和说明
void	actionCreateResource() Creates the xml page using the specified resource name.
java.lang.String	buildSelectBodyFile(java.lang.String attributes) Builds the html for the page body file select box.
java.lang.String	buildSelectTemplates(java.lang.String attributes) Builds the html for the page template select box.
static java.util.TreeMap<java.lang.String,java.lang.String>	getBodies(CmsObject cms, java.lang.String currWpPath) Returns a sorted Map of all available body files of the OpenCms modules.
static java.util.TreeMap<java.lang.String,java.lang.String>	getBodies(CmsObject cms, java.lang.String currWpPath, boolean emptyMap) Returns a sorted Map of all available body files of the OpenCms modules.
protected static java.util.TreeMap<java.lang.String,java.lang.String>	getElements(CmsObject cms, java.lang.String elementFolder, java.lang.String currWpPath, boolean emptyMap) Returns a sorted Map of all available elements in the specified subfolder of the OpenCms modules.
java.lang.String	getParamBodyFile() Returns the body file parameter value.
java.lang.String	getParamSuffixCheck() Returns the request parameter flag indicating if the suffix field is present or not.
java.lang.String	getParamTemplate() Returns the template parameter value.
static java.util.TreeMap<java.lang.String,java.lang.String>	getTemplates(CmsObject cms, java.lang.String currWpPath) Returns a sorted Map of all available templates of the OpenCms modules.
static java.util.TreeMap<java.lang.String,java.lang.String>	getTemplates(CmsObject cms, java.lang.String currWpPath, boolean emptyMap) Returns a sorted Map of all available templates of the OpenCms modules.
protected void	initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request) Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
void	setParamBodyFile(java.lang.String bodyFile) Sets the body file parameter value.
void	setParamSuffixCheck(java.lang.String paramSuffixCheck) Sets the request parameter flag indicating if the suffix field is present or not.
void	setParamTemplate(java.lang.String template) Sets the template parameter value.

从类继承的方法 org.opencms.workplace.explorer.CmsNewResource

actionCloseDialog, actionDialog, actionEditProperties, actionSelect, appendSuffixHtml, clearSession, computeFullResourceName, computeNewTitleProperty, computeNewTitleProperty, createPropertyObject, createResourceProperties, createResourceProperties, customHtmlStart, dialogButtons, dialogButtonsAdvancedNextCancel, dialogButtonsHtml, dialogButtonsNextCancel, forwardEditProperties, getListItems, getNewResourceHandler, getParamAppendSuffixHtml, getParamCurrentFolder, getParamDialogmode, getParamNewFormUri, getParamNewResourceEditProps, getParamNewResourceType, getParamNewResourceUri, getParamPage, getSuffixHtml, getTitle, isCreateIndexMode, isResourceCreated, paramsAsHidden, setColumns, setInitialResourceName, setParamAppendSuffixHtml, setParamCurrentFolder, setParamDialogmode, setParamNewFormUri, setParamNewResourceEditProps, setParamNewResourceType, setParamNewResourceUri, setParamPage, setResourceCreated

从类继承的方法 org.opencms.workplace.list.A_CmsListResourceTypeDialog

customHtmlBeforeList, customHtmlEnd, defaultActionHtmlContent, executeListMultiActions, executeListSingleActions, fillDetails, getParamSelectedType, paramsAsHidden, setIndependentActions, setMultiActions, setParamSelectedType

从类继承的方法 org.opencms.workplace.list.A_CmsListDialog

defaultActionHtml, defaultActionHtmlEnd, defaultActionHtmlStart, displayDialog, displayDialog, executeDefaultActions, executeListIndepActions, executeSearch, executeSelectPage, executeSort, fillList, getList, getListId, getListObject, getListState, getMetadata, getMetadata, getParamFormName, getParamListAction, getParamSearchFilter, getParamSelItems, getParamSortCol, getSelectedItem, getSelectedItems, initializeDetail, isActive, listRecovery, listSave, refreshList, removeList, setList, setListObject, setParamFormName, setParamListAction, setParamSearchFilter, setParamSelItems, setParamSortCol, setSearchAction, throwListUnsupportedActionException, validateParamaters, writeDialog

从类继承的方法 org.opencms.workplace.CmsDialog

appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockDialog, buildLockDialog, buildLockHeaderBox, checkResourcePermissions, checkResourcePermissions, computeCurrentFolder, dialog, dialogBlock, dialogBlockEnd, dialogBlockStart, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, 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

从类继承的方法 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

从类继承的方法 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, getStartSiteRoot, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, htmlEnd, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, switchToCurrentProject, switchToTempProject

从类继承的方法 java.lang.Object

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

字段详细资料

PARAM_BODYFILE

public static final java.lang.String PARAM_BODYFILE

Request parameter name for the selected body.

另请参阅:

常量字段值

PARAM_SUFFIXCHECK

public static final java.lang.String PARAM_SUFFIXCHECK

Request parameter name for the suffix check.

另请参阅:

常量字段值

PARAM_TEMPLATE

public static final java.lang.String PARAM_TEMPLATE

Request parameter name for the selected template.

另请参阅:

常量字段值

构造器详细资料

CmsNewResourceXmlPage

public CmsNewResourceXmlPage(CmsJspActionElement jsp)

Public constructor with JSP action element.

参数:

jsp - an initialized JSP action element

CmsNewResourceXmlPage

public CmsNewResourceXmlPage(javax.servlet.jsp.PageContext context,
                     javax.servlet.http.HttpServletRequest req,
                     javax.servlet.http.HttpServletResponse res)

Public constructor with JSP variables.

参数:

context - the JSP page context

req - the JSP request

res - the JSP response

方法详细资料

getBodies

public static java.util.TreeMap<java.lang.String,java.lang.String> getBodies(CmsObject cms,
                                                             java.lang.String currWpPath)
                                                                      throws CmsException

Returns a sorted Map of all available body files of the OpenCms modules.

参数:

cms - the current cms object

currWpPath - the current path in the OpenCms workplace

返回:

a sorted map with the body file title as key and absolute path to the body file as value

抛出:

CmsException - if reading a folder or file fails

getBodies

public static java.util.TreeMap<java.lang.String,java.lang.String> getBodies(CmsObject cms,
                                                             java.lang.String currWpPath,
                                                             boolean emptyMap)
                                                                      throws CmsException

Returns a sorted Map of all available body files of the OpenCms modules.

参数:

cms - the current cms object

currWpPath - the current path in the OpenCms workplace

emptyMap - flag indicating if it is OK to return a filtered empty Map

返回:

a sorted map with the body file title as key and absolute path to the body file as value

抛出:

CmsException - if reading a folder or file fails

getTemplates

public static java.util.TreeMap<java.lang.String,java.lang.String> getTemplates(CmsObject cms,
                                                                java.lang.String currWpPath)
                                                                         throws CmsException

Returns a sorted Map of all available templates of the OpenCms modules.

参数:

cms - the current cms object

currWpPath - the current path in the OpenCms workplace

返回:

a sorted map with the template title as key and absolute path to the template as value

抛出:

CmsException - if reading a folder or file fails

getTemplates

public static java.util.TreeMap<java.lang.String,java.lang.String> getTemplates(CmsObject cms,
                                                                java.lang.String currWpPath,
                                                                boolean emptyMap)
                                                                         throws CmsException

Returns a sorted Map of all available templates of the OpenCms modules.

参数:

cms - the current cms object

currWpPath - the current path in the OpenCms workplace

emptyMap - flag indicating if it is OK to return a filtered empty Map

返回:

a sorted map with the template title as key and absolute path to the template as value

抛出:

CmsException - if reading a folder or file fails

getElements

protected static java.util.TreeMap<java.lang.String,java.lang.String> getElements(CmsObject cms,
                                                               java.lang.String elementFolder,
                                                               java.lang.String currWpPath,
                                                               boolean emptyMap)
                                                                           throws CmsException

Returns a sorted Map of all available elements in the specified subfolder of the OpenCms modules.

参数:

cms - the current cms object

elementFolder - the module subfolder to search for elements

currWpPath - the current path in the OpenCms workplace

emptyMap - flag indicating if it is OK to return a filtered empty Map

返回:

a sorted map with the element title as key and absolute path to the element as value

抛出:

CmsException - if reading a folder or file fails

actionCreateResource

public void actionCreateResource()
                          throws javax.servlet.jsp.JspException

Creates the xml page using the specified resource name.

覆盖:

actionCreateResource 在类中 CmsNewResource

抛出:

javax.servlet.jsp.JspException - if inclusion of error dialog fails

buildSelectBodyFile

public java.lang.String buildSelectBodyFile(java.lang.String attributes)

Builds the html for the page body file select box.

参数:

attributes - optional attributes for the <select> tag

返回:

the html for the page body file select box

buildSelectTemplates

public java.lang.String buildSelectTemplates(java.lang.String attributes)

Builds the html for the page template select box.

参数:

attributes - optional attributes for the <select> tag

返回:

the html for the page template select box

getParamBodyFile

public java.lang.String getParamBodyFile()

Returns the body file parameter value.

返回:

the body file parameter value

getParamSuffixCheck

public java.lang.String getParamSuffixCheck()

Returns the request parameter flag indicating if the suffix field is present or not.

返回:

the request parameter flag indicating if the suffix field is present or not

getParamTemplate

public java.lang.String getParamTemplate()

Returns the template parameter value.

返回:

the template parameter value

setParamBodyFile

public void setParamBodyFile(java.lang.String bodyFile)

Sets the body file parameter value.

参数:

bodyFile - the body file parameter value

setParamSuffixCheck

public void setParamSuffixCheck(java.lang.String paramSuffixCheck)

Sets the request parameter flag indicating if the suffix field is present or not.

参数:

paramSuffixCheck - he request parameter flag indicating if the suffix field is present or not

setParamTemplate

public void setParamTemplate(java.lang.String template)

Sets the template parameter value.

参数:

template - the template parameter value

initWorkplaceRequestValues

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

从类复制的说明: CmsWorkplace

Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.

覆盖:

initWorkplaceRequestValues 在类中 CmsNewResource

参数:

settings - the workplace settings

request - the current request

另请参阅:

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