org.opencms.workplace.list

类 A_CmsSelectResourceList

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_CmsListExplorerDialog

org.opencms.workplace.list.A_CmsSelectResourceList

直接已知子类:

CmsNewResourceXmlContentModel

public abstract class A_CmsSelectResourceList
extends A_CmsListExplorerDialog

A base list dialog to select a resource.

This dialog can be used as part of a wizard based dialog by forwarding to it and after the selection switching back to the wizard. Necessary request parameters have to be passed through.

从以下版本开始:

6.5.6

字段概要

字段

限定符和类型	字段和说明
static int	BUTTON_FINISH Constant for the "Finish" button in the build button methods.
static int	BUTTON_NEXT Constant for the "Next" button in the build button methods.
static java.lang.String	LIST_COLUMN_SELECT List column id constant.
static java.lang.String	LIST_RACTION_SEL List independent action id constant.

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

LIST_ACTION_EDIT, LIST_ACTION_LOCKICON, LIST_ACTION_PROJSTATEICON, LIST_ACTION_TYPEICON, LIST_COLUMN_DATECREATE, LIST_COLUMN_DATEEXP, LIST_COLUMN_DATELASTMOD, LIST_COLUMN_DATEREL, LIST_COLUMN_EDIT, LIST_COLUMN_LOCKEDBY, LIST_COLUMN_LOCKICON, LIST_COLUMN_NAME, LIST_COLUMN_PERMISSIONS, LIST_COLUMN_PROJSTATEICON, LIST_COLUMN_ROOT_PATH, LIST_COLUMN_SITE, LIST_COLUMN_SIZE, LIST_COLUMN_STATE, LIST_COLUMN_TITLE, LIST_COLUMN_TYPE, LIST_COLUMN_TYPEICON, LIST_COLUMN_USERCREATE, LIST_COLUMN_USERLASTMOD, LIST_DEFACTION_OPEN, PARAM_SHOW_EXPLORER, PATH_EXPLORER_LIST

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

构造器概要

构造器

限定符	构造器和说明
protected	A_CmsSelectResourceList(CmsJspActionElement jsp, java.lang.String listId, CmsMessageContainer listName) Creates a new select resource list ordered and searchable by name.
protected	A_CmsSelectResourceList(CmsJspActionElement jsp, java.lang.String listId, CmsMessageContainer listName, java.lang.String sortedColId, CmsListOrderEnum sortOrder, java.lang.String searchableColId) Default constructor.

方法概要

方法

限定符和类型	方法和说明
void	actionDialog() Override this to set additional parameters before forwarding or to change the forward target.
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.
java.lang.String	dialogButtons() Builds a default button row with a continue and cancel button.
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.
void	displayDialog() Performs the dialog actions depending on the initialized action and displays the dialog form.
void	executeListMultiActions() This method should handle every defined list multi action, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.
void	executeListSingleActions() This method should handle every defined list single action, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.
protected void	fillDetails(java.lang.String detailId) Lazy initialization for detail data.
abstract java.lang.String	getListTitle() Returns the title of the list to display.
java.lang.String	getSelectedResourceName() Returns the resource name of the selected resource.
protected void	initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request) Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
protected boolean	isColumnVisible(int colFlag) The following columns are visible by default: type icon, resource name, title and last modification date.
abstract java.lang.String	nextUrl() Returns the url to forward the parameters after selection.
protected void	setColumns(CmsListMetadata metadata) Adds the standard explorer view columns to the list.
protected void	setMultiActions(CmsListMetadata metadata) Should add the multi actions to the given list metadata object.

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

applyColumnVisibilities, defaultActionHtmlStart, executeListIndepActions, executeSelectPage, fillList, getAdditionalParametersForExplorerForward, getCollector, getColVisibilities, getListItems, getListStateForCollector, getParamShowexplorer, getProject, getResourceUtil, getResourceUtil, setColumnVisibilities, setColumnVisibility, setColVisibilities, setIndependentActions, setParamShowexplorer

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

defaultActionHtml, defaultActionHtmlContent, defaultActionHtmlEnd, displayDialog, executeDefaultActions, executeSearch, executeSort, 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, paramsAsHidden, paramsAsHidden, 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

字段详细资料

BUTTON_FINISH

public static final int BUTTON_FINISH

Constant for the "Finish" button in the build button methods.

另请参阅:

常量字段值

BUTTON_NEXT

public static final int BUTTON_NEXT

Constant for the "Next" button in the build button methods.

另请参阅:

常量字段值

LIST_COLUMN_SELECT

public static final java.lang.String LIST_COLUMN_SELECT

List column id constant.

另请参阅:

常量字段值

LIST_RACTION_SEL

