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

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Content Management System » opencms » org.opencms.workplace 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.opencms.workplace.CmsDialog
   org.opencms.workplace.CmsWidgetDialog

All known Subclasses:   org.opencms.workplace.tools.history.CmsHistorySettingsDialog,  org.opencms.workplace.tools.publishqueue.CmsPublishQueueHistoricalReportDialog,  org.opencms.workplace.tools.workplace.broadcast.A_CmsMessageDialog,  org.opencms.workplace.tools.modules.CmsModulesUploadFromServer,  org.opencms.workplace.tools.accounts.CmsGroupOverviewDialog,  org.opencms.workplace.tools.database.CmsRemovePubLocksDialog,  org.opencms.workplace.tools.database.CmsDatabaseImportFromServer,  org.opencms.workplace.tools.content.check.CmsContentCheckDialog,  org.opencms.workplace.tools.history.CmsHistoryClearDialog,  com.alkacon.opencms.counter.CmsCounterDialog,  org.opencms.workplace.tools.searchindex.A_CmsEditSearchIndexDialog,  org.opencms.workplace.tools.workplace.broadcast.CmsSendEmailGroupsDialog,  org.opencms.workplace.tools.workplace.broadcast.CmsSendPopupGroupsDialog,  org.opencms.workplace.tools.modules.CmsDependenciesEdit,  org.opencms.workplace.tools.modules.CmsExportpointsOverview,  org.opencms.workplace.tools.workplace.CmsEditLoginMessageDialog,  org.opencms.workplace.tools.accounts.A_CmsUserDataImexportDialog,  org.opencms.workplace.commons.CmsResourceInfoDialog,  org.opencms.workplace.demos.list.CmsGroupDemo,  org.opencms.workplace.tools.searchindex.A_CmsMappingDialog,  org.opencms.workplace.tools.content.CmsElementChangeLocaleDialog,  org.opencms.workplace.tools.accounts.CmsRoleOverviewDialog,  org.opencms.workplace.tools.modules.CmsModulesOverview,  org.opencms.workplace.tools.content.CmsTagReplaceDialog,  org.opencms.workplace.tools.content.CmsXmlContentRepairDialog,  org.opencms.workplace.tools.scheduler.CmsEditScheduledJobInfoDialog,  org.opencms.workplace.tools.accounts.CmsUserOverviewDialog,  org.opencms.workplace.tools.accounts.CmsEditUserAddInfoDialog,  org.opencms.workplace.tools.modules.CmsExportpointsEdit,  org.opencms.workplace.tools.modules.CmsDependenciesOverview,  org.opencms.workplace.search.CmsSearchDialog,  org.opencms.workplace.tools.searchindex.A_CmsFieldConfigurationDialog,  org.opencms.workplace.tools.link.CmsInternalLinkValidationDialog,  org.opencms.workplace.tools.accounts.A_CmsEditGroupDialog,  org.opencms.workplace.demos.widget.CmsAdminWidgetDemo3,  org.opencms.workplace.demos.widget.CmsAdminWidgetDemo8,  org.opencms.workplace.tools.projects.CmsEditProjectDialog,  org.opencms.workplace.tools.workplace.broadcast.CmsSelectReceiverDialog,  com.alkacon.opencms.newsletter.admin.CmsSubscriberImportDialog,  org.opencms.workplace.demos.widget.CmsAdminWidgetDemo6,  org.opencms.workplace.tools.searchindex.A_CmsEditIndexSourceDialog,  org.opencms.workplace.demos.widget.CmsAdminWidgetDemo1,  org.opencms.workplace.demos.widget.CmsAdminWidgetDemo5,  org.opencms.workplace.tools.accounts.A_CmsEditUserDialog,  org.opencms.workplace.demos.widget.CmsAdminWidgetDemo9,  org.opencms.workplace.tools.workplace.CmsSynchronizeSettingsDialog,  org.opencms.workplace.tools.searchindex.A_CmsFieldDialog,  org.opencms.workplace.tools.accounts.CmsUserRoleDialog,  org.opencms.workplace.tools.modules.CmsModulesEditBase,  org.opencms.workplace.tools.database.CmsHtmlImportDialog,  org.opencms.workplace.demos.widget.CmsAdminWidgetDemo4,  org.opencms.workplace.tools.database.CmsDatabaseExportDialog,  org.opencms.workplace.tools.workplace.rfsfile.A_CmsRfsFileWidgetDialog,  org.opencms.workplace.demos.widget.CmsAdminWidgetDemo7,  org.opencms.workplace.tools.accounts.A_CmsOrgUnitDialog,
CmsWidgetDialog
abstract public class CmsWidgetDialog extends CmsDialog implements I_CmsWidgetDialog(Code)
Base class for dialogs that use the OpenCms widgets without XML content.


