Package com.lowagie.text
Class List
java.lang.Object
com.lowagie.text.List
- All Implemented Interfaces:
Element
,TextElementArray
- Direct Known Subclasses:
GreekList
,RomanList
,ZapfDingbatsList
,ZapfDingbatsNumberList
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
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
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected boolean
Indicates if the indentation of all the items has to be aligned.static final boolean
a possible value for the lettered parameterprotected boolean
Indicates if the indentation has to be set automatically.protected int
This variable indicates the first number of a numbered list.protected float
The indentation of this list on the left side.protected float
The indentation of this list on the right side.protected boolean
Indicates if the listsymbols are numerical or alphabetical.This is theArrayList
containing the differentListItem
s.protected boolean
Indicates if the listsymbols are lowercase or uppercase.static final boolean
a possible value for the lettered parameterprotected boolean
Indicates if the list has to be numbered.static final boolean
a possible value for the lettered parameterstatic final boolean
a possible value for the numbered parameterprotected String
In case you are using numbered/lettered lists, this String is added after the number/letter.protected String
In case you are using numbered/lettered lists, this String is added before the number/letter.protected Chunk
This is the listsymbol of a list that is not numbered.protected float
The indentation of the listitems.static final boolean
a possible value for the numbered parameterstatic final boolean
a possible value for the lettered parameterFields 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, FOOTNOTE, HEADER, IMGRAW, IMGTEMPLATE, JBIG2, JPEG, JPEG2000, KEYWORDS, LIST, LISTITEM, MARKED, MODIFICATIONDATE, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE, YMARK
-
Constructor Summary
ConstructorsConstructorDescriptionList()
Constructs aList
.List
(boolean numbered) Constructs aList
.List
(boolean numbered, boolean lettered) Constructs aList
.List
(boolean numbered, boolean lettered, float symbolIndent) Creates a listList
(boolean numbered, float symbolIndent) Constructs aList
.List
(float symbolIndent) Constructs aList
with a specific symbol indentation. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Adds anElement
to theList
.boolean
Adds a nestedList
to theList
.boolean
Adds aString
to theList
.Gets all the chunks in this element.int
getFirst()
Gets the first number .float
Gets the indentation of this paragraph on the left side.float
Gets the indentation of this paragraph on the right side.getItems()
Gets all the items in the list.Returns the String that is after a number or letter in the list symbol.Returns the String that is before a number or letter in the list symbol.Gets the Chunk containing the symbol.float
Gets the symbol indentation.float
Gets the leading of the first listitem.boolean
Checks if all the listitems should be aligned.boolean
Checks if the indentation of list items is done automatically.boolean
Checks if this element is a content object.boolean
isEmpty()
Returnstrue
if the list is empty.boolean
Checks if the list is lettered.boolean
Checks if the list lettering is lowercase.boolean
Checks if this element is nestable.boolean
Checks if the list is numbered.void
Makes sure all the items in the list have the same indentation.boolean
process
(ElementListener listener) Processes the element by adding it (or the different parts) to anElementListener
.void
setAlignindent
(boolean alignindent) void
setAutoindent
(boolean autoindent) void
setFirst
(int first) Sets the number that has to come first in the list.void
setIndentationLeft
(float indentation) Sets the indentation of this paragraph on the left side.void
setIndentationRight
(float indentation) Sets the indentation of this paragraph on the right side.void
setLettered
(boolean lettered) void
setListSymbol
(Chunk symbol) Sets the listsymbol.void
setListSymbol
(String symbol) Sets the listsymbol.void
setLowercase
(boolean uppercase) void
setNumbered
(boolean numbered) void
setPostSymbol
(String postSymbol) Sets the String that has to be added after a number or letter in the list symbol.void
setPreSymbol
(String preSymbol) Sets the String that has to be added before a number or letter in the list symbol.void
setSymbolIndent
(float symbolIndent) int
size()
Gets the size of the list.int
type()
Gets the type of the text element.
-
Field Details
-
ORDERED
public static final boolean ORDEREDa possible value for the numbered parameter- See Also:
-
UNORDERED
public static final boolean UNORDEREDa possible value for the numbered parameter- See Also:
-
NUMERICAL
public static final boolean NUMERICALa possible value for the lettered parameter- See Also:
-
ALPHABETICAL
public static final boolean ALPHABETICALa possible value for the lettered parameter- See Also:
-
UPPERCASE
public static final boolean UPPERCASEa possible value for the lettered parameter- See Also:
-
LOWERCASE
public static final boolean LOWERCASEa possible value for the lettered parameter- See Also:
-
list
This is theArrayList
containing the differentListItem
s. -
numbered
protected boolean numberedIndicates if the list has to be numbered. -
lettered
protected boolean letteredIndicates if the listsymbols are numerical or alphabetical. -
lowercase
protected boolean lowercaseIndicates if the listsymbols are lowercase or uppercase. -
autoindent
protected boolean autoindentIndicates if the indentation has to be set automatically. -
alignindent
protected boolean alignindentIndicates if the indentation of all the items has to be aligned. -
first
protected int firstThis variable indicates the first number of a numbered list. -
symbol
This is the listsymbol of a list that is not numbered. -
preSymbol
In case you are using numbered/lettered lists, this String is added before the number/letter.- Since:
- iText 2.1.1
-
postSymbol
In case you are using numbered/lettered lists, this String is added after the number/letter.- Since:
- iText 2.1.1
-
indentationLeft
protected float indentationLeftThe indentation of this list on the left side. -
indentationRight
protected float indentationRightThe indentation of this list on the right side. -
symbolIndent
protected float symbolIndentThe indentation of the listitems.
-
-
Constructor Details
-
List
public List()Constructs aList
. -
List
public List(float symbolIndent) Constructs aList
with a specific symbol indentation.- Parameters:
symbolIndent
- the symbol indentation- Since:
- iText 2.0.8
-
List
public List(boolean numbered) Constructs aList
.- Parameters:
numbered
- a boolean
-
List
public List(boolean numbered, boolean lettered) Constructs aList
.- Parameters:
numbered
- a booleanlettered
- has the list to be 'numbered' with letters
-
List
public List(boolean numbered, float symbolIndent) Constructs aList
.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 booleansymbolIndent
- 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 letterssymbolIndent
- the indentation of the symbol
-
-
Method Details
-
process
Processes the element by adding it (or the different parts) to anElementListener
. -
type
public int type()Gets the type of the text element. -
getChunks
Gets all the chunks in this element. -
add
Adds anElement
to theList
.- Specified by:
add
in interfaceTextElementArray
- Parameters:
o
- the element to add.- Returns:
- true if adding the element succeeded
-
add
Adds a nestedList
to theList
.- Parameters:
nested
- the nested list to add.- Returns:
- true if adding the nested list succeeded
-
add
Adds aString
to theList
.- Parameters:
s
- the string to add.- Returns:
- true if adding the string succeeded
-
normalizeIndentation
public void normalizeIndentation()Makes sure all the items in the list have the same indentation. -
setListSymbol
Sets the listsymbol.- Parameters:
symbol
- aChunk
-
setListSymbol
Sets the listsymbol.This is a shortcut for
setListSymbol(Chunk symbol)
.- Parameters:
symbol
- aString
-
getItems
Gets all the items in the list.- Returns:
- an
ArrayList
containingListItem
s.
-
size
public int size()Gets the size of the list.- Returns:
- a
size
-
isEmpty
public boolean isEmpty()Returnstrue
if the list is empty.- Returns:
true
if the list is empty
-
getTotalLeading
public float getTotalLeading()Gets the leading of the first listitem.- Returns:
- a
leading
-
isNumbered
public boolean isNumbered()Checks if the list is numbered.- Returns:
true
if the list is numbered,false
otherwise.
-
setNumbered
public void setNumbered(boolean numbered) - Parameters:
numbered
- the numbered to set
-
isLettered
public boolean isLettered()Checks if the list is lettered.- Returns:
true
if the list is lettered,false
otherwise.
-
setLettered
public void setLettered(boolean lettered) - Parameters:
lettered
- the lettered to set
-
isLowercase
public boolean isLowercase()Checks if the list lettering is lowercase.- Returns:
true
if it is lowercase,false
otherwise.
-
setLowercase
public void setLowercase(boolean uppercase) - Parameters:
uppercase
- the uppercase to set
-
isAutoindent
public boolean isAutoindent()Checks if the indentation of list items is done automatically.- Returns:
- the autoindent
-
setAutoindent
public void setAutoindent(boolean autoindent) - Parameters:
autoindent
- the autoindent to set
-
isAlignindent
public boolean isAlignindent()Checks if all the listitems should be aligned.- Returns:
- the alignindent
-
setAlignindent
public void setAlignindent(boolean alignindent) - Parameters:
alignindent
- the alignindent to set
-
getFirst
public int getFirst()Gets the first number .- Returns:
- a number
-
setFirst
public void setFirst(int first) Sets the number that has to come first in the list.- Parameters:
first
- a number
-
getSymbol
Gets the Chunk containing the symbol.- Returns:
- a Chunk with a symbol
-
getIndentationLeft
public float getIndentationLeft()Gets the indentation of this paragraph on the left side.- Returns:
- the indentation
-
setIndentationLeft
public void setIndentationLeft(float indentation) Sets the indentation of this paragraph on the left side.- Parameters:
indentation
- the new indentation
-
getIndentationRight
public float getIndentationRight()Gets the indentation of this paragraph on the right side.- Returns:
- the indentation
-
setIndentationRight
public void setIndentationRight(float indentation) Sets the indentation of this paragraph on the right side.- Parameters:
indentation
- the new indentation
-
getSymbolIndent
public float getSymbolIndent()Gets the symbol indentation.- Returns:
- the symbol indentation
-
setSymbolIndent
public void setSymbolIndent(float symbolIndent) - Parameters:
symbolIndent
- the symbolIndent to set
-
isContent
public boolean isContent()Description copied from interface:Element
Checks if this element is a content object. If not, it's a metadata object. -
isNestable
public boolean isNestable()Description copied from interface:Element
Checks if this element is nestable.- Specified by:
isNestable
in interfaceElement
- Returns:
- true if this element can be nested inside other elements.
- Since:
- iText 2.0.8
- See Also:
-
getPostSymbol
Returns the String that is after a number or letter in the list symbol.- Returns:
- the String that is after a number or letter in the list symbol
- Since:
- iText 2.1.1
-
setPostSymbol
Sets the String that has to be added after a number or letter in the list symbol.- Parameters:
postSymbol
- the String that has to be added after a number or letter in the list symbol.- Since:
- iText 2.1.1
-
getPreSymbol
Returns the String that is before a number or letter in the list symbol.- Returns:
- the String that is before a number or letter in the list symbol
- Since:
- iText 2.1.1
-
setPreSymbol
Sets the String that has to be added before a number or letter in the list symbol.- Parameters:
preSymbol
- the String that has to be added before a number or letter in the list symbol.- Since:
- iText 2.1.1
-