KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > opencms > workplace > commons > CmsGroupSelectionList


1 /*
2  * File : $Source$
3  * Date : $Date$
4  * Version: $Revision$
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.commons;
33
34 import org.opencms.file.CmsGroup;
35 import org.opencms.jsp.CmsJspActionElement;
36 import org.opencms.main.CmsException;
37 import org.opencms.main.CmsRuntimeException;
38 import org.opencms.security.CmsPrincipal;
39 import org.opencms.util.CmsStringUtil;
40 import org.opencms.workplace.list.A_CmsListDefaultJsAction;
41 import org.opencms.workplace.list.A_CmsListDialog;
42 import org.opencms.workplace.list.CmsListColumnAlignEnum;
43 import org.opencms.workplace.list.CmsListColumnDefinition;
44 import org.opencms.workplace.list.CmsListDefaultAction;
45 import org.opencms.workplace.list.CmsListDirectAction;
46 import org.opencms.workplace.list.CmsListItem;
47 import org.opencms.workplace.list.CmsListMetadata;
48 import org.opencms.workplace.list.CmsListOrderEnum;
49 import org.opencms.workplace.tools.CmsToolMacroResolver;
50
51 import java.util.ArrayList JavaDoc;
52 import java.util.Iterator JavaDoc;
53 import java.util.List JavaDoc;
54
55 import javax.servlet.http.HttpServletRequest JavaDoc;
56 import javax.servlet.http.HttpServletResponse JavaDoc;
57 import javax.servlet.jsp.PageContext JavaDoc;
58
59 /**
60  * Group selection dialog.<p>
61  *
62  * @author Michael Moossen
63  *
64  * @version $Revision$
65  *
66  * @since 6.0.0
67  */
68 public class CmsGroupSelectionList extends A_CmsListDialog {
69
70     /** list action id constant. */
71     public static final String JavaDoc LIST_ACTION_ICON = "ai";
72
73     /** list action id constant. */
74     public static final String JavaDoc LIST_ACTION_SELECT = "js";
75
76     /** list column id constant. */
77     public static final String JavaDoc LIST_COLUMN_ICON = "ci";
78
79     /** list column id constant. */
80     public static final String JavaDoc LIST_COLUMN_NAME = "cn";
81
82     /** list id constant. */
83     public static final String JavaDoc LIST_ID = "lug";
84
85     /** Stores the value of the request parameter for the flags. */
86     private String JavaDoc m_paramFlags;
87
88     /** Stores the value of the request parameter for the user name. */
89     private String JavaDoc m_paramUser;
90
91     /**
92      * Public constructor.<p>
93      *
94      * @param jsp an initialized JSP action element
95      */
96     public CmsGroupSelectionList(CmsJspActionElement jsp) {
97
98         super(
99             jsp,
100             LIST_ID,
101             Messages.get().container(Messages.GUI_GROUPSELECTION_LIST_NAME_0),
102             LIST_COLUMN_NAME,
103             CmsListOrderEnum.ORDER_ASCENDING,
104             LIST_COLUMN_NAME);
105     }
106
107     /**
108      * Public constructor with JSP variables.<p>
109      *
110      * @param context the JSP page context
111      * @param req the JSP request
112      * @param res the JSP response
113      */
114     public CmsGroupSelectionList(PageContext JavaDoc context, HttpServletRequest JavaDoc req, HttpServletResponse JavaDoc res) {
115
116         this(new CmsJspActionElement(context, req, res));
117     }
118
119     /**
120      * @see org.opencms.workplace.tools.CmsToolDialog#dialogTitle()
121      */
122     public String JavaDoc dialogTitle() {
123
124         // build title
125 StringBuffer JavaDoc html = new StringBuffer JavaDoc(512);
126         html.append("<div class='screenTitle'>\n");
127         html.append("\t<table width='100%' cellspacing='0'>\n");
128         html.append("\t\t<tr>\n");
129         html.append("\t\t\t<td>\n");
130         if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(getParamUser())) {
131             html.append(Messages.get().getBundle(getLocale()).key(
132                 Messages.GUI_GROUPSELECTION_USER_TITLE_1,
133                 getParamUser()));
134         } else {
135             html.append(Messages.get().getBundle(getLocale()).key(Messages.GUI_GROUPSELECTION_INTRO_TITLE_0));
136         }
137         html.append("\n\t\t\t</td>");
138         html.append("\t\t</tr>\n");
139         html.append("\t</table>\n");
140         html.append("</div>\n");
141         return CmsToolMacroResolver.resolveMacros(html.toString(), this);
142     }
143
144     /**
145      * @see org.opencms.workplace.list.A_CmsListDialog#executeListMultiActions()
146      */
147     public void executeListMultiActions() throws CmsRuntimeException {
148
149         throwListUnsupportedActionException();
150     }
151
152     /**
153      * @see org.opencms.workplace.list.A_CmsListDialog#executeListSingleActions()
154      */
155     public void executeListSingleActions() throws CmsRuntimeException {
156
157         throwListUnsupportedActionException();
158     }
159
160     /**
161      * Returns the flags parameter value.<p>
162      *
163      * @return the flags parameter value
164      */
165     public String JavaDoc getParamFlags() {
166
167         return m_paramFlags;
168     }
169
170     /**
171      * Returns the user name parameter.<p>
172      *
173      * @return the user name paramter
174      */
175     public String JavaDoc getParamUser() {
176
177         return m_paramUser;
178     }
179
180     /**
181      * Sets the flags parameter value.<p>
182      *
183      * @param flags the flags parameter value to set
184      */
185     public void setParamFlags(String JavaDoc flags) {
186
187         m_paramFlags = flags;
188     }
189
190     /**
191      * Sets the user name.<p>
192      *
193      * @param userName the user name to set
194      */
195     public void setParamUser(String JavaDoc userName) {
196
197         m_paramUser = userName;
198     }
199
200     /**
201      * @see org.opencms.workplace.list.A_CmsListDialog#fillDetails(java.lang.String)
202      */
203     protected void fillDetails(String JavaDoc detailId) {
204
205         // noop
206 }
207
208     /**
209      * Returns the groups to show for selection.<p>
210      *
211      * @return A list of group objects
212      *
213      * @throws CmsException if womething goes wrong
214      */
215     protected List JavaDoc getGroups() throws CmsException {
216
217         List JavaDoc ret = new ArrayList JavaDoc();
218         if (getParamUser() != null) {
219             ret.addAll(getCms().getGroupsOfUser(getParamUser()));
220         } else {
221             ret.addAll(getCms().getGroups());
222         }
223         if (getParamFlags() != null) {
224             int flags = Integer.parseInt(getParamFlags());
225             return CmsPrincipal.filterFlag(ret, flags);
226         }
227         return ret;
228     }
229
230     /**
231      * @see org.opencms.workplace.list.A_CmsListDialog#getListItems()
232      */
233     protected List JavaDoc getListItems() throws CmsException {
234
235         List JavaDoc ret = new ArrayList JavaDoc();
236
237         // get content
238 List JavaDoc groups = getGroups();
239         Iterator JavaDoc itGroups = groups.iterator();
240         while (itGroups.hasNext()) {
241             CmsGroup group = (CmsGroup)itGroups.next();
242             CmsListItem item = getList().newItem(group.getId().toString());
243             item.set(LIST_COLUMN_NAME, group.getName());
244             ret.add(item);
245         }
246         return ret;
247     }
248     
249     /**
250      * @see org.opencms.workplace.list.A_CmsListDialog#setColumns(org.opencms.workplace.list.CmsListMetadata)
251      */
252     protected void setColumns(CmsListMetadata metadata) {
253
254         // create column for icon display
255 CmsListColumnDefinition iconCol = new CmsListColumnDefinition(LIST_COLUMN_ICON);
256         iconCol.setName(Messages.get().container(Messages.GUI_GROUPSELECTION_LIST_COLS_ICON_0));
257         iconCol.setHelpText(Messages.get().container(Messages.GUI_GROUPSELECTION_LIST_COLS_ICON_HELP_0));
258         iconCol.setWidth("20");
259         iconCol.setAlign(CmsListColumnAlignEnum.ALIGN_CENTER);
260         iconCol.setSorteable(false);
261         // set icon action
262 CmsListDirectAction iconAction = new CmsListDirectAction(LIST_ACTION_ICON);
263         iconAction.setName(Messages.get().container(Messages.GUI_GROUPSELECTION_LIST_ICON_NAME_0));
264         iconAction.setHelpText(Messages.get().container(Messages.GUI_GROUPSELECTION_LIST_ICON_HELP_0));
265         iconAction.setIconPath("buttons/group.png");
266         iconAction.setEnabled(false);
267         iconCol.addDirectAction(iconAction);
268         // add it to the list definition
269 metadata.addColumn(iconCol);
270
271         // create column for login
272 CmsListColumnDefinition nameCol = new CmsListColumnDefinition(LIST_COLUMN_NAME);
273         nameCol.setName(Messages.get().container(Messages.GUI_GROUPSELECTION_LIST_COLS_NAME_0));
274         nameCol.setWidth("100%");
275         CmsListDefaultAction selectAction = new A_CmsListDefaultJsAction(LIST_ACTION_SELECT) {
276
277             /**
278              * @see org.opencms.workplace.list.A_CmsListDirectJsAction#jsCode()
279              */
280             public String JavaDoc jsCode() {
281
282                 return "window.opener.setGroupFormValue('"
283                     + getItem().get(LIST_COLUMN_NAME)
284                     + "'); window.opener.focus(); window.close();";
285             }
286         };
287         selectAction.setName(Messages.get().container(Messages.GUI_GROUPSELECTION_LIST_ACTION_SELECT_NAME_0));
288         selectAction.setHelpText(Messages.get().container(Messages.GUI_GROUPSELECTION_LIST_ACTION_SELECT_HELP_0));
289         nameCol.addDefaultAction(selectAction);
290         // add it to the list definition
291 metadata.addColumn(nameCol);
292     }
293
294     /**
295      * @see org.opencms.workplace.list.A_CmsListDialog#setIndependentActions(org.opencms.workplace.list.CmsListMetadata)
296      */
297     protected void setIndependentActions(CmsListMetadata metadata) {
298
299         // no-op
300 }
301
302     /**
303      * @see org.opencms.workplace.list.A_CmsListDialog#setMultiActions(org.opencms.workplace.list.CmsListMetadata)
304      */
305     protected void setMultiActions(CmsListMetadata metadata) {
306
307         // no-op
308 }
309
310     /**
311      * @see org.opencms.workplace.list.A_CmsListDialog#validateParamaters()
312      */
313     protected void validateParamaters() throws Exception JavaDoc {
314
315         try {
316             getCms().readUser(getParamUser()).getName();
317         } catch (Exception JavaDoc e) {
318             setParamUser(null);
319         }
320         try {
321             Integer.valueOf(getParamFlags());
322         } catch (Throwable JavaDoc e) {
323             setParamFlags(null);
324         }
325     }
326 }
327
Popular Tags