com.ibm.as400.util.html
Class OrderedListItem

java.lang.Object
  com.ibm.as400.util.html.HTMLTagAttributes
      com.ibm.as400.util.html.HTMLListItem
          com.ibm.as400.util.html.OrderedListItem

All Implemented Interfaces:

HTMLTagElement, Serializable

public class OrderedListItem
extends HTMLListItem

The OrderedListItem class represents an item in an ordered list item.

This example creates a OrderedListItem tag:

  // Create an OrderedList.
  OrderedList list = new OrderedList(HTMLConstants.CAPITALS);
  

  // Create an OrderedListItem.
  OrderedListItem listItem = new OrderedListItem();
  

  // Set the data in the list item.
  listItem.setItemData(new HTMLText("my list item"));
  

  // Add the list item to the OrderedList.
  list.addListItem(listItem);
  System.out.println(list.toString());
  

Here is the output of the OrderedListItem tag:

  <ol type="capitals">
  <li>my list item</li>
  </ol>
  

Here is the output of the OrderedListItem tag using XSL Formatting Objects:

  <fo:block-container>
  <fo:list-block>
  <fo:list-item>
  <fo:list-item-label>A.</fo:list-item-label>
  <fo:list-item-body><fo:block-container><fo:block>my list item</fo:block>
  </fo:block-container>
  </fo:list-item-body>
  </fo:list-item>
  </fo:list-block>
  </fo:block-container>
  

OrderedListItem objects generate the following events:

• PropertyChangeEvent

See Also:

Serialized Form

Constructor and Description

OrderedListItem()
Constructs a default OrderedListItem object.

OrderedListItem(HTMLTagElement data)
Constructs a OrderedListItem object with the specified list item data.

Method Summary

Modifier and Type	Method and Description
String	getType() Returns the type of the order labeling.
int	getValue() Returns the number for the current list item
void	setType(String type) Sets the order labeling to be used.
void	setValue(int value) Sets a number other than the incremented value for the current List Item (LI) in an Ordered List (OL.)

Methods inherited from class com.ibm.as400.util.html.HTMLListItem

getDirection, getFOTag, getItemData, getLanguage, getTag, isUseFO, setDirection, setItemData, setLanguage, setUseFO, toString

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

OrderedListItem

public OrderedListItem()

Constructs a default OrderedListItem object.

OrderedListItem

public OrderedListItem(HTMLTagElement data)

Constructs a OrderedListItem object with the specified list item data.

Parameters:

data - The data to use in the ordered list item.

Method Detail

getType

public String getType()

Returns the type of the order labeling.

Returns:

The type.

getValue

public int getValue()

Returns the number for the current list item

Returns:

The number.

setType

public void setType(String type)

Sets the order labeling to be used. The default order is by number, (1, 2, 3, etc.).

Parameters:

type - The order labeling scheme. One of the following constants defined in HTMLConstants: NUMBERS, CAPITALS, LOWER_CASE, LARGE_ROMAN, or SMALL_ROMAN.

See Also:

HTMLConstants

setValue

public void setValue(int value)

Sets a number other than the incremented value for the current List Item (LI) in an Ordered List (OL.) It is thus possible to create a non-sequential list. Values are automatically converted to the TYPE attribute, if present, of the parent OL element or current LI element. The number value must be a positive integer.

Parameters:

value - The ordered list item value.