com.lowagie.text

Class List

public class List extends Object implements TextElementArray

A List contains several ListItems.

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 ListItem

Field Summary
static booleanALPHABETICAL
a possible value for the lettered parameter
protected booleanalignindent
protected booleanautoindent
protected intfirst
This variable indicates the first number of a numbered list.
protected floatindentationLeft
The indentation of this list on the left side.
protected floatindentationRight
The indentation of this list on the right side.
protected booleanlettered
protected ArrayListlist
This is the ArrayList containing the different ListItems.
protected booleanlowercase
static booleanLOWERCASE
a possible value for the lettered parameter
protected PropertiesmarkupAttributes
Contains extra markupAttributes
protected booleannumbered
This variable indicates if the list has to be numbered.
static booleanNUMBERICAL
a possible value for the lettered parameter
static booleanORDERED
a possible value for the numbered parameter
protected Chunksymbol
This is the listsymbol of a list that is not numbered.
protected floatsymbolIndent
The indentation of the listitems.
static booleanUNORDERED
a possible value for the numbered parameter
static booleanUPPERCASE
a possible value for the lettered parameter
Constructor Summary
List()
Constructs a List.
List(boolean numbered)
Constructs a List.
List(boolean numbered, boolean lettered)
Constructs a List.
List(boolean numbered, float symbolIndent)
Constructs a List.
List(boolean numbered, boolean lettered, float symbolIndent)
Creates a list
List(Properties attributes)
Returns a List that has been constructed taking in account the value of some attributes.
Method Summary
booleanadd(Object o)
Adds an Object to the List.
intfirst()
Gets the first number .
ArrayListgetChunks()
Gets all the chunks in this element.
ArrayListgetItems()
Gets all the items in the list.
static StringgetLowerCaseLetter(int index)
Translates a number to a letter(combination).
static StringgetUpperCaseLetter(int index)
Translates a number to a letter(combination).
floatindentationLeft()
Gets the indentation of this paragraph on the left side.
floatindentationRight()
Gets the indentation of this paragraph on the right side.
booleanisAlignindent()
booleanisLettered()
Checks if the list is lettered.
booleanisLowerCase()
Checks if the list lettering is lowercase.
booleanisNumbered()
Checks if the list is numbered.
static booleanisSymbol(String tag)
Checks if a given tag corresponds with the listsymbol tag of this object.
static booleanisTag(String tag)
Checks if a given tag corresponds with this object.
floatleading()
Gets the leading of the first listitem.
voidnormalizeIndentation()
booleanprocess(ElementListener listener)
Processes the element by adding it (or the different parts) to an ElementListener.
voidsetAlignindent(boolean alignindent)
voidsetAutoindent(boolean autoindent)
voidsetFirst(int first)
Sets the number that has to come first in the list.
voidsetIndentationLeft(float indentation)
Sets the indentation of this paragraph on the left side.
voidsetIndentationRight(float indentation)
Sets the indentation of this paragraph on the right side.
voidsetListSymbol(Chunk symbol)
Sets the listsymbol.
voidsetListSymbol(String symbol)
Sets the listsymbol.
voidsetLowerCase(boolean uppercase)
intsize()
Gets the size of the list.
Chunksymbol()
Gets the Chunk containing the symbol.
floatsymbolIndent()
Gets the symbol indentation.
inttype()
Gets the type of the text element.

Field Detail

ALPHABETICAL

public static final boolean ALPHABETICAL
a possible value for the lettered parameter

alignindent

protected boolean alignindent

autoindent

protected boolean autoindent

first

protected int first
This variable indicates the first number of a numbered list.

indentationLeft

protected float indentationLeft
The indentation of this list on the left side.

indentationRight

protected float indentationRight
The indentation of this list on the right side.

lettered

protected boolean lettered

list

protected ArrayList list
This is the ArrayList containing the different ListItems.

lowercase

protected boolean lowercase

LOWERCASE

public static final boolean LOWERCASE
a possible value for the lettered parameter

markupAttributes

protected Properties markupAttributes
Contains extra markupAttributes

numbered

protected boolean numbered
This variable indicates if the list has to be numbered.

NUMBERICAL

public static final boolean NUMBERICAL
a possible value for the lettered parameter

ORDERED

public static final boolean ORDERED
a possible value for the numbered parameter

symbol

protected Chunk symbol
This is the listsymbol of a list that is not numbered.

symbolIndent

protected float symbolIndent
The indentation of the listitems.

UNORDERED

