KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2 * File : $Source: /usr/local/cvs/opencms/src-modules/com/opencms/workplace/CmsModuleDemos.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 import org.opencms.main.OpenCms;
35 import org.opencms.workplace.CmsWorkplace;
36
37 import com.opencms.legacy.CmsXmlTemplateLoader;
38 import com.opencms.template.CmsXmlTemplateFile;
39
40 import java.util.Hashtable JavaDoc;
41 import java.util.Iterator JavaDoc;
42
43 /**
44  * Template class for displaying OpenCms workplace administration module
45  *
46  * Creation date: (30.08.00 17:59:38)
47  * @author Hanjo Riege
48  *
49  * @deprecated Will not be supported past the OpenCms 6 release.
50  */
51 public class CmsModuleDemos extends CmsWorkplaceDefault {
52
53     /**
54      * Gets the content of a defined section in a given template file and its subtemplates
55      * with the given parameters.
56      *
57      * @see #getContent(CmsObject, String, String, Hashtable, String)
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      */
64     public byte[] getContent(CmsObject cms, String JavaDoc templateFile, String JavaDoc elementName, Hashtable JavaDoc parameters, String JavaDoc templateSelector) throws CmsException {
65         if(CmsLog.getLog(this).isDebugEnabled() && C_DEBUG) {
66             CmsLog.getLog(this).debug("Getting content of element " + ((elementName==null)?"<root>":elementName));
67             CmsLog.getLog(this).debug("Template file is: " + templateFile);
68             CmsLog.getLog(this).debug("Selected template section is: " + ((templateSelector==null)?"<default>":templateSelector));
69         }
70         CmsXmlTemplateFile templateDocument = getOwnTemplateFile(cms, templateFile, elementName, parameters, templateSelector);
71         String JavaDoc currentname;
72         Iterator JavaDoc modules = OpenCms.getModuleManager().getModuleNames().iterator();
73         String JavaDoc completeList = "";
74         String JavaDoc servPath = CmsXmlTemplateLoader.getRequest(cms.getRequestContext()).getServletUrl();
75         while(modules.hasNext()) {
76             String JavaDoc name = (String JavaDoc)modules.next();
77             String JavaDoc nicename = OpenCms.getModuleManager().getModule(name).getNiceName();
78             if(nicename == null || nicename.equals("")) {
79                 currentname = name;
80             }
81             else {
82                 currentname = nicename;
83             }
84             templateDocument.setData("name", currentname);
85             templateDocument.setData("namelink", servPath + "/moduledemos/" + name + "/index.html");
86             completeList += templateDocument.getProcessedDataValue("list_entry");
87             templateDocument.setData("doc_name", currentname);
88             templateDocument.setData("doc_link", servPath + CmsWorkplace.VFS_PATH_MODULES + name + "/doc/index.html");
89             completeList += templateDocument.getProcessedDataValue("doc_entry");
90         }
91         templateDocument.setData("list", completeList);
92
93         // Now load the template file and start the processing
94 return startProcessing(cms, templateDocument, elementName, parameters, templateSelector);
95     }
96
97     /**
98      * Indicates if the results of this class are cacheable.
99      *
100      * @param cms CmsObject Object for accessing system resources
101      * @param templateFile Filename of the template file
102      * @param elementName Element name of this template in our parent template.
103      * @param parameters Hashtable with all template class parameters.
104      * @param templateSelector template section that should be processed.
105      * @return <EM>true</EM> if cacheable, <EM>false</EM> otherwise.
106      */
107     public boolean isCacheable(CmsObject cms, String JavaDoc templateFile, String JavaDoc elementName, Hashtable JavaDoc parameters, String JavaDoc templateSelector) {
108         return false;
109     }
110 }
111
Popular Tags