View Javadoc

1   package org.apache.maven.doxia.markup;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import javax.swing.text.html.HTML.Tag;
23  
24  
25  /**
26   * List of <code>Html</code> tags.
27   * <p>
28   *   This should contain all valid XHTML 1.0 tags, comprising the tags in
29   *   {@link javax.swing.text.html.HTML.Tag} plus several others.
30   * </p>
31   *
32   * @see <a href="http://www.w3.org/TR/html401/index/elements.html">http://www.w3.org/TR/html401/index/elements.html</a>
33   *
34   * @author ltheussl
35   * @version $Id: HtmlMarkup.java 1185112 2011-10-17 11:33:00Z ltheussl $
36   * @since 1.0
37   */
38  public interface HtmlMarkup
39      extends XmlMarkup
40  {
41  
42      /** A simple HTML tag. Eg <code>&lt;br/&gt;</code>. */
43      int TAG_TYPE_SIMPLE = 1;
44  
45      /** A start HTML tag. Eg <code>&lt;p&gt;</code>. */
46      int TAG_TYPE_START = 2;
47  
48      /** An end HTML tag. Eg <code>&lt;/p&gt;</code>. */
49      int TAG_TYPE_END = 3;
50  
51      /**
52       * An HTML entity. Eg <code>&amp;lt;</code>.
53       *
54       * @since 1.1.1.
55       */
56      int ENTITY_TYPE = 4;
57  
58      /**
59       * A CDATA type event.
60       *
61       * @since 1.1.1.
62       */
63      int CDATA_TYPE = 5;
64  
65      // ----------------------------------------------------------------------
66      // All XHTML 1.0 tags
67      // ----------------------------------------------------------------------
68  
69      /** Xhtml tag for <code>a</code>. */
70      Tag A = Tag.A;
71  
72      /** Xhtml tag for <code>abbr</code>. */
73      Tag ABBR = new Tag()
74      {
75          /** {@inheritDoc} */
76          @Override
77          public String toString()
78          {
79              return "abbr";
80          }
81      };
82  
83      /** Xhtml tag for <code>acronym</code>. */
84      Tag ACRONYM = new Tag()
85      {
86          /** {@inheritDoc} */
87          @Override
88          public String toString()
89          {
90              return "acronym";
91          }
92      };
93  
94      /** Xhtml tag for <code>address</code>. */
95      Tag ADDRESS = Tag.ADDRESS;
96  
97      /** Xhtml tag for <code>applet</code>. */
98      Tag APPLET = Tag.APPLET;
99  
100     /** Xhtml tag for <code>area</code>. */
101     Tag AREA = Tag.AREA;
102 
103     /** Xhtml tag for <code>b</code>. */
104     Tag B = Tag.B;
105 
106     /** Xhtml tag for <code>base</code>. */
107     Tag BASE = Tag.BASE;
108 
109     /** Xhtml tag for <code>basefont</code>. */
110     Tag BASEFONT = Tag.BASEFONT;
111 
112     /** Xhtml tag for <code>bdo</code>. */
113     Tag BDO = new Tag()
114     {
115         /** {@inheritDoc} */
116         @Override
117         public String toString()
118         {
119             return "bdo";
120         }
121     };
122 
123     /** Xhtml tag for <code>big</code>. */
124     Tag BIG = Tag.BIG;
125 
126     /** Xhtml tag for <code>blockquote</code>. */
127     Tag BLOCKQUOTE = Tag.BLOCKQUOTE;
128 
129     /** Xhtml tag for <code>body</code>. */
130     Tag BODY = Tag.BODY;
131 
132     /** Xhtml tag for <code>br</code>. */
133     Tag BR = Tag.BR;
134 
135     /** Xhtml tag for <code>button</code>. */
136     Tag BUTTON = new Tag()
137     {
138         /** {@inheritDoc} */
139         @Override
140         public String toString()
141         {
142             return "button";
143         }
144     };
145 
146     /** Xhtml tag for <code>caption</code>. */
147     Tag CAPTION = Tag.CAPTION;
148 
149     /** Xhtml tag for <code>center</code>. */
150     Tag CENTER = Tag.CENTER;
151 
152     /** Xhtml tag for <code>cite</code>. */
153     Tag CITE = Tag.CITE;
154 
155     /** Xhtml tag for <code>code</code>. */
156     Tag CODE = Tag.CODE;
157 
158     /** Xhtml tag for <code>col</code>. */
159     Tag COL = new Tag()
160     {
161         /** {@inheritDoc} */
162         @Override
163         public String toString()
164         {
165             return "col";
166         }
167     };
168 
169     /** Xhtml tag for <code>colgroup</code>. */
170     Tag COLGROUP = new Tag()
171     {
172         /** {@inheritDoc} */
173         @Override
174         public String toString()
175         {
176             return "colgroup";
177         }
178     };
179 
180     /** Xhtml tag for <code>dd</code>. */
181     Tag DD = Tag.DD;
182 
183     /** Xhtml tag for <code>del</code>. */
184     Tag DEL = new Tag()
185     {
186         /** {@inheritDoc} */
187         @Override
188         public String toString()
189         {
190             return "del";
191         }
192     };
193 
194     /** Xhtml tag for <code>dfn</code>. */
195     Tag DFN = Tag.DFN;
196 
197     /** Xhtml tag for <code>dir</code>. */
198     Tag DIR = Tag.DIR;
199 
200     /** Xhtml tag for <code>div</code>. */
201     Tag DIV = Tag.DIV;
202 
203     /** Xhtml tag for <code>dl</code>. */
204     Tag DL = Tag.DL;
205 
206     /** Xhtml tag for <code>dt</code>. */
207     Tag DT = Tag.DT;
208 
209     /** Xhtml tag for <code>em</code>. */
210     Tag EM = Tag.EM;
211 
212     /** Xhtml tag for <code>fieldset</code>. */
213     Tag FIELDSET = new Tag()
214     {
215         /** {@inheritDoc} */
216         @Override
217         public String toString()
218         {
219             return "fieldset";
220         }
221     };
222 
223     /** Xhtml tag for <code>font</code>. */
224     Tag FONT = Tag.FONT;
225 
226     /** Xhtml tag for <code>form</code>. */
227     Tag FORM = Tag.FORM;
228 
229     /** Xhtml tag for <code>frame</code>. */
230     Tag FRAME = Tag.FRAME;
231 
232     /** Xhtml tag for <code>frameset</code>. */
233     Tag FRAMESET = Tag.FRAMESET;
234 
235     /** Xhtml tag for <code>h1</code>. */
236     Tag H1 = Tag.H1;
237 
238     /** Xhtml tag for <code>h2</code>. */
239     Tag H2 = Tag.H2 ;
240 
241     /** Xhtml tag for <code>h3</code>. */
242     Tag H3 = Tag.H3;
243 
244     /** Xhtml tag for <code>h4</code>. */
245     Tag H4 = Tag.H4;
246 
247     /** Xhtml tag for <code>h5</code>. */
248     Tag H5 = Tag.H5;
249 
250     /** Xhtml tag for <code>h6</code>. */
251     Tag H6 = Tag.H6;
252 
253     /** Xhtml tag for <code>head</code>. */
254     Tag HEAD = Tag.HEAD;
255 
256     /** Xhtml tag for <code>hr</code>. */
257     Tag HR = Tag.HR;
258 
259     /** Xhtml tag for <code>html</code>. */
260     Tag HTML = Tag.HTML;
261 
262     /** Xhtml tag for <code>i</code>. */
263     Tag I = Tag.I;
264 
265     /** Xhtml tag for <code>iframe</code>. */
266     Tag IFRAME = new Tag()
267     {
268         /** {@inheritDoc} */
269         @Override
270         public String toString()
271         {
272             return "iframe";
273         }
274     };
275 
276     /** Xhtml tag for <code>img</code>. */
277     Tag IMG = Tag.IMG;
278 
279     /** Xhtml tag for <code>input</code>. */
280     Tag INPUT = Tag.INPUT;
281 
282     /** Xhtml tag for <code>ins</code>. */
283     Tag INS = new Tag()
284     {
285         /** {@inheritDoc} */
286         @Override
287         public String toString()
288         {
289             return "ins";
290         }
291     };
292 
293     /** Xhtml tag for <code>isindex</code>. */
294     Tag ISINDEX = Tag.ISINDEX;
295 
296     /** Xhtml tag for <code>kbd</code>. */
297     Tag KBD = Tag.KBD;
298 
299     /** Xhtml tag for <code>label</code>. */
300     Tag LABEL = new Tag()
301     {
302         /** {@inheritDoc} */
303         @Override
304         public String toString()
305         {
306             return "label";
307         }
308     };
309 
310     /** Xhtml tag for <code>legend</code>. */
311     Tag LEGEND = new Tag()
312     {
313         /** {@inheritDoc} */
314         @Override
315         public String toString()
316         {
317             return "legend";
318         }
319     };
320 
321     /** Xhtml tag for <code>li</code>. */
322     Tag LI = Tag.LI;
323 
324     /** Xhtml tag for <code>link</code>. */
325     Tag LINK = Tag.LINK;
326 
327     /** Xhtml tag for <code>map</code>. */
328     Tag MAP = Tag.MAP;
329 
330     /** Xhtml tag for <code>menu</code>. */
331     Tag MENU = Tag.MENU;
332 
333     /** Xhtml tag for <code>meta</code>. */
334     Tag META = Tag.META;
335 
336     /** Xhtml tag for <code>noframes</code>. */
337     Tag NOFRAMES = Tag.NOFRAMES;
338 
339     /** Xhtml tag for <code>noscript</code>. */
340     Tag NOSCRIPT = new Tag()
341     {
342         /** {@inheritDoc} */
343         @Override
344         public String toString()
345         {
346             return "noscript";
347         }
348     };
349 
350     /** Xhtml tag for <code>object</code>. */
351     Tag OBJECT = Tag.OBJECT;
352 
353     /** Xhtml tag for <code>ol</code>. */
354     Tag OL = Tag.OL;
355 
356     /** Xhtml tag for <code>optgroup</code>. */
357     Tag OPTGROUP = new Tag()
358     {
359         /** {@inheritDoc} */
360         @Override
361         public String toString()
362         {
363             return "optgroup";
364         }
365     };
366 
367     /** Xhtml tag for <code>option</code>. */
368     Tag OPTION = Tag.OPTION;
369 
370     /** Xhtml tag for <code>p</code>. */
371     Tag P = Tag.P;
372 
373     /** Xhtml tag for <code>param</code>. */
374     Tag PARAM = Tag.PARAM;
375 
376     /** Xhtml tag for <code>pre</code>. */
377     Tag PRE = Tag.PRE;
378 
379     /** Xhtml tag for <code>q</code>. */
380     Tag Q = new Tag()
381     {
382         /** {@inheritDoc} */
383         @Override
384         public String toString()
385         {
386             return "q";
387         }
388     };
389 
390     /** Xhtml tag for <code>s</code>. */
391     Tag S = Tag.S;
392 
393     /** Xhtml tag for <code>samp</code>. */
394     Tag SAMP = Tag.SAMP;
395 
396     /** Xhtml tag for <code>script</code>. */
397     Tag SCRIPT = Tag.SCRIPT;
398 
399     /** Xhtml tag for <code>select</code>. */
400     Tag SELECT = Tag.SELECT;
401 
402     /** Xhtml tag for <code>small</code>. */
403     Tag SMALL = Tag.SMALL;
404 
405     /** Xhtml tag for <code>span</code>. */
406     Tag SPAN = Tag.SPAN;
407 
408     /** Xhtml tag for <code>strike</code>. */
409     Tag STRIKE = Tag.STRIKE;
410 
411     /** Xhtml tag for <code>strong</code>. */
412     Tag STRONG = Tag.STRONG;
413 
414     /** Xhtml tag for <code>style</code>. */
415     Tag STYLE = Tag.STYLE;
416 
417     /** Xhtml tag for <code>sub</code>. */
418     Tag SUB = Tag.SUB;
419 
420     /** Xhtml tag for <code>sup</code>. */
421     Tag SUP = Tag.SUP;
422 
423     /** Xhtml tag for <code>table</code>. */
424     Tag TABLE = Tag.TABLE;
425 
426     /** Xhtml tag for <code>tbody</code>. */
427     Tag TBODY = new Tag()
428     {
429         /** {@inheritDoc} */
430         @Override
431         public String toString()
432         {
433             return "tbody";
434         }
435     };
436 
437     /** Xhtml tag for <code>td</code>. */
438     Tag TD = Tag.TD;
439 
440     /** Xhtml tag for <code>textarea</code>. */
441     Tag TEXTAREA = Tag.TEXTAREA;
442 
443     /** Xhtml tag for <code>tfoot</code>. */
444     Tag TFOOT = new Tag()
445     {
446         /** {@inheritDoc} */
447         @Override
448         public String toString()
449         {
450             return "tfoot";
451         }
452     };
453 
454     /** Xhtml tag for <code>th</code>. */
455     Tag TH = Tag.TH;
456 
457     /** Xhtml tag for <code>thead</code>. */
458     Tag THEAD = new Tag()
459     {
460         /** {@inheritDoc} */
461         @Override
462         public String toString()
463         {
464             return "thead";
465         }
466     };
467 
468     /** Xhtml tag for <code>title</code>. */
469     Tag TITLE = Tag.TITLE;
470 
471     /** Xhtml tag for <code>tr</code>. */
472     Tag TR = Tag.TR;
473 
474     /** Xhtml tag for <code>tt</code>. */
475     Tag TT = Tag.TT;
476 
477     /** Xhtml tag for <code>u</code>. */
478     Tag U = Tag.U;
479 
480     /** Xhtml tag for <code>ul</code>. */
481     Tag UL = Tag.UL;
482 
483     /** Xhtml tag for <code>var</code>. */
484     Tag VAR = Tag.VAR ;
485 }