Pdf (Aspose.Pdf for Java) - Aspose.Pdf for .NET and Java

Product Suites

Aspose.Total for .NET and Java

Aspose.Total for Reporting Services

File Format Components

Aspose.Words for .NET and Java

Aspose.Cells for .NET and Java

Aspose.Pdf for .NET and Java

Product Information

Programmer's Guide

Knowledge Base

Aspose.Pdf for .Net API Reference

Aspose.Pdf for Java API Reference

com.aspose.pdf

com.aspose.pdf.elements

ActionType (Aspose.Pdf for Java)

AlignmentType (Aspose.Pdf for Java)

AnnotationIconType (Aspose.Pdf for Java)

Arc (Aspose.Pdf for Java)

AsposeXMLReader (Aspose.Pdf for Java)

Attachment (Aspose.Pdf for Java)

AttachmentType (Aspose.Pdf for Java)

BorderInfo (Aspose.Pdf for Java)

BorderSide (Aspose.Pdf for Java)

BorderType (Aspose.Pdf for Java)

Cell (Aspose.Pdf for Java)

Cells (Aspose.Pdf for Java)

Circle (Aspose.Pdf for Java)

CmykColorSpace (Aspose.Pdf for Java)

Color (Aspose.Pdf for Java)

ColumnInfo (Aspose.Pdf for Java)

Curve (Aspose.Pdf for Java)

DestinationType (Aspose.Pdf for Java)

ElementFactory (Aspose.Pdf for Java)

Ellipse (Aspose.Pdf for Java)

FileIconType (Aspose.Pdf for Java)

Graph (Aspose.Pdf for Java)

GraphInfo (Aspose.Pdf for Java)

GrayColorSpace (Aspose.Pdf for Java)

HeaderFooter (Aspose.Pdf for Java)

HeaderFooterType (Aspose.Pdf for Java)

Heading (Aspose.Pdf for Java)

HeadingInfo (Aspose.Pdf for Java)

HeadingType (Aspose.Pdf for Java)

HyperLink (Aspose.Pdf for Java)

HyperLinkToFile (Aspose.Pdf for Java)

HyperLinkToLocalPdf (Aspose.Pdf for Java)

HyperLinkToOuterPdf (Aspose.Pdf for Java)

HyperLinkToWeb (Aspose.Pdf for Java)

Image (Aspose.Pdf for Java)

ImageFileType (Aspose.Pdf for Java)

ImageInfo (Aspose.Pdf for Java)

ImageOpenType (Aspose.Pdf for Java)

JavaScript (Aspose.Pdf for Java)

JavaScripts (Aspose.Pdf for Java)

Line (Aspose.Pdf for Java)

LineStyleType (Aspose.Pdf for Java)

List (Aspose.Pdf for Java)

ListSection (Aspose.Pdf for Java)

MarginInfo (Aspose.Pdf for Java)

OpenType (Aspose.Pdf for Java)

PageSetup (Aspose.Pdf for Java)

PageSize (Aspose.Pdf for Java)

PageTransitionType (Aspose.Pdf for Java)

Paragraph (Aspose.Pdf for Java)

Paragraphs (Aspose.Pdf for Java)

Pdf (Aspose.Pdf for Java)

PdfElementBase (Aspose.Pdf for Java)

Rectangle (Aspose.Pdf for Java)

RectData (Aspose.Pdf for Java)

RenderingMode (Aspose.Pdf for Java)

RgbColorSpace (Aspose.Pdf for Java)

Row (Aspose.Pdf for Java)

Rows (Aspose.Pdf for Java)

Section (Aspose.Pdf for Java)

Sections (Aspose.Pdf for Java)

Security (Aspose.Pdf for Java)

Segment (Aspose.Pdf for Java)

Segments (Aspose.Pdf for Java)

Shape (Aspose.Pdf for Java)

Shapes (Aspose.Pdf for Java)

Table (Aspose.Pdf for Java)

Text (Aspose.Pdf for Java)

TextInfo (Aspose.Pdf for Java)

VerticalAlignmentType (Aspose.Pdf for Java)

VerticalTextRotationType (Aspose.Pdf for Java)

com.aspose.pdf.exception

