KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > opencms > defaults > CmsXmlFormTemplate


1 /*
2 * File : $Source: /usr/local/cvs/opencms/src-modules/com/opencms/defaults/CmsXmlFormTemplate.java,v $
3 * Date : $Date: 2005/05/17 13:47:32 $
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 package com.opencms.defaults;
30
31 import org.opencms.file.CmsObject;
32 import org.opencms.main.CmsException;
33
34 import com.opencms.template.CmsXmlTemplate;
35 import com.opencms.template.CmsXmlTemplateFile;
36
37 import java.util.Hashtable JavaDoc;
38
39 /**
40  * Common template class for displaying OpenCms workplace screens.
41  * <P>
42  * Reads template files of the content type <code>CmsXmlWpTemplateFile</code>.
43  * <P>
44  * Most special workplace classes may extend this class.
45  *
46  * @author Alexander Lucas
47  * @version $Revision: 1.1 $ $Date: 2005/05/17 13:47:32 $
48  * @see com.opencms.workplace.CmsXmlWpTemplateFile
49  *
50  * @deprecated Will not be supported past the OpenCms 6 release.
51  */
52 public class CmsXmlFormTemplate extends CmsXmlTemplate {
53     
54     /**
55      * Reads in the template file and starts the XML parser for the expected
56      * content type <class>CmsXmlFormTemplateFile</code>.<p>
57      *
58      * @param cms CmsObject Object for accessing system resources
59      * @param templateFile Filename of the template file
60      * @param elementName Element name of this template in our parent template
61      * @param parameters Hashtable with all template class parameters
62      * @param templateSelector template section that should be processed
63      * @return the template document
64      * @throws CmsException if something goes wrong
65      */
66     public CmsXmlTemplateFile getOwnTemplateFile(CmsObject cms, String JavaDoc templateFile, String JavaDoc elementName, Hashtable JavaDoc parameters, String JavaDoc templateSelector) throws CmsException {
67         CmsXmlFormTemplateFile xmlTemplateDocument = new CmsXmlFormTemplateFile(cms, templateFile);
68         return xmlTemplateDocument;
69     }
70 }
71
Popular Tags