org.opencms.workplace.list
Class CmsListExplorerFrameset
java.lang.Object
org.opencms.workplace.CmsWorkplace
org.opencms.workplace.tools.CmsToolDialog
org.opencms.workplace.CmsDialog
org.opencms.workplace.tools.CmsExplorerDialog
org.opencms.workplace.list.CmsListExplorerFrameset
public class CmsListExplorerFrameset
- extends CmsExplorerDialog
Explorer dialog for the project files view.
- Since:
- 6.0.0
- Version:
- $Revision: 1.11 $
- Author:
- Michael Moossen
Field Summary |
static java.lang.String |
PARAM_PAGE
Page parameter name. |
static java.lang.String |
PARAM_TITLE_URI
Title uri parameter name. |
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.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 |
Method Summary |
java.lang.String |
defaultActionHtml()
Generates the dialog starting html code. |
java.lang.String |
dialogTitle()
Generates the standard new style dialog title row, and tool grouping. |
void |
displayDialog()
Performs the dialog actions depending on the initialized action and displays the dialog form. |
void |
displayFrameSet()
Validates the needed parameters and display the frameset. |
protected java.lang.String |
getFormContent()
Returns the form contents. |
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(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. |
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 |
getAdminTool, getCurrentToolPath, getParamBase, getParamForce, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamForce, 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, 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 |
PARAM_PAGE
public static final java.lang.String PARAM_PAGE
- Page parameter name.
- See Also:
- Constant Field Values
PARAM_TITLE_URI
public static final java.lang.String PARAM_TITLE_URI
- Title uri parameter name.
- See Also:
- Constant Field Values
CmsListExplorerFrameset
public CmsListExplorerFrameset(CmsJspActionElement jsp)
- Public constructor with JSP action element.
- Parameters:
jsp
- an initialized JSP action element
CmsListExplorerFrameset
public CmsListExplorerFrameset(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 contextreq
- the JSP requestres
- the JSP response
defaultActionHtml
public java.lang.String defaultActionHtml()
- Generates the dialog starting html code.
- Returns:
- html code
dialogTitle
public java.lang.String dialogTitle()
- Description copied from class:
CmsToolDialog
- Generates the standard new style dialog title row, and tool grouping.
It is called by the CmsDialog.dialog(int, String)
method.
- Overrides:
dialogTitle
in class CmsToolDialog
- Returns:
- a dialog window start / end segment
- See Also:
CmsToolDialog.dialogTitle()
displayDialog
public void displayDialog()
throws java.io.IOException,
javax.servlet.ServletException
- Performs the dialog actions depending on the initialized action and displays the dialog form.
- Throws:
javax.servlet.ServletException
- if forwarding explorer view fails
java.io.IOException
- if forwarding explorer view fails
displayFrameSet
public void displayFrameSet()
throws java.io.IOException
- Validates the needed parameters and display the frameset.
- Throws:
java.io.IOException
- in case of errros displaying to the required page
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)
getFormContent
protected java.lang.String getFormContent()
- Returns the form contents.
- Returns:
- the form contents
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 CmsDialog
- Parameters:
settings
- the workplace settingsrequest
- the current request- See Also:
CmsDialog.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)