com.aspose.pdf.utils

Aspose.Slides for .NET and Java

Aspose.Pdf.Kit for .NET and Java

Aspose.Tasks for .NET

Aspose.Form for .NET

Aspose.Metafiles for Java

Aspose.Flash for .NET

Aspose.Recognition for .NET

SSRS Rendering Extensions

Aspose.Words for Reporting Services

Aspose.Slides for Reporting Services

Aspose.Cells for Reporting Services

Aspose.Pdf for Reporting Services

Aspose.BarCode for Reporting Services

JasperReports Exporters

Aspose.Slides for JasperReports

Visual Components

Aspose.BarCode for .NET and Java

Aspose.Grid for .NET

Aspose.Chart for .NET

Aspose.Editor for .NET

Aspose.AdHoc for .NET

Utility Components

Aspose.Network for .NET

Aspose.Workflow for .NET

Aspose.Spell for .NET

Aspose.ASPXpand for .NET

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.aspose.pdf.elements
Class Pdf

java.lang.Object
  com.aspose.pdf.elements.Pdf

public class Pdf
extends java.lang.Object
extends java.lang.Object

Represents the Pdf document.

Constructor Summary
`Pdf()` Initialize a new instance of the Pdf class.

Method Summary
`void`	`addAuthor(java.lang.String author)` Sets a string that indicates the author name of the Pdf document.
`void`	`addCreator(java.lang.String creator)` Sets a string that indicates the creator of the Pdf document.
`void`	`addKeywords(java.lang.String keyWords)` Sets a string that indicates key words of the Pdf document.
`void`	`addProducer(java.lang.String producer)` Sets a string that indicates Producer of the Pdf document.
`void`	`addSubject(java.lang.String subject)` Sets a string that indicates the subject of the Pdf document.
`void`	`addTitle(java.lang.String title)` Sets a string that indicates the title of the Pdf document.
`void`	`bindFo(java.io.InputStream foStream)` Binds fo file as InputSteam. NOTE: This is Beta version of Fo2Pdf.
`void`	`bindFo(java.io.InputStream xmlStream, java.io.InputStream xsltStream)` Binds xml file and according xsl file as InputStream to be converted. NOTE: This is Beta version of Fo2Pdf.
`void`	`bindHTML(java.io.InputStream htmlStream, java.net.URL baseUrl)` Binds a html stream and convert it to Pdf Stream. NOTE: This is Beta version of bindHTML.
`static Pdf`	`bindXML(java.io.InputStream xmlStream)` Reads info from an xml document.
`static Pdf`	`bindXMLByDom(java.io.InputStream xmlStream)` Reads info from an xml document.
`static void`	`copyStream(java.io.InputStream in, java.io.OutputStream out)`
`Color`	`getBackgroundColor()` Gets a Color object that indicates the background color of the pdf.
`java.lang.String`	`getBackgroundImageFile()` Gets a string that indicates the background image file name.
`float`	`getBackgroundImageFixedWidth()` Gets a float value that indicates the fixed width of the background image.
`int`	`getBookMarkLevel()` Gets or sets a int value that indicates how many levels of Heading of the pdf document is to be bookmarked. The default value is 0, which means every heading of the PDF is to be taged as a bookmark.
`DestinationType`	`getDestinationType()` Gets a DestinationType value that indicates the document open action.
`int`	`getFirstLineIndent()` Gets an int value that indicates the indent of the first line.
`static java.lang.String`	`getFoImagePath()` Sets an image path to system image path.
`GraphInfo`	`getGraphInfo()` Gets a GraphInfo object that indicates the graph info in the Pdf document.
`java.lang.String`	`getHeadingCaption(int headingLevel, int headingType, boolean isPrefixed)` Gets the heading caption at a heading level.
`HeadingInfo`	`getHeadingInfo()` Gets the heading info object of the pdf document.
`JavaScripts`	`getJavaScripts()` Gets a JavaScripts object that indicates the JavaScripts to be added into the PDF.
`OpenType`	`getOpenType()` Gets an OpenType that indicates the document open type.
`int`	`getPageDuration()` Gets a int value that indicates the duration in seconds for the current page. This property is used when using auto advancing in presentation mode.
`PageSetup`	`getPageSetup()` Gets a PageSetup object that indicates the page setup info in the Pdf document.
`PageTransitionType`	`getPageTransition()` Gets a PageTransitionType that indicates the pdf document page transition type.
`Sections`	`getSections()` Gets a Sections collection that indicates all sections in the Pdf document.
`Security`	`getSecurity()` Gets a Security object that indicates the document security information.
`TextInfo`	`getTextInfo()` Gets a TextInfo object that indicates the text info in the Pdf document.
`boolean`	`isBookmarked()` Gets or sets a bool value that indicates whether the pdf document is bookmarked when generating PDF document. The default value is false.
`boolean`	`isPageNumberRestarted()` Gets a bool value that indicates whether the page number is restarted in new section.
`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`	`resetNumber(int position)` Resets all heading number after given position.
`void`	`save(java.io.OutputStream out)` Saves the converted pdf stream.
`void`	`setBackgroundColor(Color color)` Sets a Color object that indicates the background color of the pdf.
`void`	`setBackgroundImageFile(java.lang.String imageFile)` Sets a string that indicates the background image file name.
`void`	`setBackgroundImageFixedWidth(float imageFixedWidth)` Sets a float value that indicates the fixed width of the background image.
`void`	`setBackgroundImagePosition(float xPosition, float yPosition)` Sets the background image position.
`void`	`setBookmarked(boolean isBookmarked)`
`void`	`setBookMarkLevel(int bookMarkLevel)`
`void`	`setDestinationType(DestinationType type)` Sets a DestinationType value that indicates the document open action.
`void`	`setFirstLineIndent(int indent)` Sets an int value that indicates the indent of the first line.
`static void`	`setFoImagePath(java.lang.String path)` Sets an image path to system image path.
`void`	`setGraphInfo(GraphInfo graphInfo)` Sets a GraphInfo object that indicates the graph info in the Pdf document.
`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`	`setJavaScripts(JavaScripts scripts)` Sets a JavaScripts object that indicates the JavaScripts to be added into the PDF.
`void`	`setOpenType(OpenType type)` Sets an OpenType that indicates the document open type.
`void`	`setPageDuration(int duration)` Sets a int value that indicates the duration in seconds for the current page.
`Pdf`	`setPageNumberRestarted(boolean pageNumberRestarted)` Gets a bool value that indicates whether the page number is restarted in new section.
`void`	`setPageSetup(PageSetup pageSetup)` Sets a PageSetup object that indicates the page setup info in the Pdf document.
`Pdf`	`setPageTransition(PageTransitionType transition)` Sets a PageTransitionType that indicates the pdf document page transition type.
`void`	`setSections(Sections secs)` Sets a Sections collection that indicates all sections in the Pdf document.
`Pdf`	`setSecurity(Security security)` Sets a Security object that indicates the document security information.
`void`	`setTextInfo(TextInfo textInfo)` Sets a TextInfo object that indicates the text info in the Pdf document.
`java.lang.String`	`version()` Gets the version of Aspose Pdf.

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

