Class ListItem

java.lang.Object

java.util.AbstractCollection

java.util.AbstractList

java.util.ArrayList

com.gitlab.pdftk_java.com.lowagie.text.Phrase

com.gitlab.pdftk_java.com.lowagie.text.Paragraph

com.gitlab.pdftk_java.com.lowagie.text.ListItem

All Implemented Interfaces:

Element, MarkupAttributes, TextElementArray, Serializable, Cloneable, Iterable, Collection, List, RandomAccess, SequencedCollection

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:

• This is an item
• This is another item

See Also:

• Element
• List
• Paragraph
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private static final long	serialVersionUID	A serial version UID
private Chunk	symbol	this is the symbol that wil proceed the listitem.

Fields inherited from class Paragraph

alignment, indentationLeft, indentationRight, keeptogether, multipliedLeading, spacingAfter, spacingBefore

Fields inherited from class Phrase

font, leading, markupAttributes

Fields inherited from class AbstractList

modCount

Fields inherited from interface 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, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE

Constructor Summary

Constructors

Constructor	Description
ListItem()	Constructs a ListItem.
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(Chunk chunk)	Constructs a ListItem with a certain Chunk.
ListItem(Phrase phrase)	Constructs a ListItem with a certain Phrase.
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(Properties attributes)	Returns a ListItem that has been constructed taking in account the value of some attributes.

Method Summary

Modifier and Type	Method	Description
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 Paragraph

add, alignment, getExtraParagraphSpace, getFirstLineIndent, getKeepTogether, getMultipliedLeading, indentationLeft, indentationRight, setAlignment, setAlignment, setExtraParagraphSpace, setFirstLineIndent, setIndentationLeft, setIndentationRight, setKeepTogether, setLeading, setLeading, setSpacingAfter, setSpacingBefore, spacingAfter, spacingBefore

Methods inherited from class Phrase

add, addAll, addSpecial, font, getChunks, getInstance, getInstance, getInstance, getMarkupAttribute, getMarkupAttributeNames, getMarkupAttributes, isEmpty, leading, leadingDefined, process, setMarkupAttribute, setMarkupAttributes

Methods inherited from class ArrayList

addAll, addFirst, addLast, clear, clone, contains, ensureCapacity, equals, forEach, get, getFirst, getLast, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeFirst, removeIf, removeLast, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class AbstractCollection

containsAll, toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Collection

parallelStream, stream, toArray

Methods inherited from interface Element

getChunks, process, toString

Methods inherited from interface List

containsAll, reversed

Methods inherited from interface MarkupAttributes

getMarkupAttribute, getMarkupAttributeNames, getMarkupAttributes, setMarkupAttribute, setMarkupAttributes

Methods inherited from interface TextElementArray

add

Field Details

serialVersionUID

private static final long serialVersionUID

A serial version UID

See Also:

• Constant Field Values

symbol

private Chunk symbol

this is the symbol that wil proceed the listitem.

Constructor Details

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 Details

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