com.hfg.html

Class HTMLTag

java.lang.Object

com.hfg.xml.XMLContainerImpl

com.hfg.xml.XMLTag

com.hfg.html.HTMLTag

All Implemented Interfaces:

HTMLNode, XMLContainer, XMLizable, XMLNode, Cloneable, Comparable

Direct Known Subclasses:

Applet, Col, Colgroup, Em, Form, Frame, Frameset, H1, H2, H3, Head, HTML, HTMLTagWithCoreEvents, IFrame, InputHidden, Meta, Nobr, ObjectTag, Ol, OptGroup, Param, Script, StyleTag, TBody, TFoot, THead, Ul

public class HTMLTag
extends XMLTag
implements HTMLNode, Cloneable

Base class for HTML elements.

Nested Class Summary

Nested classes/interfaces inherited from class com.hfg.xml.XMLContainerImpl

XMLContainerImpl.sMode

Field Summary

Fields inherited from class com.hfg.xml.XMLContainerImpl

mContentAndSubtagList

Constructor Summary

Constructors

Constructor and Description
HTMLTag(String inName)
HTMLTag(String inName, Hashtable<String,String> inAttributes)
HTMLTag(String inName, Hashtable inAttributes, String inContent)
HTMLTag(XMLNode inXMLNode)

Method Summary

Modifier and Type	Method and Description
HTMLTag	addClass(String inValue)
HTMLTag	addStyle(String inValue)
HTMLTag	applyColorSpec(ColorSpec inValue)
HTMLTag	clone()
String	getClassAttribute() Not called getClass() for obvious reasons.
boolean	getDraggable()
String	getId()
String	getStyle()
protected void	initFromXMLNode(XMLNode inXMLNode)
HTMLTag	removeClass(String inValue)
HTMLTag	removeStyleProperty(CSSProperty inValue)
HTMLTag	setAttribute(String inName, Object inValue)
HTMLTag	setAttribute(XMLName inName, Object inValue)
HTMLTag	setClass(String inValue)
HTMLTag	setDraggable(boolean inValue)
HTMLTag	setId(String inValue)
HTMLTag	setStyle(CharSequence inValue)
HTMLTag	setStyleColor(Color inValue) Sets the CSS color declaration in the existing style attribute content or, if no color declaration exists, one is added.
String	toHTML()
void	toHTML(OutputStream inStream)
void	toHTML(PrintWriter inWriter)
String	toIndentedHTML(int inInitialIndentLevel, int inIndentSize)
void	toIndentedHTML(OutputStream inOutputStream, int inInitialIndentLevel, int inIndentSize)
void	toIndentedHTML(PrintWriter inWriter, int inInitialIndentLevel, int inIndentSize)
String	toText() Returns output stripped of HTML tags.

Methods inherited from class com.hfg.xml.XMLTag

addSubtag, addSubtag, addXMLNamespaceDeclaration, compareTo, equals, findNodesByAttributeValue, findNodesByAttributeValue, getAttribute, getAttribute, getAttributes, getAttributeValue, getAttributeValue, getEndTag, getNamespace, getQualifiedTagName, getStartTag, getTagName, hasAttribute, hasAttribute, hasAttributes, isEmptyTag, removeAttribute, removeAttribute, replaceCharacterEntities, setAttribute, setAttributes, setContent, setDefaultXMLNamespaceDeclaration, setNamespace, setSortAttributesBeforeWriting, setTagName, setTagName, sortAttributes, toIndentedXML, toIndentedXML, toIndentedXML, toIndentedXML, toString, toXML, toXML, toXML, toXML, useDoubleQuotes, verifyTagName, verifyTagName, verifyTagName, verifyTagName

Methods inherited from class com.hfg.xml.XMLContainerImpl

addContent, addContentWithoutEscaping, addSubtag, addSubtag, addSubtags, clearContent, clearSubtags, getContent, getContentPlusSubtagList, getNextSibling, getOptionalSubtagByName, getOptionalSubtagByName, getOptionalSubtagByName, getOptionalSubtagByName, getParentNode, getPreviousSibling, getRequiredSubtagById, getRequiredSubtagById, getRequiredSubtagByName, getRequiredSubtagByName, getSubtagByAttribute, getSubtagByAttribute, getSubtags, getSubtagsByAttribute, getSubtagsByAttribute, getSubtagsByAttribute, getSubtagsByAttribute, getSubtagsByAttribute, getSubtagsByClass, getSubtagsByClass, getSubtagsByName, getSubtagsByName, getSubtagsByName, getSubtagsByName, getSubtagsByName, getTotalTagCount, getUnescapedContent, getXMLNodeSubtags, hasContent, hasContentOrSubtags, indexOf, innerHTML, removeSubtag, removeSubtagsByAttribute, removeSubtagsByAttribute, removeSubtagsByAttribute, removeSubtagsByClass, removeSubtagsByClass, removeSubtagsByName, removeSubtagsByName, removeSubtagsByName, setContent, setParentNode, setSubtags

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.hfg.xml.XMLNode

