com.aspose.pdf.elements
Class ListSection

java.lang.Object
  com.aspose.pdf.elements.PdfElementBase
      com.aspose.pdf.elements.Section
          com.aspose.pdf.elements.ListSection

All Implemented Interfaces:

java.lang.Cloneable

public class ListSection
extends Section

Represents a ListSection in pdf document.

 [SampleCode]
 list= new ListSection(sec1);
 list.add("?", "number 1 item.");
 list.add("?", "number 2 item.");
 sec1.add(list);
 

Constructor Summary

ListSection(Pdf pdf)
Initialize a new instance of the Leader class.

Method Summary

void	clear() Clear listItems of ListSection.
float	getDistanceBetweenIndents() Gets the float that indicates the ditance Between start indent of list item label and list item body. The unit is point, default value is 24.
org.w3c.dom.Element	getDOMElement() Gets a DOM representation of the pdf element.
float	getLabelSeperation() Gets the float that indicates the seperation between list item label end and list item body start.
boolean	isEmpty() Returns true if the collection contains no listItem.
java.util.Iterator	iterator() Returns an iterator over the listItem objects in segments in proper sequence.
void	remove(int index) Removes a ListItem object from the collection at the specified position.
void	setDistanceBetweenIndents(float betweenIndents) Sets the float that indicates the ditance Between start indent of list item label and list item body.
void	setLabelSeperation(float seperation) Sets the float that indicates the seperation between list item label end and list item body start.
int	size() Gets the size of listItem objects collection.

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

clone, getBackgroundColor, getBackgroundImageFile, getBackgroundImageFixedHeight, getBackgroundImageFixedWidth, getColumnInfo, getEvenFooter, getEvenHeader, getFirstLineIndent, getFirstPageFooter, getFirstPageHeader, getGraphInfo, getLastPageFooter, getLastPageHeader, getOddFooter, getOddHeader, getPageRotatingAngle, getPageSetup, getParagraphs, getPdf, getStartingPageNumber, getTextInfo, isBackgroundImageBlackWhite, isDisabled, isLandscape, isNewColumn, isNewColumn, isPageNumberRestarted, isPageNumberRestarted, isSpaced, setBackgroundColor, setBackgroundImageFile, setBackgroundImageFixedHeight, setBackgroundImageFixedWidth, setColumnInfo, setEvenFooter, setEvenHeader, setFirstLineIndent, setFirstPageFooter, setFirstPageHeader, setGraphInfo, setIsBackgroundImageBlackWhite, setIsDisabled, setIsLandscape, setIsSpaced, setLastPageFooter, setLastPageHeader, setOddFooter, setOddHeader, setPageRotatingAngle, setPageSetup, setParagraphs, setStartingPageNumber, setTextInfo

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

ListSection

public ListSection(Pdf pdf)
            throws AsposeBaseException

Initialize a new instance of the Leader class.

Parameters:

pdf - The ListSection will inherit format info from the pdf.

Throws:

AsposeBaseException

Method Detail

clear

public void clear()

Clear listItems of ListSection.

remove

public void remove(int index)

Removes a ListItem object from the collection at the specified position.

Parameters:

index - The index of the listItem that willed removed.

size

public int size()

Gets the size of listItem objects collection.

iterator

public java.util.Iterator iterator()

Returns an iterator over the listItem objects in segments in proper sequence.

isEmpty

public boolean isEmpty()

Returns true if the collection contains no listItem.

getDistanceBetweenIndents

public float getDistanceBetweenIndents()

Gets the float that indicates the ditance Between start indent of list item label and list item body.
The unit is point, default value is 24.

Returns:

Returns the ditance Between start indent of list item label and list item body.

setDistanceBetweenIndents

public void setDistanceBetweenIndents(float betweenIndents)

Sets the float that indicates the ditance Between start indent of list item label and list item body.

Parameters:

betweenIndents - The ditance between indents to set.

getLabelSeperation

public float getLabelSeperation()

Gets the float that indicates the seperation between list item label end and
list item body start. The unit is point, default value is 6.

Returns:

Returns the label seperation.

setLabelSeperation

public void setLabelSeperation(float seperation)

Sets the float that indicates the seperation between list item label end and
list item body start.

Parameters:

seperation - The label seperation to set.

getDOMElement

public org.w3c.dom.Element getDOMElement()
                                  throws AsposeBaseException

Description copied from class: PdfElementBase

Gets a DOM representation of the pdf element.

Overrides:

getDOMElement in class Section

Throws:

AsposeBaseException

See Also:

PdfElementBase.getDOMElement()