PdfDevice
Inheritance: java.lang.Object, com.aspose.tex.rendering.Device
All Implemented Interfaces: com.aspose.tex.rendering.IInteractiveDevice, com.aspose.tex.rendering.IFragmentRasterizer
public class PdfDevice extends Device implements IInteractiveDevice, IFragmentRasterizer
Implements the interface for outputting text and graphic content to PDF document.
Constructors
Constructor | Description |
---|---|
PdfDevice() | Creates a new instance. |
PdfDevice(OutputStream stream) | Creates a new instance. |
Methods
Method | Description |
---|---|
initialize() | Initializes the device. |
getPageCount() | Gets the number of pages. |
isReady() | Shows if device is ready for output. |
getDestinationName() | Gets destination name: output file name or device description. |
create() | Creates a copy of this device. |
dispose() | Disposes the device. |
startDocument() | Starts the whole document. |
endDocument() | Finalizes the whole document. |
startPage(float width, float height) | Starts a new page. |
endPage() | Finalizes a page. |
addHyperlink(Rectangle2D activeRect, ColoredStroke border, String targetUri) | Sets the hyperlink with a URI as its target. |
addBookmark(String name, Point2D position) | Adds the bookmark identified by the name. |
setTransform(AffineTransform matrix) | Sets the current coordinate space transformation. |
setClip(Shape path) | Sets the current clip path. |
getStroke() | Gets the current stroke. |
setStroke(ColoredStroke value) | Sets the current stroke. |
getFill() | Gets the current fill color. |
setFill(Color value) | Sets the current fill color. |
getStrokeOpacity() | Gets the current stroke opacity. |
setStrokeOpacity(float value) | Sets the current stroke opacity. |
getFillOpacity() | Gets the current fill opacity. |
setFillOpacity(float value) | Sets the current fill opacity. |
drawString(String str, float originX, float originY, List | Draws a text string. |
drawPath(Shape path) | Draws a path. |
fillPath(Shape path) | Fills a path. |
showImage(Point2D origin, Dimension2D size, byte[] imageData) | Shows a raster image. |
startFragment() | Starts a fragment to rasterize. |
endFragment() | Ends a fragment to rasterize. |
PdfDevice()
public PdfDevice()
Creates a new instance. The output file will be written to the output working directory taking the job name as a file name.
PdfDevice(OutputStream stream)
public PdfDevice(OutputStream stream)
Creates a new instance. The output file will be written to specified stream.
Parameters:
Parameter | Type | Description |
---|---|---|
stream | java.io.OutputStream | The stream to write the output file to. |
initialize()
public void initialize()
Initializes the device.
getPageCount()
public int getPageCount()
Gets the number of pages.
Returns: int
isReady()
public boolean isReady()
Shows if device is ready for output.
Returns: boolean
getDestinationName()
public String getDestinationName()
Gets destination name: output file name or device description.
Returns: java.lang.String
create()
public Device create()
Creates a copy of this device.
Returns: Device - Copy of this device.
dispose()
public void dispose()
Disposes the device.
startDocument()
public void startDocument()
Starts the whole document.
endDocument()
public void endDocument()
Finalizes the whole document.
startPage(float width, float height)
public void startPage(float width, float height)
Starts a new page.
Parameters:
Parameter | Type | Description |
---|---|---|
width | float | The page width. |
height | float | The page height. |
endPage()
public void endPage()
Finalizes a page.
addHyperlink(Rectangle2D activeRect, ColoredStroke border, String targetUri)
public void addHyperlink(Rectangle2D activeRect, ColoredStroke border, String targetUri)
Sets the hyperlink with a URI as its target.
Parameters:
Parameter | Type | Description |
---|---|---|
activeRect | java.awt.geom.Rectangle2D | The active rectangle of the link. |
border | ColoredStroke | The link border. |
targetUri | java.lang.String | The target URI. |
addBookmark(String name, Point2D position)
public void addBookmark(String name, Point2D position)
Adds the bookmark identified by the name.
Parameters:
Parameter | Type | Description |
---|---|---|
name | java.lang.String | The bookmark name. |
position | java.awt.geom.Point2D | The bookmark position. |
setTransform(AffineTransform matrix)
public void setTransform(AffineTransform matrix)
Sets the current coordinate space transformation.
Parameters:
Parameter | Type | Description |
---|---|---|
matrix | java.awt.geom.AffineTransform | The transformation matrix. |
setClip(Shape path)
public void setClip(Shape path)
Sets the current clip path.
Parameters:
Parameter | Type | Description |
---|---|---|
path | java.awt.Shape | The clip path. |
getStroke()
public ColoredStroke getStroke()
Gets the current stroke.
Returns: ColoredStroke - The current stroke.
setStroke(ColoredStroke value)
public void setStroke(ColoredStroke value)
Sets the current stroke.
Parameters:
Parameter | Type | Description |
---|---|---|
value | ColoredStroke | The new current stroke. |
getFill()
public Color getFill()
Gets the current fill color.
Returns: java.awt.Color - The current fill color.
setFill(Color value)
public void setFill(Color value)
Sets the current fill color.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.awt.Color | The new current fill color. |
getStrokeOpacity()
public float getStrokeOpacity()
Gets the current stroke opacity.
Returns: float - The current stroke opacity.
setStrokeOpacity(float value)
public void setStrokeOpacity(float value)
Sets the current stroke opacity.
Parameters:
Parameter | Type | Description |
---|---|---|
value | float | The current stroke opacity. |
getFillOpacity()
public float getFillOpacity()
Gets the current fill opacity.
Returns: float - The current fill opacity.
setFillOpacity(float value)
public void setFillOpacity(float value)
Sets the current fill opacity.
Parameters:
Parameter | Type | Description |
---|---|---|
value | float | The current fill opacity. |
drawString(String str, float originX, float originY, List charInfos)
public void drawString(String str, float originX, float originY, List<GlyphData> charInfos)
Draws a text string.
Parameters:
Parameter | Type | Description |
---|---|---|
str | java.lang.String | The string. |
originX | float | The x coordinate of the origin. |
originY | float | The x coordinate of the origin. |
charInfos | java.util.List<com.aspose.tex.rendering.GlyphData> | Glyph data required for precise typesetting of a text string. |
drawPath(Shape path)
public void drawPath(Shape path)
Draws a path.
Parameters:
Parameter | Type | Description |
---|---|---|
path | java.awt.Shape | A path to draw. |
fillPath(Shape path)
public void fillPath(Shape path)
Fills a path.
Parameters:
Parameter | Type | Description |
---|---|---|
path | java.awt.Shape | A path to fill. |
showImage(Point2D origin, Dimension2D size, byte[] imageData)
public void showImage(Point2D origin, Dimension2D size, byte[] imageData)
Shows a raster image.
Parameters:
Parameter | Type | Description |
---|---|---|
origin | java.awt.geom.Point2D | The bottom-left corner of the shown image. |
size | java.awt.geom.Dimension2D | The size of the shown image. |
imageData | byte[] | The image data. |
startFragment()
public void startFragment()
Starts a fragment to rasterize.
endFragment()
public void endFragment()
Ends a fragment to rasterize.