com.lowagie.text
Class ListItem

java.lang.Object
  extended byjava.util.AbstractCollection
      extended byjava.util.AbstractList
          extended byjava.util.ArrayList
              extended bycom.lowagie.text.Phrase
                  extended bycom.lowagie.text.Paragraph
                      extended bycom.lowagie.text.ListItem
All Implemented Interfaces:
Cloneable, Collection, Element, List, MarkupAttributes, RandomAccess, Serializable, TextElementArray

public class ListItem
extends Paragraph
implements TextElementArray, MarkupAttributes

A ListItem is a Paragraph that can be added to a List.

Example 1:

 List list = new List(true, 20);
 list.add(new ListItem("First line"));
 list.add(new ListItem("The second line is longer to see what happens once the end of the line is reached. Will it start on a new line?"));
 list.add(new ListItem("Third line"));
 
The result of this code looks like this:
  1. First line
  2. The second line is longer to see what happens once the end of the line is reached. Will it start on a new line?
  3. Third line
Example 2:
 List overview = new List(false, 10);
 overview.add(new ListItem("This is an item"));
 overview.add("This is another item");
 
The result of this code looks like this:

See Also:
Element, List, Paragraph, Serialized Form

Nested Class Summary
 
Nested classes inherited from class java.util.AbstractList
 
Field Summary
private  Chunk symbol
          this is the symbol that wil proceed the listitem.
 
Fields inherited from class com.lowagie.text.Paragraph
alignment, indentationLeft, indentationRight, keeptogether
 
Fields inherited from class com.lowagie.text.Phrase
font, leading, markupAttributes
 
Fields inherited from class java.util.ArrayList
 
Fields inherited from class java.util.AbstractList
modCount
 
Fields inherited from interface com.lowagie.text.Element
ALIGN_BASELINE, ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_JUSTIFIED, ALIGN_JUSTIFIED_ALL, ALIGN_LEFT, ALIGN_MIDDLE, ALIGN_RIGHT, ALIGN_TOP, ALIGN_UNDEFINED, ANCHOR, ANNOTATION, AUTHOR, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, CCITTG3_1D, CCITTG3_2D, CCITTG4, CELL, CHAPTER, CHUNK, CREATIONDATE, CREATOR, GRAPHIC, HEADER, IMGRAW, IMGTEMPLATE, JPEG, KEYWORDS, LIST, LISTITEM, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE
 
Constructor Summary
ListItem()
          Constructs a ListItem.
ListItem(Chunk chunk)
          Constructs a ListItem with a certain Chunk.
ListItem(float leading)
          Constructs a ListItem with a certain leading.
ListItem(float leading, Chunk chunk)
          Constructs a ListItem with a certain Chunk and a certain leading.
ListItem(float leading, String string)
          Constructs a ListItem with a certain String and a certain leading.
ListItem(float leading, String string, Font font)
          Constructs a ListItem with a certain leading, String and Font.
ListItem(Phrase phrase)
          Constructs a ListItem with a certain Phrase.
ListItem(Properties attributes)
          Returns a ListItem that has been constructed taking in account the value of some attributes.
ListItem(String string)
          Constructs a ListItem with a certain String.
ListItem(String string, Font font)
          Constructs a ListItem with a certain String and a certain Font.
 
Method Summary
static boolean isTag(String tag)
          Checks if a given tag corresponds with this object.
 Chunk listSymbol()
          Returns the listsymbol.
 void setListSymbol(Chunk symbol)
          Sets the listsymbol.
 int type()
          Gets the type of the text element.
 
Methods inherited from class com.lowagie.text.Paragraph
add, alignment, getKeepTogether, indentationLeft, indentationRight, setAlignment, setAlignment, setIndentationLeft, setIndentationRight, setKeepTogether
 
Methods inherited from class com.lowagie.text.Phrase
add, addAll, addSpecial, font, getChunks, getMarkupAttribute, getMarkupAttributeNames, getMarkupAttributes, isEmpty, leading, leadingDefined, process, setLeading, setMarkupAttribute, setMarkupAttributes
 
Methods inherited from class java.util.ArrayList
addAll, clear, clone, contains, ensureCapacity, get, indexOf, lastIndexOf, remove, removeRange, set, size, toArray, toArray, trimToSize
 
Methods inherited from class java.util.AbstractList
equals, hashCode, iterator, listIterator, listIterator, subList
 
Methods inherited from class java.util.AbstractCollection
containsAll, remove, removeAll, retainAll, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.lowagie.text.TextElementArray
add
 
Methods inherited from interface com.lowagie.text.Element
getChunks, process, toString
 
Methods inherited from interface com.lowagie.text.MarkupAttributes
getMarkupAttribute, getMarkupAttributeNames, getMarkupAttributes, setMarkupAttribute, setMarkupAttributes
 
Methods inherited from interface java.util.List
containsAll, equals, hashCode, iterator, listIterator, listIterator, remove, removeAll, retainAll, subList
 

Field Detail

symbol

private Chunk symbol
this is the symbol that wil proceed the listitem.

Constructor Detail

ListItem

public ListItem()
Constructs a ListItem.


ListItem

public ListItem(float leading)
Constructs a ListItem with a certain leading.

Parameters:
leading - the leading

ListItem

public ListItem(Chunk chunk)
Constructs a ListItem with a certain Chunk.

Parameters:
chunk - a Chunk

ListItem

public ListItem(String string)
Constructs a ListItem with a certain String.

Parameters:
string - a String

ListItem

public ListItem(String string,
                Font font)
Constructs a ListItem with a certain String and a certain Font.

Parameters:
string - a String
font - a String

ListItem

public ListItem(float leading,
                Chunk chunk)
Constructs a ListItem with a certain Chunk and a certain leading.

Parameters:
leading - the leading
chunk - a Chunk

ListItem

public ListItem(float leading,
                String string)
Constructs a ListItem with a certain String and a certain leading.

Parameters:
leading - the leading
string - a String

ListItem

public ListItem(float leading,
                String string,
                Font font)
Constructs a ListItem with a certain leading, String and Font.

Parameters:
leading - the leading
string - a String
font - a Font

ListItem

public ListItem(Phrase phrase)
Constructs a ListItem with a certain Phrase.

Parameters:
phrase - a Phrase

ListItem

public ListItem(Properties attributes)
Returns a ListItem that has been constructed taking in account the value of some attributes.

Parameters:
attributes - Some attributes
Method Detail

type

public int type()
Gets the type of the text element.

Specified by:
type in interface Element
Overrides:
type in class Paragraph
Returns:
a type

setListSymbol

public void setListSymbol(Chunk symbol)
Sets the listsymbol.

Parameters:
symbol - a Chunk

listSymbol

public Chunk listSymbol()
Returns the listsymbol.

Returns:
a Chunk

isTag

public static boolean isTag(String tag)
Checks if a given tag corresponds with this object.

Parameters:
tag - the given tag
Returns:
true if the tag corresponds