KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2 * File : $Source: /usr/local/cvs/opencms/src-modules/com/opencms/workplace/CmsAdminModuleAdminProperties.java,v $
3 * Date : $Date: 2005/06/27 23:22:07 $
4 * Version: $Revision: 1.3 $
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.workplace;
30
31 import org.opencms.file.CmsObject;
32 import org.opencms.main.CmsException;
33 import org.opencms.main.CmsLog;
34
35 import com.opencms.core.I_CmsSession;
36 import com.opencms.legacy.CmsXmlTemplateLoader;
37 import com.opencms.template.CmsXmlTemplateFile;
38
39 import java.util.Hashtable JavaDoc;
40 import java.util.Vector JavaDoc;
41
42 /**
43  * Template class for displaying the conflicting Files for a new Module.
44  * Creation date: (06.09.00 09:30:25)
45  * @author Hanjo Riege
46  *
47  * @deprecated Will not be supported past the OpenCms 6 release.
48  */
49 public class CmsAdminModuleAdminProperties extends CmsWorkplaceDefault {
50     
51     /**
52      * Gets the content of a defined section in a given template file and its subtemplates
53      * with the given parameters.
54      *
55      * @see #getContent(CmsObject, String, String, Hashtable, String)
56      * @param cms CmsObject Object for accessing system resources.
57      * @param templateFile Filename of the template file.
58      * @param elementName Element name of this template in our parent template.
59      * @param parameters Hashtable with all template class parameters.
60      * @param templateSelector template section that should be processed.
61      */
62     public byte[] getContent(CmsObject cms, String JavaDoc templateFile, String JavaDoc elementName, Hashtable JavaDoc parameters, String JavaDoc templateSelector) throws CmsException {
63         if(CmsLog.getLog(this).isDebugEnabled() && C_DEBUG) {
64             CmsLog.getLog(this).debug("Getting content of element " + ((elementName==null)?"<root>":elementName));
65             CmsLog.getLog(this).debug("Template file is: " + templateFile);
66             CmsLog.getLog(this).debug("Selected template section is: " + ((templateSelector==null)?"<default>":templateSelector));
67         }
68         CmsXmlTemplateFile xmlTemplateDocument = getOwnTemplateFile(cms, templateFile, elementName, parameters, templateSelector);
69         I_CmsSession session = CmsXmlTemplateLoader.getSession(cms.getRequestContext(), true);
70         Hashtable JavaDoc sessionData = (Hashtable JavaDoc)session.getValue(CmsWorkplaceDefault.C_SESSION_MODULE_ADMIN_DATA);
71         String JavaDoc module = (String JavaDoc)sessionData.get(CmsWorkplaceDefault.C_MODULE_PACKETNAME);
72         xmlTemplateDocument.setData("packetname", module);
73         Vector JavaDoc paraNames = (Vector JavaDoc)sessionData.get(CmsWorkplaceDefault.C_SESSION_MODULE_ADMIN_PROP_NAMES);
74         Vector JavaDoc paraDescr = (Vector JavaDoc)sessionData.get(CmsWorkplaceDefault.C_SESSION_MODULE_ADMIN_PROP_DESCR);
75         Vector JavaDoc paraTyp = (Vector JavaDoc)sessionData.get(CmsWorkplaceDefault.C_SESSION_MODULE_ADMIN_PROP_TYP);
76         Vector JavaDoc paraVal = (Vector JavaDoc)sessionData.get(CmsWorkplaceDefault.C_SESSION_MODULE_ADMIN_PROP_VAL);
77         String JavaDoc allList = "";
78         for(int i = 0;i < paraNames.size();i++) {
79             xmlTemplateDocument.setData("propname", (String JavaDoc)paraNames.elementAt(i));
80             xmlTemplateDocument.setData("typ", (String JavaDoc)paraTyp.elementAt(i));
81             xmlTemplateDocument.setData("value", (String JavaDoc)paraVal.elementAt(i));
82             xmlTemplateDocument.setData("description", (String JavaDoc)paraDescr.elementAt(i));
83             allList += xmlTemplateDocument.getProcessedDataValue("list_entry", this);
84         }
85         xmlTemplateDocument.setData("list", allList);
86         
87         // Now load the template file and start the processing
88 return startProcessing(cms, xmlTemplateDocument, elementName, parameters, templateSelector);
89     }
90     
91     /**
92      * Indicates if the results of this class are cacheable.
93      *
94      * @param cms CmsObject Object for accessing system resources
95      * @param templateFile Filename of the template file
96      * @param elementName Element name of this template in our parent template.
97      * @param parameters Hashtable with all template class parameters.
98      * @param templateSelector template section that should be processed.
99      * @return <EM>true</EM> if cacheable, <EM>false</EM> otherwise.
100      */
101     public boolean isCacheable(CmsObject cms, String JavaDoc templateFile, String JavaDoc elementName, Hashtable JavaDoc parameters, String JavaDoc templateSelector) {
102         return false;
103     }
104 }
105
Popular Tags