org.opencms.workplace.list
Class A_CmsListResourceTypeDialog

java.lang.Object
  extended byorg.opencms.workplace.CmsWorkplace
      extended byorg.opencms.workplace.tools.CmsToolDialog
          extended byorg.opencms.workplace.CmsDialog
              extended byorg.opencms.workplace.list.A_CmsListDialog
                  extended byorg.opencms.workplace.list.A_CmsListResourceTypeDialog
Direct Known Subclasses:
CmsChtype, CmsNewResource, CmsNewResourceFolder

public abstract class A_CmsListResourceTypeDialog
extends A_CmsListDialog

Super class for all dialogs needed to display a list of resource types.

Since:
6.7.2
Version:
$Revision: 1.6 $
Author:
Peter Bonrad

Field Summary
static java.lang.String LIST_ACTION_SEL
          List independent action id constant.
static java.lang.String LIST_COLUMN_ICON
          List column id constant.
static java.lang.String LIST_COLUMN_NAME
          List column id constant.
static java.lang.String LIST_COLUMN_SELECT
          List column id constant.
static java.lang.String LIST_DETAIL_DESCRIPTION
          List detail description info.
static java.lang.String LIST_ID
          List id constant.
static java.lang.String PARAM_SELECTED_TYPE
          Request parameter name for the index page resource type.
 
Fields inherited from class 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, PARAM_FORMNAME, PARAM_LIST_ACTION, PARAM_PAGE, PARAM_SEARCH_FILTER, PARAM_SEL_ITEMS, PARAM_SORT_COL
 
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.tools.CmsToolDialog
PARAM_BASE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW
 
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
A_CmsListResourceTypeDialog(CmsJspActionElement jsp)
          Public constructor with JSP action element.
A_CmsListResourceTypeDialog(CmsJspActionElement jsp, java.lang.String listId, CmsMessageContainer listName, java.lang.String sortedColId, CmsListOrderEnum sortOrder, java.lang.String searchableColId)
          Public constructor.