findNodesByAttributeValue, findNodesByAttributeValue, getAttribute, getAttribute, getAttributes, getAttributeValue, getAttributeValue, getNamespace, getTagName, hasAttribute, hasAttribute, hasAttributes, isEmptyTag, removeAttribute, removeAttribute, replaceCharacterEntities, setAttribute, setAttributes, setNamespace, setTagName, setTagName, toIndentedXML, verifyTagName, verifyTagName, verifyTagName, verifyTagName

Methods inherited from interface com.hfg.xml.XMLContainer

addContent, addContentWithoutEscaping, addSubtag, addSubtags, clearContent, clearSubtags, getContent, getNextSibling, getOptionalSubtagByName, getOptionalSubtagByName, getParentNode, getPreviousSibling, getRequiredSubtagByName, getRequiredSubtagByName, getSubtags, getSubtagsByName, getSubtagsByName, getSubtagsByName, getSubtagsByName, getTotalTagCount, getUnescapedContent, getXMLNodeSubtags, hasContent, indexOf, removeSubtag, removeSubtagsByName, removeSubtagsByName, setContent, setParentNode, setSubtags

Methods inherited from interface com.hfg.xml.XMLizable

toIndentedXML, toIndentedXML, toIndentedXML, toXML, toXML, toXML

Constructor Detail

HTMLTag

public HTMLTag(String inName)

HTMLTag

public HTMLTag(String inName,
               Hashtable<String,String> inAttributes)

HTMLTag

public HTMLTag(String inName,
               Hashtable inAttributes,
               String inContent)

HTMLTag

public HTMLTag(XMLNode inXMLNode)

Method Detail

toHTML

public String toHTML()

Specified by:

toHTML in interface HTMLNode

toHTML

public void toHTML(OutputStream inStream)

toHTML

public void toHTML(PrintWriter inWriter)

Specified by:

toHTML in interface HTMLNode

toIndentedHTML

public String toIndentedHTML(int inInitialIndentLevel,
                             int inIndentSize)

toIndentedHTML

public void toIndentedHTML(OutputStream inOutputStream,
                           int inInitialIndentLevel,
                           int inIndentSize)

toIndentedHTML

public void toIndentedHTML(PrintWriter inWriter,
                           int inInitialIndentLevel,
                           int inIndentSize)

toText

public String toText()

Returns output stripped of HTML tags.

Returns:

raw text string

clone

public HTMLTag clone()

Specified by:

clone in interface XMLizable

Overrides:

clone in class XMLTag

setId

public HTMLTag setId(String inValue)

getId

public String getId()

setAttribute

public HTMLTag setAttribute(String inName,
                            Object inValue)

Specified by:

setAttribute in interface XMLNode

Overrides:

setAttribute in class XMLTag

setAttribute

public HTMLTag setAttribute(XMLName inName,
                            Object inValue)

Specified by:

setAttribute in interface XMLNode

Overrides:

setAttribute in class XMLTag

setClass

public HTMLTag setClass(String inValue)

addClass

public HTMLTag addClass(String inValue)

removeClass

public HTMLTag removeClass(String inValue)

getClassAttribute

public String getClassAttribute()

Not called getClass() for obvious reasons.

Returns:

the value of the 'class' attribute specifying one or more CSS classes

setStyle

public HTMLTag setStyle(CharSequence inValue)

getStyle

public String getStyle()

addStyle

public HTMLTag addStyle(String inValue)

removeStyleProperty

public HTMLTag removeStyleProperty(CSSProperty inValue)

applyColorSpec

public HTMLTag applyColorSpec(ColorSpec inValue)

setStyleColor

public HTMLTag setStyleColor(Color inValue)

Sets the CSS color declaration in the existing style attribute content or, if no color declaration exists, one is added.

Parameters:

inValue - Color value to use. A value of null will cause an existing color declaration to be removed.

Returns:

this HTMLTag object to facilitate method chaining

setDraggable

public HTMLTag setDraggable(boolean inValue)

getDraggable

public boolean getDraggable()

initFromXMLNode

protected void initFromXMLNode(XMLNode inXMLNode)