View Javadoc

1   /**
2    * This file Copyright (c) 2011-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.templating.editor.client.widget.controlbar;
35  
36  
37  import static info.magnolia.templating.editor.client.jsni.JavascriptUtils.getI18nMessage;
38  
39  import info.magnolia.rendering.template.AreaDefinition;
40  import info.magnolia.templating.editor.client.PageEditor;
41  import info.magnolia.templating.editor.client.dom.MgnlElement;
42  import info.magnolia.templating.elements.AreaElement;
43  
44  import java.util.Map;
45  
46  import com.google.gwt.core.client.GWT;
47  import com.google.gwt.event.dom.client.ClickEvent;
48  import com.google.gwt.event.dom.client.ClickHandler;
49  import com.google.gwt.user.client.ui.PushButton;
50  
51  
52  /**
53   * Area bar.
54   */
55  public class AreaBar extends AbstractBar {
56  
57      private String workspace;
58      private String path;
59  
60      private String name;
61      private String type;
62      private String dialog;
63      private boolean optional;
64      private boolean created;
65      private boolean isInherited;
66      private boolean editable = true;
67  
68      public AreaBar(MgnlElement mgnlElement) throws IllegalArgumentException {
69          super(mgnlElement);
70  
71          checkMandatories(mgnlElement.getAttributes());
72  
73          GWT.log("Area ["+this.name+"] is of type " + this.type);
74  
75          this.addStyleName("area");
76  
77          setVisible(false);
78          createButtons();
79  
80          attach();
81  
82      }
83  
84      private void createButtons() {
85  
86          if (this.dialog != null) {
87              // do not show edit-icon if the area has not been created
88              if (!this.optional || (this.optional && this.created)) {
89                  PushButton editButton = new PushButton();
90                  editButton.addClickHandler(new ClickHandler() {
91                      @Override
92                      public void onClick(ClickEvent event) {
93                          PageEditor.openDialog(dialog, workspace, path);
94                      }
95                  });
96                  editButton.setTitle(getI18nMessage("buttons.area.edit.js"));
97                  editButton.setStylePrimaryName("mgnlEditorPushButton");
98                  editButton.addStyleName("edit");
99                  addPrimaryButton(editButton);
100             }
101         }
102         if(this.optional) {
103             if (this.created) {
104                 PushButton removeButton = new PushButton();
105                 removeButton.addClickHandler(new ClickHandler() {
106                     @Override
107                     public void onClick(ClickEvent event) {
108                         PageEditor.deleteComponent(path);
109                     }
110                 });
111                 removeButton.setTitle(getI18nMessage("buttons.area.delete.js"));
112                 removeButton.setStylePrimaryName("mgnlEditorPushButton");
113                 removeButton.addStyleName("remove");
114                 addSecondaryButton(removeButton);
115             }
116             else {
117                 PushButton createbutton = new PushButton();
118                 createbutton.setStylePrimaryName("mgnlEditorButton");
119 
120                 createbutton.addClickHandler(new ClickHandler() {
121                     @Override
122                     public void onClick(ClickEvent event) {
123                         PageEditor.createComponent(workspace, path, "mgnl:area");
124                     }
125                 });
126                 createbutton.setTitle(getI18nMessage("buttons.area.add.js"));
127                 createbutton.setStylePrimaryName("mgnlEditorPushButton");
128                 createbutton.addStyleName("add");
129                 addSecondaryButton(createbutton);
130             }
131         }
132 
133     }
134 
135     private void checkMandatories(Map<String, String> attributes) throws IllegalArgumentException {
136 
137         String content = attributes.get("content");
138         if (content != null) {
139             int i = content.indexOf(':');
140 
141             this.workspace = content.substring(0, i);
142             this.path = content.substring(i + 1);
143         }
144 
145         this.name = attributes.get("name");
146         this.type = attributes.get("type");
147 
148         this.dialog = attributes.get("dialog");
149 
150         this.isInherited = getMgnlElement().isInherited();
151 
152         if (attributes.containsKey("editable")) {
153             this.editable = Boolean.parseBoolean(attributes.get("editable"));
154         }
155 
156         String availableComponents = "";
157         if(!AreaDefinition.TYPE_NO_COMPONENT.equals(this.type)) {
158             availableComponents = attributes.get("availableComponents");
159         }
160 
161         boolean showAddButton = Boolean.parseBoolean(attributes.get(AreaElement.SHOW_ADD_BUTTON));
162         boolean showNewComponentArea = Boolean.parseBoolean(attributes.get(AreaElement.SHOW_NEW_COMPONENT_AREA));
163 
164         this.optional = Boolean.parseBoolean(attributes.get("optional"));
165         this.created = Boolean.parseBoolean(attributes.get("created"));
166 
167         // break no matter what follows
168         if (this.isInherited || !this.editable) {
169             throw new IllegalArgumentException("Not injecting any Areabar");
170         }
171 
172         // area can be deleted or created
173        if (this.optional) {
174             return;
175         }
176 
177         else if (this.type.equals(AreaDefinition.TYPE_SINGLE)) {
178             return;
179         }
180 
181         // can show add new component area
182         else if (showNewComponentArea || (showAddButton && !availableComponents.isEmpty())) {
183             return;
184         }
185 
186         // area can be edited
187         else if (dialog != null && !dialog.isEmpty()) {
188             return;
189         }
190 
191         else {
192             throw new IllegalArgumentException("Not injecting any Areabar");
193         }
194     }
195 
196 }