View Javadoc
1   /**
2    * This file Copyright (c) 2003-2014 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$ ($Author$)
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      @Override
70      public String onSelect(ListControl list, Integer index) {
71          return list.getName() + ".select(" + index + ");";
72      }
73  
74      /**
75       * Show the context menu
76       */
77      @Override
78      public String onRightClick(ListControl list, Integer index) {
79          if (list.getContextMenu() != null) {
80              return list.getContextMenu().getName() + ".show(event);";
81          }
82          return "";
83      }
84  
85      @Override
86      public String onDblClick(ListControl list, Integer index) {
87          return list.getName() + ".show();";
88      }
89  
90      public String getJavaScriptObject(ListControl list, Integer index){
91          return "{" + buildJavaScriptObject(list, list.getIteratorValueObject()) + "}";
92      }
93  
94      protected String buildJavaScriptObject(ListControl list, Object value) {
95          return "id: '" + toViewId(list.getIteratorId()) + "'";
96      }
97  
98      public String toViewId(String id) {
99          return StringEscapeUtils.escapeJavaScript(id);
100     }
101 
102     public boolean isBorder() {
103         return this.border;
104     }
105 
106     public void setBorder(boolean border) {
107         this.border = border;
108     }
109 
110     /**
111      * Defines the class/constructor function used to instantiate the javascript list object.
112      */
113     public String getJavaScriptClass() {
114         return this.javaScriptClass;
115     }
116 
117     public void setJavaScriptClass(String javaScriptClass) {
118         this.javaScriptClass = javaScriptClass;
119     }
120 
121     /**
122      * The arguments passed to the constructor.
123      */
124     public String getConstructorArguments(ListControl list){
125         return "'" + list.getName() + "', document.mgnlForm";
126     }
127 }