org.pajes.html
Class OrderedList

java.lang.Object
  org.pajes.html.Tag
      org.pajes.html.TraversableElement
          org.pajes.html.Container
              org.pajes.html.ListContainer
                  org.pajes.html.OrderedList

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, HTML, Traversable

public class OrderedList
extends ListContainer

Creates an HTML Ordered List

See Also:

Serialized Form

Field Summary

Fields inherited from class org.pajes.html.Tag

ON_CLICK_ATTRIBUTE, TAG_CLOSE, TAG_LEFT, TAG_RIGHT

Constructor Summary

OrderedList()
Build a new Ordered List.

OrderedList(java.lang.String labelType)
Build a new Ordered List with the specified label type.

OrderedList(java.lang.String labelType, int startSequence)
Build a new Ordered List with the specified label type and starting number.

Method Summary

OrderedList	setLabelType(java.lang.String labelType) Set the type of labelling ('A, B, C', 'a, b, c', 'i, ii, ii') etc.
OrderedList	setStartSequence(int startSequence) Sets the starting sequence number of this list.
OrderedList	setStartSequence(java.lang.Integer startSequence) Sets the starting sequence number of this list.

Methods inherited from class org.pajes.html.ListContainer

add, add

Methods inherited from class org.pajes.html.Container

add, add, addContent, clear, clone, delete, delete, destroy, get, getContent, getContents, getPosition, insert, replace, set, setContent, setContent, size, writeContent

Methods inherited from class org.pajes.html.TraversableElement

dump, dump, getAll, getFieldByName, getFirstFieldByName, getFirstTagByAttribute, getFirstTagByClass, getFirstTagByID, getFirstTagByName, getTagByAttribute, getTagByClass, getTagByID, getTagByName, setWritable

Methods inherited from class org.pajes.html.Tag

addAttribute, addAttributes, addAttributes, clearAttribute, clearAttributes, getAttribute, getAttributes, getAttributeSet, getContainer, getDocument, getId, getOnClickHandler, getOnDBLClickHandler, getOnKeyDownHandler, getOnKeyPressHandler, getOnKeyUpHandler, getOnMouseDownHandler, getOnMouseOutHandler, getOnMouseOverHandler, getOnMouseUpHandler, getParent, getStyle, getStyleSheetClass, getTagName, getTitle, getWritePermission, hasAttribute, init, initAttributes, isChildOf, isChildOf, isWritable, isWritable, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributes, setAttributes, setContainer, setId, setOnClickHandler, setOnDBLClickHandler, setOnKeyDownHandler, setOnKeyPressHandler, setOnKeyUpHandler, setOnMouseDownHandler, setOnMouseOutHandler, setOnMouseOverHandler, setOnMouseUpHandler, setParent, setStyle, setStyleSheetClass, setTagName, setTitle, setWritable, setWriteAttributes, setWriteEndTag, setWritelnAfter, setWritelnAfterContent, setWritelnBefore, setWritelnBeforeContent, setWritePermission, toString, write

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pajes.html.Traversable

isWritable

Methods inherited from interface org.pajes.html.HTML

getContainer, getDocument, getId, getParent, getWritePermission, isChildOf, isChildOf, setContainer, setParent, setWritePermission, write

Constructor Detail

OrderedList

public OrderedList()

Build a new Ordered List.

OrderedList

public OrderedList(java.lang.String labelType)

Build a new Ordered List with the specified label type.

Parameters:

labelType - - one of ('A', 'a', 'I', 'i', '1')

OrderedList

public OrderedList(java.lang.String labelType,
                   int startSequence)

Build a new Ordered List with the specified label type and starting number.

Parameters:

labelType - - one of ('A', 'a', 'I', 'i', '1')

startSequence - - eg 3 = c, d, e, f etc.

Method Detail

setLabelType

public OrderedList setLabelType(java.lang.String labelType)

Set the type of labelling ('A, B, C', 'a, b, c', 'i, ii, ii') etc.

Parameters:

labelType - - one of ('A', 'a', 'I', 'i', '1')

Returns:

the modified OrderedList object.

Throws:

TagException - if an invalid lable type is specified.

setStartSequence

public OrderedList setStartSequence(int startSequence)

Sets the starting sequence number of this list.

Parameters:

startSequence - the number at which the list should commence.

Returns:

the modified OrderedList object.

Throws:

TagException - if start sequence is less than zero.

setStartSequence

public OrderedList setStartSequence(java.lang.Integer startSequence)

Sets the starting sequence number of this list.

Parameters:

startSequence - the number at which the list should commence.

Returns:

the modified OrderedList object.