cmsxmlwptemplatefile.java

cms是开源的框架

/*
* File   : $Source: /usr/local/cvs/opencms/src-modules/com/opencms/workplace/CmsXmlWpTemplateFile.java,v $
* Date   : $Date: 2005/06/27 23:22:07 $
* Version: $Revision: 1.3 $
*
* 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.file.CmsFile;
import org.opencms.file.CmsObject;
import org.opencms.main.CmsException;
import org.opencms.main.CmsLog;

import com.opencms.template.CmsTemplateClassManager;
import com.opencms.template.CmsXmlTemplateFile;

import java.util.Hashtable;

import org.w3c.dom.Element;

/**
 * Content definition for Workplace template files.
 *
 * @author Alexander Lucas
 * @author Michael Emmerich
 * @version $Revision: 1.3 $ $Date: 2005/06/27 23:22:07 $
 * 
 * @deprecated Will not be supported past the OpenCms 6 release.
 */

public class CmsXmlWpTemplateFile extends CmsXmlTemplateFile {

    private Hashtable m_wpTags = new Hashtable();

    /** Reference to the actual language file. */
    private CmsXmlLanguageFile m_languageFile = null;

    /**
     * Default constructor.
     */
    public CmsXmlWpTemplateFile() throws CmsException {
        super();
        registerMyTags();
    }

    /**
     * Constructor for creating a new object containing the content
     * of the given filename.
     *
     * @param cms CmsObject object for accessing system resources.
     * @param filename Name of the body file that shoul be read.
     */
    public CmsXmlWpTemplateFile(CmsObject cms, CmsFile file) throws CmsException {
        super();
        registerMyTags();
        init(cms, file);
    }

    /**
     * Constructor for creating a new object containing the content
     * of the given filename.
     *
     * @param cms CmsObject object for accessing system resources.
     * @param filename Name of the body file that shoul be read.
     */
    public CmsXmlWpTemplateFile(CmsObject cms, String filename) throws CmsException {
        super();
        registerMyTags();
        init(cms, filename);
    }

    /**
     * Clears the startup tag that can be used in workplace documents.
     */
    public void clearStartup() {
        setData(CmsWorkplaceDefault.C_TAG_STARTUP, "");
    }

    /**
     * Fast method to replace a datablock.
     * <P>
     * <b>USE WITH CARE!</b>
     * <P>
     * Using this method only if
     * <ul>
     * <li>The tag name is given in lowercase</li>
     * <li>The datablock already exists (it may be empty)</li>
     * <li>Neither tag nor data are <code>null</code></li>
     * <li>You are sure, there will occurr no errors</li>
     * </ul>
     *
     * @param tag Key for this datablock.
     * @param data String to be put in the datablock.
     */
    public void fastSetXmlData(String tag, String data) {
        fastSetData(tag, data);
    }

    /**
     * Gets the actual instance of the language file.
     * @return Language file.
     */
    public CmsXmlLanguageFile getLanguageFile() {
        return m_languageFile;
    }

    /**
     * Gets the text and CDATA content of a processed datablock from the
     * datablock hashtable.
     *
     * @param tag Key for the datablocks hashtable.
     * @return Processed datablock for the given key.
     * @deprecated Use getProcessedDataValue instead.
     * @throws CmsException
     */
    public String getProcessedXmlDataValue(String tag) throws CmsException {
        return getProcessedDataValue(tag);
    }

    /**
     * Gets the text and CDATA content of a processed datablock from the
     * datablock hashtable.
     *
     * @param tag Key for the datablocks hashtable.
     * @param callingObject Object that should be used to look up user methods.
     * @return Processed datablock for the given key.
     * @deprecated Use getProcessedDataValue instead.
     * @throws CmsException
     */
    public String getProcessedXmlDataValue(String tag, Object callingObject) throws CmsException {
        return getProcessedDataValue(tag, callingObject);
    }

