com.itextpdf.layout.element

Class ListItem

java.lang.Object

com.itextpdf.commons.actions.sequence.AbstractIdentifiableElement

com.itextpdf.layout.ElementPropertyContainer

com.itextpdf.layout.element.AbstractElement

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

com.itextpdf.layout.element.Div

com.itextpdf.layout.element.ListItem

All Implemented Interfaces:

IAbstractElement, IBlockElement, IElement, IPropertyContainer, IAccessibleElement

public class ListItem
extends Div

A list item is a layout element that is one entry in a List. The list object controls the prefix, postfix, and numbering of the list items.

Field Summary

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

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
ListItem() Creates a ListItem.
ListItem(Image image) Creates a list item with an image.
ListItem(String text) Creates a list item with text.

Method Summary

Modifier and Type	Method and Description
AccessibilityProperties	getAccessibilityProperties() Gets the accessibility properties.
T1	getDefaultProperty(int property) Gets the default property from this entity.
protected IRenderer	makeNewRenderer() Creates new renderer instance.
ListItem	setListSymbol(Image image) Sets the list item symbol to be used.
ListItem	setListSymbol(ListNumberingType listNumberingType) Sets the list item numbering type to be used.
ListItem	setListSymbol(String symbol) Sets the list item symbol to be used.
ListItem	setListSymbol(Text text) Sets the list item symbol to be used.
ListItem	setListSymbolOrdinalValue(int ordinalValue) Customizes the index of the item in the list.

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

add, add, add, setFillAvailableArea, setFillAvailableAreaOnSplit

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

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

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

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

Methods inherited from class com.itextpdf.layout.ElementPropertyContainer

deleteOwnProperty, getOwnProperty, getSplitCharacters, getStrokeColor, getStrokeWidth, getTextRenderingMode, hasOwnProperty, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundImage, setBackgroundImage, setBaseDirection, setBold, setBorder, setBorderBottom, setBorderBottomLeftRadius, setBorderBottomRightRadius, setBorderLeft, setBorderRadius, setBorderRight, setBorderTop, setBorderTopLeftRadius, setBorderTopRightRadius, setCharacterSpacing, setDestination, setFixedPosition, setFixedPosition, setFixedPosition, setFixedPosition, setFont, setFontColor, setFontColor, setFontFamily, setFontFamily, setFontKerning, setFontScript, setFontSize, setHorizontalAlignment, setHyphenation, setItalic, setLineThrough, setOpacity, setProperty, setRelativePosition, setSplitCharacters, setStrokeColor, setStrokeWidth, setTextAlignment, setTextRenderingMode, setUnderline, setUnderline, setUnderline, setUnderline, 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.IAbstractElement

getChildren

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

Constructor Detail

ListItem

public ListItem()

Creates a ListItem.

ListItem

public ListItem(String text)

Creates a list item with text.

Parameters:

text - the textual contents of the list item

ListItem

public ListItem(Image image)

Creates a list item with an image.

Parameters:

image - the graphical contents of the list item

Method Detail

setListSymbolOrdinalValue

public ListItem setListSymbolOrdinalValue(int ordinalValue)

Customizes the index of the item in the list.

Parameters:

ordinalValue - the custom value property of an ordered list's list item.

Returns:

this listItem.

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<Div>

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

setListSymbol

public ListItem setListSymbol(String symbol)

Sets the list item symbol to be used.

Parameters:

symbol - the textual symbol to be used for the item.

Returns:

this list item.

setListSymbol

public ListItem setListSymbol(Text text)

Sets the list item symbol to be used.

Parameters:

text - the Text object to be used for the item.

Returns:

this list item.

setListSymbol

public ListItem setListSymbol(Image image)

Sets the list item symbol to be used.

Parameters:

image - the Image object to be used for the item.

Returns:

this list.

setListSymbol

public ListItem setListSymbol(ListNumberingType listNumberingType)

Sets the list item numbering type to be used.

Parameters:

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

Returns:

this list item.

getAccessibilityProperties

public AccessibilityProperties getAccessibilityProperties()

Description copied from interface: IAccessibleElement

Gets the accessibility properties. See also IAccessibleElement.

Specified by:

getAccessibilityProperties in interface IAccessibleElement

Overrides:

getAccessibilityProperties in class Div

Returns:

an interface that allows to specify properties of a tagged element in Tagged PDF.

makeNewRenderer

protected IRenderer makeNewRenderer()

Description copied from class: AbstractElement

Creates new renderer instance.

Overrides:

makeNewRenderer in class Div

Returns:

new IRenderer