author:
   Alexander Kandzior
version:
   $Revision: 1.67 $
since:
   6.0.0



Field Summary
final public static  intACTION_ELEMENT_ADD
     Action for optional element creation.
final public static  intACTION_ELEMENT_REMOVE
     Action for optional element removal.
final public static  intACTION_ERROR
     Value for the action: error in the form validation.
final public static  intACTION_SAVE
     Value for the action: save the dialog.
final public static  StringDIALOG_SAVE
     Request parameter value for the action: save the dialog.
final public static  StringEDITOR_ACTION_ELEMENT_ADD
     Indicates an optional element should be created.
final public static  StringEDITOR_ACTION_ELEMENT_REMOVE
     Indicates an optional element should be removed.
final public static  StringHIDDEN_PARAM_PREFIX
     Prefix for "hidden" parameters, required since these must be unescaped later.
protected  Listm_commitErrors
     The errors thrown by commit actions.
protected  Objectm_dialogObject
     The object edited with this widget dialog.
protected  Listm_pages
     The allowed pages for this dialog in a List.
protected  Stringm_paramPage
     Controls which page is currently displayed in the dialog.
protected  Listm_validationErrorList
     The validation errors for the input form.
protected  Mapm_widgetParamValues
     Contains all parameter value of this dialog.
protected  Listm_widgets
     The list of widgets used on the dialog.

Constructor Summary
public  CmsWidgetDialog(CmsJspActionElement jsp)
    
public  CmsWidgetDialog(PageContext context, HttpServletRequest req, HttpServletResponse res)
    

Method Summary
public  voidactionCancel()
    
abstract public  voidactionCommit()
    
public  voidactionToggleElement()
    
protected  voidaddCommitError(Exception error)
    
protected  voidaddWidget(CmsWidgetDialogParameter param)
    
public  StringbuildAddElement(String elementName, int insertAfter, boolean enabled)
    
public  StringbuildDialogForm()
    
public  StringbuildRemoveElement(String elementName, int index, boolean enabled)
    
public  voidclearDialogObject()
    
protected  booleancloseDialogOnCommit()
    
protected  ListcommitWidgetValues()
    
protected  ListcommitWidgetValues(String dialogPage)
    
protected  StringcreateDialogHtml()
    
protected  StringcreateDialogHtml(String dialog)
    
protected  StringcreateDialogRowHtml(CmsWidgetDialogParameter base)
    
protected  StringcreateDialogRowsHtml(int startIndex, int endIndex)
    
protected  StringcreateWidgetBlockEnd()
    
protected  StringcreateWidgetBlockStart(String headline)
    
protected  StringcreateWidgetErrorHeader()
    
protected  StringcreateWidgetTableEnd()
    
protected  StringcreateWidgetTableStart()
    
protected  StringdefaultActionHtml()
    
protected  StringdefaultActionHtmlContent()
    
protected  StringdefaultActionHtmlEnd()
    
protected  StringdefaultActionHtmlStart()
    
abstract protected  voiddefineWidgets()
    
public  StringdialogBlockEnd()
    
public  StringdialogBlockStart(String headline)
    
public  StringdialogButtonsCustom()
    
public  voiddisplayDialog()
    
public  voiddisplayDialog(boolean writeLater)
    
protected  voidfillWidgetValues(HttpServletRequest request)
    
public  intgetButtonStyle()
    
public  ListgetCommitErrors()
    
public  ObjectgetDialogObject()
    
protected  StringgetDialogTitle()
     Returns the title for this Dialog.

In the default implementation this method returns null.

public  SetgetHelpMessageIds()
    
abstract protected  String[]getPageArray()
    
protected  ListgetPages()
    
public  StringgetParamElementIndex()
    
public  StringgetParamElementName()
    
public  StringgetParamPage()
    
public  StringgetParamValue(String name)
    
public  StringgetParamValue(String name, int index)
    
protected  CmsWidgetDialogParametergetParameterDefinition(String name)
    
protected  MapgetParameters()
    
public  StringgetUserAgent()
    
protected  ListgetValidationErrorList()
    
protected  StringgetWidget(CmsWidgetDialogParameter param)
    
public  StringgetWidgetHtmlEnd()
    
public  StringgetWidgetIncludes()
    
public  StringgetWidgetInitCalls()
    
public  StringgetWidgetInitMethods()
    
protected  ListgetWidgets()
    
protected  booleanhasCommitErrors()
    
protected  booleanhasValidationErrors()
    
protected  voidinitWorkplaceRequestValues(CmsWorkplaceSettings settings, HttpServletRequest request)
    
