Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate

com.aspose.pdf.elements
Class Section

java.lang.Object
  extended bycom.aspose.pdf.elements.PdfElementBase
      extended bycom.aspose.pdf.elements.Section
All Implemented Interfaces:
java.lang.Cloneable

public class Section
extends PdfElementBase

Represents a section in a Pdf document.


Constructor Summary
Section(ElementFactory elementFactory)
          Initializes a new instance of the Section class.
Section(Pdf pdf)
          Initializes a new instance of the Section class.
 
Method Summary
 java.lang.Object clone()
          Clone an object.
 org.w3c.dom.Element getDOMElement()
          Gets a DOM representation of the pdf element.
 int getFirstLineIndent()
          Gets an int value that indicates the blank space at the beginning of the section.
 Footer getFooter()
          Gets a Footer object that indicates the footer of the section.
 Header getHeader()
          Gets a Header object that indicates the header of the section.
 PageSetup getPageSetup()
          Gets a PageSetup that indicates page info of the section.
 Paragraphs getParagraphs()
          Gets a Paragraph collection that indicates all paragraphs in the section.
 TextInfo getTextInfo()
           
 boolean isSpaced()
          Gets a bool value that indicates whether the spaces at the begin of the text and returns in the text be shown.
 void setFirstLineIndent(int indent)
          Sets an int value that indicates the blank space at the beginning of the section.
 void setFooter(Footer footer)
          Sets a Footer object that indicates the footer of the section.
 void setHeader(Header header)
          Sets a Header object that indicates the header of the section.
 void setIsSpaced(boolean isSpaced)
          Sets a bool value that indicates whether the spaces at the begin of the text and returns in the text be shown.
 void setPageSetup(PageSetup pageSetup)
          Sets a PageSetup that indicates page info of the section.
 void setParagraphs(Paragraphs paragraphs)
          Sets a Paragraph collection that indicates all paragraphs in the section.
 void setTextInfo(TextInfo textInfo)
           
 
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

Section

public Section(ElementFactory elementFactory)
        throws AsposeBaseException
Initializes a new instance of the Section class.

Parameters:
elementFactory - xsl-fo DOM element factory.
Throws:
AsposeBaseException

Section

public Section(Pdf pdf)
        throws java.lang.Exception
Initializes a new instance of the Section class.

Parameters:
pdf - the pdf document that owns the Section.
Throws:
java.lang.Exception
Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Description copied from class: PdfElementBase
Clone an object.

Overrides:
clone in class PdfElementBase
Throws:
java.lang.CloneNotSupportedException
See Also:
java.lang.Object#clone()

setPageSetup

public void setPageSetup(PageSetup pageSetup)
Sets a PageSetup that indicates page info of the section.


getPageSetup

public PageSetup getPageSetup()
Gets a PageSetup that indicates page info of the section.


setTextInfo

public void setTextInfo(TextInfo textInfo)

getTextInfo

public TextInfo getTextInfo()

getParagraphs

public Paragraphs getParagraphs()
Gets a Paragraph collection that indicates all paragraphs in the section.

Returns:
Returns the paragraphs collection.

setParagraphs

public void setParagraphs(Paragraphs paragraphs)
Sets a Paragraph collection that indicates all paragraphs in the section.

Parameters:
paragraphs - The paragraphs to set.

getFirstLineIndent

public int getFirstLineIndent()
Gets an int value that indicates the blank space at the beginning of the section.

Returns:
Returns the m_firstLineIndent.

setFirstLineIndent

public void setFirstLineIndent(int indent)
Sets an int value that indicates the blank space at the beginning of the section.


isSpaced

public boolean isSpaced()
Gets a bool value that indicates whether the spaces at the begin of the text and returns in the text be shown.

 [SampleCode]
 Gets or sets a bool value that indicates whether the spaces at
 the begin of the text and returns in the text be shown. 
 For the following XML: 
       
       	The first line,
       	The second line.
       
 If IsSpaced is false, the result will be: 
 The first line,The second line.
 If IsSpaced is true, the result will be: 
 				The first line,
 					The second line.
 


setIsSpaced

public void setIsSpaced(boolean isSpaced)
Sets a bool value that indicates whether the spaces at the begin of the text and returns in the text be shown.


getHeader

public Header getHeader()
Gets a Header object that indicates the header of the section.


setHeader

public void setHeader(Header header)
Sets a Header object that indicates the header of the section.


getFooter

public Footer getFooter()
Gets a Footer object that indicates the footer of the section.


setFooter

public void setFooter(Footer footer)
Sets a Footer object that indicates the footer of the section.


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 PdfElementBase
Throws:
AsposeBaseException
See Also:
PdfElementBase.getDOMElement()