Pdf

public Pdf()
    throws AsposeBaseException

Initialize a new instance of the Pdf class.

 [SampleCode]
 Pdf pdf = new Pdf();
 Section sec1 = pdf.getSections().add();
 Text text1 = new Text(sec1,"Hello World, this is my first pdf.");
 sec1.getParagraphs().add(text1);
 pdf.save(new FileOutputStream(new File("./HelloWorldExample.pdf")));

Throws:: AsposeBaseException

Method Detail

setFoImagePath

public static void setFoImagePath(java.lang.String path)

Sets an image path to system image path.

Parameters:: path - The path to set.

getFoImagePath

public static java.lang.String getFoImagePath()

Sets an image path to system image path.

bindFo

public void bindFo(java.io.InputStream foStream)
            throws AsposeBaseException

Binds fo file as InputSteam.
NOTE: This is Beta version of Fo2Pdf. Some complex XSL-FO may not be supported and we may be not able to fix it in short time.

 [SampleCode]
 Pdf docConvert = new Pdf();
 docConvert.bindFo(new FileInputStream(new File("../fofile/helloworld.fo")));
 docConvert.save(new FileOutputStream(new File("./helloworld.pdf")));

Parameters:: foStream - Format-Object file as InputStream to be converted
Throws:: AsposeBaseException

