Head (com.hfg API Documentation)

java.lang.Object
- com.hfg.xml.XMLContainerImpl
- - com.hfg.xml.XMLTag
  - - com.hfg.html.HTMLTag
    - - com.hfg.html.Head

All Implemented Interfaces:

HTMLNode, XMLContainer, XMLizable, XMLNode, Cloneable, Comparable
```
public class Head
extends HTMLTag
```
Represents a head (<head>) tag.

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

Head()

Head(String inTitle)
Constructor that takes the page title.

Head(XMLNode inXMLNode)

Constructors
Constructor and Description
`Head()`
`Head(String inTitle)` Constructor that takes the page title.
`Head(XMLNode inXMLNode)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Script`	`addJavascript(String inJavascript)` Adds the specified javascript to a 'script' block.
`Script`	`addJavascriptLink(String inURL)` Adds a link to an external stylesheet.
`void`	`addMetaNoCache()` Adds a '<meta http-equiv="pragma" content="no-cache" />' tag, a '<meta http-equiv="cache-control" content="no-cache" />' tag, and a '<meta http-equiv="expires" content="0" />' tag to the header.
`void`	`addMetaRefresh(int inTimeSpan, String inURL)` Adds a 'meta http-equiv="refresh"' tag to the header
`void`	`addMetaTag(String inHttpEquiv, String inValue)` Adds a 'meta' tag to the header
`Head`	`addStyle(String inStyle)` Deprecated. use addStyleTag()
`void`	`addStyleSheetLink(String inURL)` Adds a link to an external stylesheet.
`void`	`addStyleTag(String inStyle)` Adds the specified text to a 'style' block.
`void`	`clearStyle()` Removes all style content in the header.
`String`	`getStyle()` Returns the style content.
`String`	`getTitle()` Returns the page title.
`void`	`setShortcutIconLink(String inURL)` Adds a link to a shortcut icon.
`Head`	`setTitle(String inTitle)` Sets the page title.

Methods inherited from class com.hfg.html.HTMLTag
addClass, applyColorSpec, clone, getClassAttribute, getDraggable, getId, initFromXMLNode, removeClass, removeStyleProperty, setAttribute, setAttribute, setClass, setDraggable, setId, setStyle, setStyleColor, toHTML, toHTML, toHTML, toIndentedHTML, toIndentedHTML, toIndentedHTML, toText

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.XMLizable
toIndentedXML, toIndentedXML, toIndentedXML, toXML, toXML, toXML

- Constructor Detail
  - Head
```
public Head()
```
  - Head
```
public Head(String inTitle)
```
    Constructor that takes the page title.
    
    Parameters:
    
    inTitle - the page title
  - Head
```
public Head(XMLNode inXMLNode)
```
- Method Detail
  - setTitle
```
public Head setTitle(String inTitle)
```
    Sets the page title.
    
    Parameters:
    
    inTitle - the page title
    
    Returns:
    
    this Head object to enable method chaining
  - getTitle
```
public String getTitle()
```
    Returns the page title.
    
    Returns:
    
    this page title
  - addJavascriptLink
```
public Script addJavascriptLink(String inURL)
```
    Adds a link to an external stylesheet.
    
    Parameters:
    
    inURL - the URL of a javascript file for inclusion via a 'script' tag
    
    Returns:
    
    the created 'script' tag
  - addJavascript
```
public Script addJavascript(String inJavascript)
```
    Adds the specified javascript to a 'script' block.
    
    Parameters:
    
    inJavascript - javascript for inclusion via a 'script' tag
    
    Returns:
    
    the created 'script' tag
  - clearStyle
```
public void clearStyle()
```
    Removes all style content in the header.
  - addStyle
```
public Head addStyle(String inStyle)
```
    Deprecated. use addStyleTag()
    
    Overridden to redirect to addStyleTag() since addStyle doesn't make much sense for the HEAD tag anyway.
    
    Overrides:
    
    addStyle in class HTMLTag
    
    Parameters:
    
    inStyle - CSS style text for inclusion via a 'style' tag
    
    Returns:
    
    this Head object to enable method chaining
  - addStyleTag
```
public void addStyleTag(String inStyle)
```
    Adds the specified text to a 'style' block.
    
    Parameters:
    
    inStyle - CSS style text for inclusion via a 'style' tag
  - getStyle
```
public String getStyle()
```
    Returns the style content.
    
    Overrides:
    
    getStyle in class HTMLTag
    
    Returns:
    
    the content of the 'style' tag
  - addStyleSheetLink
```
public void addStyleSheetLink(String inURL)
```
    Adds a link to an external stylesheet.
    
    Parameters:
    
    inURL - the URL of a CSS file for inclusion via a 'link' tag
  - setShortcutIconLink
```
public void setShortcutIconLink(String inURL)
```
    Adds a link to a shortcut icon.
    
    Parameters:
    
    inURL - the URL of a shortcut icon file for inclusion via a 'link' tag
  - addMetaTag
```
public void addMetaTag(String inHttpEquiv,
                       String inValue)
```
    Adds a 'meta' tag to the header
    
    Parameters:
    
    inHttpEquiv - the http-equiv value
    
    inValue - the content attribute value.
  - addMetaRefresh
```
public void addMetaRefresh(int inTimeSpan,
                           String inURL)
```
    Adds a 'meta http-equiv="refresh"' tag to the header
    
    Parameters:
    
    inTimeSpan - delay in seconds before refreshing page.
    
    inURL - the URL of the page to refresh with.
  - addMetaNoCache
```
public void addMetaNoCache()
```
    Adds a '<meta http-equiv="pragma" content="no-cache" />' tag, a '<meta http-equiv="cache-control" content="no-cache" />' tag, and a '<meta http-equiv="expires" content="0" />' tag to the header.

Class Head

Nested Class Summary

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

Field Summary

Fields inherited from class com.hfg.xml.XMLContainerImpl

Constructor Summary

Method Summary

Methods inherited from class com.hfg.html.HTMLTag

Methods inherited from class com.hfg.xml.XMLTag

Methods inherited from class com.hfg.xml.XMLContainerImpl

Methods inherited from class java.lang.Object

Methods inherited from interface com.hfg.xml.XMLNode

Methods inherited from interface com.hfg.xml.XMLContainer

Methods inherited from interface com.hfg.xml.XMLizable

Constructor Detail

Head

Head

Head

Method Detail

setTitle

getTitle

addJavascriptLink

addJavascript

clearStyle

addStyle

addStyleTag

getStyle

addStyleSheetLink

setShortcutIconLink

addMetaTag

addMetaRefresh

addMetaNoCache