com.ibm.as400.util.html
Class HTMLHead

java.lang.Object
  extended by com.ibm.as400.util.html.HTMLTagAttributes
      extended by com.ibm.as400.util.html.HTMLHead
All Implemented Interfaces:
HTMLTagElement, Serializable

public class HTMLHead
extends HTMLTagAttributes
implements Serializable

The HTMLHead class represents an HTML head tag, which contains information about the HTML document.

This example creates an HTMLHead tag:

  // Create an HTMLHead with a title.
  HTMLHead head = new HTMLHead("My HTML Document");
  

// Create an HTMLMeta. HTMLMeta meta = new HTMLMeta("expires", "Mon, 01 Jun 2000 12:00:00 CST"); HTMLMeta meta2 = new HTMLMeta("refresh", "5", "http://www.sample.com/next.html");

// Add the meta information to the HTMLHead head.addMetaInformation(meta); head.addMetaInformation(meta2);

Here is the output of the HTMLHead tag:

  <head>
  <meta http-equiv="expired" content="Mon, 06 Jun 2000 12:00:00 CST" />
  <meta http-equiv="refresh" content="5; URL=http://www.sample.com/next.html" />
  <title>My HTML Document</title>
  </head>
  
Using XSL Formatting Objects, the head tag represents a page header.

Calling getFOTag() would produce the following.

<fo:static-content flow-name='xsl-region-before'> <fo:block-container> My HTML Document</fo:block-container> </fo:static-content>

HTMLHead objects generate the following events:

See Also:
Serialized Form

Constructor Summary
HTMLHead()
          Constructs a default HTMLHead object.
HTMLHead(String title)
          Constructs an HTMLHead object with the specified title.
HTMLHead(String title, HTMLMeta meta)
          Constructs an HTMLHead object with the specified title and meta information.
 
Method Summary
 void addMetaInformation(HTMLMeta meta)
          Adds HTMLMeta information to the HTMLHead.
 void addMetaInformationElementListener(ElementListener listener)
          Adds an ElementListener.
 String getDirection()
          Returns the direction of the text interpretation.
 String getFOTag()
          Returns the tag for the XSL-FO header.
 String getLanguage()
          Returns the language of the head element.
 String getTag()
          Returns the tag for the HTML alignment.
 String getTitle()
          Returns the title of the HTMLHead object.
 boolean isUseFO()
          Returns if Formatting Object tags are outputted.
 void removeMetaInformation(HTMLMeta meta)
          Removes an HTMLMeta from the HTMLHead.
 void removeMetaInformationElementListener(ElementListener listener)
          Removes this ElementListener.
 void setDirection(String dir)
          Sets the direction of the text interpretation.
 void setLanguage(String lang)
          Sets the language of the HTMLHead tag.
 void setTitle(String title)
          Sets the title of the HTML document.
 void setUseFO(boolean useFO)
          Sets if Formatting Object tags should be used.
 String toString()
          Returns a String representation for the HTMLHead tag.
 
Methods inherited from class com.ibm.as400.util.html.HTMLTagAttributes
addPropertyChangeListener, getAttributes, getAttributeString, removePropertyChangeListener, setAttributes
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

HTMLHead

public HTMLHead()
Constructs a default HTMLHead object.


HTMLHead

public HTMLHead(String title)
Constructs an HTMLHead object with the specified title.

Parameters:
title - The title of the HTML document.

HTMLHead

public HTMLHead(String title,
                HTMLMeta meta)
Constructs an HTMLHead object with the specified title and meta information.

Parameters:
title - The title of the HTML document.
meta - The HTML meta information.
Method Detail

addMetaInformation

public void addMetaInformation(HTMLMeta meta)
Adds HTMLMeta information to the HTMLHead. The <head> tag contains a list of <meta> tags.

Parameters:
meta - The meta information to add.

addMetaInformationElementListener

public void addMetaInformationElementListener(ElementListener listener)
Adds an ElementListener.

Parameters:
listener - The ElementListener.

getDirection

public String getDirection()
Returns the direction of the text interpretation.

Returns:
The direction of the text.

getLanguage

public String getLanguage()
Returns the language of the head element.

Returns:
The language of the head element.

getTag

public String getTag()
Returns the tag for the HTML alignment.

Specified by:
getTag in interface HTMLTagElement
Returns:
The tag.

getFOTag

public String getFOTag()
Returns the tag for the XSL-FO header. The language attribute and Meta tags are not supported in XSL-FO.

Specified by:
getFOTag in interface HTMLTagElement
Returns:
The tag.

getTitle

public String getTitle()
Returns the title of the HTMLHead object.

Returns:
The title.

isUseFO

public boolean isUseFO()
Returns if Formatting Object tags are outputted. The default value is false.

Returns:
true if the output generated is an XSL formatting object, false if the output generated is HTML.

removeMetaInformationElementListener

public void removeMetaInformationElementListener(ElementListener listener)
Removes this ElementListener.

Parameters:
listener - The ElementListener.

removeMetaInformation

public void removeMetaInformation(HTMLMeta meta)
Removes an HTMLMeta from the HTMLHead.

Parameters:
meta - The meta information to remove.

setDirection

public void setDirection(String dir)
Sets the direction of the text interpretation. Setting the direction will add the dir attribute to both the head tag and the title tag if one is being used.

Parameters:
dir - The direction. One of the following constants defined in HTMLConstants: LTR or RTL.
See Also:
HTMLConstants

setLanguage

public void setLanguage(String lang)
Sets the language of the HTMLHead tag. Setting the language will add the lang attribute to both the head tag and the title tag if one is being used.

Parameters:
lang - The language. Example language tags include: en and en-US.

setTitle

public void setTitle(String title)
Sets the title of the HTML document.

Parameters:
title - The title of the HTML document.

setUseFO

public void setUseFO(boolean useFO)
Sets if Formatting Object tags should be used. The default value is false.

Parameters:
useFO - - true if output generated is an XSL formatting object, false if the output generated is HTML.

toString

public String toString()
Returns a String representation for the HTMLHead tag.

Overrides:
toString in class Object
Returns:
The tag.