org.opencms.workplace
Class CmsDialog

java.lang.Object
  extended byorg.opencms.workplace.CmsWorkplace
      extended byorg.opencms.workplace.tools.CmsToolDialog
          extended byorg.opencms.workplace.CmsDialog
Direct Known Subclasses:
A_CmsDiffViewDialog, A_CmsGallery, A_CmsListDialog, CmsChacc, CmsChnav, CmsCommentImages, CmsCopyToProject, CmsDeletedResources, CmsDialogCopyLanguage, CmsDialogElements, CmsDisplayResource, CmsEditorBase, CmsEditPointer, CmsExplorerDialog, CmsHelpTemplateBean, CmsImageComparisonDialog, CmsListCsvExportDialog, CmsListPrintDialog, CmsMultiDialog, CmsOpenGallery, CmsPointerComparisonDialog, CmsPreEditorAction, CmsRenameImages, CmsReplace, CmsResourceComparisonDialog, CmsSearchEditorWrapper, CmsSecure, CmsTabDialog, CmsWidgetDialog

public class CmsDialog
extends CmsToolDialog

Provides methods for building the dialog windows of OpenCms.

Since:
6.0.0
Version:
$Revision: 1.102 $
Author:
Andreas Zahner

Field Summary
static int ACTION_CANCEL
          Value for the action: cancel.
static int ACTION_CLOSEPOPUP
          Value for the action: close popup window.
static int ACTION_CLOSEPOPUP_SAVE
          Value for the action: save & close popup window.
static int ACTION_CONFIRMED
          Value for the action: confirmed.
static int ACTION_CONTINUE
          Value for the action: continue.
static int ACTION_DEFAULT
          Value for the action: default (show initial dialog form).
static int ACTION_LOCKS_CONFIRMED
          Value for the action: locks confirmed.
static int ACTION_OK
          Value for the action: ok.
static int ACTION_REPORT_BEGIN
          Value for the action: begin the report.
static int ACTION_REPORT_END
          Value for the action: end the report.
static int ACTION_REPORT_UPDATE
          Value for the action: update the report.
static int ACTION_SET
          Value for the action: button "set" clicked.
static int ACTION_WAIT
          Value for the action: wait (show please wait screen).
protected static java.lang.String ATTRIBUTE_THROWABLE
          Key name for the throwable attribute.
static int BUTTON_ADVANCED
          Constant for the "Advanced" button in the build button methods.
static int BUTTON_BACK
          Constant for the "Back" button in the build button methods.
static int BUTTON_CANCEL
          Constant for the "Cancel" button in the build button methods.
static int BUTTON_CLOSE
          Constant for the "Close" button in the build button methods.
static int BUTTON_CONTINUE
          Constant for the "Continue" button in the build button methods.
static int BUTTON_DETAILS
          Constant for the "Details" button in the build button methods.