public  StringparamsAsHidden()
    
protected  voidsetCommitErrors(List errors)
    
public  voidsetDialogObject(Object dialogObject)
    
protected  voidsetKeyPrefix(String prefix)
    
protected  voidsetPages(List pages)
    
public  voidsetParamElementIndex(String elementIndex)
    
public  voidsetParamElementName(String elementName)
    
public  voidsetParamPage(String paramPage)
    
protected  voidsetValidationErrorList(List errors)
    
protected  voidvalidateParamaters()
    
public  StringwidgetParamsAsHidden()
    
public  StringwidgetParamsAsHidden(String excludeDialogPage)
     Returns the values of all widget parameters of this dialog as HTML hidden fields, excluding the widget values that are on the given dialog page.

This can be used to create multi-page dialogs where the values are passed from one page to another before everything is submitted.

public  voidwriteDialog()
    

Field Detail
ACTION_ELEMENT_ADD
final public static int ACTION_ELEMENT_ADD(Code)
Action for optional element creation.



ACTION_ELEMENT_REMOVE
final public static int ACTION_ELEMENT_REMOVE(Code)
Action for optional element removal.



ACTION_ERROR
final public static int ACTION_ERROR(Code)
Value for the action: error in the form validation.



ACTION_SAVE
final public static int ACTION_SAVE(Code)
Value for the action: save the dialog.



DIALOG_SAVE
final public static String DIALOG_SAVE(Code)
Request parameter value for the action: save the dialog.



EDITOR_ACTION_ELEMENT_ADD
final public static String EDITOR_ACTION_ELEMENT_ADD(Code)
Indicates an optional element should be created.



EDITOR_ACTION_ELEMENT_REMOVE
final public static String EDITOR_ACTION_ELEMENT_REMOVE(Code)
Indicates an optional element should be removed.



HIDDEN_PARAM_PREFIX
final public static String HIDDEN_PARAM_PREFIX(Code)
Prefix for "hidden" parameters, required since these must be unescaped later.



m_commitErrors
protected List m_commitErrors(Code)
The errors thrown by commit actions.



m_dialogObject
protected Object m_dialogObject(Code)
The object edited with this widget dialog.



m_pages
protected List m_pages(Code)
The allowed pages for this dialog in a List.



m_paramPage
protected String m_paramPage(Code)
Controls which page is currently displayed in the dialog.



m_validationErrorList
protected List m_validationErrorList(Code)
The validation errors for the input form.



m_widgetParamValues
protected Map m_widgetParamValues(Code)
Contains all parameter value of this dialog.



m_widgets
protected List m_widgets(Code)
The list of widgets used on the dialog.




Constructor Detail
CmsWidgetDialog
public CmsWidgetDialog(CmsJspActionElement jsp)(Code)
Public constructor with JSP action element.


Parameters:
  jsp - an initialized JSP action element




CmsWidgetDialog
public CmsWidgetDialog(PageContext context, HttpServletRequest req, HttpServletResponse res)(Code)
Public constructor with JSP variables.


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





Method Detail
actionCancel
public void actionCancel()(Code)
Deletes the edited dialog object from the session.




actionCommit
abstract public void actionCommit() throws IOException, ServletException(Code)
Commits the edited object after pressing the "OK" button.


throws:
  IOException - in case of errors forwarding to the required result page
throws:
  ServletException - in case of errors forwarding to the required result page




actionToggleElement
public void actionToggleElement()(Code)
Adds or removes an optional element.

Depends on the value stored in the CmsDialog.getAction method.




addCommitError
protected void addCommitError(Exception error)(Code)
Adds the given error to the list of errors that are thrown by save actions or form generation.

If the error list has not been initialized yet, this is done automatically.


Parameters:
  error - the errors to add




addWidget
protected void addWidget(CmsWidgetDialogParameter param)(Code)
Adds a new widget parameter definition to the list of all widgets of this dialog.


Parameters:
  param - the widget parameter definition to add




buildAddElement
public String buildAddElement(String elementName, int insertAfter, boolean enabled)(Code)
Returns the html for a button to add an optional element.


Parameters:
  elementName - name of the element
Parameters:
  insertAfter - the index of the element after which the new element should be created
Parameters:
  enabled - if true, the button to add an element is shown, otherwise a spacer is returned the html for a button to add an optional element




buildDialogForm
public String buildDialogForm()(Code)
Builds the HTML for the dialog form.

the HTML for the dialog form




buildRemoveElement
public String buildRemoveElement(String elementName, int index, boolean enabled)(Code)
Returns the html for a button to remove an optional element.


Parameters:
  elementName - name of the element
Parameters:
  index - the element index of the element to remove
