A
List
contains several
ListItem
s.
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:
-
First line
-
The second line is longer to see what happens once the end of the line is reached. Will it start on a new line?
-
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:
-
This is an item
-
This is another item
ALPHABETICAL
public static final boolean ALPHABETICAL
a possible value for the lettered parameter
LOWERCASE
public static final boolean LOWERCASE
a possible value for the lettered parameter
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
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
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 ListItem
s.
lowercase
protected boolean lowercase
markupAttributes
protected Properties markupAttributes
Contains extra markupAttributes
numbered
protected boolean numbered
This variable indicates if the list has to be numbered.
symbol
protected Chunk symbol
This is the listsymbol of a list that is not numbered.
symbolIndent
protected float symbolIndent
The indentation of the listitems.
List
public List()
Constructs a List
.
List
public List(Properties attributes)
Returns a List
that has been constructed taking in account
the value of some attributes.
attributes
- Some attributes
List
public List(boolean numbered)
Constructs a List
.
List
public List(boolean numbered,
boolean lettered)
Constructs a List
.
numbered
- a booleanlettered
- has the list to be 'numbered' with letters
List
public List(boolean numbered,
boolean lettered,
float symbolIndent)
Creates a list
numbered
- has the list to be numbered?lettered
- has the list to be 'numbered' with letterssymbolIndent
- the indentation of the symbol
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.
numbered
- a booleansymbolIndent
- the indentation that has to be used for the listsymbol
add
public boolean add(Object o)
Adds an Object
to the List
.
- add in interface TextElementArray
- true if adding the object succeeded
first
public int first()
Gets the first number .
getChunks
public ArrayList getChunks()
Gets all the chunks in this element.
- getChunks in interface Element
getItems
public ArrayList getItems()
Gets all the items in the list.
- an
ArrayList
containing ListItem
s.
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.
index
- a number greater than 0
- 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.
index
- a number greater than 0
- a String corresponding with the index.
indentationLeft
public float indentationLeft()
Gets the indentation of this paragraph on the left side.
indentationRight
public float indentationRight()
Gets the indentation of this paragraph on the right side.
isAlignindent
public boolean isAlignindent()
isLettered
public boolean isLettered()
Checks if the list is lettered.
true
if the list is lettered, false
otherwise.
isLowerCase
public boolean isLowerCase()
Checks if the list lettering is lowercase.
true
if it is lowercase, false
otherwise.
isNumbered
public boolean isNumbered()
Checks if the list is numbered.
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.
- true if the tag corresponds
isTag
public static boolean isTag(String tag)
Checks if a given tag corresponds with this object.
- true if the tag corresponds
leading
public float leading()
Gets the leading of the first listitem.
normalizeIndentation
public void normalizeIndentation()
process
public boolean process(ElementListener listener)
Processes the element by adding it (or the different parts) to an
ElementListener
.
- process in interface Element
listener
- an ElementListener
true
if the element was processed successfully
setAlignindent
public void setAlignindent(boolean alignindent)
alignindent
- the alignindent to set
setAutoindent
public void setAutoindent(boolean autoindent)
autoindent
- the autoindent to set
setFirst
public void setFirst(int first)
Sets the number that has to come first in the list.
setIndentationLeft
public void setIndentationLeft(float indentation)
Sets the indentation of this paragraph on the left side.
indentation
- the new indentation
setIndentationRight
public void setIndentationRight(float indentation)
Sets the indentation of this paragraph on the right side.
indentation
- the new indentation
setListSymbol
public void setListSymbol(String symbol)
Sets the listsymbol.
This is a shortcut for
setListSymbol(Chunk symbol)
.
setListSymbol
public void setListSymbol(Chunk symbol)
Sets the listsymbol.
setLowerCase
public void setLowerCase(boolean uppercase)
uppercase
- the uppercase to set
size
public int size()
Gets the size of the list.
symbol
public Chunk symbol()
Gets the Chunk containing the symbol.
symbolIndent
public float symbolIndent()
Gets the symbol indentation.
type
public int type()
Gets the type of the text element.
- type in interface Element