Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate

com.aspose.pdf.elements
Class Footer

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

public class Footer
extends PdfElementBase

Represents a footer of a page in a Pdf document.


Constructor Summary
Footer(Section section)
          Initialize a new instance of the Footer class.
 
Method Summary
 java.lang.Object clone()
          Clone an object.
 org.w3c.dom.Element getDOMElement()
          Gets a DOM representation of the pdf element.
 float getFooterHeight()
          Gets a float value that indicates the height of footer.
 java.lang.String getFooterName()
          Gets the Name of Footer.
 Text getFooterText()
          Gets a Text that indicates the content in the footer.
 void setFooterHeight(float height)
          Gets a float value that indicates the height of footer.
 void setFooterText(Text content)
          Sets a Text that indicates the content in the footer.
 
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

Footer

public Footer(Section section)
Initialize a new instance of the Footer class.

 [SampleCode]
 Pdf pdf = new Pdf();
 Section sec1 = pdf.getSections().add();
 Footer foot = new Footer(sec1);
 Text footText = new Text(sec1,"Aspose Footer");
 foot.setFooterText(footText);
 sec1.setFooter(foot);
 

Parameters:
section - The Section that owns the footer.
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()

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()

getFooterHeight

public float getFooterHeight()
Gets a float value that indicates the height of footer.
The unit is point.


setFooterHeight

public void setFooterHeight(float height)
Gets a float value that indicates the height of footer.
The default value is The unit is point.

Parameters:
height - The height to set.

getFooterText

public Text getFooterText()
Gets a Text that indicates the content in the footer.


setFooterText

public void setFooterText(Text content)
Sets a Text that indicates the content in the footer.

Throws:
java.lang.CloneNotSupportedException

getFooterName

public java.lang.String getFooterName()
Gets the Name of Footer.