Parameters:
  enabled - if true, the button to remove an element is shown, otherwise a spacer is returned the html for a button to remove an optional element




clearDialogObject
public void clearDialogObject()(Code)
Clears the "dialog object" for this widget dialog by removing it from the current users session.




closeDialogOnCommit
protected boolean closeDialogOnCommit()(Code)
Returns true if the dialog should be closed after the values have been committed.

The default implementation returns true in case there are no commit errors.

true if the dialog should be closed after the values have been committed




commitWidgetValues
protected List commitWidgetValues()(Code)
Commits all values on the dialog.

a List of all Exceptions that occured when comitting the dialog.




commitWidgetValues
protected List commitWidgetValues(String dialogPage)(Code)
Commits all values on the given dialog page.


Parameters:
  dialogPage - the dialog (page) to commit a List of all Exceptions that occurred when committing the dialog page.




createDialogHtml
protected String createDialogHtml()(Code)
Creates the dialog HTML for all defined widgets of this dialog.

the dialog HTML for all defined widgets of this dialog




createDialogHtml
protected String createDialogHtml(String dialog)(Code)
Creates the dialog HTML for all defined widgets of the named dialog (page).

To get a more complex layout variation, you have to overwrite this method in your dialog class.


Parameters:
  dialog - the dialog (page) to get the HTML for the dialog HTML for all defined widgets of the named dialog (page)




createDialogRowHtml
protected String createDialogRowHtml(CmsWidgetDialogParameter base)(Code)
Creates the dialog HTML for all occurrences of one widget parameter.


Parameters:
  base - the widget parameter base the dialog HTML for one widget parameter




createDialogRowsHtml
protected String createDialogRowsHtml(int startIndex, int endIndex)(Code)
Creates the dialog widget rows HTML for the specified widget indices.


Parameters:
  startIndex - the widget index to start with
Parameters:
  endIndex - the widget index to stop at the dialog widget rows HTML for the specified widget indices




createWidgetBlockEnd
protected String createWidgetBlockEnd()(Code)
Creates the complete widget dialog end block HTML that finishes a widget block.

the complete widget dialog end block HTML that finishes a widget block




createWidgetBlockStart
protected String createWidgetBlockStart(String headline)(Code)
Create the complete widget dialog start block HTML that begins a widget block with optional headline.


Parameters:
  headline - the headline String for the block the complete widget dialog start block HTML that begins a widget block with optional headline




createWidgetErrorHeader
protected String createWidgetErrorHeader()(Code)
Creates the HTML for the error message if validation errors were found.

the HTML for the error message if validation errors were found




createWidgetTableEnd
protected String createWidgetTableEnd()(Code)
Creates the HTML for the table around the dialog widgets.

the HTML for the table around the dialog widgets




createWidgetTableStart
protected String createWidgetTableStart()(Code)
Creates the HTML to close the table around the dialog widgets.

the HTML to close the table around the dialog widgets




defaultActionHtml
protected String defaultActionHtml() throws JspException(Code)
Generates the dialog starting html code.

html code
throws:
  JspException - if something goes wrong




defaultActionHtmlContent
protected String defaultActionHtmlContent()(Code)
Returns the html code for the default action content.

html code




defaultActionHtmlEnd
protected String defaultActionHtmlEnd()(Code)
Generates the dialog ending html code.

html code




defaultActionHtmlStart
protected String defaultActionHtmlStart() throws JspException(Code)
Generates the dialog starting html code.

html code
throws:
  JspException - if something goes wrong




defineWidgets
abstract protected void defineWidgets()(Code)
Defines the list of parameters for this dialog.




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

3D block start / end segment




dialogBlockStart
public String dialogBlockStart(String headline)(Code)
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 3D block start / end segment




dialogButtonsCustom
public String dialogButtonsCustom()(Code)
Creates the HTML for the buttons on the dialog.

the HTML for the buttons on the dialog.




displayDialog
public void displayDialog() throws JspException, IOException, ServletException(Code)
Performs the dialog actions depending on the initialized action and displays the dialog form.


throws:
  JspException - if dialog actions fail
throws:
  IOException - if writing to the JSP out fails, or in case of errors forwarding to the required result page
throws:
  ServletException - in case of errors forwarding to the required result page




displayDialog
public void displayDialog(boolean writeLater) throws JspException, IOException, ServletException(Code)
Performs the dialog actions depending on the initialized action and displays the dialog form if needed.


Parameters:
  writeLater - if true no output is written, you have to call manually the CmsWidgetDialog.defaultActionHtml() method.
throws:
  JspException - if dialog actions fail
throws:
  IOException - if writing to the JSP out fails, or in case of errors forwarding to the required result page