    /**
     * Gets the text and CDATA content of a processed datablock from the
     * datablock hashtable.
     * <P>
     * The userObj Object is passed to all called user methods.
     * By using this, the initiating class can pass customized data to its methods.
     *
     * @param tag Key for the datablocks hashtable.
     * @param callingObject Object that should be used to look up user methods.
     * @param userObj any object that should be passed to user methods
     * @return Processed datablock for the given key.
     * @deprecated Use getProcessedDataValue instead.
     * @throws CmsException
     */
    public String getProcessedXmlDataValue(String tag, Object callingObject,
            Object userObj) throws CmsException {
        return getProcessedDataValue(tag, callingObject, userObj);
    }

    /**
     * Gets the text and CDATA content of a datablock from the
     * datablock hashtable.
     *
     * @param tag Key for the datablocks hashtable.
     * @return Datablock content for the given key or null if no datablock
     * @deprecated Use getDataValue instead.
     * is found for this key.
     */
    public String getXmlDataValue(String tag) throws CmsException {
        return getDataValue(tag);
    }

    /**
     * Gets the expected tagname for the XML documents of this content type
     * @return Expected XML tagname.
     */
    public String getXmlDocumentTagName() {
        return "WORKPLACE";
    }

    /**
     * Handles any occurence of any special workplace XML tag like <code>&lt;BUTTON&gt;</code> or
     * <code>&lt;LABEL&gt;</code>. Looks up the appropriate workplace element class for the current
     * tag and calls the <code>handleSpecialWorkplaceTag()</code> method of this class.
     * <P>
     * Every workplace element class used by this method has to implement the interface
     * <code>I_CmsWpElement</code>
     *
     * @param n XML element containing the current special workplace tag.
     * @param callingObject reference to the calling object.
     * @param userObj hashtable containig all user parameters.
     * @throws CmsException
     * @see com.opencms.workplace.I_CmsWpElement
     */
    public Object handleAnyTag(Element n, Object callingObject, Object userObj) throws CmsException {
        Object result = null;
        I_CmsWpElement workplaceObject = null;
        String tagname = n.getTagName().toLowerCase();
        String classname = null;
        classname = (String)m_wpTags.get(tagname);
        if(classname == null || "".equals(classname)) {
            throwException("Don't know which class handles " + tagname + " tags.");
        }
        Object loadedClass = CmsTemplateClassManager.getClassInstance(classname);
        if(!(loadedClass instanceof I_CmsWpElement)) {
            throwException("Loaded class " + classname + " is not implementing I_CmsWpElement");
        }
        processNode(n, m_mainProcessTags, null, callingObject, userObj);
        workplaceObject = (I_CmsWpElement)loadedClass;
        try {
            result = workplaceObject.handleSpecialWorkplaceTag(m_cms, n, this, callingObject,
                    (Hashtable)userObj, m_languageFile);
        }catch(Exception e) {
            String errorMessage = "Error while building workplace element \"" + tagname + "\": " + e;
            if(e instanceof CmsException) {
                if(CmsLog.getLog(this).isWarnEnabled()) {
                    CmsLog.getLog(this).warn(errorMessage, e);
                }
                throw (CmsException)e;
            }else {
                throwException(errorMessage, e);
            }
        }
        return result;
    }

    /**
     * Checks if this Template owns a datablock with the given key.
     * @param key Datablock key to be checked.
     * @deprecated Use hasData instead.
     * @return true if a datablock is found, false otherwise.
     */

    public boolean hasXmlData(String tag) throws CmsException {
        return hasData(tag);
    }

    /**
     * Overridden init method of A_CmsXmlContent.
     * This method is now extended to get an actual instance of the
     * language file.
     * @param cms CmsObject Object for accessing resources.
     * @param file CmsFile object of the file to be loaded and parsed.
     * @throws CmsException
     */
    public void init(CmsObject cms, CmsFile file) throws CmsException {
        m_languageFile = new CmsXmlLanguageFile(cms);
        String encoding = m_languageFile.getEncoding();
        if (encoding != null) {
            cms.getRequestContext().setEncoding(encoding);
        }
        super.init(cms, file);
    }

    /**
     * Overridden init method of A_CmsXmlContent.
     * This method is now extended to get an actual instance of the
     * language file.
     * @param cms CmsObject Object for accessing resources.
     * @param file CmsFile object of the file to be loaded and parsed.
     * @throws CmsException
     */
    public void init(CmsObject cms, String filename) throws CmsException {
        m_languageFile = new CmsXmlLanguageFile(cms);
        String encoding = m_languageFile.getEncoding();
        if (encoding != null) {
            cms.getRequestContext().setEncoding(encoding);
        }
        super.init(cms, filename);
    }

