org.opencms.workplace.explorer
Class CmsNewResourceFolder

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
                      extended byorg.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:

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

Since:
6.7.1
Version:
$Revision: 1.26 $
Author:
Andreas Zahner, Peter Bonrad

Field Summary
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.
 
Fields inherited from class 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
 
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
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.
 
Method Summary
 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 getAvailableResTypes()
          Returns a list with all available resource types for the index page.
protected  java.util.List 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.
 
Methods inherited from class org.opencms.workplace.list.A_CmsListResourceTypeDialog
defaultActionHtmlContent, dialogButtons, executeListMultiActions, executeListSingleActions, fillDetails, paramsAsHidden, setIndependentActions, setMultiActions, setParamSelectedType
 
Methods inherited from class 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
 
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, 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

DEFAULT_AVAILABLE

public static final java.lang.String DEFAULT_AVAILABLE
Default list of available resource types for the index page.

See Also:
Constant Field Values

DEFAULT_MARKER

public static final java.lang.String DEFAULT_MARKER
The marker for the default selected resource type.

See Also:
Constant Field Values

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.

See Also:
Constant Field Values

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.

See Also:
Constant Field Values

PARAM_CURRENTFOLDER

public static final java.lang.String PARAM_CURRENTFOLDER
Request parameter name for the current folder name.

See Also:
Constant Field Values

PARAM_INDEX_PAGE_TYPE

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

See Also:
Constant Field Values

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.

See Also:
Constant Field Values
Constructor Detail

CmsNewResourceFolder

public CmsNewResourceFolder(CmsJspActionElement jsp)
Public constructor.

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

Parameters:
context - the JSP page context
req - the JSP request
res - the JSP response
Method Detail

actionCreateResource

public boolean actionCreateResource()
                             throws javax.servlet.jsp.JspException
Creates the folder using the specified resource name.

Returns:
if the resource was created successfully
Throws:
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
Description copied from class: A_CmsListDialog
Performs the dialog actions depending on the initialized action.

Overrides:
actionDialog in class A_CmsListResourceTypeDialog
Throws:
javax.servlet.jsp.JspException
javax.servlet.ServletException
java.io.IOException
See Also:
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.

Throws:
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.

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

getParamNewResourceEditProps

public java.lang.String getParamNewResourceEditProps()
Returns the paramNewResourceEditProps.

Returns:
the paramNewResourceEditProps

getParamSelectedType

public java.lang.String getParamSelectedType()
Description copied from class: A_CmsListResourceTypeDialog
Returns the paramSelectedType.

Overrides:
getParamSelectedType in class A_CmsListResourceTypeDialog
Returns:
the paramSelectedType
See Also:
A_CmsListResourceTypeDialog.getParamSelectedType()

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 A_CmsListResourceTypeDialog
See Also:
CmsWorkplace.paramsAsHidden()

setParamCurrentFolder

public void setParamCurrentFolder(java.lang.String paramCurrentFolder)
Sets the current folder.

Parameters:
paramCurrentFolder - the current folder to set

setParamNewResourceEditProps

public void setParamNewResourceEditProps(java.lang.String paramNewResourceEditProps)
Sets the paramNewResourceEditProps.

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

Returns:
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.

Overrides:
customHtmlBeforeList in class A_CmsListResourceTypeDialog
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_CmsListResourceTypeDialog
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_CmsListResourceTypeDialog
See Also:
A_CmsListDialog.customHtmlStart()

dialogButtonsHtml

protected void dialogButtonsHtml(java.lang.StringBuffer result,
                                 int button,
                                 java.lang.String attribute)
Description copied from class: CmsDialog
Renders the HTML for a single input button of a specified type.

Overrides:
dialogButtonsHtml in class CmsDialog
Parameters:
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
See Also:
CmsDialog.dialogButtonsHtml(java.lang.StringBuffer, int, java.lang.String)

getAvailableResTypes

protected java.util.List 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.

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

getListItems

protected java.util.List getListItems()
Description copied from class: A_CmsListDialog
Should generate a list with the list items to be displayed.

Specified by:
getListItems in class A_CmsListDialog
Returns:
a list of CmsListItems
See Also:
A_CmsListDialog.getListItems()

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 A_CmsListDialog
See Also:
A_CmsListDialog.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)

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.

Overrides:
setColumns in class A_CmsListResourceTypeDialog
See Also:
A_CmsListResourceTypeDialog.setColumns(org.opencms.workplace.list.CmsListMetadata)