View Javadoc

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