Package org.opencms.workplace.list
Class CmsTwoListsDialog
- java.lang.Object
-
- org.opencms.workplace.list.CmsTwoListsDialog
-
- Direct Known Subclasses:
CmsTwoListsDialogsWOStart
,CmsTwoOrgUnitUsersList
public class CmsTwoListsDialog extends java.lang.Object
Helper class for managing two lists on the same dialog.- Since:
- 6.0.0
-
-
Constructor Summary
Constructors Constructor Description CmsTwoListsDialog(A_CmsListDialog wp1, A_CmsListDialog wp2)
Default constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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 workplace instance of the active list.A_CmsListDialog
getFirstWp()
Returns the workplace instance of the first list.A_CmsListDialog
getPassiveWp()
Returns the workplace instance of the passive list.A_CmsListDialog
getSecondWp()
Returns the workplace instance of the second list.void
writeDialog()
Writes the dialog html code, only if the
is set.CmsDialog.ACTION_DEFAULT
-
-
-
Constructor Detail
-
CmsTwoListsDialog
public CmsTwoListsDialog(A_CmsListDialog wp1, A_CmsListDialog wp2)
Default constructor.- Parameters:
wp1
- the workplace instance for the first listwp2
- the workplace instance for the second list
-
-
Method Detail
-
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
-
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 failjava.io.IOException
- if writing to the JSP out fails, or in case of errors forwarding to the required result pagejavax.servlet.ServletException
- in case of errors forwarding to the required result page
-
writeDialog
public void writeDialog() throws java.io.IOException
Writes the dialog html code, only if the
is set.CmsDialog.ACTION_DEFAULT
- Throws:
java.io.IOException
- if writing to the JSP out fails, or in case of errors 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
- iftrue
no output is written, you have to call manually the
method.defaultActionHtml()
- Throws:
javax.servlet.jsp.JspException
- if dialog actions failjava.io.IOException
- if writing to the JSP out fails, or in case of errors forwarding to the required result pagejavax.servlet.ServletException
- in case of errors forwarding to the required result page
-
getActiveWp
public A_CmsListDialog getActiveWp()
Returns the workplace instance of the active list.- Returns:
- the workplace instance of the active list
-
getFirstWp
public A_CmsListDialog getFirstWp()
Returns the workplace instance of the first list.- Returns:
- the workplace instance of the first list
-
getPassiveWp
public A_CmsListDialog getPassiveWp()
Returns the workplace instance of the passive list.- Returns:
- the workplace instance of the passive list
-
getSecondWp
public A_CmsListDialog getSecondWp()
Returns the workplace instance of the second list.- Returns:
- the workplace instance of the second list
-
-