com.aspose.pdf.elements
Class List

java.lang.Object
  com.aspose.pdf.elements.PdfElementBase
      com.aspose.pdf.elements.Paragraph
          com.aspose.pdf.elements.List

All Implemented Interfaces:

java.lang.Cloneable

public class List
extends Paragraph

Represents a List paragraph in pdf.

Constructor Summary

List(Section section)
Initializes a new instance of the List class.

Method Summary

List	addListItem(Segment listItem) Adds a list item to the list.
int	getFirstNumber() Gets the value of the first number of list.
float	getIndentionLeft() Gets the indention to the left side of page.
float	getIndentionRight() Gets the indention to the right side of page.
Segment	getListSymbol() Gets the symbol of the list.
float	getSymbolIndent() Gets the list indention of the symbol.
TextInfo	getTextInfo() Gets the TextInfo object thats represents the format of the list.
boolean	isNumbered() Gets whether the list is numbered.
List	removeListItem(int index) Removes a list item from the list at index.
List	setFirstNumber(int firstNumber) Sets the value of the first number of list.
List	setIndentionLeft(float indentionLeft) Sets the indention to the left side of page.
List	setIndentionRight(float indentionRight) Sets the indention to the right side of page.
List	setListSymbol(Segment listSymbol) Sets the symbol of the list.
List	setNumbered(boolean isNumbered) Sets whether the list is numbered.
List	setSymbolIndent(float symbolIndent) Sets the list indention of the symbol.
List	setTextInfo(TextInfo textInfo) Sets the TextInfo object thats represents the format of the list.

Methods inherited from class com.aspose.pdf.elements.Paragraph

clone, getDOMElement, getLeft, getMargin, getTop, isDisabled, isFirstParagraph, isKeptTogether, isOnOddPage, setDisabled, setFirstParagraph, setKeptTogether, setLeft, setMargin, setOnOddPage, setTop

Methods inherited from class com.aspose.pdf.elements.PdfElementBase

getElementFactory, getID, getNameIndex, setID

Methods inherited from class java.lang.Object

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

Constructor Detail

List

public List(Section section)

Initializes a new instance of the List class.

Method Detail

addListItem

public List addListItem(Segment listItem)

Adds a list item to the list.

removeListItem

public List removeListItem(int index)

Removes a list item from the list at index.

getIndentionLeft

public float getIndentionLeft()

Gets the indention to the left side of page.

setIndentionLeft

public List setIndentionLeft(float indentionLeft)

Sets the indention to the left side of page.

getIndentionRight

public float getIndentionRight()

Gets the indention to the right side of page.

setIndentionRight

public List setIndentionRight(float indentionRight)

Sets the indention to the right side of page.

getListSymbol

public Segment getListSymbol()

Gets the symbol of the list.

setListSymbol

public List setListSymbol(Segment listSymbol)

Sets the symbol of the list.

getSymbolIndent

public float getSymbolIndent()

Gets the list indention of the symbol.

setSymbolIndent

public List setSymbolIndent(float symbolIndent)

Sets the list indention of the symbol.

isNumbered

public boolean isNumbered()

Gets whether the list is numbered. The defalut value is true.

setNumbered

public List setNumbered(boolean isNumbered)

Sets whether the list is numbered.

getFirstNumber

public int getFirstNumber()

Gets the value of the first number of list. The default value is 1.

setFirstNumber

public List setFirstNumber(int firstNumber)

Sets the value of the first number of list.

getTextInfo

public TextInfo getTextInfo()

Gets the TextInfo object thats represents the format of the list.

setTextInfo

public List setTextInfo(TextInfo textInfo)

Sets the TextInfo object thats represents the format of the list.