com.aspose.tex.rendering

Class ImageDevice

java.lang.Object

com.aspose.tex.rendering.Device

com.aspose.tex.rendering.ImageDevice

public class ImageDevice
extends Device

Implements the interface for outputting text and graphic content to image(s).

Constructor Summary

Constructors

Modifier	Constructor and Description
	ImageDevice()
	ImageDevice(boolean whiteBackground) Creates new instance.
protected	ImageDevice(ImageDevice device) Clone constructor.

Method Summary

Modifier and Type	Method and Description
Device	create() Creates a copy of this device.
void	cropPage(int scale, Color bgColor, float margin)
void	dispose() Disposes this device instance.
void	drawPath(Shape path) Draws a path.
void	drawString(String str, float originX, float originY, List<GlyphData> charInfos) Draws a text string.
void	endDocument() Finalizes the whole document.
void	endPage() Finalizes a page.
void	fillPath(Shape path) Fills a path.
String	getDestinationName() Gets destination name: output file name or device description.
Color	getFill() Gets the current fill color.
int	getPageCount() Gets the number of pages.
byte[][]	getResult() Returns the resulting images byte arrays.
ColoredStroke	getStroke() Gets the current stroke.
void	init() Initializes device.
boolean	isReady() Shows if device is ready for output.
void	setClip(Shape path) Sets the current clip path.
void	setFill(Color value) Sets the current fill color.
void	setStroke(ColoredStroke value) Sets the current stroke.
void	setTransform(AffineTransform matrix) Sets the current coordinate space transformation.
void	showImage(Point2D origin, Dimension2D size, byte[] imageData) Shows a raster image.
void	startDocument() Starts the whole document.
void	startPage(float width, float height) Starts a new page.

Methods inherited from class com.aspose.tex.rendering.Device

restoreGraphicsState, saveGraphicsState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImageDevice

public ImageDevice()

ImageDevice

public ImageDevice(boolean whiteBackground)

Creates new instance. The output file will be written to the output working directory taking the job name as a file name.

Parameters:

whiteBackground - If true then fills white background on every page.

ImageDevice

protected ImageDevice(ImageDevice device)

Clone constructor. Initializes this device with another device.

Parameters:

device - The device to clone.

Method Detail

init

public void init()

Initializes device.

Specified by:

init in class Device

getPageCount

public int getPageCount()

Gets the number of pages.

Specified by:

getPageCount in class Device

Returns:

The number of pages.

isReady

public boolean isReady()

Shows if device is ready for output.

Specified by:

isReady in class Device

Returns:

True if device is ready to receive output. Otherwise, False.

getDestinationName

public String getDestinationName()

Gets destination name: output file name or device description.

Specified by:

getDestinationName in class Device

Returns:

Destination name: output file name or device description.

getResult

public byte[][] getResult()

Returns the resulting images byte arrays. The first dimension is for pages.

Returns:

The resulting images byte arrays.

create

public Device create()

Creates a copy of this device.

Overrides:

create in class Device

Returns:

Copy of this device.

dispose

public void dispose()

Disposes this device instance. Finalizes this device instance graphics state, i.e. switches composing context to the level higher then this device's graphics state.

Overrides:

dispose in class Device

startDocument

public void startDocument()

Starts the whole document.

Specified by:

startDocument in class Device

endDocument

public void endDocument()

Finalizes the whole document.

Specified by:

endDocument in class Device

startPage

public void startPage(float width,
                      float height)

Starts a new page.

Specified by:

startPage in class Device

Parameters:

width - The page width.

height - The page height.

endPage

public void endPage()

Finalizes a page.

Specified by:

endPage in class Device

setTransform

public void setTransform(AffineTransform matrix)

Sets the current coordinate space transformation.

Specified by:

setTransform in class Device

Parameters:

matrix - The transformation matrix.

setClip

public void setClip(Shape path)

Sets the current clip path.

Specified by:

setClip in class Device

Parameters:

path - The clip path.

getStroke

public ColoredStroke getStroke()

Gets the current stroke.

Overrides:

getStroke in class Device

Returns:

The current stroke.

setStroke

public void setStroke(ColoredStroke value)

Sets the current stroke.

Overrides:

setStroke in class Device

Parameters:

value - The new current stroke.

getFill

public Color getFill()

Gets the current fill color.

Overrides:

getFill in class Device

Returns:

The current fill color.

setFill

public void setFill(Color value)

Sets the current fill color.

Overrides:

setFill in class Device

Parameters:

value - The new current fill color.

drawString

public void drawString(String str,
                       float originX,
                       float originY,
                       List<GlyphData> charInfos)

Draws a text string.

Specified by:

drawString in class Device

Parameters:

str - The string.

originX - The x coordinate of the origin.

originY - The x coordinate of the origin.

charInfos - Glyph data required for precise typesetting of a text string.

drawPath

public void drawPath(Shape path)

Draws a path.

Specified by:

drawPath in class Device

Parameters:

path - A path to draw.

fillPath

public void fillPath(Shape path)

Fills a path.

Specified by:

fillPath in class Device

Parameters:

path - A path to fill.

showImage

public void showImage(Point2D origin,
                      Dimension2D size,
                      byte[] imageData)

Shows a raster image.

Specified by:

showImage in class Device

Parameters:

origin - The bottom-left corner of the shown image.

size - The size of the shown image.

imageData - The image data.

cropPage

public void cropPage(int scale,
                     Color bgColor,
                     float margin)