cmspanel.java

内容管理

/*
* File   : $Source: /usr/local/cvs/opencms/src/com/opencms/workplace/CmsPanel.java,v $
* Date   : $Date: 2003/01/20 23:59:19 $
* Version: $Revision: 1.11 $
*
* This library is part of OpenCms -
* the Open Source Content Mananagement System
*
* Copyright (C) 2001  The OpenCms Group
*
* 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 OpenCms, please see the
* OpenCms 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 com.opencms.workplace;

import com.opencms.core.CmsException;
import com.opencms.file.CmsObject;
import com.opencms.file.CmsRequestContext;
import com.opencms.template.A_CmsXmlContent;

import java.util.Hashtable;
import java.util.Vector;

import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

/**
 * Class for building workplace panel bars. <BR>
 * Called by CmsXmlTemplateFile for handling the special XML tag <code>&lt;PANELBAR&gt;</code>.
 *
 * @author Alexander Lucas
 * @version $Revision: 1.11 $ $Date: 2003/01/20 23:59:19 $
 */

public class CmsPanel extends A_CmsWpElement implements I_CmsWpElement,I_CmsWpConstants {


    /** Workplace tag used for each panel in <code>&lt;PANELBAR&gt;</code> */
    public static final String C_WPTAG_PANEL = "panel";


    /** Attribute used for panelnames <code>C_WPTAG_PANEL</code> */
    public static final String C_WPTAG_ATTR_PANELNAME = "name";

    /**
     * Handling of the <CODE>&lt;PANELBAR&gt;</CODE> tags.
     * <P>
     * Reads the code of a panel from the panel definition file
     * and returns the processed code with the actual elements.
     * <P>
     * Panel bars can be referenced in any workplace template by <br>
     * <code>&lt;PANELBAR&gt;<br>
     * &lt;PANEL&gt; name="..."/&gt;<br>
     * &lt;PANEL&gt; name="..."/&gt;<br>
     * ...
     * </code>
     * For each <code>&lt;PANEL&gt;</code> element one panel will be created.
     * The text for this panel will be taken from the language file's
     * <code>&lt;PANEL&gt;</code> section using the panel name.
     * <p>
     * Each panel will be linked to the currently requested URL,
     * extended by the <code>?panel=name</code> parameter.
     *
     * @param cms CmsObject Object for accessing resources.
     * @param n XML element containing the <code>&lt;INPUT&gt;</code> tag.
     * @param doc Reference to the A_CmsXmlContent object of the initiating XLM document.
     * @param callingObject reference to the calling object.
     * @param parameters Hashtable containing all user parameters.
     * @param lang CmsXmlLanguageFile conataining the currently valid language file.
     * @return Processed button.
     * @throws CmsException
     */

    public Object handleSpecialWorkplaceTag(CmsObject cms, Element n, A_CmsXmlContent doc,
            Object callingObject, Hashtable parameters, CmsXmlLanguageFile lang) throws CmsException {

        // Currently requested panel
        String selectedPanel = (String)parameters.get(C_PARA_PANEL);
        if(selectedPanel == null) {
            selectedPanel = "";
        }

        // panel definition file
        CmsXmlWpTemplateFile paneldef = getPanelDefinitions(cms);

        // base URL of the page, each panel is linked to.

        // This URL will be extendeb by "?panel=panelname" or "&panel=panelname"
        CmsRequestContext reqCont = cms.getRequestContext();
        String url = reqCont.getRequest().getServletUrl() + reqCont.getUri();
        if(url.indexOf("?") >= 0) {
            url = url + "&panel=";
        }
        else {
            url = url + "?panel=";
        }

        // Node reference used in loops
        Node nodeLoop;

        // Name of the currently processed panel
        String panelName = null;

        // Some StringBuffer for storing the results
        StringBuffer resultBg = new StringBuffer();
        StringBuffer resultTxt = new StringBuffer();
        StringBuffer resultAll = new StringBuffer();

        // Collect all available panels and put them into
        // the Vector panels
        NodeList nl = n.getChildNodes();
        Vector panels = new Vector();
        for(int i = 0;i < nl.getLength();i++) {
            Element tempElem = null;
            nodeLoop = nl.item(i);
            if(nodeLoop.getNodeType() == Node.ELEMENT_NODE) {
                tempElem = (Element)nodeLoop;
                if(tempElem.getNodeName().toLowerCase().equals(C_WPTAG_PANEL)) {
                    panelName = tempElem.getAttribute(C_WPTAG_ATTR_PANELNAME);
                    if(panelName != null && !panelName.equals("")) {
                        panels.addElement(panelName);
                    }
                }
            }
        }

        // Get the index of the currently requested panel
        int currentPanelNo = panels.indexOf(selectedPanel);

        // Generate the output for each panel.

        // Panel background and text will be written separately
        for(int i = 0;i < panels.size();i++) {
            panelName = (String)panels.elementAt(i);
            paneldef.setData(C_PANEL_LINK, panelName);
            paneldef.setData(C_PANEL_NAME, lang.getLanguageValue("panel." + panelName));
            if(i == currentPanelNo) {
                resultBg.append(paneldef.getProcessedDataValue(C_TAG_PANEL_BGACTIVE, callingObject, null));
                resultTxt.append(paneldef.getProcessedDataValue(C_TAG_PANEL_TEXTACTIVE));
            }
            else {
                resultBg.append(paneldef.getProcessedDataValue(C_TAG_PANEL_BGINACTIVE, callingObject, null));
                resultTxt.append(paneldef.getProcessedDataValue(C_TAG_PANEL_TEXTINACTIVE));
            }
        }

        // Now build the end result
        resultAll.append(paneldef.getDataValue(C_TAG_PANEL_STARTSEQ));
        resultAll.append(resultBg.toString());
        resultAll.append(paneldef.getDataValue(C_TAG_PANEL_SEPBGTEXT));
        resultAll.append(resultTxt.toString());
        resultAll.append(paneldef.getDataValue(C_TAG_PANEL_ENDSEQ));
        return resultAll.toString();
    }
}