org.opencms.workplace.explorer
Class CmsNewResourceXmlContentModel

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_CmsListExplorerDialog
                      extended byorg.opencms.workplace.list.A_CmsSelectResourceList
                          extended byorg.opencms.workplace.explorer.CmsNewResourceXmlContentModel

public class CmsNewResourceXmlContentModel
extends A_CmsSelectResourceList

The new resource xmlcontent model file selection dialog handles the selection of a model file for a new xmlcontent.

Creates a list of model files to choose from and forwards either to the new resource dialog or to the editor.

The following files use this class:

Since:
6.5.4
Version:
$Revision: 1.4 $
Author:
Andreas Zahner

Field Summary
static java.lang.String LIST_DETAIL_DESCRIPTION
          List detail description info.
static java.lang.String LIST_ID
          List id constant.
static java.lang.String VFS_PATH_MODELDIALOG
          Absolute path to the model file dialog.
static java.lang.String VFS_PATH_NEWRESOURCEDIALOG
          Absolute path to thenew resource dialog.
 
Fields inherited from class org.opencms.workplace.list.A_CmsSelectResourceList
BUTTON_FINISH, BUTTON_NEXT, LIST_COLUMN_SELECT, LIST_RACTION_SEL
 
Fields inherited from class 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
 
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
CmsNewResourceXmlContentModel(CmsJspActionElement jsp)
          Public constructor.