static int BUTTON_DISCARD
          Constant for the "Discard" button in the build button methods (same function as "Cancel" button but different text on button.
static int BUTTON_EDIT
          Constant for the "Edit" button in the build button methods (same function as "Ok" button but different text on button.
static int BUTTON_OK
          Constant for the "OK" button in the build button methods.
static int BUTTON_OK_NO_SUBMIT
          Constant for the "OK" button in the build button methods (without form submission).
static int BUTTON_SET
          Constant for the "Set" button in the build button methods.
static java.lang.String DIALOG_BACK
          Request parameter value for the action: back.
static java.lang.String DIALOG_CANCEL
          Request parameter value for the action: cancel.
static java.lang.String DIALOG_CONFIRMED
          Request parameter value for the action: dialog confirmed.
static java.lang.String DIALOG_CONTINUE
          Request parameter value for the action: continue.
static java.lang.String DIALOG_INITIAL
          Request parameter value for the action: initial call.
static java.lang.String DIALOG_LOCKS_CONFIRMED
          Request parameter value for the action: dialog locks confirmed.
static java.lang.String DIALOG_OK
          Request parameter value for the action: ok.
static java.lang.String DIALOG_SET
          Request parameter value for the action: set.
static java.lang.String DIALOG_WAIT
          Request parameter value for the action: show please wait screen.
static java.lang.String PARAM_ACTION
          Request parameter name for the action.
static java.lang.String PARAM_CLOSELINK
          Request parameter name for the closelink.
static java.lang.String PARAM_DIALOGTYPE
          Request parameter name for the dialog type.
static java.lang.String PARAM_ERRORSTACK
          Request parameter name for the error stack.
static java.lang.String PARAM_FILE
          Request parameter name for the file.
static java.lang.String PARAM_FRAMENAME
          Request parameter name for the frame name.
static java.lang.String PARAM_ISPOPUP
          Request parameter name for the "is popup" flag.
static java.lang.String PARAM_LOCK
          Request parameter name for the lock.
static java.lang.String PARAM_MESSAGE
          Request parameter name for the error message.
static java.lang.String PARAM_ORIGINALPARAMS
          Request parameter name for the originalparams.
static java.lang.String PARAM_PREACTIONDONE
          Request parameter name for the preactiondone.
static java.lang.String PARAM_REDIRECT
          Request parameter name for the redirect flag.
static java.lang.String PARAM_RESOURCE
          Request parameter name for the resource.
static java.lang.String PARAM_TARGET
          Request parameter name for the target.
static java.lang.String PARAM_THREAD
          Request parameter name for the thread id.
static java.lang.String PARAM_THREAD_HASNEXT
          Request parameter name for indicating if another thread is following the current one.
static java.lang.String PARAM_TITLE
          Request parameter name for the dialog title.
static java.lang.String REPORT_BEGIN
          Request parameter value for the action: begin the report.
static java.lang.String REPORT_END
          Request parameter value for the action: end the report.
static java.lang.String REPORT_UPDATE
          Request parameter value for the action: update the report.
 
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
CmsDialog(CmsJspActionElement jsp)
          Public constructor with JSP action element.
CmsDialog(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
          Public constructor with JSP variables.
 
Method Summary
 void actionCloseDialog()
          Used to close the current JSP dialog.
protected  java.lang.String appendDelimiter(java.lang.String attribute)
          Appends a space char. between tag attributes.
 java.lang.String buildAjaxResultContainer(java.lang.String title)
          Returns the html code to build the ajax report container.
protected  java.lang.String buildAjaxWaitMessage()
          Returns ajax wait message.
 java.lang.String buildLockAdditionalOptions()
          Override to display additional options in the lock dialog.
 java.lang.String buildLockConfirmationMessageJS()
          Returns the html code to build the confirmation messages.
 java.lang.String buildLockDialog()
          Returns the html code to build the lock dialog.
 java.lang.String buildLockDialog(CmsLockFilter nonBlockingFilter, CmsLockFilter blockingFilter, int hiddenTimeout, boolean includeRelated)
          Returns the html code to build the lock dialog.
 java.lang.String buildLockHeaderBox()
          Returns the html code to build the header box.
protected  boolean checkResourcePermissions(CmsPermissionSet required, boolean neededForFolder)
          Checks if the permissions of the current user on the resource to use in the dialog are sufficient.
protected  boolean checkResourcePermissions(CmsPermissionSet required, boolean neededForFolder, CmsMessageContainer errorMessage)
          Checks if the permissions of the current user on the resource to use in the dialog are sufficient.
protected  java.lang.String computeCurrentFolder()
          Returns the full path of the current workplace folder.
 java.lang.String dialog(int segment, java.lang.String attributes)
          Builds the outer dialog window border.
 java.lang.String dialogBlock(int segment, java.lang.String headline, boolean error)
          Builds a block with 3D border and optional subheadline in the dialog content area.
 java.lang.String dialogBlockEnd()
          Builds the end HTML for a block with 3D border in the dialog content area.
 java.lang.String dialogBlockStart(java.lang.String headline)
          Builds the start HTML for a block with 3D border and optional subheadline in the dialog content area.
 java.lang.String dialogButtonRow(int segment)
          Builds the button row under the dialog content area without the buttons.
 java.lang.String dialogButtonRowEnd()
          Builds the end of the button row under the dialog content area without the buttons.
 java.lang.String dialogButtonRowStart()
          Builds the start of the button row under the dialog content area without the buttons.
 java.lang.String dialogButtons(int[] buttons, java.lang.String[] attributes)
          Builds the html for the button row under the dialog content area, including buttons.
 java.lang.String dialogButtonsClose()
          Builds a button row with a single "close" button.
 java.lang.String dialogButtonsClose(java.lang.String closeAttribute)
          Builds a button row with a single "close" button.
 java.lang.String dialogButtonsCloseDetails(java.lang.String closeAttribute, java.lang.String detailsAttribute)
          Builds a button row with a "close" and a "details" 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.
 java.lang.String dialogButtonsOk()
          Builds a button row with a single "ok" button.
 java.lang.String dialogButtonsOk(java.lang.String okAttribute)
          Builds a button row with a single "ok" button.
 java.lang.String dialogButtonsOkCancel()
          Builds a button row with an "ok" and a "cancel" button.
 java.lang.String dialogButtonsOkCancel(java.lang.String okAttributes, java.lang.String cancelAttributes)
          Builds a button row with an "ok" and a "cancel" button.
 java.lang.String dialogButtonsOkCancelAdvanced(java.lang.String okAttributes, java.lang.String cancelAttributes, java.lang.String advancedAttributes)
          Builds a button row with an "ok", a "cancel" and an "advanced" button.
 java.lang.String dialogButtonsSetOkCancel(java.lang.String setAttributes, java.lang.String okAttributes, java.lang.String cancelAttributes)
          Builds a button row with a "set", an "ok", and a "cancel" button.
 java.lang.String dialogContent(int segment, java.lang.String title)
          Builds the content area of the dialog window.
 java.lang.String dialogContentEnd()
          Returns the end html for the content area of the dialog window.
 java.lang.String dialogContentStart(java.lang.String title)
          Returns the start html for the content area of the dialog window.
 java.lang.String dialogEnd()
          Returns the end html for the outer dialog window border.
 java.lang.String dialogHead(java.lang.String title)
          Builds the title of the dialog window.
 java.lang.String dialogHorizontalSpacer(int width)
          Builds an invisible horizontal spacer with the specified width.
 java.lang.String dialogLockButtons()
          Builds the necessary button row.
 java.lang.String dialogRow(int segment)
          Builds a dialog line without break (display: block).
 java.lang.String dialogRowEnd()
          Builds the end of a dialog line without break (display: block).
 java.lang.String dialogRowStart()
          Builds the start of a dialog line without break (display: block).
 java.lang.String dialogScriptSubmit()
          Builds the standard javascript for submitting the dialog.
 java.lang.String dialogSeparator()
          Builds a horizontal separator line in the dialog content area.
 java.lang.String dialogSpacer()
          Builds a space between two elements in the dialog content area.
 java.lang.String dialogStart()
          Returns the start html for the outer dialog window border.
 java.lang.String dialogStart(java.lang.String attributes)
          Returns the start html for the outer dialog window border.
 java.lang.String dialogSubheadline(java.lang.String headline)
          Builds a subheadline in the dialog content area.
 java.lang.String dialogToggleStart(java.lang.String headline, java.lang.String id, boolean show)
          Builds the HTML code to fold and unfold a white-box.
 java.lang.String dialogWhiteBox(int segment)
          Builds a white box in the dialog content area.
 java.lang.String dialogWhiteBoxEnd()
          Builds the end of a white box in the dialog content area.
 java.lang.String dialogWhiteBoxStart()
          Builds the start of a white box in the dialog content area.
 int getAction()
          Returns the action value.
protected  java.lang.String getAdministrationBackLink()
          Returns the link URL to get back one folder in the administration view.
 java.lang.String getCancelAction()
          Returns the action to be carried out after a click on the cancel button..
 java.lang.String getDialogRealUri()
          Returns the http URI of the current dialog, to be used as value for the "action" attribute of a html form.
 java.lang.String getDialogUri()
          Returns the http URI of the current dialog, to be used as value for the "action" attribute of a html form.
 java.lang.String getOnlineHelpUriCustom()
          Returns the custom mapping for the online help.
 java.lang.String getParamAction()
          Returns the value of the action parameter, or null if this parameter was not provided.
 java.lang.String getParamCloseLink()
          Returns the value of the close link parameter, or null if this parameter was not provided.
 java.lang.String getParamDialogtype()
          Returns the value of the dialog type parameter, or null if this parameter was not provided.
 java.lang.String getParamFramename()
          Returns the value of the frame name parameter.
 java.lang.String getParamIsPopup()
          Returns the is popup parameter.
 java.lang.String getParamMessage()
          Returns the value of the message parameter, or null if this parameter was not provided.
 java.lang.String getParamOriginalParams()
          Returns the value of the original parameters parameter.
 java.lang.String getParamPreActionDone()
          Returns the value of the preaction done parameter.
 java.lang.String getParamRedirect()
          Returns the value of the redirect flag parameter.
 java.lang.String getParamResource()
          Returns the value of the file parameter, or null if this parameter was not provided.
 java.lang.String getParamTitle()
          Returns the value of the title parameter, or null if this parameter was not provided.
 java.lang.String getState()
          Gets a formatted file state string.
 boolean hasCorrectLockstate()
          Checks if the current resource has lock state exclusive or inherited.
 boolean hasSiblings()
          Checks if this resource has siblings.
 java.lang.String htmlStart()
          Builds the start html of the page, including setting of DOCTYPE and inserting a header with the content-type.
 java.lang.String htmlStart(java.lang.String helpUrl)
          Builds the start html of the page, including setting of DOCTYPE and inserting a header with the content-type.
 java.lang.String htmlStart(java.lang.String helpUrl, java.lang.String title)
          Builds the start html of the page, including setting of DOCTYPE and inserting a header with the content-type.
 java.lang.String htmlStartStyle(java.lang.String title, java.lang.String stylesheet)
          Builds the start html of the page, including setting of DOCTYPE, inserting a header with the content-type and choosing an individual style sheet.
 void includeErrorpage(CmsWorkplace wp, java.lang.Throwable t)
          Displays the throwable on the error page and logs the error.
static CmsDialog initCmsDialog(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
          Returns an initialized CmsDialog instance that is read from the request attributes.
protected  void initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
          Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
 boolean isPopup()
          Returns the "isPopup" flag.
 boolean isPreEditor()
          Returns if the dialog is called in direct edit mode before the editor is opened.
 java.lang.String pageHtml(int segment, java.lang.String helpUrl)
          Builds the start html of the page, including setting of DOCTYPE and inserting a header with the content-type.
 java.lang.String pageHtml(int segment, java.lang.String helpUrl, java.lang.String title)
          Builds the start html of the page, including setting of DOCTYPE and inserting a header with the content-type.
protected  void setAction(int value)
          Sets the action value.
 void setOnlineHelpUriCustom(java.lang.String uri)
          Set the custom mapping for the online help.
 void setParamAction(java.lang.String value)
          Sets the value of the action parameter.
 void setParamCloseLink(java.lang.String value)
          Sets the value of the close link parameter.
 void setParamDialogtype(java.lang.String value)
          Sets the value of the dialog type parameter.
 void setParamFramename(java.lang.String value)
          Sets the value of the frame name parameter.
 void setParamIsPopup(java.lang.String value)
          Sets the is popup parameter.
 void setParamMessage(java.lang.String value)
          Sets the value of the message parameter.
 void setParamOriginalParams(java.lang.String paramOriginalParams)
          Sets the value of the original parameters parameter.
 void setParamPreActionDone(java.lang.String paramPreActionDone)
          Sets the value of the preaction done parameter.
 void setParamRedirect(java.lang.String redirect)
          Sets the value of the redirect flag parameter.
 void setParamResource(java.lang.String value)
          Sets the value of the file parameter.
 void setParamTitle(java.lang.String value)
          Sets the value of the title parameter.
 
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

ACTION_CANCEL

public static final int ACTION_CANCEL
Value for the action: cancel.

See Also:
Constant Field Values

ACTION_CLOSEPOPUP

public static final int ACTION_CLOSEPOPUP
Value for the action: close popup window.

See Also:
Constant Field Values

ACTION_CLOSEPOPUP_SAVE

public static final int ACTION_CLOSEPOPUP_SAVE
Value for the action: save & close popup window.

See Also:
Constant Field Values

ACTION_CONFIRMED

public static final int ACTION_CONFIRMED
Value for the action: confirmed.

See Also:
Constant Field Values

ACTION_CONTINUE

public static final int ACTION_CONTINUE
Value for the action: continue.

See Also:
Constant Field Values

ACTION_DEFAULT

public static final int ACTION_DEFAULT
Value for the action: default (show initial dialog form).

See Also:
Constant Field Values

ACTION_LOCKS_CONFIRMED

public static final int ACTION_LOCKS_CONFIRMED
Value for the action: locks confirmed.

See Also:
Constant Field Values

ACTION_OK

public static final int ACTION_OK
Value for the action: ok.

See Also:
Constant Field Values

ACTION_REPORT_BEGIN

public static final int ACTION_REPORT_BEGIN
Value for the action: begin the report.

See Also:
Constant Field Values

ACTION_REPORT_END

public static final int ACTION_REPORT_END
Value for the action: end the report.

See Also:
Constant Field Values

ACTION_REPORT_UPDATE

public static final int ACTION_REPORT_UPDATE
Value for the action: update the report.

See Also:
Constant Field Values

ACTION_SET

public static final int ACTION_SET
Value for the action: button "set" clicked.

See Also:
Constant Field Values

ACTION_WAIT

public static final int ACTION_WAIT
Value for the action: wait (show please wait screen).

See Also:
Constant Field Values

BUTTON_ADVANCED

public static final int BUTTON_ADVANCED
Constant for the "Advanced" button in the build button methods.

See Also:
Constant Field Values

BUTTON_BACK

public static final int BUTTON_BACK
Constant for the "Back" button in the build button methods.

See Also:
Constant Field Values

BUTTON_CANCEL

public static final int BUTTON_CANCEL
Constant for the "Cancel" button in the build button methods.

See Also:
Constant Field Values

BUTTON_CLOSE

public static final int BUTTON_CLOSE
Constant for the "Close" button in the build button methods.

See Also:
Constant Field Values

BUTTON_CONTINUE

public static final int BUTTON_CONTINUE
Constant for the "Continue" button in the build button methods.

See Also:
Constant Field Values

BUTTON_DETAILS

public static final int BUTTON_DETAILS
Constant for the "Details" button in the build button methods.

See Also:
Constant Field Values

BUTTON_DISCARD

public static final int BUTTON_DISCARD
Constant for the "Discard" button in the build button methods (same function as "Cancel" button but different text on button.

See Also:
Constant Field Values

BUTTON_EDIT

public static final int BUTTON_EDIT
Constant for the "Edit" button in the build button methods (same function as "Ok" button but different text on button.

See Also:
Constant Field Values

BUTTON_OK

public static final int BUTTON_OK
Constant for the "OK" button in the build button methods.

See Also:
Constant Field Values

BUTTON_OK_NO_SUBMIT

public static final int BUTTON_OK_NO_SUBMIT
Constant for the "OK" button in the build button methods (without form submission).

See Also:
Constant Field Values

BUTTON_SET

public static final int BUTTON_SET
Constant for the "Set" button in the build button methods.

See Also:
Constant Field Values

DIALOG_BACK

public static final java.lang.String DIALOG_BACK
Request parameter value for the action: back.

See Also:
Constant Field Values

DIALOG_CANCEL

public static final java.lang.String DIALOG_CANCEL
Request parameter value for the action: cancel.

See Also:
Constant Field Values

DIALOG_CONFIRMED

public static final java.lang.String DIALOG_CONFIRMED
Request parameter value for the action: dialog confirmed.

See Also:
Constant Field Values

DIALOG_CONTINUE

public static final java.lang.String DIALOG_CONTINUE
Request parameter value for the action: continue.

See Also:
Constant Field Values

DIALOG_INITIAL

public static final java.lang.String DIALOG_INITIAL
Request parameter value for the action: initial call.

See Also:
Constant Field Values

DIALOG_LOCKS_CONFIRMED

public static final java.lang.String DIALOG_LOCKS_CONFIRMED
Request parameter value for the action: dialog locks confirmed.

See Also:
Constant Field Values

DIALOG_OK

public static final java.lang.String DIALOG_OK
Request parameter value for the action: ok.

See Also:
Constant Field Values

DIALOG_SET

public static final java.lang.String DIALOG_SET
Request parameter value for the action: set.

See Also:
Constant Field Values

DIALOG_WAIT

public static final java.lang.String DIALOG_WAIT
Request parameter value for the action: show please wait screen.

See Also:
Constant Field Values

PARAM_ACTION

public static final java.lang.String PARAM_ACTION
Request parameter name for the action.

See Also:
Constant Field Values

PARAM_CLOSELINK

public static final java.lang.String PARAM_CLOSELINK
Request parameter name for the closelink.

See Also:
Constant Field Values

PARAM_DIALOGTYPE

public static final java.lang.String PARAM_DIALOGTYPE
Request parameter name for the dialog type.

See Also:
Constant Field Values

PARAM_ERRORSTACK

public static final java.lang.String PARAM_ERRORSTACK
Request parameter name for the error stack.

See Also:
Constant Field Values

PARAM_FILE

public static final java.lang.String PARAM_FILE
Request parameter name for the file.

See Also:
Constant Field Values

PARAM_FRAMENAME

public static final java.lang.String PARAM_FRAMENAME
Request parameter name for the frame name.

See Also:
Constant Field Values

PARAM_ISPOPUP

public static final java.lang.String PARAM_ISPOPUP
Request parameter name for the "is popup" flag.

See Also:
Constant Field Values

PARAM_LOCK

public static final java.lang.String PARAM_LOCK
Request parameter name for the lock.

See Also:
Constant Field Values

PARAM_MESSAGE

public static final java.lang.String PARAM_MESSAGE
Request parameter name for the error message.

See Also:
Constant Field Values

PARAM_ORIGINALPARAMS

public static final java.lang.String PARAM_ORIGINALPARAMS
Request parameter name for the originalparams.

See Also:
Constant Field Values

PARAM_PREACTIONDONE

public static final java.lang.String PARAM_PREACTIONDONE
Request parameter name for the preactiondone.

See Also:
Constant Field Values

PARAM_REDIRECT

public static final java.lang.String PARAM_REDIRECT
Request parameter name for the redirect flag.

See Also:
Constant Field Values

PARAM_RESOURCE

public static final java.lang.String PARAM_RESOURCE
Request parameter name for the resource.

See Also:
Constant Field Values

PARAM_TARGET

public static final java.lang.String PARAM_TARGET
Request parameter name for the target.

See Also:
Constant Field Values

PARAM_THREAD

public static final java.lang.String PARAM_THREAD
Request parameter name for the thread id.

See Also:
Constant Field Values

PARAM_THREAD_HASNEXT

public static final java.lang.String PARAM_THREAD_HASNEXT
Request parameter name for indicating if another thread is following the current one.

See Also:
Constant Field Values

PARAM_TITLE

public static final java.lang.String PARAM_TITLE
Request parameter name for the dialog title.

See Also:
Constant Field Values

REPORT_BEGIN

public static final java.lang.String REPORT_BEGIN
Request parameter value for the action: begin the report.

See Also:
Constant Field Values

REPORT_END

public static final java.lang.String REPORT_END
Request parameter value for the action: end the report.

See Also:
Constant Field Values

REPORT_UPDATE

public static final java.lang.String REPORT_UPDATE
Request parameter value for the action: update the report.

See Also:
Constant Field Values

ATTRIBUTE_THROWABLE

protected static final java.lang.String ATTRIBUTE_THROWABLE
Key name for the throwable attribute.

See Also:
Constant Field Values
Constructor Detail

CmsDialog

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

Parameters:
jsp - an initialized JSP action element

CmsDialog

public CmsDialog(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

initCmsDialog

public static CmsDialog initCmsDialog(javax.servlet.jsp.PageContext context,
                                      javax.servlet.http.HttpServletRequest req,
                                      javax.servlet.http.HttpServletResponse res)
Returns an initialized CmsDialog instance that is read from the request attributes.

This method is used by dialog elements. The dialog elements do not initialize their own workplace class, but use the initialized instance of the "master" class. This is required to ensure that parameters of the "master" class can properly be kept on the dialog elements.

To prevent null pointer exceptions, an empty dialog is returned if nothing is found in the request attributes.

Parameters:
context - the JSP page context
req - the JSP request
res - the JSP response
Returns:
an initialized CmsDialog instance that is read from the request attributes

actionCloseDialog

public void actionCloseDialog()
                       throws javax.servlet.jsp.JspException
Used to close the current JSP dialog.

This method tries to include the URI stored in the workplace settings. This URI is determined by the frame name, which has to be set in the frame name parameter.

Throws:
javax.servlet.jsp.JspException - if including an element fails

buildAjaxResultContainer

public java.lang.String buildAjaxResultContainer(java.lang.String title)
Returns the html code to build the ajax report container.

Parameters:
title - the title of the report box
Returns:
html code

buildLockAdditionalOptions

public java.lang.String buildLockAdditionalOptions()
Override to display additional options in the lock dialog.

Returns:
html code to display additional options

buildLockConfirmationMessageJS

public java.lang.String buildLockConfirmationMessageJS()
Returns the html code to build the confirmation messages.

Returns:
html code

buildLockDialog

public java.lang.String buildLockDialog()
                                 throws CmsException
Returns the html code to build the lock dialog.

Returns:
html code
Throws:
CmsException - if something goes wrong

buildLockDialog

public java.lang.String buildLockDialog(CmsLockFilter nonBlockingFilter,
                                        CmsLockFilter blockingFilter,
                                        int hiddenTimeout,
                                        boolean includeRelated)
                                 throws CmsException
Returns the html code to build the lock dialog.

Parameters:
nonBlockingFilter - the filter to get all non blocking locks
blockingFilter - the filter to get all blocking locks
hiddenTimeout - the maximal number of milliseconds the dialog will be hidden
includeRelated - indicates if the report should include related resources
Returns:
html code
Throws:
CmsException - if something goes wrong

buildLockHeaderBox

public java.lang.String buildLockHeaderBox()
                                    throws CmsException
Returns the html code to build the header box.

Returns:
html code
Throws:
CmsException - if something goes wrong

dialog

public java.lang.String dialog(int segment,
                               java.lang.String attributes)
Builds the outer dialog window border.

Parameters:
segment - the HTML segment (START / END)
attributes - optional additional attributes for the opening dialog table
Returns:
a dialog window start / end segment

dialogBlock

public java.lang.String dialogBlock(int segment,
                                    java.lang.String headline,
                                    boolean error)
Builds a block with 3D border and optional subheadline in the dialog content area.

Parameters:
segment - the HTML segment (START / END)
headline - the headline String for the block
error - if true, an error block will be created
Returns:
3D block start / end segment

dialogBlockEnd

public java.lang.String dialogBlockEnd()
Builds the end HTML for a block with 3D border in the dialog content area.

Returns:
3D block start / end segment

dialogBlockStart

public java.lang.String dialogBlockStart(java.lang.String headline)
Builds the start HTML for a block with 3D border and optional subheadline in the dialog content area.

Parameters:
headline - the headline String for the block
Returns:
3D block start / end segment

dialogButtonRow

public java.lang.String dialogButtonRow(int segment)
Builds the button row under the dialog content area without the buttons.

Parameters:
segment - the HTML segment (START / END)
Returns:
the button row start / end segment

dialogButtonRowEnd

public java.lang.String dialogButtonRowEnd()
Builds the end of the button row under the dialog content area without the buttons.

Returns:
the button row end segment

dialogButtonRowStart

public java.lang.String dialogButtonRowStart()
Builds the start of the button row under the dialog content area without the buttons.

Returns:
the button row start segment

dialogButtons

public java.lang.String dialogButtons(int[] buttons,
                                      java.lang.String[] attributes)
Builds the html for the button row under the dialog content area, including buttons.

Parameters:
buttons - array of constants of which buttons to include in the row
attributes - array of Strings for additional button attributes
Returns:
the html for the button row under the dialog content area, including buttons

dialogButtonsClose

public java.lang.String dialogButtonsClose()
Builds a button row with a single "close" button.

Returns:
the button row

dialogButtonsClose

public java.lang.String dialogButtonsClose(java.lang.String closeAttribute)
Builds a button row with a single "close" button.

Parameters:
closeAttribute - additional attributes for the "close" button
Returns:
the button row

dialogButtonsCloseDetails

public java.lang.String dialogButtonsCloseDetails(java.lang.String closeAttribute,
                                                  java.lang.String detailsAttribute)
Builds a button row with a "close" and a "details" button.

Parameters:
closeAttribute - additional attributes for the "close" button
detailsAttribute - additional attributes for the "details" button
Returns:
the button row

dialogButtonsOk

public java.lang.String dialogButtonsOk()
Builds a button row with a single "ok" button.

Returns:
the button row

dialogButtonsOk

public java.lang.String dialogButtonsOk(java.lang.String okAttribute)
Builds a button row with a single "ok" button.

Parameters:
okAttribute - additional attributes for the "ok" button
Returns:
the button row

dialogButtonsOkCancel

public java.lang.String dialogButtonsOkCancel()
Builds a button row with an "ok" and a "cancel" button.

Returns:
the button row

dialogButtonsOkCancel

public java.lang.String dialogButtonsOkCancel(java.lang.String okAttributes,
                                              java.lang.String cancelAttributes)
Builds a button row with an "ok" and a "cancel" button.

Parameters:
okAttributes - additional attributes for the "ok" button
cancelAttributes - additional attributes for the "cancel" button
Returns:
the button row

dialogButtonsOkCancelAdvanced

public java.lang.String dialogButtonsOkCancelAdvanced(java.lang.String okAttributes,
                                                      java.lang.String cancelAttributes,
                                                      java.lang.String advancedAttributes)
Builds a button row with an "ok", a "cancel" and an "advanced" button.

Parameters:
okAttributes - additional attributes for the "ok" button
cancelAttributes - additional attributes for the "cancel" button
advancedAttributes - additional attributes for the "advanced" button
Returns:
the button row

dialogButtonsSetOkCancel

public java.lang.String dialogButtonsSetOkCancel(java.lang.String setAttributes,
                                                 java.lang.String okAttributes,
                                                 java.lang.String cancelAttributes)
Builds a button row with a "set", an "ok", and a "cancel" button.

Parameters:
setAttributes - additional attributes for the "set" button
okAttributes - additional attributes for the "ok" button
cancelAttributes - additional attributes for the "cancel" button
Returns:
the button row

dialogContent

public java.lang.String dialogContent(int segment,
                                      java.lang.String title)
Builds the content area of the dialog window.

Parameters:
segment - the HTML segment (START / END)
title - the title String for the dialog window
Returns:
a content area start / end segment

dialogContentEnd

public java.lang.String dialogContentEnd()
Returns the end html for the content area of the dialog window.

Returns:
the end html for the content area of the dialog window

dialogContentStart

public java.lang.String dialogContentStart(java.lang.String title)
Returns the start html for the content area of the dialog window.

Parameters:
title - the title for the dialog
Returns:
the start html for the content area of the dialog window

dialogEnd

public java.lang.String dialogEnd()
Returns the end html for the outer dialog window border.

Returns:
the end html for the outer dialog window border

dialogHead

public java.lang.String dialogHead(java.lang.String title)
Builds the title of the dialog window.

Parameters:
title - the title String for the dialog window
Returns:
the HTML title String for the dialog window

dialogHorizontalSpacer

public java.lang.String dialogHorizontalSpacer(int width)
Builds an invisible horizontal spacer with the specified width.

Parameters:
width - the width of the spacer in pixels
Returns:
an invisible horizontal spacer with the specified width

dialogLockButtons

public java.lang.String dialogLockButtons()
Builds the necessary button row.

Returns:
the button row

dialogRow

public java.lang.String dialogRow(int segment)
Builds a dialog line without break (display: block).

Parameters:
segment - the HTML segment (START / END)
Returns:
a row start / end segment

dialogRowEnd

public java.lang.String dialogRowEnd()
Builds the end of a dialog line without break (display: block).

Returns:
the row end segment

dialogRowStart

public java.lang.String dialogRowStart()
Builds the start of a dialog line without break (display: block).

Returns:
the row start segment

dialogScriptSubmit

public java.lang.String dialogScriptSubmit()
Builds the standard javascript for submitting the dialog.

Overrides:
dialogScriptSubmit in class CmsToolDialog
Returns:
the standard javascript for submitting the dialog

dialogSeparator

public java.lang.String dialogSeparator()
Builds a horizontal separator line in the dialog content area.

Returns:
a separator element

dialogSpacer

public java.lang.String dialogSpacer()
Builds a space between two elements in the dialog content area.

Returns:
a space element

dialogStart

public java.lang.String dialogStart()
Returns the start html for the outer dialog window border.

Returns:
the start html for the outer dialog window border

dialogStart

public java.lang.String dialogStart(java.lang.String attributes)
Returns the start html for the outer dialog window border.

Parameters:
attributes - optional html attributes to insert
Returns:
the start html for the outer dialog window border

dialogSubheadline

public java.lang.String dialogSubheadline(java.lang.String headline)
Builds a subheadline in the dialog content area.

Parameters:
headline - the desired headline string
Returns:
a subheadline element

dialogToggleStart

public java.lang.String dialogToggleStart(java.lang.String headline,
                                          java.lang.String id,
                                          boolean show)
Builds the HTML code to fold and unfold a white-box.

Parameters:
headline - the heading to display
id - the id of the toggle
show - true if the white box is open at the beginning
Returns:
HTML code to fold and unfold a white-box

dialogWhiteBox

public java.lang.String dialogWhiteBox(int segment)
Builds a white box in the dialog content area.

Parameters:
segment - the HTML segment (START / END)
Returns:
the white box start / end segment

dialogWhiteBoxEnd

public java.lang.String dialogWhiteBoxEnd()
Builds the end of a white box in the dialog content area.

Returns:
the white box end segment

dialogWhiteBoxStart

public java.lang.String dialogWhiteBoxStart()
Builds the start of a white box in the dialog content area.

Returns:
the white box start segment

getAction

public int getAction()
Returns the action value.

The action value is used on JSP pages to select the proper action in a large "switch" statement.

Returns:
the action value

getCancelAction

public java.lang.String getCancelAction()
Returns the action to be carried out after a click on the cancel button..

Returns:
the action to be carried out after a click on the cancel button.

getDialogRealUri

public java.lang.String getDialogRealUri()
Returns the http URI of the current dialog, to be used as value for the "action" attribute of a html form.

This URI is the real one.

Returns:
the http URI of the current dialog

getDialogUri

public java.lang.String getDialogUri()
Returns the http URI of the current dialog, to be used as value for the "action" attribute of a html form.

This URI could not be really the real one...

Returns:
the http URI of the current dialog

getOnlineHelpUriCustom

public java.lang.String getOnlineHelpUriCustom()
Returns the custom mapping for the online help.

Returns:
the custom mapping for the online help

getParamAction

public java.lang.String getParamAction()
Returns the value of the action parameter, or null if this parameter was not provided.

The action parameter is very important, it will select the dialog action to perform. The value of the getAction() method will be initialized from the action parameter.

Returns:
the value of the action parameter

getParamCloseLink

public java.lang.String getParamCloseLink()
Returns the value of the close link parameter, or null if this parameter was not provided.

Returns:
the value of the close link parameter

getParamDialogtype

public java.lang.String getParamDialogtype()
Returns the value of the dialog type parameter, or null if this parameter was not provided.

This parameter is very important. It must match to the localization keys, e.g. "copy" for the copy dialog.

This parameter must be set manually by the subclass during first initialization.

Returns:
the value of the dialog type parameter

getParamFramename

public java.lang.String getParamFramename()
Returns the value of the frame name parameter.

Returns:
the value of the frame name parameter

getParamIsPopup

public java.lang.String getParamIsPopup()
Returns the is popup parameter.

Use this parameter to indicate that the dialog is shown in a popup window.

Returns:
the is popup parameter

getParamMessage

public java.lang.String getParamMessage()
Returns the value of the message parameter, or null if this parameter was not provided.

The message parameter is used on dialogs to show any text message.

Returns:
the value of the message parameter

getParamOriginalParams

public java.lang.String getParamOriginalParams()
Returns the value of the original parameters parameter.

This stores the request parameter values from a previous dialog, if necessary.

Returns:
the value of the original parameters parameter

getParamPreActionDone

public java.lang.String getParamPreActionDone()
Returns the value of the preaction done parameter.

Returns:
the value of the preaction done parameter

getParamRedirect

public java.lang.String getParamRedirect()
Returns the value of the redirect flag parameter.

Returns:
the value of the redirect flag parameter

getParamResource

public java.lang.String getParamResource()
Returns the value of the file parameter, or null if this parameter was not provided.

The file parameter selects the file on which the dialog action is to be performed.

Returns:
the value of the file parameter

getParamTitle

public java.lang.String getParamTitle()
Returns the value of the title parameter, or null if this parameter was not provided.

This parameter is used to build the title of the dialog. It is a parameter so that the title can be passed to included elements.

Returns:
the value of the title parameter

getState

public java.lang.String getState()
                          throws CmsException
Gets a formatted file state string.

Returns:
formatted state string
Throws:
CmsException - if something goes wrong

hasCorrectLockstate

public boolean hasCorrectLockstate()
Checks if the current resource has lock state exclusive or inherited.

This is used to determine whether the dialog shows the option to delete all siblings of the resource or not.

Returns:
true if lock state is exclusive or inherited, otherwise false

hasSiblings

public boolean hasSiblings()
Checks if this resource has siblings.

Returns:
true if this resource has siblings

htmlStart

public java.lang.String htmlStart()
Builds the start html of the page, including setting of DOCTYPE and inserting a header with the content-type.

Returns:
the start html of the page

htmlStart

public java.lang.String htmlStart(java.lang.String helpUrl)
Builds the start html of the page, including setting of DOCTYPE and inserting a header with the content-type.

This overloads the default method of the parent class.

Overrides:
htmlStart in class CmsWorkplace
Parameters:
helpUrl - the key for the online help to include on the page
Returns:
the start html of the page

htmlStart

public java.lang.String htmlStart(java.lang.String helpUrl,
                                  java.lang.String title)
Builds the start html of the page, including setting of DOCTYPE and inserting a header with the content-type.

Parameters:
helpUrl - the key for the online help to include on the page
title - the title for the page
Returns:
the start html of the page

htmlStartStyle

public java.lang.String htmlStartStyle(java.lang.String title,
                                       java.lang.String stylesheet)
Builds the start html of the page, including setting of DOCTYPE, inserting a header with the content-type and choosing an individual style sheet.

Parameters:
title - the title for the page
stylesheet - the style sheet to include
Returns:
the start html of the page

includeErrorpage

public void includeErrorpage(CmsWorkplace wp,
                             java.lang.Throwable t)
                      throws javax.servlet.jsp.JspException
Displays the throwable on the error page and logs the error.

Parameters:
wp - the workplace class
t - the throwable to be displayed on the error page
Throws:
javax.servlet.jsp.JspException - if the include of the error page jsp fails

isPopup

public boolean isPopup()
Returns the "isPopup" flag.

Returns:
the "isPopup" flag

isPreEditor

public boolean isPreEditor()
Returns if the dialog is called in direct edit mode before the editor is opened.

Returns:
true if the dialog is called in direct edit mode before the editor is opened

pageHtml

public java.lang.String pageHtml(int segment,
                                 java.lang.String helpUrl)
Builds the start html of the page, including setting of DOCTYPE and inserting a header with the content-type.

This overloads the default method of the parent class.

Overrides:
pageHtml in class CmsWorkplace
Parameters:
segment - the HTML segment (START / END)
helpUrl - the url for the online help to include on the page
Returns:
the start html of the page

pageHtml

public java.lang.String pageHtml(int segment,
                                 java.lang.String helpUrl,
                                 java.lang.String title)
Builds the start html of the page, including setting of DOCTYPE and inserting a header with the content-type.

This overloads the default method of the parent class.

Parameters:
segment - the HTML segment (START / END)
helpUrl - the url for the online help to include on the page
title - the title for the page
Returns:
the start html of the page

setOnlineHelpUriCustom

public void setOnlineHelpUriCustom(java.lang.String uri)
Set the custom mapping for the online help.

This value will be set to a javascript variable called onlineHelpUriCustom. If it is set, the top.head javascript for the online help will use this value.

This method should be called from initWorkplaceRequestValues(CmsWorkplaceSettings, HttpServletRequest), CmsWorkplace.initWorkplaceMembers(CmsJspActionElement) or from the jsp if the dialog class is used for several actions. It should be used whenever the online help mapping does not work (due to jsp - forwards).

Parameters:
uri - the left hand value in mapping.properties for the online help pages

setParamAction

public void setParamAction(java.lang.String value)
Sets the value of the action parameter.

Parameters:
value - the value to set

setParamCloseLink

public void setParamCloseLink(java.lang.String value)
Sets the value of the close link parameter.

Parameters:
value - the value to set

setParamDialogtype

public void setParamDialogtype(java.lang.String value)
Sets the value of the dialog type parameter.

Parameters:
value - the value to set

setParamFramename

public void setParamFramename(java.lang.String value)
Sets the value of the frame name parameter.

Parameters:
value - the value to set

setParamIsPopup

public void setParamIsPopup(java.lang.String value)
Sets the is popup parameter.

Parameters:
value - the is popup parameter value

setParamMessage

public void setParamMessage(java.lang.String value)
Sets the value of the message parameter.

Parameters:
value - the value to set

setParamOriginalParams

public void setParamOriginalParams(java.lang.String paramOriginalParams)
Sets the value of the original parameters parameter.

Parameters:
paramOriginalParams - the value of the original parameters parameter

setParamPreActionDone

public void setParamPreActionDone(java.lang.String paramPreActionDone)
Sets the value of the preaction done parameter.

Parameters:
paramPreActionDone - the value of the preaction done parameter

setParamRedirect

public void setParamRedirect(java.lang.String redirect)
Sets the value of the redirect flag parameter.

Parameters:
redirect - the value of the redirect flag parameter

setParamResource

public void setParamResource(java.lang.String value)
Sets the value of the file parameter.

Parameters:
value - the value to set

setParamTitle

public void setParamTitle(java.lang.String value)
Sets the value of the title parameter.

Parameters:
value - the value to set

appendDelimiter

protected java.lang.String appendDelimiter(java.lang.String attribute)
Appends a space char. between tag attributes.

Parameters:
attribute - a tag attribute
Returns:
the tag attribute with a leading space char

buildAjaxWaitMessage

protected java.lang.String buildAjaxWaitMessage()
Returns ajax wait message.

Returns:
html code

checkResourcePermissions

protected boolean checkResourcePermissions(CmsPermissionSet required,
                                           boolean neededForFolder)
Checks if the permissions of the current user on the resource to use in the dialog are sufficient.

Automatically generates a CmsMessageContainer object with an error message and stores it in the users session.

Parameters:
required - the required permissions for the dialog
neededForFolder - if true, the permissions are required for the parent folder of the resource (e.g. for editors)
Returns:
true if the permissions are sufficient, otherwise false

checkResourcePermissions

protected boolean checkResourcePermissions(CmsPermissionSet required,
                                           boolean neededForFolder,
                                           CmsMessageContainer errorMessage)
Checks if the permissions of the current user on the resource to use in the dialog are sufficient.

Automatically generates a CmsMessageContainer object with an error message and stores it in the users session.

Parameters:
required - the required permissions for the dialog
neededForFolder - if true, the permissions are required for the parent folder of the resource (e.g. for editors)
errorMessage - the message container that is stored in the session in case the permissions are not sufficient
Returns:
true if the permissions are sufficient, otherwise false

computeCurrentFolder

protected java.lang.String computeCurrentFolder()
Returns the full path of the current workplace folder.

Returns:
the full path of the current workplace folder

dialogButtonsHtml

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.

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

getAdministrationBackLink

protected java.lang.String getAdministrationBackLink()
Returns the link URL to get back one folder in the administration view.

Returns:
the link URL to get back one folder in the administration view

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

setAction

protected void setAction(int value)
Sets the action value.

Parameters:
value - the action value