1. /*

  2.  * @(#)HTML.java	1.31 00/02/02

  3.  *

  4.  * Copyright 1998-2000 Sun Microsystems, Inc. All Rights Reserved.

  5.  * 

  6.  * This software is the proprietary information of Sun Microsystems, Inc.  

  7.  * Use is subject to license terms.

  8.  * 

  9.  */

  10. package javax.swing.text.html;

  11. 

  12. import java.io.*;

  13. import java.util.Hashtable;

  14. import javax.swing.text.AttributeSet;

  15. import javax.swing.text.StyleContext;

  16. 

  17. /**

  18.  * Constants used in the HTMLDocument.  These

  19.  * are basically tag and attribute definitions.

  20.  *

  21.  * @author  Timothy Prinzing

  22.  * @author  Sunita Mani

  23.  *

  24.  * @version 1.31 02/02/00

  25.  */

  26. public class HTML {

  27. 

  28.     /**

  29.      * Typesafe enumeration for an html tag.  Although the

  30.      * set of html tags is a closed set, we have let the

  31.      * set open so that people can add their own tag types

  32.      * to their custom parser and still communicate to the

  33.      * reader.

  34.      */

  35.     public static class Tag {

  36. 

  37. 	public Tag() {}

  38. 

  39.         protected Tag(String id) {

  40. 	    this(id, false, false);

  41. 	}

  42. 

  43. 	protected Tag(String id, boolean causesBreak, boolean isBlock) {

  44. 	    name = id;

  45. 	    this.breakTag = causesBreak;

  46. 	    this.blockTag = isBlock;

  47. 	}

  48. 

  49. 	/**

  50. 	 * Block tags are tags that add structure to

  51. 	 * a document.

  52. 	 */

  53. 	public boolean isBlock() {

  54. 	    return blockTag;

  55. 	}

  56. 

  57. 	/**

  58. 	 * If the tag causes a line break, to the flow of

  59. 	 * data, then this method will return true.

  60. 	 */

  61. 	public boolean breaksFlow() {

  62. 	    return breakTag;

  63. 	}

  64. 

  65. 	public boolean isPreformatted() {

  66. 	    return (this == PRE || this == TEXTAREA);

  67. 	}

  68. 

  69. 	/**

  70. 	 * Return the string representation of the

  71. 	 * tag.

  72. 	 */

  73.         public String toString() {

  74. 	    return name;

  75. 	}

  76. 

  77. 	boolean blockTag;

  78. 	boolean breakTag;

  79. 	String name;

  80. 	boolean unknown;

  81. 

  82.     	// --- Tag Names -----------------------------------

  83. 

  84.     	public static final Tag A = new Tag("a");

  85.     	public static final Tag ADDRESS = new Tag("address");

  86.     	public static final Tag APPLET = new Tag("applet");

  87.     	public static final Tag AREA = new Tag("area");

  88.     	public static final Tag B = new Tag("b");

  89.     	public static final Tag BASE = new Tag("base");

  90.     	public static final Tag BASEFONT = new Tag("basefont");

  91.     	public static final Tag BIG = new Tag("big");

  92.     	public static final Tag BLOCKQUOTE = new Tag("blockquote", true, true);

  93.     	public static final Tag BODY = new Tag("body", true, true);

  94.     	public static final Tag BR = new Tag("br", true, false);

  95.     	public static final Tag CAPTION = new Tag("caption");

  96.     	public static final Tag CENTER = new Tag("center", true, false);

  97.     	public static final Tag CITE = new Tag("cite");

  98.     	public static final Tag CODE = new Tag("code");

  99.     	public static final Tag DD = new Tag("dd", true, true);

  100.     	public static final Tag DFN = new Tag("dfn");

  101.     	public static final Tag DIR = new Tag("dir", true, true);

  102.     	public static final Tag DIV = new Tag("div", true, true);

  103.     	public static final Tag DL = new Tag("dl", true, true);

  104.     	public static final Tag DT = new Tag("dt", true, true);

  105.     	public static final Tag EM = new Tag("em");

  106.     	public static final Tag FONT = new Tag("font");

  107.     	public static final Tag FORM = new Tag("form", true, false);

  108. 	public static final Tag FRAME = new Tag("frame");

  109. 	public static final Tag FRAMESET = new Tag("frameset");

  110.     	public static final Tag H1 = new Tag("h1", true, true);

  111.     	public static final Tag H2 = new Tag("h2", true, true);

  112.     	public static final Tag H3 = new Tag("h3", true, true);

  113.     	public static final Tag H4 = new Tag("h4", true, true);

  114.     	public static final Tag H5 = new Tag("h5", true, true);

  115.     	public static final Tag H6 = new Tag("h6", true, true);

  116.     	public static final Tag HEAD = new Tag("head", true, true);

  117.     	public static final Tag HR = new Tag("hr", true, false);

  118.     	public static final Tag HTML = new Tag("html", true, false);

  119.     	public static final Tag I = new Tag("i");

  120.     	public static final Tag IMG = new Tag("img");

  121.     	public static final Tag INPUT = new Tag("input");

  122.     	public static final Tag ISINDEX = new Tag("isindex", true, false);

  123.     	public static final Tag KBD = new Tag("kbd");

  124.     	public static final Tag LI = new Tag("li", true, true);

  125.     	public static final Tag LINK = new Tag("link");

  126.     	public static final Tag MAP = new Tag("map");

  127.     	public static final Tag MENU = new Tag("menu", true, true);

  128.     	public static final Tag META = new Tag("meta");

  129. 	/*public*/ static final Tag NOBR = new Tag("nobr");

  130. 	public static final Tag NOFRAMES = new Tag("noframes", true, true);

  131.     	public static final Tag OBJECT = new Tag("object");

  132.     	public static final Tag OL = new Tag("ol", true, true);

  133.     	public static final Tag OPTION = new Tag("option");

  134.     	public static final Tag P = new Tag("p", true, true);

  135.     	public static final Tag PARAM = new Tag("param");

  136.     	public static final Tag PRE = new Tag("pre", true, true);

  137.     	public static final Tag SAMP = new Tag("samp");

  138.     	public static final Tag SCRIPT = new Tag("script");

  139.     	public static final Tag SELECT = new Tag("select");

  140.     	public static final Tag SMALL = new Tag("small");

  141.     	public static final Tag SPAN = new Tag("span");

  142.     	public static final Tag STRIKE = new Tag("strike");

  143.     	public static final Tag S = new Tag("s");

  144.     	public static final Tag STRONG = new Tag("strong");

  145.     	public static final Tag STYLE = new Tag("style");

  146.     	public static final Tag SUB = new Tag("sub");

  147.     	public static final Tag SUP = new Tag("sup");

  148.     	public static final Tag TABLE = new Tag("table", false, true);

  149.     	public static final Tag TD = new Tag("td", true, true);

  150.     	public static final Tag TEXTAREA = new Tag("textarea");

  151.     	public static final Tag TH = new Tag("th", true, true);

  152.     	public static final Tag TITLE = new Tag("title", true, true);

  153.     	public static final Tag TR = new Tag("tr", false, true);

  154.     	public static final Tag TT = new Tag("tt");

  155.     	public static final Tag U = new Tag("u");

  156.     	public static final Tag UL = new Tag("ul", true, true);

  157.     	public static final Tag VAR = new Tag("var");

  158. 

  159. 	/**

  160. 	 * All text content must be in a paragraph element.

  161. 	 * If a paragraph didn't exist when content was

  162. 	 * encountered, a paragraph is manufactured.

  163. 	 * <p>

  164. 	 * This is a tag synthesized by the html reader.

  165. 	 * Since elements are identified by their tag type,

  166. 	 * we create a some fake tag types to mark the elements

  167. 	 * that were manufactured.

  168. 	 */

  169. 	public static final Tag IMPLIED = new Tag("p-implied");

  170. 

  171. 	/**

  172. 	 * All text content is labeled with this tag.

  173. 	 * <p>

  174. 	 * This is a tag synthesized by the html reader.

  175. 	 * Since elements are identified by their tag type,

  176. 	 * we create a some fake tag types to mark the elements

  177. 	 * that were manufactured.

  178. 	 */

  179. 	public static final Tag CONTENT = new Tag("content");

  180. 

  181. 	/**

  182. 	 * All comments are labeled with this tag.

  183. 	 * <p>

  184. 	 * This is a tag synthesized by the html reader.

  185. 	 * Since elements are identified by their tag type,

  186. 	 * we create a some fake tag types to mark the elements

  187. 	 * that were manufactured.

  188. 	 */

  189. 	public static final Tag COMMENT = new Tag("comment");

  190. 

  191. 	static final Tag allTags[]  = {

  192. 	    A, ADDRESS, APPLET, AREA, B, BASE, BASEFONT, BIG,

  193. 	    BLOCKQUOTE, BODY, BR, CAPTION, CENTER, CITE, CODE,

  194. 	    DD, DFN, DIR, DIV, DL, DT, EM, FONT, FORM, FRAME,

  195. 	    FRAMESET, H1, H2, H3, H4, H5, H6, HEAD, HR, HTML,

  196. 	    I, IMG, INPUT, ISINDEX, KBD, LI, LINK, MAP, MENU,

  197. 	    META, NOBR, NOFRAMES, OBJECT, OL, OPTION, P, PARAM,

  198. 	    PRE, SAMP, SCRIPT, SELECT, SMALL, SPAN, STRIKE, S,

  199. 	    STRONG, STYLE, SUB, SUP, TABLE, TD, TEXTAREA,

  200. 	    TH, TITLE, TR, TT, U, UL, VAR	

  201. 	};

  202. 

  203. 	static {

  204. 	    // Force HTMLs static initialize to be loaded.

  205. 	    getTag("html");

  206. 	}

  207.     }

  208. 

  209.     // There is no unique instance of UnknownTag, so we allow it to be

  210.     // Serializable.

  211.     public static class UnknownTag extends Tag implements Serializable {

  212. 	

  213. 	public UnknownTag(String id) {

  214. 	    super(id);

  215. 	}

  216. 

  217. 	public int hashCode() {

  218. 	    return toString().hashCode();

  219. 	}

  220. 

  221. 	/**

  222. 	 * Compares this object to the specifed object.

  223. 	 * The result is <code>true</code> if and only if the argument is not

  224. 	 * <code>null</code> and is a <code>UnknownTag</code> object with the same

  225. 	 * name.

  226. 	 * @param     obj   the object to compare this tag with.

  227. 	 * @return    <code>true</code> if the objects are equal;

  228. 	 *            <code>false</code> otherwise.

  229. 	 */

  230.         public boolean equals(Object obj) {

  231. 	    if (obj instanceof UnknownTag) {

  232. 		return toString().equals(obj.toString());

  233. 	    }

  234. 	    return false;

  235. 	}

  236. 

  237. 	private void writeObject(java.io.ObjectOutputStream s)

  238. 	             throws IOException {

  239. 	    s.defaultWriteObject();

  240. 	    s.writeBoolean(blockTag);

  241. 	    s.writeBoolean(breakTag);

  242. 	    s.writeBoolean(unknown);

  243. 	    s.writeObject(name);

  244. 	}

  245. 

  246. 	private void readObject(ObjectInputStream s)

  247. 	    throws ClassNotFoundException, IOException {

  248. 	    s.defaultReadObject();

  249. 	    blockTag = s.readBoolean();

  250. 	    breakTag = s.readBoolean();

  251. 	    unknown = s.readBoolean();

  252. 	    name = (String)s.readObject();

  253. 	}

  254.     }

  255. 

  256.     /**

  257.      * Typesafe enumeration representing an html

  258.      * attribute.

  259.      */

  260.     public static final class Attribute {

  261. 

  262. 	Attribute(String id) {

  263. 	    name = id;

  264. 	}

  265. 

  266. 	public String toString() {

  267. 	    return name;

  268. 	}

  269. 

  270. 	private String name;

  271. 

  272. 	public static final Attribute SIZE = new Attribute("size");

  273. 	public static final Attribute COLOR = new Attribute("color");

  274. 	public static final Attribute CLEAR = new Attribute("clear");

  275. 	public static final Attribute BACKGROUND = new Attribute("background");

  276. 	public static final Attribute BGCOLOR = new Attribute("bgcolor");

  277. 	public static final Attribute TEXT = new Attribute("text");

  278. 	public static final Attribute LINK = new Attribute("link");

  279. 	public static final Attribute VLINK = new Attribute("vlink");

  280. 	public static final Attribute ALINK = new Attribute("alink");

  281. 	public static final Attribute WIDTH = new Attribute("width");

  282. 	public static final Attribute HEIGHT = new Attribute("height");

  283. 	public static final Attribute ALIGN = new Attribute("align");

  284. 	public static final Attribute NAME = new Attribute("name");

  285. 	public static final Attribute HREF = new Attribute("href");

  286. 	public static final Attribute REL = new Attribute("rel");

  287. 	public static final Attribute REV = new Attribute("rev");

  288. 	public static final Attribute TITLE = new Attribute("title");

  289. 	public static final Attribute TARGET = new Attribute("target");

  290. 	public static final Attribute SHAPE = new Attribute("shape");

  291. 	public static final Attribute COORDS = new Attribute("coords");

  292. 	public static final Attribute ISMAP = new Attribute("ismap");

  293. 	public static final Attribute NOHREF = new Attribute("nohref");

  294. 	public static final Attribute ALT = new Attribute("alt");

  295. 	public static final Attribute ID = new Attribute("id");

  296. 	public static final Attribute SRC = new Attribute("src");

  297. 	public static final Attribute HSPACE = new Attribute("hspace");

  298. 	public static final Attribute VSPACE = new Attribute("vspace");

  299. 	public static final Attribute USEMAP = new Attribute("usemap");

  300. 	public static final Attribute LOWSRC = new Attribute("lowsrc");

  301. 	public static final Attribute CODEBASE = new Attribute("codebase");

  302. 	public static final Attribute CODE = new Attribute("code");

  303. 	public static final Attribute ARCHIVE = new Attribute("archive");

  304. 	public static final Attribute VALUE = new Attribute("value");

  305. 	public static final Attribute VALUETYPE = new Attribute("valuetype");

  306. 	public static final Attribute TYPE = new Attribute("type");

  307. 	public static final Attribute CLASS = new Attribute("class");

  308. 	public static final Attribute STYLE = new Attribute("style");

  309. 	public static final Attribute LANG = new Attribute("lang");

  310. 	public static final Attribute FACE = new Attribute("face");

  311. 	public static final Attribute DIR = new Attribute("dir");

  312. 	public static final Attribute DECLARE = new Attribute("declare");

  313. 	public static final Attribute CLASSID = new Attribute("classid");

  314. 	public static final Attribute DATA = new Attribute("data");

  315. 	public static final Attribute CODETYPE = new Attribute("codetype");

  316. 	public static final Attribute STANDBY = new Attribute("standby");

  317. 	public static final Attribute BORDER = new Attribute("border");

  318. 	public static final Attribute SHAPES = new Attribute("shapes");

  319. 	public static final Attribute NOSHADE = new Attribute("noshade");

  320. 	public static final Attribute COMPACT = new Attribute("compact");

  321. 	public static final Attribute START = new Attribute("start");

  322. 	public static final Attribute ACTION = new Attribute("action");

  323. 	public static final Attribute METHOD = new Attribute("method");

  324. 	public static final Attribute ENCTYPE = new Attribute("enctype");

  325. 	public static final Attribute CHECKED = new Attribute("checked");

  326. 	public static final Attribute MAXLENGTH = new Attribute("maxlength");

  327. 	public static final Attribute MULTIPLE = new Attribute("multiple");

  328. 	public static final Attribute SELECTED = new Attribute("selected");

  329. 	public static final Attribute ROWS = new Attribute("rows");

  330. 	public static final Attribute COLS = new Attribute("cols");

  331. 	public static final Attribute DUMMY = new Attribute("dummy");

  332. 	public static final Attribute CELLSPACING = new Attribute("cellspacing");

  333. 	public static final Attribute CELLPADDING = new Attribute("cellpadding");

  334. 	public static final Attribute VALIGN = new Attribute("valign");

  335. 	public static final Attribute HALIGN = new Attribute("halign");

  336. 	public static final Attribute NOWRAP = new Attribute("nowrap");

  337. 	public static final Attribute ROWSPAN = new Attribute("rowspan");

  338. 	public static final Attribute COLSPAN = new Attribute("colspan");

  339. 	public static final Attribute PROMPT = new Attribute("prompt");

  340. 	public static final Attribute HTTPEQUIV = new Attribute("http-equiv");

  341. 	public static final Attribute CONTENT = new Attribute("content");

  342. 	public static final Attribute LANGUAGE = new Attribute("language");

  343. 	public static final Attribute VERSION = new Attribute("version");

  344. 	public static final Attribute N = new Attribute("n");

  345. 	public static final Attribute FRAMEBORDER = new Attribute("frameborder");

  346. 	public static final Attribute MARGINWIDTH = new Attribute("marginwidth");

  347. 	public static final Attribute MARGINHEIGHT = new Attribute("marginheight");

  348. 	public static final Attribute SCROLLING = new Attribute("scrolling");

  349. 	public static final Attribute NORESIZE = new Attribute("noresize");

  350. 	public static final Attribute ENDTAG = new Attribute("endtag");

  351. 	public static final Attribute COMMENT = new Attribute("comment");

  352. 	static final Attribute MEDIA = new Attribute("media");

  353. 

  354. 	static final Attribute allAttributes[] = {

  355. 	    FACE,

  356. 	    COMMENT,

  357. 	    SIZE,

  358. 	    COLOR,

  359. 	    CLEAR,

  360. 	    BACKGROUND,

  361. 	    BGCOLOR,

  362. 	    TEXT,

  363. 	    LINK,

  364. 	    VLINK,

  365. 	    ALINK,

  366. 	    WIDTH,

  367. 	    HEIGHT,

  368. 	    ALIGN,

  369. 	    NAME,

  370. 	    HREF,

  371.             REL,

  372.             REV,

  373.             TITLE,

  374.             TARGET,

  375.             SHAPE,

  376.             COORDS,

  377.             ISMAP,

  378.             NOHREF,

  379.             ALT,

  380.             ID,

  381.             SRC,

  382.             HSPACE,

  383.             VSPACE,

  384.             USEMAP,

  385.             LOWSRC,

  386.             CODEBASE,

  387.             CODE,

  388.             ARCHIVE,

  389.             VALUE,

  390.             VALUETYPE,

  391.             TYPE,

  392.             CLASS,

  393.             STYLE,

  394.             LANG,

  395.             DIR,

  396.             DECLARE,

  397.             CLASSID,

  398.             DATA,

  399.             CODETYPE,

  400.             STANDBY,

  401.             BORDER,

  402.             SHAPES,

  403.             NOSHADE,

  404.             COMPACT,

  405.             START,

  406.             ACTION,

  407.             METHOD,

  408.             ENCTYPE,

  409.             CHECKED,

  410.             MAXLENGTH,

  411.             MULTIPLE,

  412.             SELECTED,

  413.             ROWS,

  414.             COLS,

  415.             DUMMY,

  416.             CELLSPACING,

  417.             CELLPADDING,

  418.             VALIGN,

  419.             HALIGN,

  420.             NOWRAP,

  421.             ROWSPAN,

  422.             COLSPAN,

  423.             PROMPT,

  424.             HTTPEQUIV,

  425.             CONTENT,

  426.             LANGUAGE,

  427.             VERSION,

  428.             N,

  429.             FRAMEBORDER,

  430.             MARGINWIDTH,

  431.             MARGINHEIGHT,

  432.             SCROLLING,

  433.             NORESIZE,

  434.             MEDIA,

  435. 	    ENDTAG

  436. 	};

  437.     }

  438. 

  439.     // The secret to 73, is that, given that the Hashtable contents

  440.     // never change once the static initialization happens, the initial size 

  441.     // that the hashtable grew to was determined, and then that very size

  442.     // is used.

  443.     //

  444.     private static final Hashtable tagHashtable = new Hashtable(73);

  445. 

  446.     static {

  447. 

  448. 	for (int i = 0; i < Tag.allTags.length; i++ ) {

  449. 	    tagHashtable.put(Tag.allTags[i].toString(), Tag.allTags[i]);

  450. 	    StyleContext.registerStaticAttributeKey(Tag.allTags[i]);

  451. 	}

  452. 	StyleContext.registerStaticAttributeKey(Tag.IMPLIED);

  453. 	StyleContext.registerStaticAttributeKey(Tag.CONTENT);

  454. 	StyleContext.registerStaticAttributeKey(Tag.COMMENT);

  455. 	for (int i = 0; i < Attribute.allAttributes.length; i++) {

  456. 	    StyleContext.registerStaticAttributeKey(Attribute.

  457. 						    allAttributes[i]);

  458. 	}

  459.     }

  460. 

  461.     /**

  462.      * This is the set of actual html tags that

  463.      * are known about the the default html reader.

  464.      * This set does not include tags that are

  465.      * manufactured by the reader.

  466.      */

  467.     public static Tag[] getAllTags() {

  468. 	Tag[] tags = new Tag[Tag.allTags.length];

  469. 	System.arraycopy(Tag.allTags, 0, tags, 0, Tag.allTags.length);

  470. 	return tags;

  471.     }

  472. 

  473.     /**

  474.      * Fetch a tag constant for a well-known tag name (i.e. one of

  475.      * the tags in the set <code>allTags</code>).  If the given

  476.      * name does not represent one of the well-known tags, then

  477.      * null will be returned.

  478.      */

  479.     public static Tag getTag(String tagName) {

  480. 

  481. 	Object t =  tagHashtable.get(tagName);

  482. 	return (t == null ? null : (Tag)t);

  483.     }

  484. 

  485.     /**

  486.      * Fetch an integer attribute value.  Attribute values

  487.      * are stored as a string, and this is a convenience method

  488.      * to convert to an actual integer.

  489.      *

  490.      * @param attr the set of attributes to use to try to fetch a value

  491.      * @param key the key to use to fetch the value.

  492.      * @param def the default value to use if the attribute isn't

  493.      *  defined or there is an error converting to an integer.

  494.      */

  495.     public static int getIntegerAttributeValue(AttributeSet attr,

  496. 					       Attribute key, int def) {

  497. 	int value = def;

  498. 	String istr = (String) attr.getAttribute(key);

  499. 	if (istr != null) {

  500. 	    try {

  501. 		value = Integer.valueOf(istr).intValue();

  502. 	    } catch (NumberFormatException e) {

  503. 		value = def;

  504. 	    }

  505. 	}

  506. 	return value;

  507.     }

  508. 

  509.     //  This is used in cases where the value for the attribute has not

  510.     //  been specified.

  511.     //

  512.     public static final String NULL_ATTRIBUTE_VALUE = "#DEFAULT";

  513. 

  514.     // size determined similar to size of tagHashtable

  515.     private static final Hashtable attHashtable = new Hashtable(77);

  516. 

  517.     static {

  518. 

  519. 	for (int i = 0; i < Attribute.allAttributes.length; i++ ) {

  520. 	    attHashtable.put(Attribute.allAttributes[i].toString(), Attribute.allAttributes[i]);

  521. 	}

  522.     }

  523. 

  524.     /**

  525.      * This is the set of html attributes recognized.

  526.      */

  527.     public static Attribute[] getAllAttributeKeys() {

  528. 	Attribute[] attributes = new Attribute[Attribute.allAttributes.length];

  529. 	System.arraycopy(Attribute.allAttributes, 0, 

  530. 			 attributes, 0, Attribute.allAttributes.length);

  531. 	return attributes;

  532.     }

  533. 

  534.     /**

  535.      * Fetch an attribute constant for a well-known attribute name

  536.      * (i.e. one of the attributes in the set <code>allAttributes</code>).

  537.      * If the given name does not represent one of the well-known attributes,

  538.      * then null will be returned.

  539.      */

  540.     public static Attribute getAttributeKey(String attName) {

  541. 	Object a = attHashtable.get(attName);

  542. 	if (a == null) {

  543. 	  return null;

  544. 	}

  545. 	return (Attribute)a;

  546.     }

  547. 

  548. }