View Javadoc

1   /**
2    * This file Copyright (c) 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.templating.jsp.cms;
35  
36  import info.magnolia.rendering.template.AreaDefinition;
37  import info.magnolia.templating.elements.AreaElement;
38  
39  import java.util.Map;
40  
41  import javax.servlet.jsp.JspException;
42  
43  import org.tldgen.annotations.Attribute;
44  import org.tldgen.annotations.BodyContent;
45  import org.tldgen.annotations.Tag;
46  
47  
48  /**
49   * A jsp tag for rendering an arbitrary piece of content.
50   *
51   * @version $Id$
52   *
53   */
54  @Tag(name="area", bodyContent=BodyContent.EMPTY)
55  
56  public class AreaTag extends AbstractTag<AreaElement> {
57  
58      // Edit Tag Variable
59      private Object area;
60      private String name;
61      private String components;
62      private String dialog;
63      private String type;
64      private Object contextAttributes;
65      private Boolean editable;
66  
67  
68  
69      @Attribute(required=false, rtexprvalue=true)
70      public void setEditable(Boolean editable) {
71          this.editable = editable;
72      }
73  
74      @Attribute(required=false, rtexprvalue=true)
75      public void setArea(Object area) {
76          this.area = area;
77      }
78  
79      @Attribute(required=true, rtexprvalue=true)
80      public void setName(String name) {
81          this.name = name;
82      }
83  
84      @Attribute(required=false, rtexprvalue=true)     /**
85       * @Attribute required="false" rtexprvalue="true"
86       */
87      public void setComponents(String components) {
88          this.components = components;
89      }
90  
91      @Attribute(required=false, rtexprvalue=true)
92      public void setDialog(String dialog) {
93          this.dialog = dialog;
94      }
95  
96      @Attribute(required=false, rtexprvalue=true)
97      public void setType(String type) {
98          this.type = type;
99      }
100 
101     @Attribute(required=false, rtexprvalue=true)
102     public void setContextAttributes(Object contextAttributes) {
103         this.contextAttributes = contextAttributes;
104     }
105 
106     @Override
107     protected void prepareTemplatingElement(AreaElement templatingElement) throws JspException{
108         initContentElement(templatingElement);
109 
110         Map<String,Object> contextAttributes = mapConvertor(this.contextAttributes, "contextAttributes",false);
111         templatingElement.setArea((AreaDefinition)area);
112         templatingElement.setName(name);
113         templatingElement.setAvailableComponents(components);
114         templatingElement.setDialog(dialog);
115         templatingElement.setType(type);
116         templatingElement.setContextAttributes(contextAttributes);
117         templatingElement.setEditable(editable);
118     }
119 
120 }