CPDFGeneration.layout

Class CList

java.lang.Object

CPDFGeneration.layout.CElementPropertyContainer

CPDFGeneration.layout.CAbstractElement

CPDFGeneration.layout.CBlockElement

CPDFGeneration.layout.CList

All Implemented Interfaces:

CIElement

public class CList
extends CBlockElement

Field Summary

Fields inherited from class CPDFGeneration.layout.CElementPropertyContainer

elementPtr

Constructor Summary

Constructors

Constructor and Description
CList(long ptr) Create a list element with native pointer.

Method Summary

Modifier and Type	Method and Description
CListItem	createListItemElement() Create a list item element as a child of this list with empty text.
CListItem	createListItemElement(java.lang.String text) Create a list item element as a child of this list with initial text.
CElementType	getType() Get element type.
boolean	IsUnordered() Check whether this list is unordered.
CList	setItemStartIndex(int start) Set the start index for ordered list items (e.g., start numbering from N).
CList	setListSymbol(CBackgroundImage image) Set list symbol using an image source array.
CList	setListSymbol(CListNumberType listNumberingType) Set list numbering type for ordered lists.
CList	setListSymbol(CListSymbolType type) Set list symbol using a predefined symbol type.
CList	setListSymbol(CText text) Set list symbol using a CText element.
CList	setListSymbol(java.lang.String text) Set list symbol using a plain text string.
CList	setSymbolIndent(float symbolIndent) Set the indentation between the list symbol and the list item content.

Methods inherited from class CPDFGeneration.layout.CBlockElement

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

Methods inherited from class CPDFGeneration.layout.CAbstractElement

addStyle, getChildren, getStyles, hasProperty, isAbsolute, isEmpty

Methods inherited from class CPDFGeneration.layout.CElementPropertyContainer

deleteProperty, getProperties, getStrokeColor, getStrokeWidth, hasProperty, setAbsolutePosition, setAbsolutePosition, setBackgroundColor, setBackgroundImage, setBorder, setBorderBottom, setBorderBottomLeftRadius, setBorderBottomRightRadius, setBorderLeft, setBorderRadius, setBorderRight, setBorderTop, setBorderTopLeftRadius, setBorderTopRightRadius, setCharacterSpacing, setFontColor, setFontFamily, setFontSize, setFontStyle, setFontWeight, setHorizontalAlignment, setInlineVerticalAlignment, setOpacity, setStrokeColor, setStrokeWidth, setTextAlignment, setUnderline, setWordSpacing

Methods inherited from class java.lang.Object

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

Constructor Detail

CList

public CList(long ptr)

Create a list element with native pointer.

Parameters:

ptr - Native list pointer/handle.

Method Detail

getType

public CElementType getType()

Get element type.

Returns:

CElementType.ELEMENT_LIST.

createListItemElement

public CListItem createListItemElement()

Create a list item element as a child of this list with empty text.

Returns:

A CListItem element instance.

createListItemElement

public CListItem createListItemElement(java.lang.String text)

Create a list item element as a child of this list with initial text.

Parameters:

text - Item text.

Returns:

A CListItem element instance.

IsUnordered

public boolean IsUnordered()

Check whether this list is unordered.

Returns:

true if unordered, false if ordered (implementation-defined).

setListSymbol

public CList setListSymbol(java.lang.String text)

Set list symbol using a plain text string. This method supports chaining.

Parameters:

text - Symbol text (e.g., "•", "-", etc.).

Returns:

This CList instance.

setListSymbol

public CList setListSymbol(CText text)

Set list symbol using a CText element. This method supports chaining.

Parameters:

text - Text element used as symbol.

Returns:

This CList instance.

setListSymbol

public CList setListSymbol(CListSymbolType type)

Set list symbol using a predefined symbol type. This method supports chaining.

Parameters:

type - Symbol type enum.

Returns:

This CList instance.

setListSymbol

public CList setListSymbol(CBackgroundImage image)

Set list symbol using an image source array. This method supports chaining.

Parameters:

image - Image sources (paths or URLs), as expected by native implementation.

Returns:

This CList instance.

setListSymbol

public CList setListSymbol(CListNumberType listNumberingType)

Set list numbering type for ordered lists. This method supports chaining.

Parameters:

listNumberingType - Numbering type enum.

Returns:

This CList instance.

setItemStartIndex

public CList setItemStartIndex(int start)

Set the start index for ordered list items (e.g., start numbering from N). This method supports chaining.

Parameters:

start - Start index.

Returns:

This CList instance.

setSymbolIndent

public CList setSymbolIndent(float symbolIndent)

Set the indentation between the list symbol and the list item content. This method supports chaining.

Parameters:

symbolIndent - Indent value (unit is implementation-defined; commonly points).

Returns:

This CList instance.