KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2 * File : $Source: /usr/local/cvs/opencms/src-modules/com/opencms/workplace/CmsAdminModule.java,v $
3 * Date : $Date: 2005/05/31 15:51:19 $
4 * Version: $Revision: 1.2 $
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.file.CmsRequestContext;
33 import org.opencms.main.CmsException;
34 import org.opencms.main.CmsLog;
35 import org.opencms.main.OpenCms;
36
37 import com.opencms.template.CmsXmlTemplateFile;
38
39 import java.util.Collections JavaDoc;
40 import java.util.Hashtable JavaDoc;
41 import java.util.Vector 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 CmsAdminModule 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         
71         CmsXmlTemplateFile xmlTemplateDocument = getOwnTemplateFile(cms, templateFile, elementName, parameters, templateSelector);
72         
73         
74         // Set the New Module Icon
75
CmsRequestContext reqCont = cms.getRequestContext();
76         if(reqCont.currentProject().isOnlineProject()){
77             xmlTemplateDocument.setData("activeIcon","online");
78         }else{
79             xmlTemplateDocument.setData("activeIcon","");
80         }
81
82
83         // Now load the template file and start the processing
84
return startProcessing(cms, xmlTemplateDocument, elementName, parameters, templateSelector);
85     }
86     
87     /**
88      * Indicates if the results of this class are cacheable.
89      *
90      * @param cms CmsObject Object for accessing system resources
91      * @param templateFile Filename of the template file
92      * @param elementName Element name of this template in our parent template.
93      * @param parameters Hashtable with all template class parameters.
94      * @param templateSelector template section that should be processed.
95      * @return <EM>true</EM> if cacheable, <EM>false</EM> otherwise.
96      */

97     public boolean isCacheable(CmsObject cms, String JavaDoc templateFile, String JavaDoc elementName, Hashtable JavaDoc parameters, String JavaDoc templateSelector) {
98         return false;
99     }
100     
101     /**
102      * Gets the modules.
103      * <P>
104      *
105      * @param cms CmsObject Object for accessing system resources.
106      * @param names Vector to be filled with the appropriate values in this method.
107      * @param values Vector to be filled with the appropriate values in this method.
108      * @return Vector representing the current projects.
109      * @throws CmsException
110      */

111     public Vector JavaDoc moduleList(CmsObject cms, CmsXmlLanguageFile lang)
112         throws CmsException {
113         Vector JavaDoc retVec = new Vector JavaDoc(OpenCms.getModuleManager().getModuleNames());
114         Collections.sort(retVec);
115         return retVec;
116     }
117 }
118
Popular Tags