View Javadoc
1   /*
2    * #%L
3    * wcm.io
4    * %%
5    * Copyright (C) 2019 wcm.io
6    * %%
7    * Licensed under the Apache License, Version 2.0 (the "License");
8    * you may not use this file except in compliance with the License.
9    * You may obtain a copy of the License at
10   *
11   *      http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   * #L%
19   */
20  package io.wcm.handler.commons.dom;
21  
22  import org.osgi.annotation.versioning.ProviderType;
23  
24  /**
25   * Html area element.
26   */
27  @ProviderType
28  @SuppressWarnings("java:S110") // # parent inheritance
29  public final class Area extends HtmlElement {
30  
31    private static final long serialVersionUID = 1L;
32  
33    private static final String ELEMENT_NAME = "area";
34  
35    private static final String ATTRIBUTE_REL = "rel";
36    private static final String ATTRIBUTE_HREF = "href";
37    private static final String ATTRIBUTE_TARGET = "target";
38    private static final String ATTRIBUTE_TABINDEX = "tabindex";
39    private static final String ATTRIBUTE_ACCESSKEY = "accesskey";
40    private static final String ATTRIBUTE_ALT = "alt";
41    private static final String ATTRIBUTE_SHAPE = "shape";
42    private static final String ATTRIBUTE_COORDS = "coords";
43  
44    /**
45     * Initializes html element.
46     */
47    public Area() {
48      super(ELEMENT_NAME);
49    }
50  
51    /**
52     * Html "rel" attribute.
53     * @return Value of attribute
54     */
55    public String getRel() {
56      return getAttributeValue(ATTRIBUTE_REL);
57    }
58  
59    /**
60     * Html "rel" attribute.
61     * @param value Value of attribute
62     * @return Self reference
63     */
64    public Area setRel(String value) {
65      setAttribute(ATTRIBUTE_REL, value);
66      return this;
67    }
68  
69    /**
70     * Html "href" attribute.
71     * @return Value of attribute
72     */
73    public String getHRef() {
74      return getAttributeValue(ATTRIBUTE_HREF);
75    }
76  
77    /**
78     * Html "href" attribute.
79     * @param value Value of attribute
80     * @return Self reference
81     */
82    public Area setHRef(String value) {
83      setAttribute(ATTRIBUTE_HREF, value);
84      return this;
85    }
86  
87    /**
88     * Html "target" attribute.
89     * @return Value of attribute
90     */
91    public String getTarget() {
92      return getAttributeValue(ATTRIBUTE_TARGET);
93    }
94  
95    /**
96     * Html "target" attribute.
97     * @param value Value of attribute
98     * @return Self reference
99     */
100   public Area setTarget(String value) {
101     setAttribute(ATTRIBUTE_TARGET, value);
102     return this;
103   }
104 
105   /**
106    * Html "tabindex" attribute.
107    * @return Value of attribute
108    */
109   public int getTabIndex() {
110     return getAttributeValueAsInteger(ATTRIBUTE_TABINDEX);
111   }
112 
113   /**
114    * Html "tabindex" attribute.
115    * @param value Value of attribute
116    * @return Self reference
117    */
118   public Area setTabIndex(int value) {
119     setAttributeValueAsInteger(ATTRIBUTE_TABINDEX, value);
120     return this;
121   }
122 
123   /**
124    * Html "accesskey" attribute.
125    * @return Value of attribute
126    */
127   public String getAccessKey() {
128     return getAttributeValue(ATTRIBUTE_ACCESSKEY);
129   }
130 
131   /**
132    * Html "accesskey" attribute.
133    * @param value Value of attribute
134    * @return Self reference
135    */
136   public Area setAccessKey(String value) {
137     setAttribute(ATTRIBUTE_ACCESSKEY, value);
138     return this;
139   }
140 
141   /**
142    * Html "alt" attribute.
143    * @return Value of attribute
144    */
145   public String getAlt() {
146     return getAttributeValue(ATTRIBUTE_ALT);
147   }
148 
149   /**
150    * Html "alt" attribute.
151    * @param value Value of attribute
152    * @return Self reference
153    */
154   public Area setAlt(String value) {
155     setAttribute(ATTRIBUTE_ALT, value);
156     return this;
157   }
158 
159   /**
160    * Html "shape" attribute.
161    * @return Value of attribute
162    */
163   public String getShape() {
164     return getAttributeValue(ATTRIBUTE_SHAPE);
165   }
166 
167   /**
168    * Html "shape" attribute.
169    * @param value Value of attribute
170    * @return Self reference
171    */
172   public Area setShape(String value) {
173     setAttribute(ATTRIBUTE_SHAPE, value);
174     return this;
175   }
176 
177   /**
178    * Html "coords" attribute.
179    * @return Value of attribute
180    */
181   public String getCoords() {
182     return getAttributeValue(ATTRIBUTE_COORDS);
183   }
184 
185   /**
186    * Html "coords" attribute.
187    * @param value Value of attribute
188    * @return Self reference
189    */
190   public Area setCoords(String value) {
191     setAttribute(ATTRIBUTE_COORDS, value);
192     return this;
193   }
194 
195   // -- overwrite methods for builder pattern with covariant return types --
196 
197   @Override
198   protected Area setEmptyAttributeValueAsBoolean(String attributeName, boolean value) {
199     return (Area)super.setEmptyAttributeValueAsBoolean(attributeName, value);
200   }
201 
202   @Override
203   public Area setId(String value) {
204     return (Area)super.setId(value);
205   }
206 
207   @Override
208   public Area setCssClass(String value) {
209     return (Area)super.setCssClass(value);
210   }
211 
212   @Override
213   public Area addCssClass(String value) {
214     return (Area)super.addCssClass(value);
215   }
216 
217   @Override
218   public Area setStyleString(String value) {
219     return (Area)super.setStyleString(value);
220   }
221 
222   @Override
223   public Area setStyle(String styleAttribute, String styleValue) {
224     return (Area)super.setStyle(styleAttribute, styleValue);
225   }
226 
227   @Override
228   public Area setTitle(String value) {
229     return (Area)super.setTitle(value);
230   }
231 
232   @Override
233   public Area setData(String attributeName, String value) {
234     return (Area)super.setData(attributeName, value);
235   }
236 
237   @Override
238   public Area setAttributeValueAsLong(String name, long value) {
239     return (Area)super.setAttributeValueAsLong(name, value);
240   }
241 
242   @Override
243   public Area setText(String text) {
244     return (Area)super.setText(text);
245   }
246 
247 }