bindFo

public void bindFo(java.io.InputStream xmlStream,
                   java.io.InputStream xsltStream)
            throws AsposeBaseException

Binds xml file and according xsl file as InputStream to be converted.
NOTE: This is Beta version of Fo2Pdf. Some complex XSL-FO may not be supported and we may be not able to fix it in short time.

 [SampleCode]
 Pdf docConvert = new Pdf();
 docConvert.bindFo(new FileInputStream(new File("../fofile/glossary.xml")),
 new FileInputStream(new File("../fofile/glossary.xsl")));
 docConvert.save(new FileOutputStream(new File("./glossary.pdf")));

Parameters:: xmlStream - xml file stream; xsltStream - xslt file stream
Throws:: AsposeBaseException

bindXML

public static Pdf bindXML(java.io.InputStream xmlStream)
                   throws javax.xml.parsers.ParserConfigurationException,
                          org.xml.sax.SAXException,
                          java.io.IOException

Reads info from an xml document.

Parameters:: xmlStream -
Returns:: Pdf Instance
Throws:: javax.xml.parsers.ParserConfigurationException; org.xml.sax.SAXException; java.io.IOException

bindXMLByDom

public static Pdf bindXMLByDom(java.io.InputStream xmlStream)
                        throws javax.xml.parsers.ParserConfigurationException,
                               org.xml.sax.SAXException,
                               java.io.IOException

Reads info from an xml document.

Parameters:: xmlStream -
Returns:: Pdf Instance
Throws:: javax.xml.parsers.ParserConfigurationException; org.xml.sax.SAXException; java.io.IOException

bindHTML

public void bindHTML(java.io.InputStream htmlStream,
                     java.net.URL baseUrl)

Binds a html stream and convert it to Pdf Stream.
NOTE: This is Beta version of bindHTML. Only simple HTML is supported.

Parameters:: htmlStream - the html stream that to be converted; baseUrl - the url that points to the html file.
Throws:: javax.xml.parsers.ParserConfigurationException; org.xml.sax.SAXException

setSections

public void setSections(Sections secs)

Sets a Sections collection that indicates all sections in the Pdf document.

getSections

public Sections getSections()

Gets a Sections collection that indicates all sections in the Pdf document.

setPageSetup

public void setPageSetup(PageSetup pageSetup)

Sets a PageSetup object that indicates the page setup info in the Pdf document.

getPageSetup

public PageSetup getPageSetup()

Gets a PageSetup object that indicates the page setup info in the Pdf document.

getFirstLineIndent

public int getFirstLineIndent()

Gets an int value that indicates the indent of the first line.

setFirstLineIndent

public void setFirstLineIndent(int indent)

Sets an int value that indicates the indent of the first line.

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.

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.

getTextInfo

public TextInfo getTextInfo()

Gets a TextInfo object that indicates the text info in the Pdf document.

setTextInfo

public void setTextInfo(TextInfo textInfo)

Sets a TextInfo object that indicates the text info in the Pdf document.

addAuthor

public void addAuthor(java.lang.String author)

Sets a string that indicates the author name of the Pdf document.

Parameters:: author - The author name to set.

addSubject

public void addSubject(java.lang.String subject)

Sets a string that indicates the subject of the Pdf document.

Parameters:: subject - The subject to set.

addCreator

public void addCreator(java.lang.String creator)

Sets a string that indicates the creator of the Pdf document.

addKeywords

public void addKeywords(java.lang.String keyWords)

Sets a string that indicates key wor

com.aspose.pdf.elements Class Pdf

Pdf

setFoImagePath

getFoImagePath

bindFo

bindFo

bindXML

bindXMLByDom

bindHTML

setSections

getSections

setPageSetup

getPageSetup

getFirstLineIndent

setFirstLineIndent

isSpaced

setIsSpaced

getTextInfo

setTextInfo

addAuthor

addSubject

addCreator

addKeywords

com.aspose.pdf.elements
Class Pdf