View Javadoc
1   /**
2    * This file Copyright (c) 2011-2018 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.ui.vaadin.gwt.client.editor.dom.processor;
35  
36  import info.magnolia.ui.vaadin.gwt.client.editor.dom.MgnlElement;
37  import info.magnolia.ui.vaadin.gwt.client.editor.model.Model;
38  import info.magnolia.ui.vaadin.gwt.client.widget.controlbar.AbstractBar;
39  
40  import com.google.gwt.dom.client.Element;
41  import com.google.gwt.dom.client.Node;
42  
43  /**
44   * Abstract processor for {@link MgnlElement}s.
45   * Takes care of adding the element the {@link Model} and attaching the widgets at the right place in the DOM.
46   */
47  public abstract class AbstractMgnlElementProcessor {
48  
49      private MgnlElement mgnlElement;
50  
51      private Model model;
52  
53      private AbstractBar editBar;
54  
55      public AbstractMgnlElementProcessor(Model model, MgnlElement mgnlElement) {
56          this.model = model;
57          this.setMgnlElement(mgnlElement);
58      }
59  
60      public abstract void process();
61  
62      protected void attachWidget() {
63          attach();
64          addToModel();
65      }
66  
67      public void attach() {
68          // if there is a marker for the controlBar insert here
69          if (getMgnlElement().getEditElement() != null) {
70              Element parent = getMgnlElement().getEditElement();
71              parent.insertFirst(getEditBar().getElement());
72          } else if (getMgnlElement().getFirstElement() != null && getMgnlElement().getFirstElement() == getMgnlElement().getLastElement()) {
73              attach(getMgnlElement());
74          } else {
75              attach(getMgnlElement().getStartComment());
76          }
77          getEditBar().onAttach();
78      }
79  
80      public void attach(MgnlElement mgnlElement) {
81          Element element = mgnlElement.getFirstElement();
82          if (element != null) {
83              if (element.hasTagName("DIV")) {
84                  element.insertFirst(getEditBar().getElement());
85              } else {
86                  final Node parentNode = element.getParentNode();
87                  parentNode.insertBefore(getEditBar().getElement(), element);
88              }
89          }
90      }
91  
92      public void attach(Element element) {
93          Node parentNode = element.getParentNode();
94          parentNode.insertAfter(getEditBar().getElement(), element);
95      }
96  
97      protected void addToModel() {
98          getModel().addElements(getMgnlElement(), getEditBar().getElement());
99          getMgnlElement().setControlBar(getEditBar());
100     }
101 
102     public void setMgnlElement(MgnlElement mgnlElement) {
103         this.mgnlElement = mgnlElement;
104     }
105 
106     public MgnlElement getMgnlElement() {
107         return mgnlElement;
108     }
109 
110     public Model getModel() {
111         return model;
112     }
113 
114     protected void setEditBar(AbstractBar editBar) {
115         this.editBar = editBar;
116     }
117 
118     public AbstractBar getEditBar() {
119         return editBar;
120     }
121 
122 }