1 /**
2 * This file Copyright (c) 2003-2011 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.module.admininterface.lists;
35
36 import info.magnolia.cms.gui.controlx.list.ListControl;
37 import info.magnolia.cms.gui.controlx.list.ListControlRenderer;
38
39
40 import org.apache.commons.lang.StringEscapeUtils;
41 import org.slf4j.Logger;
42 import org.slf4j.LoggerFactory;
43
44
45 /**
46 * Show the context menu if existing.
47 * @author Philipp Bracher
48 * @version $Revision: 41137 $ ($Author: gjoseph $)
49 */
50 public class AdminListControlRenderer extends ListControlRenderer {
51
52 public static Logger log = LoggerFactory.getLogger(AdminListControlRenderer.class);
53
54 private boolean border = false;
55
56 private String javaScriptClass = "mgnl.controls.List";
57
58 /**
59 * Set the admin interface list template
60 */
61 public AdminListControlRenderer() {
62 super();
63 setTemplateName("info/magnolia/module/admininterface/lists/ListControl.html");
64 }
65
66 /**
67 * Sets the selected id in the js object
68 */
69 public String onSelect(ListControl list, Integer index) {
70 return list.getName() + ".select(" + index + ");";
71 }
72
73 /**
74 * Show the context menu
75 */
76 public String onRightClick(ListControl list, Integer index) {
77 if (list.getContextMenu() != null) {
78 return list.getContextMenu().getName() + ".show(event);";
79 }
80 return "";
81 }
82
83 public String onDblClick(ListControl list, Integer index) {
84 return list.getName() + ".show();";
85 }
86
87 public String getJavaScriptObject(ListControl list, Integer index){
88 return "{" + buildJavaScriptObject(list, list.getIteratorValueObject()) + "}";
89 }
90
91 protected String buildJavaScriptObject(ListControl list, Object value) {
92 return "id: '" + toViewId(list.getIteratorId()) + "'";
93 }
94
95 public String toViewId(String id) {
96 return StringEscapeUtils.escapeJavaScript(id);
97 }
98
99 public boolean isBorder() {
100 return this.border;
101 }
102
103 public void setBorder(boolean border) {
104 this.border = border;
105 }
106
107 /**
108 * Defines the class/constructor function used to instantiate the javascript list object.
109 */
110 public String getJavaScriptClass() {
111 return this.javaScriptClass;
112 }
113
114 public void setJavaScriptClass(String javaScriptClass) {
115 this.javaScriptClass = javaScriptClass;
116 }
117
118 /**
119 * The arguments passed to the constructor.
120 */
121 public String getConstructorArguments(ListControl list){
122 return "'" + list.getName() + "', document.mgnlForm";
123 }
124 }