com.itextpdf.layout.element

Class List

java.lang.Object

com.itextpdf.layout.ElementPropertyContainer

com.itextpdf.layout.element.AbstractElement

com.itextpdf.layout.element.BlockElement<List>

com.itextpdf.layout.element.List

All Implemented Interfaces:

IAccessibleElement, IBlockElement, IElement, IPropertyContainer

public class List
extends BlockElement<List>

A List is a layout element representing a series of objects that are vertically outlined with the same or very similar layout properties, giving it a sense of unity. It contains ListItem objects that can optionally be prefixed with a symbol and/or numbered.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_LIST_SYMBOL
protected PdfName	role
protected AccessibilityProperties	tagProperties

Fields inherited from class com.itextpdf.layout.element.AbstractElement

childElements, nextRenderer, styles

Fields inherited from class com.itextpdf.layout.ElementPropertyContainer

properties

Constructor Summary

Constructors

Constructor and Description
List() Creates a List with the DEFAULT_LIST_SYMBOL as a prefix.
List(ListNumberingType listNumberingType) Creates a List with a custom numbering type.

Method Summary

Modifier and Type	Method and Description
List	add(ListItem listItem) Adds a new ListItem to the bottom of the List.
List	add(String text) Adds a new ListItem to the bottom of the List.
AccessibilityProperties	getAccessibilityProperties() Gets the accessibility properties.
T1	getDefaultProperty(int property) Gets the default property from this entity.
String	getPostSymbolText() Gets the piece of text that is added after the ListItem symbol.
String	getPreSymbolText() Gets the piece of text that is added before the ListItem symbol.
PdfName	getRole() Gets the element's role.
Float	getSymbolIndent() Gets the indent offset of the ListItem symbols.
protected IRenderer	makeNewRenderer()
List	setItemStartIndex(int start) Customizes the index of the first item in the list.
List	setListSymbol(Image image) Sets the list symbol to be used.
List	setListSymbol(ListNumberingType listNumberingType) Sets the list numbering type to be used.
List	setListSymbol(String symbol) Sets the list symbol to be used.
List	setListSymbol(Text text) Sets the list symbol to be used.
List	setListSymbolAlignment(ListSymbolAlignment alignment) A specialized enum containing alignment properties for list symbols.
void	setPostSymbolText(String postSymbolText) Sets a piece of text that should be added after the ListItem symbol.
void	setPreSymbolText(String preSymbolText) Sets a piece of text that should be added before the ListItem symbol.
void	setRole(PdfName role) Sets the element's role.
List	setSymbolIndent(float symbolIndent) Sets the indent offset of the ListItem symbols.

Methods inherited from class com.itextpdf.layout.element.BlockElement

getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, isKeepTogether, isKeepWithNext, setHeight, setKeepTogether, setKeepWithNext, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMargins, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddings, setPaddingTop, setRotationAngle, setRotationAngle, setSpacingRatio, setVerticalAlignment

Methods inherited from class com.itextpdf.layout.element.AbstractElement

addStyle, createRendererSubTree, getChildren, getProperty, getRenderer, hasProperty, isEmpty, propagateArtifactRoleToChildElements, setAction, setNextRenderer, setPageNumber

Methods inherited from class com.itextpdf.layout.ElementPropertyContainer

deleteOwnProperty, getHeight, getOwnProperty, getSplitCharacters, getStrokeColor, getStrokeWidth, getTextRenderingMode, getWidth, hasOwnProperty, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBaseDirection, setBold, setBorder, setBorderBottom, setBorderBottomLeftRadius, setBorderBottomRightRadius, setBorderLeft, setBorderRadius, setBorderRight, setBorderTop, setBorderTopLeftRadius, setBorderTopRightRadius, setCharacterSpacing, setDestination, setFixedPosition, setFixedPosition, setFixedPosition, setFixedPosition, setFont, setFont, setFontColor, setFontColor, setFontKerning, setFontScript, setFontSize, setHeight, setHeightPercent, setHorizontalAlignment, setHyphenation, setItalic, setLineThrough, setOpacity, setProperty, setRelativePosition, setSplitCharacters, setStrokeColor, setStrokeWidth, setTextAlignment, setTextRenderingMode, setUnderline, setUnderline, setUnderline, setUnderline, setWidth, setWidth, setWidthPercent, setWordSpacing

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.itextpdf.layout.element.IElement

createRendererSubTree, getRenderer, setNextRenderer

Methods inherited from interface com.itextpdf.layout.IPropertyContainer

