com.ibm.as400.util.html
Class BidiOrdering

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

public class BidiOrdering
extends HTMLTagAttributes
implements Serializable

The BidiOrdering class represents an HTML tag used to alter the language and direction of text.

Here is an example of a BidiOrdering tag:

  <bdo lang="he" dir="rtl">
  Some Hebrew Text.
  </bdo>
  

The equivalent tag using XSL Formatting Objects looks like this:

  <fo:block-container writing-mode='rl'>
  <fo:block>Some Hebrew Text</fo:block>
  </fo:block-container>
  

BidiOrdering objects generate the following events:

See Also:
Serialized Form

Constructor Summary
BidiOrdering()
          Constructs a default BidiOrdering object.
BidiOrdering(String dir)
          Constructs a BidiOrdering object with the specified dir.
BidiOrdering(String lang, String dir)
          Constructs a BidiOrdering object with the specified lang and dir.
 
Method Summary
 void addItem(HTMLTagElement data)
          Adds an HTMLTagElement to the list elements.
 void addItem(String data)
          Adds a String to the list of elements.
 void addItemElementListener(ElementListener listener)
          Adds an ElementListener.
 String getDirection()
          Returns the direction of the text interpretation.
 String getFOTag()
          Returns the XSL formatting object's tag for the Bi-Directional Ordering.
 Vector getItems()
          Returns the list of items.
 String getLanguage()
          Returns the language of the element.
 String getTag()
          Returns the tag for the Bi-Directional Ordering.
 boolean isUseFO()
          Returns if Formatting Object tags are outputted.
 void removeItem(HTMLTagElement data)
          Removess an HTMLTagElement from the list.
 void removeItemElementListener(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 input tag.
 void setUseFO(boolean useFO)
          Sets if Formatting Object tags should be outputted.
 String toString()
          Returns a String representation for the BidiOrdering 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

BidiOrdering

public BidiOrdering()
Constructs a default BidiOrdering object.


BidiOrdering

public BidiOrdering(String dir)
Constructs a BidiOrdering object with the specified dir.

Parameters:
dir - The direction of the text being displayed.

BidiOrdering

public BidiOrdering(String lang,
                    String dir)
Constructs a BidiOrdering object with the specified lang and dir.

Parameters:
lang - The language of the text.
dir - The direction of text being displayed.
Method Detail

addItem

public void addItem(HTMLTagElement data)
Adds an HTMLTagElement to the list elements.

Parameters:
data - The data to re-order.

addItem

public void addItem(String data)
Adds a String to the list of elements.

Parameters:
data - The data to re-order.

addItemElementListener

public void addItemElementListener(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 element.

Returns:
The language of the element.

getItems

public Vector getItems()
Returns the list of items.

Returns:
The list.

getTag

public String getTag()
Returns the tag for the Bi-Directional Ordering.

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

getFOTag

public String getFOTag()
Returns the XSL formatting object's tag for the Bi-Directional Ordering. The language attribute is not supported in XSL-FO.

Specified by:
getFOTag in interface HTMLTagElement
Returns:
The 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.

removeItem

public void removeItem(HTMLTagElement data)
Removess an HTMLTagElement from the list.

Parameters:
data - The data to remove.

removeItemElementListener

public void removeItemElementListener(ElementListener listener)
Removes this ElementListener.

Parameters:
listener - The ElementListener.

setDirection

public void setDirection(String dir)
Sets the direction of the text interpretation.

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 input tag.

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

setUseFO

public void setUseFO(boolean useFO)
Sets if Formatting Object tags should be outputted. 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 BidiOrdering tag.

Overrides:
toString in class Object
Returns:
The tag.