throws:
  ServletException - in case of errors forwarding to the required result page




fillWidgetValues
protected void fillWidgetValues(HttpServletRequest request)(Code)
Fills all widgets of this widget dialog with the values from the request parameters.


Parameters:
  request - the current HTTP servlet request




getButtonStyle
public int getButtonStyle()(Code)

See Also:   org.opencms.widgets.I_CmsWidgetDialog.getButtonStyle



getCommitErrors
public List getCommitErrors()(Code)
Returns the errors that are thrown by save actions or form generation.

the errors that are thrown by save actions or form generation




getDialogObject
public Object getDialogObject()(Code)
Returns the dialog object for this widget dialog, or null if no dialog object has been set.

the dialog object for this widget dialog, or null




getDialogTitle
protected String getDialogTitle()(Code)
Returns the title for this Dialog.

In the default implementation this method returns null. Override this if needed.

the title for this Dialog, or null if this dialog has no title




getHelpMessageIds
public Set getHelpMessageIds()(Code)

See Also:   org.opencms.widgets.I_CmsWidgetDialog.getHelpMessageIds



getPageArray
abstract protected String[] getPageArray()(Code)
Returns the allowed pages for this dialog.

the allowed pages for this dialog




getPages
protected List getPages()(Code)
Returns the allowed pages for this dialog.

the allowed pages for this dialog




getParamElementIndex
public String getParamElementIndex()(Code)
Returns the index of the element to add or remove.

the index of the element to add or remove




getParamElementName
public String getParamElementName()(Code)
Returns the name of the element to add or remove.

the name of the element to add or remove




getParamPage
public String getParamPage()(Code)
Returns the page parameter.

the page parameter




getParamValue
public String getParamValue(String name)(Code)
Returns the value of the widget parameter with the given name, or null if no such widget parameter is available.


Parameters:
  name - the widget parameter name to get the value for the value of the widget parameter with the given name




getParamValue
public String getParamValue(String name, int index)(Code)
Returns the value of the widget parameter with the given name and index, or null if no such widget parameter is available.


Parameters:
  name - the widget parameter name to get the value for
Parameters:
  index - the widget parameter index the value of the widget parameter with the given name and index




getParameterDefinition
protected CmsWidgetDialogParameter getParameterDefinition(String name)(Code)
Returns the parameter widget definition for the given parameter name.


Parameters:
  name - the parameter name to get the definition for the parameter widget definition for the given parameter name




getParameters
protected Map getParameters()(Code)
Returns the map with the widget parameter values.

the map with the widget parameter values




getUserAgent
public String getUserAgent()(Code)

See Also:   org.opencms.widgets.I_CmsWidgetDialog.getUserAgent



getValidationErrorList
protected List getValidationErrorList()(Code)
Returns the validation errors for the dialog.

The method (@link CmsWidgetDialog#commitWidgetValues(String)) has to set this list.

the validation errors for the dialog




getWidget
protected String getWidget(CmsWidgetDialogParameter param)(Code)
Returns the widget HTML code for the given parameter.


Parameters:
  param - the name (id) of the parameter to get the widget HTML for the widget HTML code for the given parameter




getWidgetHtmlEnd
public String getWidgetHtmlEnd()(Code)
Generates the HTML for the end of the widget dialog.

This HTML includes additional components, for example the <div> tags containing the help texts.

the HTML for the end of the widget dialog




getWidgetIncludes
public String getWidgetIncludes() throws JspException(Code)
Generates the HTML include tags for external JavaScripts files of the used widgets.

the HTML include tags for external JavaScripts files of the used widgets
throws:
  JspException - if an error occurs during JavaScript generation




getWidgetInitCalls
public String getWidgetInitCalls() throws JspException(Code)
Generates the JavaScript init calls for the used widgets.

the JavaScript init calls for the used widgets
throws:
  JspException - the JavaScript init calls for the used widgets




getWidgetInitMethods
public String getWidgetInitMethods() throws JspException(Code)
Generates the JavaScript initialization methods for the used widgets.

the JavaScript initialization methods for the used widgets
throws:
  JspException - if an error occurs during JavaScript generation




getWidgets
protected List getWidgets()(Code)
Returns the list of all widgets used on this widget dialog, the List must contain Objects of type CmsWidgetDialogParameter .

the list of all widgets used on this widget dialog




hasCommitErrors
protected boolean hasCommitErrors()(Code)
Returns true if the current dialog (page) has commit errors.

true if the current dialog (page) has commit errors




hasValidationErrors
protected boolean hasValidationErrors()(Code)
Returns true if the current dialog (page) has validation errors.

true if the current dialog (page) has validation errors




initWorkplaceRequestValues
protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings, HttpServletRequest request)(Code)