    /**
     * Registers the special tags for processing with
     * processNode().
     */

    private void registerMyTags() {
        registerTag("BUTTON", "com.opencms.workplace.CmsButton");
        registerTag("ICON", "com.opencms.workplace.CmsIcon");
        registerTag("BUTTONSEPARATOR", "com.opencms.workplace.CmsButtonSeparator");

        // registerTag("ERRORBOX", "com.opencms.workplace.CmsErrorbox");
        registerTag("ERRORPAGE", "com.opencms.workplace.CmsErrorpage");
        registerTag("FILELIST", "com.opencms.workplace.CmsFileList");
        registerTag("FILETYPELIST", "com.opencms.workplace.CmsFileTypeList");
        registerTag("INPUTFIELD", "com.opencms.workplace.CmsInput");
        registerTag("JAVASCRIPTBUTTON", "com.opencms.workplace.CmsButtonJavascript");
        registerTag("LABEL", "com.opencms.workplace.CmsLabel");
        registerTag("PASSWORD", "com.opencms.workplace.CmsInputPassword");
        registerTag("SUBMITBUTTON", "com.opencms.workplace.CmsButtonSubmit");
        registerTag("TEXTBUTTON", "com.opencms.workplace.CmsButtonText");
        registerTag("SELECT", "com.opencms.workplace.CmsSelectBox");
        registerTag("PROJECTLIST", "com.opencms.workplace.CmsProjectlist");
        registerTag("PROJECTHISTORY", "com.opencms.workplace.CmsProjecthistory");
        registerTag("MODULELIST", "com.opencms.workplace.CmsModulelist");
        registerTag("CONTEXTMENUE", "com.opencms.workplace.CmsContextmenue");
        registerTag("MESSAGEBOX", "com.opencms.workplace.CmsMessagebox");
        registerTag("RADIOBUTTON", "com.opencms.workplace.CmsRadioButtons");
        registerTag("PANELBAR", "com.opencms.workplace.CmsPanel");
        registerTag("TASKLIST", "com.opencms.workplace.CmsTaskList");
        registerTag("TASKDOCU", "com.opencms.workplace.CmsTaskDocu");
        registerTag("PREFSSCROLLER", "com.opencms.workplace.CmsPrefsScroller");
        registerTag("BACKBUTTON", "com.opencms.workplace.CmsBackbutton");
        // just to be sure this is in the workplace view always aktiv
        registerTag("ELEMENT", CmsXmlTemplateFile.class, "handleElementTag", C_REGISTER_MAIN_RUN);
    }

    /**
     * Special registerTag method for this content definition class.
     * Any workplace XML tag will be registered with the superclass for handling with
     * the method <code>handleAnyTag()</code> in this class.
     * Then the tagname together with the name of the class for the template
     * element (e.g. <code>CmsButton</code> or <code>CmsLabel</code>) will be put in an internal Hashtable.
     * <P>
     * Every workplace element class used by this method has to implement the interface
     * <code>I_CmsWpElement</code>
     *
     * @param tagname XML tag to be registered as a special workplace tag.
     * @param elementClassName Appropriate workplace element class name for this tag.
     * @see com.opencms.workplace.I_CmsWpElement
     */
    private void registerTag(String tagname, String elementClassName) {
        super.registerTag(tagname, CmsXmlWpTemplateFile.class, "handleAnyTag", C_REGISTER_MAIN_RUN);
        m_wpTags.put(tagname.toLowerCase(), elementClassName);
    }

    /**
     * Removes a datablock from the internal hashtable and
     * from the XML document
     * @param tag Key of the datablock to delete.
     * @deprecated Use removeData instead.
     */
    public void removeXmlData(String tag) {
        removeData(tag);
    }

    /**
     * Creates a datablock consisting of a single TextNode containing
     * data and stores this block into the datablock-hashtable.
     *
     * @param tag Key for this datablock.
     * @param data String to be put in the datablock.
     * @deprecated Use setData instead.
     */
    public void setXmlData(String tag, String data) {
        setData(tag, data);
    }
}