org.opencms.workplace.explorer

类 CmsNewResourceFolder

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.CmsNewResourceFolder

public class CmsNewResourceFolder
extends A_CmsListResourceTypeDialog

The new resource folder dialog handles the creation of a folder.

The following files use this class:

• /commons/newresource_folder.jsp

Displays a list with resource types to choose one for the index page.

从以下版本开始:

6.7.1

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	DEFAULT_AVAILABLE Default list of available resource types for the index page.
static java.lang.String	DEFAULT_MARKER The marker for the default selected resource type.
static java.lang.String	ID_NO_INDEX_PAGE The id to use for the entry in the list, for which no index page should be created.
static java.lang.String	NAME_NO_INDEX_PAGE The name of the entry to take if no index page should be generated.
static java.lang.String	PARAM_CURRENTFOLDER Request parameter name for the current folder name.
static java.lang.String	PARAM_INDEX_PAGE_TYPE Request parameter name for the index page resource type.
static java.lang.String	PROPERTY_RESTYPES_INDEXPAGE The name of the property where to find possible restypes for the index page.

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

构造器概要

构造器

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

方法概要

方法

限定符和类型	方法和说明
boolean	actionCreateResource() Creates the folder using the specified resource name.
void	actionDialog() Performs the dialog actions depending on the initialized action.
void	actionEditProperties() Forwards to the property dialog if the resourceeditprops parameter is true.
protected java.lang.String	computeFullResourceName() Appends the full path to the new resource name given in the resource parameter.
protected java.lang.String	customHtmlBeforeList() Returns the html code to add directly before the list inside the form element.
protected java.lang.String	customHtmlEnd() Can be overwritten to add some code after the list.
protected java.lang.String	customHtmlStart() Can be overwritten to add some code before the list.
protected void	dialogButtonsHtml(java.lang.StringBuffer result, int button, java.lang.String attribute) Renders the HTML for a single input button of a specified type.
protected java.util.List<java.lang.String>	getAvailableResTypes() Returns a list with all available resource types for the index page.
protected java.util.List<CmsListItem>	getListItems() Should generate a list with the list items to be displayed.
java.lang.String	getParamCurrentFolder() Returns the current folder set by the http request.
java.lang.String	getParamNewResourceEditProps() Returns the paramNewResourceEditProps.
java.lang.String	getParamSelectedType() Returns the paramSelectedType.
protected void	initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request) Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
java.lang.String	paramsAsHidden() Returns all initialized parameters of the current workplace class as hidden field tags that can be inserted in a form.
protected void	setColumns(CmsListMetadata metadata) Should create the columns and add them to the given list metadata object.
void	setParamCurrentFolder(java.lang.String paramCurrentFolder) Sets the current folder.
void	setParamNewResourceEditProps(java.lang.String paramNewResourceEditProps) Sets the paramNewResourceEditProps.

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

defaultActionHtmlContent, dialogButtons, executeListMultiActions, executeListSingleActions, fillDetails, 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, getParamPage, getParamSearchFilter, getParamSelItems, getParamSortCol, getSelectedItem, getSelectedItems, initializeDetail, isActive, listRecovery, listSave, refreshList, removeList, setList, setListObject, setParamFormName, setParamListAction, setParamPage, setParamSearchFilter, setParamSelItems, setParamSortCol, setSearchAction, throwListUnsupportedActionException, validateParamaters, writeDialog

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

字段详细资料

DEFAULT_AVAILABLE

public static final java.lang.String DEFAULT_AVAILABLE

Default list of available resource types for the index page.

另请参阅:

常量字段值

DEFAULT_MARKER

public static final java.lang.String DEFAULT_MARKER

The marker for the default selected resource type.

另请参阅:

常量字段值

ID_NO_INDEX_PAGE

public static final java.lang.String ID_NO_INDEX_PAGE

The id to use for the entry in the list, for which no index page should be created.

另请参阅:

常量字段值

NAME_NO_INDEX_PAGE

public static final java.lang.String NAME_NO_INDEX_PAGE

The name of the entry to take if no index page should be generated.

另请参阅:

常量字段值

PARAM_CURRENTFOLDER

public static final java.lang.String PARAM_CURRENTFOLDER

Request parameter name for the current folder name.

另请参阅:

常量字段值

PARAM_INDEX_PAGE_TYPE

public static final java.lang.String PARAM_INDEX_PAGE_TYPE

Request parameter name for the index page resource type.

另请参阅:

常量字段值

PROPERTY_RESTYPES_INDEXPAGE

public static final java.lang.String PROPERTY_RESTYPES_INDEXPAGE

The name of the property where to find possible restypes for the index page.

另请参阅:

常量字段值

构造器详细资料

CmsNewResourceFolder

public CmsNewResourceFolder(CmsJspActionElement jsp)

Public constructor.

参数:

jsp - an initialized JSP action element

CmsNewResourceFolder

