/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software GmbH, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.workplace.list;
import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspWriter;
/**
* Helper class for managing two lists on the same dialog.<p>
*
* @since 6.0.0
*/
public class CmsTwoListsDialog {
/** the workplace instance for the active list. */
private A_CmsListDialog m_activeWp;
/** the workplace instance for the first list. */
private A_CmsListDialog m_firstWp;
/** the workplace instance for the passive list. */
private A_CmsListDialog m_passiveWp;
/** the workplace instance for the second list. */
private A_CmsListDialog m_secondWp;
/**
* Default constructor.<p>
*
* @param wp1 the workplace instance for the first list
* @param wp2 the workplace instance for the second list
*/
public CmsTwoListsDialog(A_CmsListDialog wp1, A_CmsListDialog wp2) {
m_activeWp = (wp1.isActive() ? wp1 : wp2);
m_passiveWp = (!wp1.isActive() ? wp1 : wp2);
m_firstWp = wp1;
m_secondWp = wp2;
}
/**
* Generates the dialog starting html code.<p>
*
* @return html code
*/
protected String defaultActionHtml() {
StringBuffer result = new StringBuffer(2048);
result.append(defaultActionHtmlStart());
result.append(defaultActionHtmlContent());
result.append(defaultActionHtmlEnd());
return result.toString();
}
/**
* Returns the html code for the default action content.<p>
*
* @return html code
*/
protected String defaultActionHtmlContent() {
StringBuffer result = new StringBuffer(2048);
result.append("<table id='twolists' cellpadding='0' cellspacing='0' align='center' width='100%'>\n");
result.append("\t<tr>\n");
result.append("\t\t<td width='50%' valign='top'>\n");
result.append("\t\t\t").append(m_firstWp.defaultActionHtmlContent()).append("\n");
result.append("\t\t</td>\n");
result.append("\t\t<td width='20'> </td>");
result.append("\t\t<td width='50%' valign='top'>\n");
result.append("\t\t\t").append(m_secondWp.defaultActionHtmlContent()).append("\n");
result.append("\t\t</td>\n");
result.append("\t</tr>\n");
result.append("</table>\n");
return result.toString();
}
/**
* Generates the dialog ending html code.<p>
*
* @return html code
*/
protected String defaultActionHtmlEnd() {
return m_activeWp.defaultActionHtmlEnd();
}
/**
* Generates the dialog starting html code.<p>
*
* @return html code
*/
protected String defaultActionHtmlStart() {
return m_activeWp.defaultActionHtmlStart();
}
/**
* Display method for two list dialogs.<p>
*
* @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
*/
public void displayDialog() throws JspException, IOException, ServletException {
displayDialog(false);
}
/**
* Writes the dialog html code, only if the <code>{@link org.opencms.workplace.CmsDialog#ACTION_DEFAULT}</code> is set.<p>
*
* @throws IOException if writing to the JSP out fails, or in case of errors forwarding to the required result page
*/
public void writeDialog() throws IOException {
if (m_activeWp.isForwarded() || m_passiveWp.isForwarded()) {
return;
}
JspWriter out = m_activeWp.getJsp().getJspContext().getOut();
out.print(defaultActionHtml());
}
/**
* Display method for two list dialogs, executes actions, but only displays if needed.<p>
*
* @param writeLater if <code>true</code> no output is written,
* you have to call manually the <code>{@link #defaultActionHtml()}</code> 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
*/
public void displayDialog(boolean writeLater) throws JspException, IOException, ServletException {
// perform the active list actions
m_activeWp.actionDialog();
if (m_activeWp.isForwarded()) {
return;
}
m_activeWp.refreshList();
m_passiveWp.refreshList();
if (writeLater) {
return;
}
JspWriter out = m_activeWp.getJsp().getJspContext().getOut();
out.print(defaultActionHtml());
}
/**
* Returns the workplace instance of the active list.<p>
*
* @return the workplace instance of the active list
*/
public A_CmsListDialog getActiveWp() {
return m_activeWp;
}
/**
* Returns the workplace instance of the first list.<p>
*
* @return the workplace instance of the first list
*/
public A_CmsListDialog getFirstWp() {
return m_firstWp;
}
/**
* Returns the workplace instance of the passive list.<p>
*
* @return the workplace instance of the passive list
*/
public A_CmsListDialog getPassiveWp() {
return m_passiveWp;
}
/**
* Returns the workplace instance of the second list.<p>
*
* @return the workplace instance of the second list
*/
public A_CmsListDialog getSecondWp() {
return m_secondWp;
}
}