A_CmsListResourceTypeDialog(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
          Public constructor with JSP variables.
 
Method Summary
 void actionDialog()
          Performs the dialog actions depending on the initialized action.
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  java.lang.String defaultActionHtmlContent()
          Returns the html code for the default action content.
 java.lang.String dialogButtons()
          Builds a default button row with a continue and cancel button.
 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.
 java.lang.String getParamSelectedType()
          Returns the paramSelectedType.
 java.lang.String paramsAsHidden()
          Returns all initialized parameters of the current workplace class as hidden field tags that can be inserted in a form.
 java.lang.String paramsAsHidden(java.util.Collection excludes)
          Returns all initialized parameters of the current workplace class that are not in the given exclusion list 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.
protected  void setIndependentActions(CmsListMetadata metadata)
          Should add the independent actions to the given list metadata object.
protected  void setMultiActions(CmsListMetadata metadata)
          Should add the multi actions to the given list metadata object.
 void setParamSelectedType(java.lang.String paramSelectedType)
          Sets the paramSelectedType.
 
Methods inherited from class org.opencms.workplace.list.A_CmsListDialog
defaultActionHtml, defaultActionHtmlEnd, defaultActionHtmlStart, displayDialog, displayDialog, executeDefaultActions, executeListIndepActions, executeSearch, executeSelectPage, executeSort, fillList, getList, getListId, getListItems, getListObject, getListState, getMetadata, getMetadata, getParamFormName, getParamListAction, getParamPage, getParamSearchFilter, getParamSelItems, getParamSortCol, getSelectedItem, getSelectedItems, initializeDetail, initWorkplaceRequestValues, isActive, listRecovery, listSave, refreshList, removeList, setList, setListObject, setParamFormName, setParamListAction, setParamPage, setParamSearchFilter, setParamSelItems, setParamSortCol, setSearchAction, throwListUnsupportedActionException, validateParamaters, writeDialog
 
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, 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
 

Field Detail

LIST_ACTION_SEL

public static final java.lang.String LIST_ACTION_SEL
List independent action id constant.

See Also:
Constant Field Values

LIST_COLUMN_ICON

public static final java.lang.String LIST_COLUMN_ICON
List column id constant.

See Also:
Constant Field Values

LIST_COLUMN_NAME

public static final java.lang.String LIST_COLUMN_NAME
List column id constant.

See Also:
Constant Field Values

LIST_COLUMN_SELECT

public static final java.lang.String LIST_COLUMN_SELECT
List column id constant.

See Also:
Constant Field Values

LIST_DETAIL_DESCRIPTION

public static final java.lang.String LIST_DETAIL_DESCRIPTION
List detail description info.

See Also:
Constant Field Values

LIST_ID

public static final java.lang.String LIST_ID
List id constant.

See Also:
Constant Field Values

PARAM_SELECTED_TYPE

public static final java.lang.String PARAM_SELECTED_TYPE
Request parameter name for the index page resource type.

See Also:
Constant Field Values
Constructor Detail

A_CmsListResourceTypeDialog

public A_CmsListResourceTypeDialog(CmsJspActionElement jsp)
Public constructor with JSP action element.

Parameters:
jsp - an initialized JSP action element

A_CmsListResourceTypeDialog

public A_CmsListResourceTypeDialog(CmsJspActionElement jsp,
                                   java.lang.String listId,
                                   CmsMessageContainer listName,
                                   java.lang.String sortedColId,
                                   CmsListOrderEnum sortOrder,
                                   java.lang.String searchableColId)
Public constructor.

Parameters:
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

A_CmsListResourceTypeDialog

public A_CmsListResourceTypeDialog(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 context
req - the JSP request
res - the JSP response
Method Detail

actionDialog

public void actionDialog()
                  throws javax.servlet.jsp.JspException,
                         javax.servlet.ServletException,
                         java.io.IOException
Description copied from class: A_CmsListDialog
Performs the dialog actions depending on the initialized action.

Overrides:
actionDialog in class A_CmsListDialog
Throws:
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
javax.servlet.jsp.JspException - if dialog actions fail
See Also:
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.

Returns:
the button row

executeListMultiActions

public void executeListMultiActions()
                             throws CmsRuntimeException
Description copied from class: A_CmsListDialog
This method should handle every defined list multi action, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.

Specified by:
executeListMultiActions in class A_CmsListDialog
Throws:
CmsRuntimeException - to signal that an action is not supported
See Also:
A_CmsListDialog.executeListMultiActions()

executeListSingleActions

public void executeListSingleActions()
                              throws CmsRuntimeException
Description copied from class: A_CmsListDialog
This method should handle every defined list single action, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.

Specified by:
executeListSingleActions in class A_CmsListDialog
Throws:
CmsRuntimeException - to signal that an action is not supported
See Also:
A_CmsListDialog.executeListSingleActions()

getParamSelectedType

public java.lang.String getParamSelectedType()
Returns the paramSelectedType.

Returns:
the paramSelectedType

paramsAsHidden

public java.lang.String paramsAsHidden()
Description copied from class: CmsWorkplace
Returns all initialized parameters of the current workplace class as hidden field tags that can be inserted in a form.

Overrides:
paramsAsHidden in class CmsWorkplace
Returns:
all initialized parameters of the current workplace class as hidden field tags that can be inserted in a html form
See Also:
CmsWorkplace.paramsAsHidden()

paramsAsHidden

public java.lang.String paramsAsHidden(java.util.Collection excludes)
Description copied from class: CmsWorkplace
Returns all initialized parameters of the current workplace class that are not in the given exclusion list as hidden field tags that can be inserted in a form.

Overrides:
paramsAsHidden in class CmsWorkplace
Parameters:
excludes - the parameters to exclude
Returns:
all initialized parameters of the current workplace class that are not in the given exclusion list as hidden field tags that can be inserted in a form
See Also:
CmsWorkplace.paramsAsHidden(java.util.Collection)

setParamSelectedType

public void setParamSelectedType(java.lang.String paramSelectedType)
Sets the paramSelectedType.

Parameters:
paramSelectedType - the paramSelectedType to set

customHtmlBeforeList

protected java.lang.String customHtmlBeforeList()
Returns the html code to add directly before the list inside the form element.

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

customHtmlEnd

protected java.lang.String customHtmlEnd()
Description copied from class: A_CmsListDialog
Can be overwritten to add some code after the list.

Overrides:
customHtmlEnd in class A_CmsListDialog
Returns:
custom html code
See Also:
A_CmsListDialog.customHtmlEnd()

customHtmlStart

protected java.lang.String customHtmlStart()
Description copied from class: A_CmsListDialog
Can be overwritten to add some code before the list.

Overrides:
customHtmlStart in class A_CmsListDialog
Returns:
custom html code
See Also:
A_CmsListDialog.customHtmlStart()

defaultActionHtmlContent

protected java.lang.String defaultActionHtmlContent()
Description copied from class: A_CmsListDialog
Returns the html code for the default action content.

Overrides:
defaultActionHtmlContent in class A_CmsListDialog
Returns:
html code
See Also:
A_CmsListDialog.defaultActionHtmlContent()

fillDetails

protected void fillDetails(java.lang.String detailId)
Description copied from class: 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.

Specified by:
fillDetails in class A_CmsListDialog
Parameters:
detailId - the id of the detail to initialize
See Also:
A_CmsListDialog.fillDetails(java.lang.String)

setColumns

protected void setColumns(CmsListMetadata metadata)
Description copied from class: 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.

Specified by:
setColumns in class A_CmsListDialog
Parameters:
metadata - the list metadata
See Also:
A_CmsListDialog.setColumns(org.opencms.workplace.list.CmsListMetadata)

setIndependentActions

protected void setIndependentActions(CmsListMetadata metadata)
Description copied from class: A_CmsListDialog
Should add the independent actions to the given list metadata object.

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

Specified by:
setIndependentActions in class A_CmsListDialog
Parameters:
metadata - the list metadata
See Also:
A_CmsListDialog.setIndependentActions(org.opencms.workplace.list.CmsListMetadata)

setMultiActions

protected void setMultiActions(CmsListMetadata metadata)
Description copied from class: 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.

Specified by:
setMultiActions in class A_CmsListDialog
Parameters:
metadata - the list metadata
See Also:
A_CmsListDialog.setMultiActions(org.opencms.workplace.list.CmsListMetadata)