public static final boolean UNORDERED
a possible value for the numbered parameter

UPPERCASE

public static final boolean UPPERCASE
a possible value for the lettered parameter

Constructor Detail

List

public List()
Constructs a List.

List

public List(boolean numbered)
Constructs a List.

Parameters: numbered a boolean

List

public List(boolean numbered, boolean lettered)
Constructs a List.

Parameters: numbered a boolean lettered has the list to be 'numbered' with letters

List

public List(boolean numbered, float symbolIndent)
Constructs a List.

Remark: the parameter symbolIndent is important for instance when generating PDF-documents; it indicates the indentation of the listsymbol. It is not important for HTML-documents.

Parameters: numbered a boolean symbolIndent the indentation that has to be used for the listsymbol

List

public List(boolean numbered, boolean lettered, float symbolIndent)
Creates a list

Parameters: numbered has the list to be numbered? lettered has the list to be 'numbered' with letters symbolIndent the indentation of the symbol

List

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

Parameters: attributes Some attributes

Method Detail

add

public boolean add(Object o)
Adds an Object to the List.

Parameters: o the object to add.

Returns: true if adding the object succeeded

first

public int first()
Gets the first number .

Returns: a number

getChunks

public ArrayList getChunks()
Gets all the chunks in this element.

Returns: an ArrayList

getItems

public ArrayList getItems()
Gets all the items in the list.

Returns: an ArrayList containing ListItems.

getLowerCaseLetter

public static String getLowerCaseLetter(int index)
Translates a number to a letter(combination). 1-26 correspond with a-z, 27 is aa, 28 is ab, and so on, aaa comes right after zz.

Parameters: index a number greater than 0

Returns: a String corresponding with the index.

getUpperCaseLetter

public static String getUpperCaseLetter(int index)
Translates a number to a letter(combination). 1-26 correspond with A-Z, 27 is AA, 28 is AB, and so on, ZZ is followed by AAA.

Parameters: index a number greater than 0

Returns: a String corresponding with the index.

indentationLeft

public float indentationLeft()
Gets the indentation of this paragraph on the left side.

Returns: the indentation

indentationRight

public float indentationRight()
Gets the indentation of this paragraph on the right side.

Returns: the indentation

isAlignindent

public boolean isAlignindent()

Returns: the alignindent

isLettered

public boolean isLettered()
Checks if the list is lettered.

Returns: true if the list is lettered, false otherwise.

isLowerCase

public boolean isLowerCase()
Checks if the list lettering is lowercase.

Returns: true if it is lowercase, false otherwise.

isNumbered

public boolean isNumbered()
Checks if the list is numbered.

Returns: true if the list is numbered, false otherwise.

isSymbol

public static boolean isSymbol(String tag)
Checks if a given tag corresponds with the listsymbol tag of this object.

Parameters: tag the given tag

Returns: true if the tag corresponds

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

leading

public float leading()
Gets the leading of the first listitem.

Returns: a leading

normalizeIndentation

public void normalizeIndentation()

process

public boolean process(ElementListener listener)
Processes the element by adding it (or the different parts) to an ElementListener.

Parameters: listener an ElementListener

Returns: true if the element was processed successfully

setAlignindent

public void setAlignindent(boolean alignindent)

Parameters: alignindent the alignindent to set

setAutoindent

public void setAutoindent(boolean autoindent)

Parameters: autoindent the autoindent to set

setFirst

public void setFirst(int first)
Sets the number that has to come first in the list.

Parameters: first a number

setIndentationLeft

public void setIndentationLeft(float indentation)
Sets the indentation of this paragraph on the left side.

Parameters: indentation the new indentation

setIndentationRight

public void setIndentationRight(float indentation)
Sets the indentation of this paragraph on the right side.

Parameters: indentation the new indentation

setListSymbol

public void setListSymbol(Chunk symbol)
Sets the listsymbol.

Parameters: symbol a Chunk

setListSymbol

public void setListSymbol(String symbol)
Sets the listsymbol.

This is a shortcut for setListSymbol(Chunk symbol).

Parameters: symbol a String

setLowerCase

public void setLowerCase(boolean uppercase)

Parameters: uppercase the uppercase to set

size

public int size()
Gets the size of the list.

Returns: a size

symbol

public Chunk symbol()
Gets the Chunk containing the symbol.

Returns: a Chunk with a symbol

symbolIndent

public float symbolIndent()
Gets the symbol indentation.

Returns: the symbol indentation

type

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

Returns: a type