org.opencms.workplace.list
Class CmsMultiListDialog

java.lang.Object
  extended by org.opencms.workplace.list.CmsMultiListDialog

public class CmsMultiListDialog
extends java.lang.Object

Helper class for managing three lists on the same dialog.

Since:
6.0.0
Version:
$Revision: 1.3 $
Author:
Jan Baudisch

Constructor Summary
CmsMultiListDialog(java.util.List wps)
          Default constructor.
 
Method Summary
protected  java.lang.String defaultActionHtml()
          Generates the dialog starting html code.
protected  java.lang.String defaultActionHtmlContent()
          Returns the html code for the default action content.
protected  java.lang.String defaultActionHtmlEnd()
          Generates the dialog ending html code.
protected  java.lang.String defaultActionHtmlStart()
          Generates the dialog starting html code.
 void displayDialog()
          Display method for two list dialogs.
 void displayDialog(boolean writeLater)
          Display method for two list dialogs, executes actions, but only displays if needed.
 A_CmsListDialog getActiveWp()
          Returns the activeWp.
 boolean isForwarded()
          Returns true if one of the lists has been forwarded.
 void writeDialog()
          Writes the dialog html code, only if the CmsDialog.ACTION_DEFAULT is set.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CmsMultiListDialog

public CmsMultiListDialog(java.util.List wps)
Default constructor.

Parameters:
wps - the lists to be displayed
Method Detail

displayDialog

public void displayDialog()
                   throws javax.servlet.jsp.JspException,
                          java.io.IOException,
                          javax.servlet.ServletException
Display method for two list dialogs.

Throws:
javax.servlet.jsp.JspException - if dialog actions fail
java.io.IOException - if writing to the JSP out fails, or in case of errros forwarding to the required result page
javax.servlet.ServletException - in case of errros forwarding to the required result page

displayDialog

public void displayDialog(boolean writeLater)
                   throws javax.servlet.jsp.JspException,
                          java.io.IOException,
                          javax.servlet.ServletException
Display method for two list dialogs, executes actions, but only displays if needed.

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

getActiveWp

public A_CmsListDialog getActiveWp()
Returns the activeWp.

Returns:
the activeWp

isForwarded

public boolean isForwarded()
Returns true if one of the lists has been forwarded.

Returns:
true if one of the lists has been forwarded

writeDialog

public void writeDialog()
                 throws java.io.IOException
Writes the dialog html code, only if the CmsDialog.ACTION_DEFAULT is set.

Throws:
java.io.IOException - if writing to the JSP out fails, or in case of errros forwarding to the required result page

defaultActionHtml

protected java.lang.String defaultActionHtml()
Generates the dialog starting html code.

Returns:
html code

defaultActionHtmlContent

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

Returns:
html code

defaultActionHtmlEnd

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

Returns:
html code

defaultActionHtmlStart

protected java.lang.String defaultActionHtmlStart()
Generates the dialog starting html code.

Returns:
html code