public CmsNewResourceFolder(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

方法详细资料

actionCreateResource

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

Creates the folder using the specified resource name.

返回:

if the resource was created successfully

抛出:

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

actionDialog

public void actionDialog()
                  throws javax.servlet.jsp.JspException,
                         javax.servlet.ServletException,
                         java.io.IOException

从类复制的说明: A_CmsListDialog

Performs the dialog actions depending on the initialized action.

覆盖:

actionDialog 在类中 A_CmsListResourceTypeDialog

抛出:

javax.servlet.jsp.JspException - if dialog actions fail

javax.servlet.ServletException - in case of errors forwarding to the required result page

java.io.IOException - in case of errors forwarding to the required result page

另请参阅:

A_CmsListDialog.actionDialog()

actionEditProperties

public void actionEditProperties()
                          throws java.io.IOException,
                                 javax.servlet.jsp.JspException,
                                 javax.servlet.ServletException

Forwards to the property dialog if the resourceeditprops parameter is true.

If the parameter is not true, the dialog will be closed.

抛出:

java.io.IOException - if forwarding to the property dialog fails

javax.servlet.ServletException - if forwarding to the property dialog fails

javax.servlet.jsp.JspException - if an inclusion fails

getParamCurrentFolder

public java.lang.String getParamCurrentFolder()

Returns the current folder set by the http request.

If the request parameter value is null/empty then returns the default computed folder.

返回:

the current folder set by the request param or the computed current folder

getParamNewResourceEditProps

public java.lang.String getParamNewResourceEditProps()

Returns the paramNewResourceEditProps.

返回:

the paramNewResourceEditProps

getParamSelectedType

public java.lang.String getParamSelectedType()

从类复制的说明: A_CmsListResourceTypeDialog

Returns the paramSelectedType.

覆盖:

getParamSelectedType 在类中 A_CmsListResourceTypeDialog

返回:

the paramSelectedType

另请参阅:

A_CmsListResourceTypeDialog.getParamSelectedType()

paramsAsHidden

public java.lang.String paramsAsHidden()

从类复制的说明: CmsWorkplace

Returns all initialized parameters of the current workplace class as hidden field tags that can be inserted in a form.

覆盖:

paramsAsHidden 在类中 A_CmsListResourceTypeDialog

返回:

all initialized parameters of the current workplace class as hidden field tags that can be inserted in a html form

另请参阅:

CmsWorkplace.paramsAsHidden()

setParamCurrentFolder

public void setParamCurrentFolder(java.lang.String paramCurrentFolder)

Sets the current folder.

参数:

paramCurrentFolder - the current folder to set

setParamNewResourceEditProps

public void setParamNewResourceEditProps(java.lang.String paramNewResourceEditProps)

Sets the paramNewResourceEditProps.

参数:

paramNewResourceEditProps - the paramNewResourceEditProps to set

computeFullResourceName

protected java.lang.String computeFullResourceName()

Appends the full path to the new resource name given in the resource parameter.

返回:

the full path of the new resource

customHtmlBeforeList

protected java.lang.String customHtmlBeforeList()

Returns the html code to add directly before the list inside the form element.

覆盖:

customHtmlBeforeList 在类中 A_CmsListResourceTypeDialog

返回:

the html code to add directly before the list inside the form element

customHtmlEnd

protected java.lang.String customHtmlEnd()

从类复制的说明: A_CmsListDialog

Can be overwritten to add some code after the list.

覆盖:

customHtmlEnd 在类中 A_CmsListResourceTypeDialog

返回:

custom html code

另请参阅:

A_CmsListDialog.customHtmlEnd()

customHtmlStart

protected java.lang.String customHtmlStart()

从类复制的说明: A_CmsListDialog

Can be overwritten to add some code before the list.

覆盖:

customHtmlStart 在类中 A_CmsListResourceTypeDialog

返回:

custom html code

另请参阅:

A_CmsListDialog.customHtmlStart()

dialogButtonsHtml

protected void dialogButtonsHtml(java.lang.StringBuffer result,
                     int button,
                     java.lang.String attribute)

从类复制的说明: CmsDialog

Renders the HTML for a single input button of a specified type.

覆盖:

dialogButtonsHtml 在类中 CmsDialog

参数:

result - a string buffer where the rendered HTML gets appended to

button - a integer key to identify the button

attribute - an optional string with possible tag attributes, or null

另请参阅:

CmsDialog.dialogButtonsHtml(java.lang.StringBuffer, int, java.lang.String)

getAvailableResTypes

protected java.util.List<java.lang.String> getAvailableResTypes()

Returns a list with all available resource types for the index page.

The information is first read from the property "restypes.indexpage". If there nothing could be found, the global settings from the resource type folder is taken. Only if there is nothing configured, the default (No index page and xmlpage) will be taken.

返回:

a list with all available resource types for the index page

getListItems

protected java.util.List<CmsListItem> getListItems()

从类复制的说明: A_CmsListDialog

Should generate a list with the list items to be displayed.

指定者:

getListItems 在类中 A_CmsListDialog

返回:

a list of CmsListItems

另请参阅:

A_CmsListDialog.getListItems()

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 在类中 A_CmsListDialog

参数:

settings - the workplace settings

request - the current request

另请参阅:

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

setColumns

protected void setColumns(CmsListMetadata metadata)

从类复制的说明: A_CmsListDialog

Should create the columns and add them to the given list metadata object.

This method will be just executed once, the first time the constructor is called.

覆盖:

setColumns 在类中 A_CmsListResourceTypeDialog

参数:

metadata - the list metadata

另请参阅:

A_CmsListResourceTypeDialog.setColumns(org.opencms.workplace.list.CmsListMetadata)