Java Doc for CmsDialog.java in  » Content-Management-System » opencms » org » opencms » workplace » Java Source Code / Java DocumentationJava Source Code and Java Documentation

author:
   Andreas Zahner
version:
   $Revision: 1.101 $
since:
   6.0.0

This method tries to include the URI stored in the workplace settings.

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

Parameters:
  required - the required permissions for the dialog
Parameters:
  neededForFolder - if true, the permissions are required for the parent folder of the resource (e.g.

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

Parameters:
  required - the required permissions for the dialog
Parameters:
  neededForFolder - if true, the permissions are required for the parent folder of the resource (e.g.

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

The action parameter is very important, it will select the dialog action to perform.

This parameter is very important.

This parameter is used to build the title of the dialog.

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

This method is used by dialog elements.

Parameters:
  jsp - an initialized JSP action element

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

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 framename parameter.

throws:
  JspException - if including an element fails

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

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

html code

html code to display additional options

html code

html code
throws:
  CmsException - if something goes wrong

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

html code
throws:
  CmsException - if something goes wrong

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

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

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

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

the full path of the current workplace folder

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

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

3D block start / end segment

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

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

the button row end segment

the button row start segment

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

the button row

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

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

Parameters:
  result - a string buffer where the rendered HTML gets appended to
Parameters:
  button - a integer key to identify the button
Parameters:
  attribute - an optional string with possible tag attributes, or null

the button row

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

the button row

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

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

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

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

the end html for the content area of the dialog window

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

the end html for the outer dialog window border

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

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

the button row

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

the row end segment

the row start segment

the standard javascript for submitting the dialog

a separator element

a space element

the start html for the outer dialog window border

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

Parameters:
  headline - the desired headline string a subheadline element

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

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

the white box end segment

the white box start segment

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

the action value

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

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

This URI is the real one.

the http URI of the current dialog

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

the http URI of the current dialog

the custom mapping for the online help

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

the value of the action parameter

the value of the closelink parameter

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.

the value of the dialogtype parameter

the value of the errorstack parameter

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

the ispopup parameter

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

the value of the message parameter

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

the value of the originalparams parameter

the value of the preactiondone parameter

the value of the redirect flag parameter

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

the value of the file parameter

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.

the value of the title parameter

formatted state string
throws:
  CmsException - if something goes wrong

This is used to determine whether the dialog shows the option to delete all siblings of the resource or not. true if lock state is exclusive or inherited, otherwise false

true if this resource has siblings

the start html of the page

This overloads the default method of the parent class.

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

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

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

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

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
Parameters:
  req - the JSP request
Parameters:
  res - the JSP response an initialized CmsDialog instance that is read from the request attributes

the "isPopup" flag

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

This overloads the default method of the parent class.

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

This overloads the default method of the parent class.

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

Parameters:
  value - the action value

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 CmsDialog.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

Parameters:
  value - the value to set

Parameters:
  value - the value to set

Parameters:
  value - the value to set

Parameters:
  value - the value to set

Parameters:
  value - the ispopup parameter value

Parameters:
  value - the value to set

Parameters:
  paramOriginalParams - the value of the originalparams parameter

Parameters:
  paramPreActionDone - the value of the preactiondone parameter

Parameters:
  redirect - the value of the redirect flag parameter

Parameters:
  value - the value to set

Parameters:
  value - the value to set