CmsNewResourceXmlContentModel(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
          Public constructor with JSP variables.
 
Method Summary
protected  void actionClose()
          Closes the dialog and forwards to the previed page in direct editor mode.
 void actionDialog()
          Overrides the default action, parameters have to be set and the forward targets may be different.
 java.lang.String dialogButtons()
          The buttons in the new resource dialog depend on various preconditions.
protected  void fillDetails(java.lang.String detailId)
          Lazy initialization for detail data.
 I_CmsListResourceCollector getCollector()
          Returns the collector to use to display the resources.
 java.lang.String getListTitle()
          Returns the title of the list to display.
 java.lang.String getParamAppendSuffixHtml()
          Returns the parameter to check if a ".html" suffix should be added to the new resource name.
 java.lang.String getParamBackLink()
          Returns the back link URL used when displaying the dialog in pre editor mode.
 java.lang.String getParamModelFile()
          Returns the parameter that specifies the model file name.
 java.lang.String getParamNewResourceEditProps()
          Returns the new resource edit properties flag parameter.
 java.lang.String getParamNewResourceType()
          Returns the new resource type parameter.
protected  boolean isColumnVisible(int colFlag)
          The following columns are visible by default: type icon, resource name, title and last modification date.
 java.lang.String nextUrl()
          Returns the url to forward the parameters after selection.
protected  void setColumns(CmsListMetadata metadata)
          Removes the default "preview file" action from the file name column.
protected  void setIndependentActions(CmsListMetadata metadata)
          Should add the independent actions to the given list metadata object.
 void setParamAppendSuffixHtml(java.lang.String paramAppendSuffixHtml)
          Sets the parameter to check if a ".html" suffix should be added to the new resource name.
 void setParamBackLink(java.lang.String paramBackLink)
          Sets the back link URL used when displaying the dialog in pre editor mode.
 void setParamModelFile(java.lang.String paramMasterFile)
          Sets the parameter that specifies the model file name.
 void setParamNewResourceEditProps(java.lang.String newResourceEditProps)
          Sets the new resource edit properties flag parameter.
 void setParamNewResourceType(java.lang.String newResourceType)
          Sets the new resource type parameter.
 
Methods inherited from class org.opencms.workplace.list.A_CmsSelectResourceList
customHtmlEnd, customHtmlStart, dialogButtonsHtml, displayDialog, executeListMultiActions, executeListSingleActions, getSelectedResourceName, initWorkplaceRequestValues, setMultiActions
 
Methods inherited from class org.opencms.workplace.list.A_CmsListExplorerDialog
applyColumnVisibilities, defaultActionHtmlStart, executeListIndepActions, executeSelectPage, fillList, getColVisibilities, getListItems, getListStateForCollector, getParamShowexplorer, getProject, getResourceUtil, getResourceUtil, setColumnVisibilities, setColumnVisibility, setColVisibilities, setParamShowexplorer
 
Methods inherited from class 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
 
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, paramsAsHidden, paramsAsHidden, 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_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

VFS_PATH_MODELDIALOG

public static final java.lang.String VFS_PATH_MODELDIALOG
Absolute path to the model file dialog.

See Also:
Constant Field Values

VFS_PATH_NEWRESOURCEDIALOG

public static final java.lang.String VFS_PATH_NEWRESOURCEDIALOG
Absolute path to thenew resource dialog.

See Also:
Constant Field Values
Constructor Detail

CmsNewResourceXmlContentModel

public CmsNewResourceXmlContentModel(CmsJspActionElement jsp)
Public constructor.

Parameters:
jsp - an initialized JSP action element

CmsNewResourceXmlContentModel

public CmsNewResourceXmlContentModel(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
Overrides the default action, parameters have to be set and the forward targets may be different.

Overrides:
actionDialog in class A_CmsSelectResourceList
Throws:
javax.servlet.jsp.JspException
javax.servlet.ServletException
java.io.IOException
See Also:
A_CmsListDialog.actionDialog()

dialogButtons

public java.lang.String dialogButtons()
The buttons in the new resource dialog depend on various preconditions.

Variations:

Overrides:
dialogButtons in class A_CmsSelectResourceList
Returns:
the button row
See Also:
A_CmsSelectResourceList.dialogButtons()

getCollector

public I_CmsListResourceCollector getCollector()
Description copied from class: A_CmsListExplorerDialog
Returns the collector to use to display the resources.

Specified by:
getCollector in class A_CmsListExplorerDialog
Returns:
the collector to use to display the resources
See Also:
A_CmsListExplorerDialog.getCollector()

getListTitle

public java.lang.String getListTitle()
Description copied from class: A_CmsSelectResourceList
Returns the title of the list to display.

Specified by:
getListTitle in class A_CmsSelectResourceList
Returns:
the title of the list to display
See Also:
A_CmsSelectResourceList.getListTitle()

getParamAppendSuffixHtml

public java.lang.String getParamAppendSuffixHtml()
Returns the parameter to check if a ".html" suffix should be added to the new resource name.

Returns:
the parameter to check if a ".html" suffix should be added to the new resource name

getParamBackLink

public java.lang.String getParamBackLink()
Returns the back link URL used when displaying the dialog in pre editor mode.

Returns:
the back link URL used when displaying the dialog in pre editor mode

getParamModelFile

public java.lang.String getParamModelFile()
Returns the parameter that specifies the model file name.

Returns:
the parameter that specifies the model file name

getParamNewResourceEditProps

public java.lang.String getParamNewResourceEditProps()
Returns the new resource edit properties flag parameter.

Returns:
the new resource edit properties flag parameter

getParamNewResourceType

public java.lang.String getParamNewResourceType()
Returns the new resource type parameter.

Returns:
the new resource type parameter

nextUrl

public java.lang.String nextUrl()
Description copied from class: A_CmsSelectResourceList
Returns the url to forward the parameters after selection.

Specified by:
nextUrl in class A_CmsSelectResourceList
Returns:
the url to forward the parameters after selection
See Also:
A_CmsSelectResourceList.nextUrl()

setParamAppendSuffixHtml

public void setParamAppendSuffixHtml(java.lang.String paramAppendSuffixHtml)
Sets the parameter to check if a ".html" suffix should be added to the new resource name.

Parameters:
paramAppendSuffixHtml - the parameter to check if a ".html" suffix should be added to the new resource name

setParamBackLink

public void setParamBackLink(java.lang.String paramBackLink)
Sets the back link URL used when displaying the dialog in pre editor mode.

Parameters:
paramBackLink - the back link URL used when displaying the dialog in pre editor mode

setParamModelFile

public void setParamModelFile(java.lang.String paramMasterFile)
Sets the parameter that specifies the model file name.

Parameters:
paramMasterFile - the parameter that specifies the model file name

setParamNewResourceEditProps

public void setParamNewResourceEditProps(java.lang.String newResourceEditProps)
Sets the new resource edit properties flag parameter.

Parameters:
newResourceEditProps - the new resource edit properties flag parameter

setParamNewResourceType

public void setParamNewResourceType(java.lang.String newResourceType)
Sets the new resource type parameter.

Parameters:
newResourceType - the new resource type parameter

actionClose

protected void actionClose()
                    throws java.io.IOException,
                           javax.servlet.ServletException
Closes the dialog and forwards to the previed page in direct editor mode.

Throws:
java.io.IOException - if forwarding fails
javax.servlet.ServletException - if forwarding fails

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.

Overrides:
fillDetails in class A_CmsSelectResourceList
See Also:
A_CmsSelectResourceList.fillDetails(java.lang.String)

isColumnVisible

protected boolean isColumnVisible(int colFlag)
Description copied from class: A_CmsSelectResourceList
The following columns are visible by default: type icon, resource name, title and last modification date.

Override this to set different column visibilities.

Overrides:
isColumnVisible in class A_CmsSelectResourceList
See Also:
A_CmsListExplorerDialog.isColumnVisible(int)

setColumns

protected void setColumns(CmsListMetadata metadata)
Removes the default "preview file" action from the file name column.

Overrides:
setColumns in class A_CmsSelectResourceList
See Also:
A_CmsListExplorerDialog.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.

Overrides:
setIndependentActions in class A_CmsListExplorerDialog
See Also:
A_CmsListExplorerDialog.setIndependentActions(org.opencms.workplace.list.CmsListMetadata)