public static final java.lang.String LIST_RACTION_SEL

List independent action id constant.

另请参阅:

常量字段值

构造器详细资料

A_CmsSelectResourceList

protected A_CmsSelectResourceList(CmsJspActionElement jsp,
                       java.lang.String listId,
                       CmsMessageContainer listName)

Creates a new select resource list ordered and searchable by name.

参数:

jsp - an initialized JSP action element

listId - the id of the displayed list

listName - the name of the list

A_CmsSelectResourceList

protected A_CmsSelectResourceList(CmsJspActionElement jsp,
                       java.lang.String listId,
                       CmsMessageContainer listName,
                       java.lang.String sortedColId,
                       CmsListOrderEnum sortOrder,
                       java.lang.String searchableColId)

Default constructor.

参数:

jsp - an initialized JSP action element

listId - the id of the displayed list

listName - the name of the list

sortedColId - the a priory sorted column

sortOrder - the order of the sorted column

searchableColId - the column to search into

方法详细资料

actionDialog

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

Override this to set additional parameters before forwarding or to change the forward target.

Usually you have to set the "action" parameter to another value before forwarding.

覆盖:

actionDialog 在类中 A_CmsListDialog

抛出:

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()

dialogButtons

public java.lang.String dialogButtons()

Builds a default button row with a continue and cancel button.

Override this to have special buttons for your dialog.

返回:

the button row

executeListMultiActions

public void executeListMultiActions()

从类复制的说明: A_CmsListDialog

This method should handle every defined list multi action, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.

指定者:

executeListMultiActions 在类中 A_CmsListDialog

另请参阅:

A_CmsListDialog.executeListMultiActions()

executeListSingleActions

public void executeListSingleActions()

从类复制的说明: A_CmsListDialog

This method should handle every defined list single action, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.

指定者:

executeListSingleActions 在类中 A_CmsListDialog

另请参阅:

A_CmsListDialog.executeListSingleActions()

getSelectedResourceName

public java.lang.String getSelectedResourceName()

Returns the resource name of the selected resource.

返回:

the resource name of the selected resource or null if no resource was selected

displayDialog

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

从类复制的说明: A_CmsListDialog

Performs the dialog actions depending on the initialized action and displays the dialog form.

覆盖:

displayDialog 在类中 A_CmsListDialog

抛出:

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

java.io.IOException - if writing to the JSP out fails, or in case of errors forwarding to the required result page

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

另请参阅:

A_CmsListDialog.displayDialog()

getListTitle

public abstract java.lang.String getListTitle()

Returns the title of the list to display.

返回:

the title of the list to display

nextUrl

public abstract java.lang.String nextUrl()

Returns the url to forward the parameters after selection.

返回:

the url to forward the parameters after selection

customHtmlEnd

protected java.lang.String customHtmlEnd()

从类复制的说明: A_CmsListDialog

Can be overwritten to add some code after the list.

覆盖:

customHtmlEnd 在类中 A_CmsListDialog

返回:

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_CmsListDialog

返回:

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)

fillDetails

protected void fillDetails(java.lang.String detailId)

从类复制的说明: A_CmsListDialog

Lazy initialization for detail data.

Should fill the given detail column for every list item in CmsHtmlList.getContent() Should not throw any kind of exception.

指定者:

fillDetails 在类中 A_CmsListDialog

参数:

detailId - the id of the detail to initialize

另请参阅:

A_CmsListDialog.fillDetails(java.lang.String)

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_CmsListExplorerDialog

参数:

settings - the workplace settings

request - the current request

另请参阅:

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

isColumnVisible

protected boolean isColumnVisible(int colFlag)

The following columns are visible by default: type icon, resource name, title and last modification date.

Override this to set different column visibilities.

覆盖:

isColumnVisible 在类中 A_CmsListExplorerDialog

参数:

colFlag - some CmsUserSettings.FILELIST_TITLE like value identifying the column to get the visibility flag for

返回:

the visibility flag for the given column

另请参阅:

A_CmsListExplorerDialog.isColumnVisible(int)

setColumns

protected void setColumns(CmsListMetadata metadata)

从类复制的说明: A_CmsListExplorerDialog

Adds the standard explorer view columns to the list.

覆盖:

setColumns 在类中 A_CmsListExplorerDialog

参数:

metadata - the list metadata

另请参阅:

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

setMultiActions

protected void setMultiActions(CmsListMetadata metadata)

从类复制的说明: A_CmsListDialog

Should add the multi actions to the given list metadata object.

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

指定者:

setMultiActions 在类中 A_CmsListDialog

参数:

metadata - the list metadata

另请参阅:

A_CmsListDialog.setMultiActions(org.opencms.workplace.list.CmsListMetadata)