Package org.opencms.workplace.list

Class CmsTwoListsDialog

java.lang.Object
org.opencms.workplace.list.CmsTwoListsDialog
Direct Known Subclasses:
CmsTwoListsDialogsWOStart, CmsTwoOrgUnitUsersList
public class CmsTwoListsDialog extends Object
Helper class for managing two lists on the same dialog.

Since:
6.0.0

  • Constructor Details

  • Method Details

    • defaultActionHtml

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

      Returns:
      html code

    • defaultActionHtmlContent

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

      Returns:
      html code

    • defaultActionHtmlEnd

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

      Returns:
      html code

    • defaultActionHtmlStart

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

      Returns:
      html code

    • displayDialog

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

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

    • writeDialog

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

      Throws:
      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, 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
      IOException - if writing to the JSP out fails, or in case of errors forwarding to the required result page
      javax.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