com.ibm.as400.util.html
Class HTMLTableCaption

java.lang.Object
  com.ibm.as400.util.html.HTMLTagAttributes
      com.ibm.as400.util.html.HTMLTableCaption

All Implemented Interfaces:

HTMLConstants, HTMLTagElement, Serializable

public class HTMLTableCaption
extends HTMLTagAttributes
implements HTMLConstants, Serializable

The HTMLTableCaption class represents an HTML Caption tag.

This example creates an HTMLTableCaption object with an HTMLText object for the caption element.

  // Create an HTMLText object for the caption text.
  HTMLText captionText = new HTMLText("MY TABLE");
  // Create the HTMLTableCaption object with the new HTMLText object.
  HTMLTableCaption caption = new HTMLTableCaption(captionText);
  // Display the tag.
  System.out.println(caption.getTag());
  

Here is the output of the tag:

  <caption>MY TABLE</caption>
  

The equivalent tag using XSL Formatting Objects is:

  <fo:block><fo:block>MY TABLE</fo:block>
  </fo:block>
  

This example creates an HTMLTableCaption object with an HTMLHyperlink object for the caption element.

  // Create an HTMLHyperlink object for the caption text.
  HTMLHyperlink companyLink = new HTMLHyperlink("http://www.myCompany.com", "My Company");
  // Create the HTMLTableCaption object with the new HTMLHyperlink object.
  HTMLTableCaption caption = new HTMLTableCaption(companyLink);
  caption.setAlignment(HTMLConstants.BOTTOM);
  // Display the tag.
  System.out.println(caption.getTag());
  

Here is the output of the tag:

  <caption align="bottom"><a href="http://www.myCompany.com>My Company"</a></caption>
  

HTMLTableCaption objects generate the following events:

• PropertyChangeEvent
• VetoableChangeEvent

See Also:

Serialized Form

Field Summary

Modifier and Type	Field and Description

Fields inherited from interface com.ibm.as400.util.html.HTMLConstants

ABSBOTTOM, ABSMIDDLE, BASELINE, BOTTOM, CAPITALS, CENTER, CIRCLE, DISC, JUSTIFY, LARGE_ROMAN, LEFT, LOWER_CASE, LTR, MIDDLE, NUMBERS, RIGHT, RTL, SMALL_ROMAN, SQUARE, TARGET_BLANK, TARGET_PARENT, TARGET_SELF, TARGET_TOP, TEXTTOP, TOP

Constructor and Description

HTMLTableCaption()
Constructs a default HTMLTableCaption object.

HTMLTableCaption(HTMLTagElement element)
Constructs an HTMLTableCaption object with the specified element.

Method Summary

Modifier and Type	Method and Description
void	addVetoableChangeListener(VetoableChangeListener listener) Adds the VetoableChangeListener.
String	getAlignment() Returns the caption alignment relative to the table.
String	getDirection() Returns the direction of the text interpretation.
HTMLTagElement	getElement() Returns the element for the caption.
String	getFOTag() Returns the XSL-FO caption tag.
String	getLanguage() Returns the language of the caption.
String	getTag() Returns the HTML caption tag.
boolean	isUseFO() Returns if Formatting Object tags are outputted.
void	removeVetoableChangeListener(VetoableChangeListener listener) Removes the VetoableChangeListener from the internal list.
void	setAlignment(String alignment) Sets the caption alignment relative to the table.
void	setDirection(String dir) Sets the direction of the text interpretation.
void	setElement(HTMLTagElement element) Sets the element for the caption.
void	setElement(String text) Sets the specified text for the caption.
void	setLanguage(String lang) Sets the language of the caption.
void	setUseFO(boolean useFO) Sets if Formatting Object tags should be used.
String	toString() Returns the HTML caption 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

HTMLTableCaption

public HTMLTableCaption()

Constructs a default HTMLTableCaption object.

HTMLTableCaption

public HTMLTableCaption(HTMLTagElement element)

Constructs an HTMLTableCaption object with the specified element.

Parameters:

element - An HTMLTagElement object.

Method Detail

addVetoableChangeListener

public void addVetoableChangeListener(VetoableChangeListener listener)

Adds the VetoableChangeListener. The specified VetoableChangeListener's vetoableChange method is called each time the value of any constrained property is changed.

Parameters:

listener - The VetoableChangeListener.

See Also:

removeVetoableChangeListener(java.beans.VetoableChangeListener)

getAlignment

public String getAlignment()

Returns the caption alignment relative to the table.

Returns:

The caption alignment. One of the following constants defined in HTMLConstants: BOTTOM, LEFT, RIGHT, or TOP.

See Also:

HTMLConstants

getDirection

public String getDirection()

Returns the direction of the text interpretation.

Returns:

The direction of the text.

getElement

public HTMLTagElement getElement()

Returns the element for the caption.

Returns:

An HTMLTagElement.

getLanguage

public String getLanguage()

Returns the language of the caption.

Returns:

The language of the caption.

getTag

public String getTag()

Returns the HTML caption tag.

Specified by:

getTag in interface HTMLTagElement

Returns:

The caption tag.

getFOTag

public String getFOTag()

Returns the XSL-FO caption tag. The language attribute is not supported in XSL-FO. The table caption will appear at the left of the page if align=left, right of the page if align=right, or at the center of the page for the rest of the alignments.

Specified by:

getFOTag in interface HTMLTagElement

Returns:

The caption tag.

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.

removeVetoableChangeListener

public void removeVetoableChangeListener(VetoableChangeListener listener)

Removes the VetoableChangeListener from the internal list. If the VetoableChangeListener is not on the list, nothing is done.

Parameters:

listener - The VetoableChangeListener.

See Also:

addVetoableChangeListener(java.beans.VetoableChangeListener)

setAlignment

public void setAlignment(String alignment)
                  throws PropertyVetoException

Sets the caption alignment relative to the table.

Parameters:

alignment - The caption alignment. One of the following constants defined in HTMLConstants: BOTTOM, LEFT, RIGHT, or TOP.

Throws:

PropertyVetoException - If the change is vetoed.

See Also:

HTMLConstants

setDirection

public void setDirection(String dir)
                  throws PropertyVetoException

Sets the direction of the text interpretation.

Parameters:

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

Throws:

PropertyVetoException - If a change is vetoed.

See Also:

HTMLConstants

setElement

public void setElement(String text)
                throws PropertyVetoException

Sets the specified text for the caption.

Parameters:

text - The caption text.

Throws:

PropertyVetoException - If the change is vetoed.

setElement

public void setElement(HTMLTagElement element)
                throws PropertyVetoException

Sets the element for the caption.

Parameters:

element - An HTMLTagElement.

Throws:

PropertyVetoException - If the change is vetoed.

setLanguage

public void setLanguage(String lang)
                 throws PropertyVetoException

Sets the language of the caption.

Parameters:

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

Throws:

PropertyVetoException - If a change is vetoed.

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 the HTML caption tag.

Overrides:

toString in class Object

Returns:

The caption tag.