deleteOwnProperty, getOwnProperty, getProperty, hasOwnProperty, hasProperty, setProperty

Field Detail

DEFAULT_LIST_SYMBOL

public static final String DEFAULT_LIST_SYMBOL

See Also:

Constant Field Values

role

protected PdfName role

tagProperties

protected AccessibilityProperties tagProperties

Constructor Detail

List

public List()

Creates a List with the DEFAULT_LIST_SYMBOL as a prefix.

List

public List(ListNumberingType listNumberingType)

Creates a List with a custom numbering type.

Parameters:

listNumberingType - a prefix style

Method Detail

getDefaultProperty

public  T1 getDefaultProperty(int property)

Description copied from interface: IPropertyContainer

Gets the default property from this entity.

Specified by:

getDefaultProperty in interface IPropertyContainer

Overrides:

getDefaultProperty in class BlockElement<List>

Type Parameters:

T1 - the return type associated with the property

Parameters:

property - the property to be retrieved

Returns:

the default property value. If the default property is not defined, null will be returned

add

public List add(ListItem listItem)

Adds a new ListItem to the bottom of the List.

Parameters:

listItem - a new list item

Returns:

this list.

add

public List add(String text)

Adds a new ListItem to the bottom of the List.

Parameters:

text - textual contents of the new list item

Returns:

this list.

setItemStartIndex

public List setItemStartIndex(int start)

Customizes the index of the first item in the list.

Parameters:

start - the custom index, as an int

Returns:

this list.

setListSymbol

public List setListSymbol(String symbol)

Sets the list symbol to be used. This will create an unordered list, i.e. all list items will be shown with the same prefix.

Parameters:

symbol - the textual symbol to be used for all items.

Returns:

this list.

setListSymbol

public List setListSymbol(Text text)

Sets the list symbol to be used. This will create an unordered list, i.e. all list items will be shown with the same prefix.

Parameters:

text - the Text object to be used for all items.

Returns:

this list.

setListSymbol

public List setListSymbol(Image image)

Sets the list symbol to be used. This will create an unordered list, i.e. all list items will be shown with the same prefix.

Parameters:

image - the Image object to be used for all items.

Returns:

this list.

setListSymbol

public List setListSymbol(ListNumberingType listNumberingType)

Sets the list numbering type to be used. This will create an ordered list, i.e. every ListItem will have a unique prefix.

Parameters:

listNumberingType - the ListNumberingType that will generate appropriate prefixes for the ListItems.

Returns:

this list.

setListSymbolAlignment

public List setListSymbolAlignment(ListSymbolAlignment alignment)

A specialized enum containing alignment properties for list symbols. ListSymbolAlignment.LEFT means that the items will be aligned as follows: 9. Item 9 10. Item 10 Whereas ListSymbolAlignment.RIGHT means the items will be aligned as follows: 9. Item 9 10. Item 10

Parameters:

alignment - the alignment of the list symbols

Returns:

this element

getSymbolIndent

public Float getSymbolIndent()

Gets the indent offset of the ListItem symbols.

Returns:

the indent offset as a float.

setSymbolIndent

public List setSymbolIndent(float symbolIndent)

Sets the indent offset of the ListItem symbols.

Parameters:

symbolIndent - the new indent offset.

Returns:

this list.

getPostSymbolText

public String getPostSymbolText()

Gets the piece of text that is added after the ListItem symbol.

Returns:

the post symbol text

setPostSymbolText

public void setPostSymbolText(String postSymbolText)

Sets a piece of text that should be added after the ListItem symbol.

Parameters:

postSymbolText - the post symbol text

getPreSymbolText

public String getPreSymbolText()

Gets the piece of text that is added before the ListItem symbol.

Returns:

the pre symbol text

setPreSymbolText

public void setPreSymbolText(String preSymbolText)

Sets a piece of text that should be added before the ListItem symbol.

Parameters:

preSymbolText - the pre symbol text

getRole

public PdfName getRole()

Description copied from interface: IAccessibleElement

Gets the element's role.

Returns:

a PdfName containing the name of the role

setRole

public void setRole(PdfName role)

Description copied from interface: IAccessibleElement

Sets the element's role.

Parameters:

role - the new role which the IAccessibleElement should take

getAccessibilityProperties

public AccessibilityProperties getAccessibilityProperties()

Description copied from interface: IAccessibleElement

Gets the accessibility properties.

Returns:

a properties wrapper object specific to a tagged element in Tagged PDF

makeNewRenderer

protected IRenderer makeNewRenderer()

Specified by:

makeNewRenderer in class AbstractElement<List>