Package com.itextpdf.text
Class ListItem
java.lang.Object
java.util.AbstractCollection<E>
java.util.AbstractList<E>
java.util.ArrayList<Element>
com.itextpdf.text.Phrase
com.itextpdf.text.Paragraph
com.itextpdf.text.ListItem
- All Implemented Interfaces:
Indentable
,Spaceable
,Element
,IAccessibleElement
,TextElementArray
,Serializable
,Cloneable
,Iterable<Element>
,Collection<Element>
,List<Element>
,RandomAccess
A
ListItem
is a Paragraph
that can be added to a List
.
Example 1:
The result of this code looks like this: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"));
- 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
The result of this code looks like this:List overview = new List(false, 10); overview.add(new ListItem("This is an item")); overview.add("This is another item");
- This is an item
- This is another item
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate ListBody
private ListLabel
private static final long
protected Chunk
this is the symbol that will precede the listitem.Fields inherited from class com.itextpdf.text.Paragraph
accessibleAttributes, alignment, id, indentationLeft, indentationRight, keeptogether, paddingTop, role, spacingAfter, spacingBefore
Fields inherited from class com.itextpdf.text.Phrase
font, hyphenation, leading, multipliedLeading, tabSettings
Fields inherited from class java.util.AbstractList
modCount
Fields inherited from interface com.itextpdf.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, BODY, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, CCITTG3_1D, CCITTG3_2D, CCITTG4, CHAPTER, CHUNK, CREATIONDATE, CREATOR, DIV, HEADER, IMGRAW, IMGTEMPLATE, JBIG2, JPEG, JPEG2000, KEYWORDS, LANGUAGE, LIST, LISTITEM, MARKED, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, SECTION, SUBJECT, TITLE, WRITABLE_DIRECT, YMARK
-
Constructor Summary
ConstructorsConstructorDescriptionListItem()
Constructs aListItem
.ListItem
(float leading) Constructs aListItem
with a certain leading.Constructs aListItem
with a certainChunk
and a certain leading.Constructs aListItem
with a certainString
and a certain leading.Constructs aListItem
with a certain leading,String
andFont
.Constructs aListItem
with a certainChunk
.Constructs aListItem
with a certainPhrase
.Constructs aListItem
with a certainString
.Constructs aListItem
with a certainString
and a certainFont
. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Changes the font of the list symbol to the font of the first chunk in the list item.cloneShallow
(boolean spacingBefore) Creates a shallow clone of the Paragraph.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.itextpdf.text.Paragraph
add, breakUp, getAccessibleAttribute, getAccessibleAttributes, getAlignment, getExtraParagraphSpace, getFirstLineIndent, getId, getIndentationLeft, getIndentationRight, getKeepTogether, getPaddingTop, getRole, getSpacingAfter, getSpacingBefore, isInline, populateProperties, setAccessibleAttribute, setAlignment, setExtraParagraphSpace, setFirstLineIndent, setId, setIndentationLeft, setIndentationRight, setKeepTogether, setPaddingTop, setRole, setSpacingAfter, setSpacingBefore, spacingAfter, spacingBefore
Methods inherited from class com.itextpdf.text.Phrase
add, add, addAll, addChunk, addSpecial, getChunks, getContent, getFont, getHyphenation, getInstance, getInstance, getInstance, getLeading, getMultipliedLeading, getTabSettings, getTotalLeading, hasLeading, isContent, isEmpty, isNestable, process, setFont, setHyphenation, setLeading, setLeading, setMultipliedLeading, setTabSettings, trim
Methods inherited from class java.util.ArrayList
addAll, clear, clone, contains, ensureCapacity, equals, forEach, get, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize
Methods inherited from class java.util.AbstractCollection
containsAll, toString
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Collection
parallelStream, stream, toArray
Methods inherited from interface java.util.List
containsAll
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
symbol
this is the symbol that will precede the listitem.- Since:
- 5.0 used to be private
-
listBody
-
listLabel
-
-
Constructor Details
-
ListItem
public ListItem()Constructs aListItem
. -
ListItem
public ListItem(float leading) Constructs aListItem
with a certain leading.- Parameters:
leading
- the leading
-
ListItem
Constructs aListItem
with a certainChunk
.- Parameters:
chunk
- aChunk
-
ListItem
Constructs aListItem
with a certainString
.- Parameters:
string
- aString
-
ListItem
Constructs aListItem
with a certainString
and a certainFont
.- Parameters:
string
- aString
font
- aString
-
ListItem
Constructs aListItem
with a certainChunk
and a certain leading.- Parameters:
leading
- the leadingchunk
- aChunk
-
ListItem
Constructs aListItem
with a certainString
and a certain leading.- Parameters:
leading
- the leadingstring
- aString
-
ListItem
Constructs aListItem
with a certain leading,String
andFont
.- Parameters:
leading
- the leadingstring
- aString
font
- aFont
-
ListItem
Constructs aListItem
with a certainPhrase
.- Parameters:
phrase
- aPhrase
-
-
Method Details
-
type
public int type()Gets the type of the text element. -
cloneShallow
Description copied from class:Paragraph
Creates a shallow clone of the Paragraph.- Overrides:
cloneShallow
in classParagraph
- Returns:
-
setListSymbol
Sets the listsymbol.- Parameters:
symbol
- aChunk
-
setIndentationLeft
public void setIndentationLeft(float indentation, boolean autoindent) Sets the indentation of this paragraph on the left side.- Parameters:
indentation
- the new indentationautoindent
- if set to true, indentation is done automagically, the given indentation float is disregarded.
-
adjustListSymbolFont
public void adjustListSymbolFont()Changes the font of the list symbol to the font of the first chunk in the list item.- Since:
- 5.0.6
-
getListSymbol
Returns the listsymbol.- Returns:
- a
Chunk
-
getListBody
-
getListLabel
-