See Also:   org.opencms.workplace.CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettingsjavax.servlet.http.HttpServletRequest)



paramsAsHidden
public String paramsAsHidden()(Code)

See Also:   org.opencms.workplace.CmsWorkplace.paramsAsHidden



setCommitErrors
protected void setCommitErrors(List errors)(Code)
Sets the errors that are thrown by save actions or form generation.


Parameters:
  errors - the errors that are thrown by save actions or form generation




setDialogObject
public void setDialogObject(Object dialogObject)(Code)
Stores the given object as "dialog object" for this widget dialog in the current users session.


Parameters:
  dialogObject - the object to store




setKeyPrefix
protected void setKeyPrefix(String prefix)(Code)
Sets an optional localized key prefix identificator for all widgets.


Parameters:
  prefix - the optional localized key prefix identificator for all widgets
See Also:   org.opencms.widgets.I_CmsWidgetParameter.setKeyPrefix(java.lang.String)




setPages
protected void setPages(List pages)(Code)
Sets the allowed pages for this dialog.


Parameters:
  pages - the allowed pages for this dialog




setParamElementIndex
public void setParamElementIndex(String elementIndex)(Code)
Sets the index of the element to add or remove.


Parameters:
  elementIndex - the index of the element to add or remove




setParamElementName
public void setParamElementName(String elementName)(Code)
Sets the name of the element to add or remove.


Parameters:
  elementName - the name of the element to add or remove




setParamPage
public void setParamPage(String paramPage)(Code)
Sets the page parameter.


Parameters:
  paramPage - the page parameter to set




setValidationErrorList
protected void setValidationErrorList(List errors)(Code)
Sets the validation errors for the dialog.

