KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > opencms > workplace > administration > CmsAdminFrameset


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src-modules/org/opencms/workplace/administration/CmsAdminFrameset.java,v $
3  * Date : $Date: 2006/04/28 15:20:57 $
4  * Version: $Revision: 1.7 $
5  *
6  * This library is part of OpenCms -
7  * the Open Source Content Mananagement System
8  *
9  * Copyright (c) 2005 Alkacon Software GmbH (http://www.alkacon.com)
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 Alkacon Software GmbH, please see the
22  * company website: http://www.alkacon.com
23  *
24  * For further information about OpenCms, please see the
25  * project website: http://www.opencms.org
26  *
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30  */
31
32 package org.opencms.workplace.administration;
33
34 import org.opencms.jsp.CmsJspActionElement;
35 import org.opencms.workplace.CmsWorkplaceSettings;
36 import org.opencms.workplace.tools.CmsToolDialog;
37
38 import javax.servlet.http.HttpServletRequest JavaDoc;
39
40 /**
41  * Helper class to create the administration frameset.<p>
42  *
43  * It allows to specify if you want or not an left side menu.<p>
44  *
45  * The following files use this class:<br>
46  * <ul>
47  * <li>/views/admin/external-fs.jsp</li>
48  * <li>/views/admin/admin-fs.jsp</li>
49  * </ul>
50  * <p>
51  *
52  * @author Michael Moossen
53  *
54  * @version $Revision: 1.7 $
55  *
56  * @since 6.0.0
57  */
58 public class CmsAdminFrameset extends CmsToolDialog {
59
60     /** Request parameter name for the "with menu" flag. */
61     public static final String JavaDoc PARAM_MENU = "menu";
62
63     /** Request parameter value. */
64     private String JavaDoc m_paramMenu;
65
66     /**
67      * Public constructor.<p>
68      *
69      * @param jsp an initialized JSP action element
70      */
71     public CmsAdminFrameset(CmsJspActionElement jsp) {
72
73         super(jsp);
74     }
75
76     /**
77      * Returns the menu parameter value.<p>
78      *
79      * @return the menu parameter value
80      */
81     public String JavaDoc getParamMenu() {
82
83         return m_paramMenu;
84     }
85
86     /**
87      * Sets the menu parameter value.<p>
88      *
89      * @param paramMenu the menu parameter value to set
90      */
91     public void setParamMenu(String JavaDoc paramMenu) {
92
93         m_paramMenu = paramMenu;
94     }
95
96     /**
97      * Tests if the current dialog should be displayed with or without menu.<p>
98      *
99      * The default is with menu, use <code>menu=no</code> for avoiding it.<p>
100      *
101      * @return <code>true</code> if the dialog should be displayed with menu
102      */
103     public boolean withMenu() {
104
105         return getParamMenu() == null || !getParamMenu().equals("no");
106     }
107
108     /**
109      * @see org.opencms.workplace.CmsWorkplace#initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)
110      */
111     protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings, HttpServletRequest JavaDoc request) {
112
113         // fill the parameter values in the get/set methods
114 fillParamValues(request);
115     }
116
117 }
Popular Tags