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 779585 2009-05-28 12:43:33Z 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          public String toString()
77          {
78              return "abbr";
79          }
80      };
81  
82      /** Xhtml tag for <code>acronym</code>. */
83      Tag ACRONYM = new Tag()
84      {
85          /** {@inheritDoc} */
86          public String toString()
87          {
88              return "acronym";
89          }
90      };
91  
92      /** Xhtml tag for <code>address</code>. */
93      Tag ADDRESS = Tag.ADDRESS;
94  
95      /** Xhtml tag for <code>applet</code>. */
96      Tag APPLET = Tag.APPLET;
97  
98      /** Xhtml tag for <code>area</code>. */
99      Tag AREA = Tag.AREA;
100 
101     /** Xhtml tag for <code>b</code>. */
102     Tag B = Tag.B;
103 
104     /** Xhtml tag for <code>base</code>. */
105     Tag BASE = Tag.BASE;
106 
107     /** Xhtml tag for <code>basefont</code>. */
108     Tag BASEFONT = Tag.BASEFONT;
109 
110     /** Xhtml tag for <code>bdo</code>. */
111     Tag BDO = new Tag()
112     {
113         /** {@inheritDoc} */
114         public String toString()
115         {
116             return "bdo";
117         }
118     };
119 
120     /** Xhtml tag for <code>big</code>. */
121     Tag BIG = Tag.BIG;
122 
123     /** Xhtml tag for <code>blockquote</code>. */
124     Tag BLOCKQUOTE = Tag.BLOCKQUOTE;
125 
126     /** Xhtml tag for <code>body</code>. */
127     Tag BODY = Tag.BODY;
128 
129     /** Xhtml tag for <code>br</code>. */
130     Tag BR = Tag.BR;
131 
132     /** Xhtml tag for <code>button</code>. */
133     Tag BUTTON = new Tag()
134     {
135         /** {@inheritDoc} */
136         public String toString()
137         {
138             return "button";
139         }
140     };
141 
142     /** Xhtml tag for <code>caption</code>. */
143     Tag CAPTION = Tag.CAPTION;
144 
145     /** Xhtml tag for <code>center</code>. */
146     Tag CENTER = Tag.CENTER;
147 
148     /** Xhtml tag for <code>cite</code>. */
149     Tag CITE = Tag.CITE;
150 
151     /** Xhtml tag for <code>code</code>. */
152     Tag CODE = Tag.CODE;
153 
154     /** Xhtml tag for <code>col</code>. */
155     Tag COL = new Tag()
156     {
157         /** {@inheritDoc} */
158         public String toString()
159         {
160             return "col";
161         }
162     };
163 
164     /** Xhtml tag for <code>colgroup</code>. */
165     Tag COLGROUP = new Tag()
166     {
167         /** {@inheritDoc} */
168         public String toString()
169         {
170             return "colgroup";
171         }
172     };
173 
174     /** Xhtml tag for <code>dd</code>. */
175     Tag DD = Tag.DD;
176 
177     /** Xhtml tag for <code>del</code>. */
178     Tag DEL = new Tag()
179     {
180         /** {@inheritDoc} */
181         public String toString()
182         {
183             return "del";
184         }
185     };
186 
187     /** Xhtml tag for <code>dfn</code>. */
188     Tag DFN = Tag.DFN;
189 
190     /** Xhtml tag for <code>dir</code>. */
191     Tag DIR = Tag.DIR;
192 
193     /** Xhtml tag for <code>div</code>. */
194     Tag DIV = Tag.DIV;
195 
196     /** Xhtml tag for <code>dl</code>. */
197     Tag DL = Tag.DL;
198 
199     /** Xhtml tag for <code>dt</code>. */
200     Tag DT = Tag.DT;
201 
202     /** Xhtml tag for <code>em</code>. */
203     Tag EM = Tag.EM;
204 
205     /** Xhtml tag for <code>fieldset</code>. */
206     Tag FIELDSET = new Tag()
207     {
208         /** {@inheritDoc} */
209         public String toString()
210         {
211             return "fieldset";
212         }
213     };
214 
215     /** Xhtml tag for <code>font</code>. */
216     Tag FONT = Tag.FONT;
217 
218     /** Xhtml tag for <code>form</code>. */
219     Tag FORM = Tag.FORM;
220 
221     /** Xhtml tag for <code>frame</code>. */
222     Tag FRAME = Tag.FRAME;
223 
224     /** Xhtml tag for <code>frameset</code>. */
225     Tag FRAMESET = Tag.FRAMESET;
226 
227     /** Xhtml tag for <code>h1</code>. */
228     Tag H1 = Tag.H1;
229 
230     /** Xhtml tag for <code>h2</code>. */
231     Tag H2 = Tag.H2 ;
232 
233     /** Xhtml tag for <code>h3</code>. */
234     Tag H3 = Tag.H3;
235 
236     /** Xhtml tag for <code>h4</code>. */
237     Tag H4 = Tag.H4;
238 
239     /** Xhtml tag for <code>h5</code>. */
240     Tag H5 = Tag.H5;
241 
242     /** Xhtml tag for <code>h6</code>. */
243     Tag H6 = Tag.H6;
244 
245     /** Xhtml tag for <code>head</code>. */
246     Tag HEAD = Tag.HEAD;
247 
248     /** Xhtml tag for <code>hr</code>. */
249     Tag HR = Tag.HR;
250 
251     /** Xhtml tag for <code>html</code>. */
252     Tag HTML = Tag.HTML;
253 
254     /** Xhtml tag for <code>i</code>. */
255     Tag I = Tag.I;
256 
257     /** Xhtml tag for <code>iframe</code>. */
258     Tag IFRAME = new Tag()
259     {
260         /** {@inheritDoc} */
261         public String toString()
262         {
263             return "iframe";
264         }
265     };
266 
267     /** Xhtml tag for <code>img</code>. */
268     Tag IMG = Tag.IMG;
269 
270     /** Xhtml tag for <code>input</code>. */
271     Tag INPUT = Tag.INPUT;
272 
273     /** Xhtml tag for <code>ins</code>. */
274     Tag INS = new Tag()
275     {
276         /** {@inheritDoc} */
277         public String toString()
278         {
279             return "ins";
280         }
281     };
282 
283     /** Xhtml tag for <code>isindex</code>. */
284     Tag ISINDEX = Tag.ISINDEX;
285 
286     /** Xhtml tag for <code>kbd</code>. */
287     Tag KBD = Tag.KBD;
288 
289     /** Xhtml tag for <code>label</code>. */
290     Tag LABEL = new Tag()
291     {
292         /** {@inheritDoc} */
293         public String toString()
294         {
295             return "label";
296         }
297     };
298 
299     /** Xhtml tag for <code>legend</code>. */
300     Tag LEGEND = new Tag()
301     {
302         /** {@inheritDoc} */
303         public String toString()
304         {
305             return "legend";
306         }
307     };
308 
309     /** Xhtml tag for <code>li</code>. */
310     Tag LI = Tag.LI;
311 
312     /** Xhtml tag for <code>link</code>. */
313     Tag LINK = Tag.LINK;
314 
315     /** Xhtml tag for <code>map</code>. */
316     Tag MAP = Tag.MAP;
317 
318     /** Xhtml tag for <code>menu</code>. */
319     Tag MENU = Tag.MENU;
320 
321     /** Xhtml tag for <code>meta</code>. */
322     Tag META = Tag.META;
323 
324     /** Xhtml tag for <code>noframes</code>. */
325     Tag NOFRAMES = Tag.NOFRAMES;
326 
327     /** Xhtml tag for <code>noscript</code>. */
328     Tag NOSCRIPT = new Tag()
329     {
330         /** {@inheritDoc} */
331         public String toString()
332         {
333             return "noscript";
334         }
335     };
336 
337     /** Xhtml tag for <code>object</code>. */
338     Tag OBJECT = Tag.OBJECT;
339 
340     /** Xhtml tag for <code>ol</code>. */
341     Tag OL = Tag.OL;
342 
343     /** Xhtml tag for <code>optgroup</code>. */
344     Tag OPTGROUP = new Tag()
345     {
346         /** {@inheritDoc} */
347         public String toString()
348         {
349             return "optgroup";
350         }
351     };
352 
353     /** Xhtml tag for <code>option</code>. */
354     Tag OPTION = Tag.OPTION;
355 
356     /** Xhtml tag for <code>p</code>. */
357     Tag P = Tag.P;
358 
359     /** Xhtml tag for <code>param</code>. */
360     Tag PARAM = Tag.PARAM;
361 
362     /** Xhtml tag for <code>pre</code>. */
363     Tag PRE = Tag.PRE;
364 
365     /** Xhtml tag for <code>q</code>. */
366     Tag Q = new Tag()
367     {
368         /** {@inheritDoc} */
369         public String toString()
370         {
371             return "q";
372         }
373     };
374 
375     /** Xhtml tag for <code>s</code>. */
376     Tag S = Tag.S;
377 
378     /** Xhtml tag for <code>samp</code>. */
379     Tag SAMP = Tag.SAMP;
380 
381     /** Xhtml tag for <code>script</code>. */
382     Tag SCRIPT = Tag.SCRIPT;
383 
384     /** Xhtml tag for <code>select</code>. */
385     Tag SELECT = Tag.SELECT;
386 
387     /** Xhtml tag for <code>small</code>. */
388     Tag SMALL = Tag.SMALL;
389 
390     /** Xhtml tag for <code>span</code>. */
391     Tag SPAN = Tag.SPAN;
392 
393     /** Xhtml tag for <code>strike</code>. */
394     Tag STRIKE = Tag.STRIKE;
395 
396     /** Xhtml tag for <code>strong</code>. */
397     Tag STRONG = Tag.STRONG;
398 
399     /** Xhtml tag for <code>style</code>. */
400     Tag STYLE = Tag.STYLE;
401 
402     /** Xhtml tag for <code>sub</code>. */
403     Tag SUB = Tag.SUB;
404 
405     /** Xhtml tag for <code>sup</code>. */
406     Tag SUP = Tag.SUP;
407 
408     /** Xhtml tag for <code>table</code>. */
409     Tag TABLE = Tag.TABLE;
410 
411     /** Xhtml tag for <code>tbody</code>. */
412     Tag TBODY = new Tag()
413     {
414         /** {@inheritDoc} */
415         public String toString()
416         {
417             return "tbody";
418         }
419     };
420 
421     /** Xhtml tag for <code>td</code>. */
422     Tag TD = Tag.TD;
423 
424     /** Xhtml tag for <code>textarea</code>. */
425     Tag TEXTAREA = Tag.TEXTAREA;
426 
427     /** Xhtml tag for <code>tfoot</code>. */
428     Tag TFOOT = new Tag()
429     {
430         /** {@inheritDoc} */
431         public String toString()
432         {
433             return "tfoot";
434         }
435     };
436 
437     /** Xhtml tag for <code>th</code>. */
438     Tag TH = Tag.TH;
439 
440     /** Xhtml tag for <code>thead</code>. */
441     Tag THEAD = new Tag()
442     {
443         /** {@inheritDoc} */
444         public String toString()
445         {
446             return "thead";
447         }
448     };
449 
450     /** Xhtml tag for <code>title</code>. */
451     Tag TITLE = Tag.TITLE;
452 
453     /** Xhtml tag for <code>tr</code>. */
454     Tag TR = Tag.TR;
455 
456     /** Xhtml tag for <code>tt</code>. */
457     Tag TT = Tag.TT;
458 
459     /** Xhtml tag for <code>u</code>. */
460     Tag U = Tag.U;
461 
462     /** Xhtml tag for <code>ul</code>. */
463     Tag UL = Tag.UL;
464 
465     /** Xhtml tag for <code>var</code>. */
466     Tag VAR = Tag.VAR ;
467 }