Use this in the method (@link CmsWidgetDialog#commitWidgetValues(String)) to set the list.


Parameters:
  errors - the validation errors




validateParamaters
protected void validateParamaters() throws Exception(Code)
Should be overridden for parameter validation.

The exception is never seen by the user, so it can be just a new Exception ().


throws:
  Exception - if the parameters are not valid




widgetParamsAsHidden
public String widgetParamsAsHidden()(Code)
Returns the values of all widget parameters of this dialog as HTML hidden fields.

the values of all widget parameters of this dialog as HTML hidden fields
See Also:   org.opencms.workplace.CmsWorkplace.paramsAsHidden




widgetParamsAsHidden
public String widgetParamsAsHidden(String excludeDialogPage)(Code)
Returns the values of all widget parameters of this dialog as HTML hidden fields, excluding the widget values that are on the given dialog page.

This can be used to create multi-page dialogs where the values are passed from one page to another before everything is submitted. If a widget A is used on page X, there should be no "hidden" HTML field for A since otherwise A would have 2 values when submitting the dialog page: The one from the widget itself and the one from the hidden field. This may lead to undefined results when processing the submitted values.


Parameters:
  excludeDialogPage - the dialog page to exclude the values for the values of all widget parameters of this dialog as HTML hidden fields,excluding the widget values that are on the given dialog page
See Also:   org.opencms.workplace.CmsWorkplace.paramsAsHidden




writeDialog
public void writeDialog() throws IOException, JspException(Code)
Writes the dialog html code, only if the CmsWidgetDialog.ACTION_DEFAULT is set.


throws:
  JspException - if dialog actions fail
throws:
  IOException - if writing to the JSP out fails, or in case of errors forwarding to the required result page




Fields inherited from org.opencms.workplace.CmsDialog
final public static int ACTION_CANCEL(Code)(Java Doc)
final public static int ACTION_CLOSEPOPUP(Code)(Java Doc)
final public static int ACTION_CLOSEPOPUP_SAVE(Code)(Java Doc)
final public static int ACTION_CONFIRMED(Code)(Java Doc)
final public static int ACTION_CONTINUE(Code)(Java Doc)
final public static int ACTION_DEFAULT(Code)(Java Doc)
final public static int ACTION_LOCKS_CONFIRMED(Code)(Java Doc)
final public static int ACTION_OK(Code)(Java Doc)
final public static int ACTION_REPORT_BEGIN(Code)(Java Doc)
final public static int ACTION_REPORT_END(Code)(Java Doc)
final public static int ACTION_REPORT_UPDATE(Code)(Java Doc)
final public static int ACTION_SET(Code)(Java Doc)
final public static int ACTION_WAIT(Code)(Java Doc)
final protected static String ATTRIBUTE_THROWABLE(Code)(Java Doc)
final public static int BUTTON_ADVANCED(Code)(Java Doc)
final public static int BUTTON_BACK(Code)(Java Doc)
final public static int BUTTON_CANCEL(Code)(Java Doc)
final public static int BUTTON_CLOSE(Code)(Java Doc)
final public static int BUTTON_CONTINUE(Code)(Java Doc)
final public static int BUTTON_DETAILS(Code)(Java Doc)
final public static int BUTTON_DISCARD(Code)(Java Doc)
final public static int BUTTON_EDIT(Code)(Java Doc)
final public static int BUTTON_OK(Code)(Java Doc)
final public static int BUTTON_OK_NO_SUBMIT(Code)(Java Doc)
final public static int BUTTON_SET(Code)(Java Doc)
final public static String DIALOG_BACK(Code)(Java Doc)
final public static String DIALOG_CANCEL(Code)(Java Doc)
final public static String DIALOG_CONFIRMED(Code)(Java Doc)
final public static String DIALOG_CONTINUE(Code)(Java Doc)
final public static String DIALOG_INITIAL(Code)(Java Doc)
final public static String DIALOG_LOCKS_CONFIRMED(Code)(Java Doc)
final public static String DIALOG_OK(Code)(Java Doc)
final public static String DIALOG_SET(Code)(Java Doc)
final public static String DIALOG_WAIT(Code)(Java Doc)
final public static String PARAM_ACTION(Code)(Java Doc)
final public static String PARAM_CLOSELINK(Code)(Java Doc)
final public static String PARAM_DIALOGTYPE(Code)(Java Doc)
final public static String PARAM_ERRORSTACK(Code)(Java Doc)
final public static String PARAM_FILE(Code)(Java Doc)
final public static String PARAM_FRAMENAME(Code)(Java Doc)
final public static String PARAM_ISPOPUP(Code)(Java Doc)
final public static String PARAM_LOCK(Code)(Java Doc)
final public static String PARAM_MESSAGE(Code)(Java Doc)
final public static String PARAM_ORIGINALPARAMS(Code)(Java Doc)
final public static String PARAM_PREACTIONDONE(Code)(Java Doc)
final public static String PARAM_REDIRECT(Code)(Java Doc)
final public static String PARAM_RESOURCE(Code)(Java Doc)
final public static String PARAM_TARGET(Code)(Java Doc)
final public static String PARAM_THREAD(Code)(Java Doc)
final public static String PARAM_THREAD_HASNEXT(Code)(Java Doc)
final public static String PARAM_TITLE(Code)(Java Doc)
final public static String REPORT_BEGIN(Code)(Java Doc)
final public static String REPORT_END(Code)(Java Doc)
final public static String REPORT_UPDATE(Code)(Java Doc)

Methods inherited from org.opencms.workplace.CmsDialog
public void actionCloseDialog() throws JspException(Code)(Java Doc)
protected String appendDelimiter(String attribute)(Code)(Java Doc)
public String buildAjaxResultContainer(String title)(Code)(Java Doc)
protected String buildAjaxWaitMessage()(Code)(Java Doc)
public String buildLockAdditionalOptions()(Code)(Java Doc)
public String buildLockConfirmationMessageJS()(Code)(Java Doc)
public String buildLockDialog() throws CmsException(Code)(Java Doc)
public String buildLockDialog(CmsLockFilter nonBlockingFilter, CmsLockFilter blockingFilter, int hiddenTimeout, boolean includeRelated) throws CmsException(Code)(Java Doc)
public String buildLockHeaderBox() throws CmsException(Code)(Java Doc)
protected boolean checkResourcePermissions(CmsPermissionSet required, boolean neededForFolder)(Code)(Java Doc)
protected boolean checkResourcePermissions(CmsPermissionSet required, boolean neededForFolder, CmsMessageContainer errorMessage)(Code)(Java Doc)
protected String computeCurrentFolder()(Code)(Java Doc)
public String dialog(int segment, String attributes)(Code)(Java Doc)
public String dialogBlock(int segment, String headline, boolean error)(Code)(Java Doc)
public String dialogBlockEnd()(Code)(Java Doc)
public String dialogBlockStart(String headline)(Code)(Java Doc)
public String dialogButtonRow(int segment)(Code)(Java Doc)
public String dialogButtonRowEnd()(Code)(Java Doc)
public String dialogButtonRowStart()(Code)(Java Doc)
public String dialogButtons(int[] buttons, String[] attributes)(Code)(Java Doc)
public String dialogButtonsClose()(Code)(Java Doc)
public String dialogButtonsClose(String closeAttribute)(Code)(Java Doc)
public String dialogButtonsCloseDetails(String closeAttribute, String detailsAttribute)(Code)(Java Doc)
protected void dialogButtonsHtml(StringBuffer result, int button, String attribute)(Code)(Java Doc)
public String dialogButtonsOk()(Code)(Java Doc)
public String dialogButtonsOk(String okAttribute)(Code)(Java Doc)
public String dialogButtonsOkCancel()(Code)(Java Doc)
public String dialogButtonsOkCancel(String okAttributes, String cancelAttributes)(Code)(Java Doc)
public String dialogButtonsOkCancelAdvanced(String okAttributes, String cancelAttributes, String advancedAttributes)(Code)(Java Doc)
public String dialogButtonsSetOkCancel(String setAttributes, String okAttributes, String cancelAttributes)(Code)(Java Doc)
public String dialogContent(int segment, String title)(Code)(Java Doc)
public String dialogContentEnd()(Code)(Java Doc)
public String dialogContentStart(String title)(Code)(Java Doc)
public String dialogEnd()(Code)(Java Doc)
public String dialogHead(String title)(Code)(Java Doc)
public String dialogHorizontalSpacer(int width)(Code)(Java Doc)
public String dialogLockButtons()(Code)(Java Doc)
public String dialogRow(int segment)(Code)(Java Doc)
public String dialogRowEnd()(Code)(Java Doc)
public String dialogRowStart()(Code)(Java Doc)
public String dialogScriptSubmit()(Code)(Java Doc)
public String dialogSeparator()(Code)(Java Doc)
public String dialogSpacer()(Code)(Java Doc)
public String dialogStart()(Code)(Java Doc)
public String dialogStart(String attributes)(Code)(Java Doc)
public String dialogSubheadline(String headline)(Code)(Java Doc)
public String dialogToggleStart(String headline, String id, boolean show)(Code)(Java Doc)
public String dialogWhiteBox(int segment)(Code)(Java Doc)
public String dialogWhiteBoxEnd()(Code)(Java Doc)
public String dialogWhiteBoxStart()(Code)(Java Doc)
public int getAction()(Code)(Java Doc)
protected String getAdministrationBackLink()(Code)(Java Doc)
public String getCancelAction()(Code)(Java Doc)
public String getDialogRealUri()(Code)(Java Doc)
public String getDialogUri()(Code)(Java Doc)
public String getOnlineHelpUriCustom()(Code)(Java Doc)
public String getParamAction()(Code)(Java Doc)
public String getParamCloseLink()(Code)(Java Doc)
public String getParamDialogtype()(Code)(Java Doc)
public String getParamFramename()(Code)(Java Doc)
public String getParamIsPopup()(Code)(Java Doc)
public String getParamMessage()(Code)(Java Doc)
public String getParamOriginalParams()(Code)(Java Doc)
public String getParamPreActionDone()(Code)(Java Doc)
public String getParamRedirect()(Code)(Java Doc)
public String getParamResource()(Code)(Java Doc)
public String getParamTitle()(Code)(Java Doc)
public String getState() throws CmsException(Code)(Java Doc)
public boolean hasCorrectLockstate()(Code)(Java Doc)
public boolean hasSiblings()(Code)(Java Doc)
public String htmlStart()(Code)(Java Doc)
public String htmlStart(String helpUrl)(Code)(Java Doc)
public String htmlStart(String helpUrl, String title)(Code)(Java Doc)
public String htmlStartStyle(String title, String stylesheet)(Code)(Java Doc)
public void includeErrorpage(CmsWorkplace wp, Throwable t) throws JspException(Code)(Java Doc)
public static CmsDialog initCmsDialog(PageContext context, HttpServletRequest req, HttpServletResponse res)(Code)(Java Doc)
protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings, HttpServletRequest request)(Code)(Java Doc)
public boolean isPopup()(Code)(Java Doc)
public boolean isPreEditor()(Code)(Java Doc)
public String pageHtml(int segment, String helpUrl)(Code)(Java Doc)
public String pageHtml(int segment, String helpUrl, String title)(Code)(Java Doc)
protected void setAction(int value)(Code)(Java Doc)
public void setOnlineHelpUriCustom(String uri)(Code)(Java Doc)
public void setParamAction(String value)(Code)(Java Doc)
public void setParamCloseLink(String value)(Code)(Java Doc)
public void setParamDialogtype(String value)(Code)(Java Doc)
public void setParamFramename(String value)(Code)(Java Doc)
public void setParamIsPopup(String value)(Code)(Java Doc)
public void setParamMessage(String value)(Code)(Java Doc)
public void setParamOriginalParams(String paramOriginalParams)(Code)(Java Doc)
public void setParamPreActionDone(String paramPreActionDone)(Code)(Java Doc)
public void setParamRedirect(String redirect)(Code)(Java Doc)
public void setParamResource(String value)(Code)(Java Doc)
public void setParamTitle(String value)(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.