cmscontextmenue.java

cms是开源的框架

/*
* File   : $Source: /usr/local/cvs/opencms/src-modules/com/opencms/workplace/CmsContextmenue.java,v $
* Date   : $Date: 2005/06/25 11:19:03 $
* Version: $Revision: 1.2 $
*
* 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 org.opencms.db.CmsUserSettings;
import org.opencms.file.CmsObject;
import org.opencms.main.CmsException;

import com.opencms.template.A_CmsXmlContent;

import java.util.Hashtable;

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

/**
 * Class for building workplace icons. <BR>
 * Called by CmsXmlTemplateFile for handling the special XML tag <code>&lt;ICON&gt;</code>.
 *
 * @author Andreas Schouten
 * @version $Revision: 1.2 $ $Date: 2005/06/25 11:19:03 $
 * @see com.opencms.workplace.CmsXmlWpTemplateFile
 * 
 * @deprecated Will not be supported past the OpenCms 6 release.
 */

public class CmsContextmenue extends A_CmsWpElement implements I_CmsWpElement {


    /** Storage for contextmenue */
    private Hashtable m_storage = new Hashtable();

    /**
     * Handling of the special workplace <CODE>&lt;Contextmenue&gt;</CODE> tags.
     * <P>
     * Returns the processed code with the actual elements.
     * <P>
     * Contextmenue can be referenced in any workplace template by <br>
     * <CODE>&lt;Contextmenue /&gt;</CODE>
     *
     * @param cms CmsObject Object for accessing resources.
     * @param n XML element containing the <code>&lt;ICON&gt;</code> tag.
     * @param doc Reference to the A_CmsXmlContent object of the initiating XLM document.
     * @param callingObject reference to the calling object <em>(not used here)</em>.
     * @param parameters Hashtable containing all user parameters <em>(not used here)</em>.
     * @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 {

        // Read Contextmenue parameters
        String name = n.getAttribute("name");
        String output = "++ missing context ++";
        if(name != null) {

            // get the current langueag
            String currentLocale = null;

            CmsUserSettings settings = new CmsUserSettings(cms);
            currentLocale = settings.getLocale().toString();
            // create the result
            StringBuffer result = new StringBuffer();

            // check if this contextmenu is already cached
            output = (String)m_storage.get(currentLocale + name + cms.getRequestContext().getUri());
            if(output == null) {

                // Get list definition and language values
                CmsXmlWpTemplateFile context = getContextmenueDefinitions(cms);

                // set the name (id) of the contextmenu
                context.setData("name", name);
                result.append(context.getProcessedDataValue("CONTEXTHEAD", callingObject,
                        parameters));
                NodeList nl = n.getChildNodes();

                // get each childnode
                for(int i = 0;i < nl.getLength();i++) {
                    Node actualNode = nl.item(i);
                    if(actualNode.getNodeType() != Node.TEXT_NODE) {
                        Element e = (Element)actualNode;

                        // this is not a text node, process it
                        if(e.getTagName().toLowerCase().equals("contextspacer")) {

                            // append a spacer
                            result.append(context.getProcessedDataValue("CONTEXTSPACER",
                                    callingObject, parameters));
                        }
                        else {
                            if(e.getTagName().toLowerCase().equals("contextentry")) {

                                // append a entry
                                context.setData("name", lang.getLanguageValue(e.getAttribute("name")));
                                context.setData("href", e.getAttribute("href"));
                                result.append(context.getProcessedDataValue("CONTEXTENTRY",
                                        callingObject, parameters));
                            }
                            else {
                                if(e.getTagName().toLowerCase().equals("contextdisabled")) {

                                    // append a entry
                                    context.setData("name", lang.getLanguageValue(e.getAttribute("name")));
                                    result.append(context.getProcessedDataValue("CONTEXTDISABLED", callingObject, parameters));
                                }
                            }
                        }
                    }
                }
                result.append(context.getProcessedDataValue("CONTEXTFOOT", callingObject,
                        parameters));
                output = result.toString();
                m_storage.put(currentLocale + name + cms.getRequestContext().getUri(), output);
            }
        }

        // rerun the result
        return output;
    }
}