001package org.apache.maven.doxia.markup;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import javax.swing.text.html.HTML.Tag;
023
024
025/**
026 * List of <code>Html</code> tags.
027 * <p>
028 *   This should contain all valid XHTML 1.0 tags, comprising the tags in
029 *   {@link javax.swing.text.html.HTML.Tag} plus several others.
030 * </p>
031 *
032 * @see <a href="http://www.w3.org/TR/html401/index/elements.html">http://www.w3.org/TR/html401/index/elements.html</a>
033 *
034 * @author ltheussl
035 * @version $Id$
036 * @since 1.0
037 */
038@SuppressWarnings( "checkstyle:interfaceistype" )
039public interface HtmlMarkup
040    extends XmlMarkup
041{
042
043    /** A simple HTML tag. Eg <code>&lt;br/&gt;</code>. */
044    int TAG_TYPE_SIMPLE = 1;
045
046    /** A start HTML tag. Eg <code>&lt;p&gt;</code>. */
047    int TAG_TYPE_START = 2;
048
049    /** An end HTML tag. Eg <code>&lt;/p&gt;</code>. */
050    int TAG_TYPE_END = 3;
051
052    /**
053     * An HTML entity. Eg <code>&amp;lt;</code>.
054     *
055     * @since 1.1.1.
056     */
057    int ENTITY_TYPE = 4;
058
059    /**
060     * A CDATA type event.
061     *
062     * @since 1.1.1.
063     */
064    int CDATA_TYPE = 5;
065
066    // ----------------------------------------------------------------------
067    // All XHTML 1.0 tags
068    // ----------------------------------------------------------------------
069
070    /** Xhtml tag for <code>a</code>. */
071    Tag A = Tag.A;
072
073    /** Xhtml tag for <code>abbr</code>. */
074    Tag ABBR = new Tag()
075    {
076        /** {@inheritDoc} */
077        @Override
078        public String toString()
079        {
080            return "abbr";
081        }
082    };
083
084    /** Xhtml tag for <code>acronym</code>. */
085    Tag ACRONYM = new Tag()
086    {
087        /** {@inheritDoc} */
088        @Override
089        public String toString()
090        {
091            return "acronym";
092        }
093    };
094
095    /** Xhtml tag for <code>address</code>. */
096    Tag ADDRESS = Tag.ADDRESS;
097
098    /** Xhtml tag for <code>applet</code>. */
099    Tag APPLET = Tag.APPLET;
100
101    /** Xhtml tag for <code>area</code>. */
102    Tag AREA = Tag.AREA;
103
104    /** Xhtml tag for <code>b</code>. */
105    Tag B = Tag.B;
106
107    /** Xhtml tag for <code>base</code>. */
108    Tag BASE = Tag.BASE;
109
110    /** Xhtml tag for <code>basefont</code>. */
111    Tag BASEFONT = Tag.BASEFONT;
112
113    /** Xhtml tag for <code>bdo</code>. */
114    Tag BDO = new Tag()
115    {
116        /** {@inheritDoc} */
117        @Override
118        public String toString()
119        {
120            return "bdo";
121        }
122    };
123
124    /** Xhtml tag for <code>big</code>. */
125    Tag BIG = Tag.BIG;
126
127    /** Xhtml tag for <code>blockquote</code>. */
128    Tag BLOCKQUOTE = Tag.BLOCKQUOTE;
129
130    /** Xhtml tag for <code>body</code>. */
131    Tag BODY = Tag.BODY;
132
133    /** Xhtml tag for <code>br</code>. */
134    Tag BR = Tag.BR;
135
136    /** Xhtml tag for <code>button</code>. */
137    Tag BUTTON = new Tag()
138    {
139        /** {@inheritDoc} */
140        @Override
141        public String toString()
142        {
143            return "button";
144        }
145    };
146
147    /** Xhtml tag for <code>caption</code>. */
148    Tag CAPTION = Tag.CAPTION;
149
150    /** Xhtml tag for <code>center</code>. */
151    Tag CENTER = Tag.CENTER;
152
153    /** Xhtml tag for <code>cite</code>. */
154    Tag CITE = Tag.CITE;
155
156    /** Xhtml tag for <code>code</code>. */
157    Tag CODE = Tag.CODE;
158
159    /** Xhtml tag for <code>col</code>. */
160    Tag COL = new Tag()
161    {
162        /** {@inheritDoc} */
163        @Override
164        public String toString()
165        {
166            return "col";
167        }
168    };
169
170    /** Xhtml tag for <code>colgroup</code>. */
171    Tag COLGROUP = new Tag()
172    {
173        /** {@inheritDoc} */
174        @Override
175        public String toString()
176        {
177            return "colgroup";
178        }
179    };
180
181    /** Xhtml tag for <code>dd</code>. */
182    Tag DD = Tag.DD;
183
184    /** Xhtml tag for <code>del</code>. */
185    Tag DEL = new Tag()
186    {
187        /** {@inheritDoc} */
188        @Override
189        public String toString()
190        {
191            return "del";
192        }
193    };
194
195    /** Xhtml tag for <code>dfn</code>. */
196    Tag DFN = Tag.DFN;
197
198    /** Xhtml tag for <code>dir</code>. */
199    Tag DIR = Tag.DIR;
200
201    /** Xhtml tag for <code>div</code>. */
202    Tag DIV = Tag.DIV;
203
204    /** Xhtml tag for <code>dl</code>. */
205    Tag DL = Tag.DL;
206
207    /** Xhtml tag for <code>dt</code>. */
208    Tag DT = Tag.DT;
209
210    /** Xhtml tag for <code>em</code>. */
211    Tag EM = Tag.EM;
212
213    /** Xhtml tag for <code>fieldset</code>. */
214    Tag FIELDSET = new Tag()
215    {
216        /** {@inheritDoc} */
217        @Override
218        public String toString()
219        {
220            return "fieldset";
221        }
222    };
223
224    /** Xhtml tag for <code>font</code>. */
225    Tag FONT = Tag.FONT;
226
227    /** Xhtml tag for <code>form</code>. */
228    Tag FORM = Tag.FORM;
229
230    /** Xhtml tag for <code>frame</code>. */
231    Tag FRAME = Tag.FRAME;
232
233    /** Xhtml tag for <code>frameset</code>. */
234    Tag FRAMESET = Tag.FRAMESET;
235
236    /** Xhtml tag for <code>h1</code>. */
237    Tag H1 = Tag.H1;
238
239    /** Xhtml tag for <code>h2</code>. */
240    Tag H2 = Tag.H2 ;
241
242    /** Xhtml tag for <code>h3</code>. */
243    Tag H3 = Tag.H3;
244
245    /** Xhtml tag for <code>h4</code>. */
246    Tag H4 = Tag.H4;
247
248    /** Xhtml tag for <code>h5</code>. */
249    Tag H5 = Tag.H5;
250
251    /** Xhtml tag for <code>h6</code>. */
252    Tag H6 = Tag.H6;
253
254    /** Xhtml tag for <code>head</code>. */
255    Tag HEAD = Tag.HEAD;
256
257    /** Xhtml tag for <code>hr</code>. */
258    Tag HR = Tag.HR;
259
260    /** Xhtml tag for <code>html</code>. */
261    Tag HTML = Tag.HTML;
262
263    /** Xhtml tag for <code>i</code>. */
264    Tag I = Tag.I;
265
266    /** Xhtml tag for <code>iframe</code>. */
267    Tag IFRAME = new Tag()
268    {
269        /** {@inheritDoc} */
270        @Override
271        public String toString()
272        {
273            return "iframe";
274        }
275    };
276
277    /** Xhtml tag for <code>img</code>. */
278    Tag IMG = Tag.IMG;
279
280    /** Xhtml tag for <code>input</code>. */
281    Tag INPUT = Tag.INPUT;
282
283    /** Xhtml tag for <code>ins</code>. */
284    Tag INS = new Tag()
285    {
286        /** {@inheritDoc} */
287        @Override
288        public String toString()
289        {
290            return "ins";
291        }
292    };
293
294    /** Xhtml tag for <code>isindex</code>. */
295    Tag ISINDEX = Tag.ISINDEX;
296
297    /** Xhtml tag for <code>kbd</code>. */
298    Tag KBD = Tag.KBD;
299
300    /** Xhtml tag for <code>label</code>. */
301    Tag LABEL = new Tag()
302    {
303        /** {@inheritDoc} */
304        @Override
305        public String toString()
306        {
307            return "label";
308        }
309    };
310
311    /** Xhtml tag for <code>legend</code>. */
312    Tag LEGEND = new Tag()
313    {
314        /** {@inheritDoc} */
315        @Override
316        public String toString()
317        {
318            return "legend";
319        }
320    };
321
322    /** Xhtml tag for <code>li</code>. */
323    Tag LI = Tag.LI;
324
325    /** Xhtml tag for <code>link</code>. */
326    Tag LINK = Tag.LINK;
327
328    /** Xhtml tag for <code>map</code>. */
329    Tag MAP = Tag.MAP;
330
331    /** Xhtml tag for <code>menu</code>. */
332    Tag MENU = Tag.MENU;
333
334    /** Xhtml tag for <code>meta</code>. */
335    Tag META = Tag.META;
336
337    /** Xhtml tag for <code>noframes</code>. */
338    Tag NOFRAMES = Tag.NOFRAMES;
339
340    /** Xhtml tag for <code>noscript</code>. */
341    Tag NOSCRIPT = new Tag()
342    {
343        /** {@inheritDoc} */
344        @Override
345        public String toString()
346        {
347            return "noscript";
348        }
349    };
350
351    /** Xhtml tag for <code>object</code>. */
352    Tag OBJECT = Tag.OBJECT;
353
354    /** Xhtml tag for <code>ol</code>. */
355    Tag OL = Tag.OL;
356
357    /** Xhtml tag for <code>optgroup</code>. */
358    Tag OPTGROUP = new Tag()
359    {
360        /** {@inheritDoc} */
361        @Override
362        public String toString()
363        {
364            return "optgroup";
365        }
366    };
367
368    /** Xhtml tag for <code>option</code>. */
369    Tag OPTION = Tag.OPTION;
370
371    /** Xhtml tag for <code>p</code>. */
372    Tag P = Tag.P;
373
374    /** Xhtml tag for <code>param</code>. */
375    Tag PARAM = Tag.PARAM;
376
377    /** Xhtml tag for <code>pre</code>. */
378    Tag PRE = Tag.PRE;
379
380    /** Xhtml tag for <code>q</code>. */
381    Tag Q = new Tag()
382    {
383        /** {@inheritDoc} */
384        @Override
385        public String toString()
386        {
387            return "q";
388        }
389    };
390
391    /** Xhtml tag for <code>s</code>. */
392    Tag S = Tag.S;
393
394    /** Xhtml tag for <code>samp</code>. */
395    Tag SAMP = Tag.SAMP;
396
397    /** Xhtml tag for <code>script</code>. */
398    Tag SCRIPT = Tag.SCRIPT;
399
400    /** Xhtml tag for <code>select</code>. */
401    Tag SELECT = Tag.SELECT;
402
403    /** Xhtml tag for <code>small</code>. */
404    Tag SMALL = Tag.SMALL;
405
406    /** Xhtml tag for <code>span</code>. */
407    Tag SPAN = Tag.SPAN;
408
409    /** Xhtml tag for <code>strike</code>. */
410    Tag STRIKE = Tag.STRIKE;
411
412    /** Xhtml tag for <code>strong</code>. */
413    Tag STRONG = Tag.STRONG;
414
415    /** Xhtml tag for <code>style</code>. */
416    Tag STYLE = Tag.STYLE;
417
418    /** Xhtml tag for <code>sub</code>. */
419    Tag SUB = Tag.SUB;
420
421    /** Xhtml tag for <code>sup</code>. */
422    Tag SUP = Tag.SUP;
423
424    /** Xhtml tag for <code>table</code>. */
425    Tag TABLE = Tag.TABLE;
426
427    /** Xhtml tag for <code>tbody</code>. */
428    Tag TBODY = new Tag()
429    {
430        /** {@inheritDoc} */
431        @Override
432        public String toString()
433        {
434            return "tbody";
435        }
436    };
437
438    /** Xhtml tag for <code>td</code>. */
439    Tag TD = Tag.TD;
440
441    /** Xhtml tag for <code>textarea</code>. */
442    Tag TEXTAREA = Tag.TEXTAREA;
443
444    /** Xhtml tag for <code>tfoot</code>. */
445    Tag TFOOT = new Tag()
446    {
447        /** {@inheritDoc} */
448        @Override
449        public String toString()
450        {
451            return "tfoot";
452        }
453    };
454
455    /** Xhtml tag for <code>th</code>. */
456    Tag TH = Tag.TH;
457
458    /** Xhtml tag for <code>thead</code>. */
459    Tag THEAD = new Tag()
460    {
461        /** {@inheritDoc} */
462        @Override
463        public String toString()
464        {
465            return "thead";
466        }
467    };
468
469    /** Xhtml tag for <code>title</code>. */
470    Tag TITLE = Tag.TITLE;
471
472    /** Xhtml tag for <code>tr</code>. */
473    Tag TR = Tag.TR;
474
475    /** Xhtml tag for <code>tt</code>. */
476    Tag TT = Tag.TT;
477
478    /** Xhtml tag for <code>u</code>. */
479    Tag U = Tag.U;
480
481    /** Xhtml tag for <code>ul</code>. */
482    Tag UL = Tag.UL;
483
484    /** Xhtml tag for <code>var</code>. */
485    Tag VAR = Tag.VAR ;
486}