com.lowagie.text

Class ListItem

Implemented Interfaces:
Element, TextElementArray

public class ListItem
extends Paragraph

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

Field Summary

private static long
serialVersionUID
private Chunk
symbol
this is the symbol that wil proceed the listitem.

Fields inherited from class com.lowagie.text.Paragraph

alignment, extraParagraphSpace, firstLineIndent, indentationLeft, indentationRight, keeptogether, multipliedLeading, serialVersionUID, spacingAfter, spacingBefore

Fields inherited from class com.lowagie.text.Phrase

font, leading, markupAttributes, serialVersionUID

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, CCITTG3_1D, CCITTG3_2D, CCITTG4, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, CELL, CHAPTER, CHUNK, CREATIONDATE, CREATOR, HEADER, IMGRAW, IMGTEMPLATE, JPEG, KEYWORDS, LIST, LISTITEM, MARKED, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE

Constructor Summary

ListItem()
Constructs a ListItem.
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.
ListItem(Chunk chunk)
Constructs a ListItem with a certain Chunk.
ListItem(Phrase phrase)
Constructs a ListItem with a certain Phrase.
ListItem(float leading)
Constructs a ListItem with 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(float leading, Chunk chunk)
Constructs a ListItem with a certain Chunk and a certain leading.

Method Summary

static boolean
isTag(String tag)
Checks if a given tag corresponds with this object.
Chunk
listSymbol()
Returns the listsymbol.
void
setIndentationLeft(float indentation, boolean autoindent)
Sets the indentation of this paragraph on the left side.
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, getExtraParagraphSpace, getFirstLineIndent, getKeepTogether, getMultipliedLeading, getTotalLeading, indentationLeft, indentationRight, isTag, setAlignment, setAlignment, setExtraParagraphSpace, setFirstLineIndent, setIndentationLeft, setIndentationRight, setKeepTogether, setLeading, setLeading, setSpacingAfter, setSpacingBefore, spacingAfter, spacingBefore, type

Methods inherited from class com.lowagie.text.Phrase

add, add, addAll, addChunk, addSpecial, content, font, getChunks, getInstance, getInstance, getInstance, isEmpty, isTag, leading, leadingDefined, process, setLeading, type

Field Details

serialVersionUID

private static final long serialVersionUID
Field Value:
1970670787169329006L

symbol

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

Constructor Details

ListItem

public ListItem()
Constructs a ListItem.

ListItem

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

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(Chunk chunk)
Constructs a ListItem with a certain Chunk.
Parameters:
chunk - a Chunk

ListItem

public ListItem(Phrase phrase)
Constructs a ListItem with a certain Phrase.
Parameters:
phrase - a Phrase

ListItem

public ListItem(float leading)
Constructs a ListItem with a certain leading.
Parameters:
leading - the leading

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(float leading,
                Chunk chunk)
Constructs a ListItem with a certain Chunk and a certain leading.
Parameters:
leading - the leading
chunk - a Chunk

Method Details

isTag

public static boolean isTag(String tag)
Checks if a given tag corresponds with this object.
Overrides:
isTag in interface Paragraph
Parameters:
tag - the given tag
Returns:
true if the tag corresponds

listSymbol

public Chunk listSymbol()
Returns the listsymbol.
Returns:
a Chunk

setIndentationLeft

public void setIndentationLeft(float indentation,
                               boolean autoindent)
Sets the indentation of this paragraph on the left side.
Parameters:
indentation - the new indentation

setListSymbol

public void setListSymbol(Chunk symbol)
Sets the listsymbol.
Parameters:
symbol - a Chunk

type

public int type()
Gets the type of the text element.
Specified by:
type in interface Element
Overrides:
type in interface Paragraph
Returns:
a type