KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > opencms > workplace > I_CmsWpElement


1 /*
2 * File : $Source: /usr/local/cvs/opencms/src-modules/com/opencms/workplace/I_CmsWpElement.java,v $
3 * Date : $Date: 2005/05/17 13:47:28 $
4 * Version: $Revision: 1.1 $
5 *
6 * This library is part of OpenCms -
7 * the Open Source Content Mananagement System
8 *
9 * Copyright (C) 2001 The OpenCms Group
10 *
11 * This library is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU Lesser General Public
13 * License as published by the Free Software Foundation; either
14 * version 2.1 of the License, or (at your option) any later version.
15 *
16 * This library is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * Lesser General Public License for more details.
20 *
21 * For further information about OpenCms, please see the
22 * OpenCms Website: http://www.opencms.org
23 *
24 * You should have received a copy of the GNU Lesser General Public
25 * License along with this library; if not, write to the Free Software
26 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 */

28
29
30 package com.opencms.workplace;
31
32 import org.opencms.file.CmsObject;
33 import org.opencms.main.CmsException;
34
35 import com.opencms.template.A_CmsXmlContent;
36
37 import java.util.Hashtable JavaDoc;
38
39 import org.w3c.dom.Element JavaDoc;
40
41 /**
42  * Interface for all workplace elements.
43  * <P>
44  * Any class called by CmsXmlTemplateFile for handling special workplace
45  * XML tags (e.g. <code>&lt;BUTTON&gt;</code> or <code>&lt;LABEL&gt;</code>)
46  * has to implement this interface.
47  *
48  * @author Alexander Lucas
49  * @version $Revision: 1.1 $ $Date: 2005/05/17 13:47:28 $
50  * @see com.opencms.workplace.CmsXmlWpTemplateFile
51  *
52  * @deprecated Will not be supported past the OpenCms 6 release.
53  */

54
55 public interface I_CmsWpElement {
56     
57     /**
58      * Method for handling the corresponding special workplace XML tag and generating the
59      * appropriate output.
60      *
61      * @param cms CmsObject Object for accessing resources.
62      * @param n XML element containing the current tag.
63      * @param doc Reference to the A_CmsXmlContent object of the initiating XLM document.
64      * @param callingObject reference to the calling object.
65      * @param parameters Hashtable containing all user parameters.
66      * @param lang CmsXmlLanguageFile conataining the currently valid language file.
67      * @return Processed special workplace XML tag.
68      * @throws CmsException
69      */

70     
71     public Object JavaDoc handleSpecialWorkplaceTag(CmsObject cms, Element JavaDoc n, A_CmsXmlContent doc, Object JavaDoc callingObject,
72             Hashtable JavaDoc parameters, CmsXmlLanguageFile lang) throws CmsException;
73 }
74
Popular Tags