Device

Inheritance: java.lang.Object

public abstract class Device

This class encapsulates rendering of document to abstract device. Rendering of the document is performed page by page.

Constructors

Constructor	Description
Device(Dimension pageSize)	Creates the new instance of Device with a size of a page.

Fields

Field	Description
DEFAULT_SIZE
VERSION	Current device version.

Methods

Method	Description
create()	Creates a copy of this device.
dispose()	Disposes the device.
draw(Shape path)	Draws a path.
drawArc(float x, float y, float width, float height, float startAngle, float arcAngle)	Draws an arc.
drawImage(BufferedImage image, AffineTransform transform, Color bkg)	Draws an image with assigned transform and background.
drawLine(float x1, float y1, float x2, float y2)	Draws a line segment.
drawOval(float x, float y, float width, float height)	Draws an oval.
drawPolygon(float[] xPoints, float[] yPoints, int nPoints)	Draws a polygon.
drawPolygon(int[] xPoints, int[] yPoints, int nPoints)	Draws a polygon.
drawPolyline(float[] xPoints, float[] yPoints, int nPoints)	Draws a polyline.
drawPolyline(int[] xPoints, int[] yPoints, int nPoints)	Draws a polyline.
drawRect(float x, float y, float width, float height)	Draws a rectangle.
drawRoundRect(float x, float y, float width, float height, float arcWidth, float arcHeight)	Draws a round rectangle.
drawString(String str, float x, float y)	Draws a string at given point.
endDocument()	Makes necessary preparation of device after the document has been rendered.
equals(Object arg0)
fill(Shape path)	Fills a path.
fillArc(float x, float y, float width, float height, float startAngle, float arcAngle)	Fills an arc.
fillOval(float x, float y, float width, float height)	Fills an oval.
fillPolygon(float[] xPoints, float[] yPoints, int nPoints)	Fills a polygon.
fillPolygon(int[] xPoints, int[] yPoints, int nPoints)	Fills a polygon.
fillRect(float x, float y, float width, float height)	Fills a rectangle.
fillRoundRect(float x, float y, float width, float height, float arcWidth, float arcHeight)	Draws a round rectangle.
getBackground()	Gets current background of the page.
getCharTM()	Gets current characters transform.
getClass()
getCreator()	Gets creator of resulting device output.
getFont()	Gets current font.
getOpacity()	Gets current opacity.
getOpacityMask()	Gets current opacity mask.
getPaint()	Gets current paint.
getProperties()	Gets device properties including metadata.
getProperty(String key)	Gets a value of string property.
getPropertyColor(String key)	Gets a value of color property.
getPropertyDouble(String key)	Gets a value of double property.
getPropertyInt(String key)	Gets a value of integer property.
getPropertyMargins(String key)	Gets a value of margins property.
getPropertyMatrix(String key)	Gets a value of matrix property.
getPropertyRectangle(String key)	Gets a value of rectangle property.
getPropertySize(String key)	Gets a value of size property.
getSaveOptions()	Returns save options.
getSize()	Gets a size of the page.
getStroke()	Gets current stroke.
getTextRenderingMode()	Gets current text rendering mode.
getTextStrokeWidth()	Gets current text stroke width.
getTransform()	Gets current transform.
hashCode()
initClip()	Initializes clip of the device.
isDirectRGB()	Indicates whether device uses direct RGB mode, that is RGB.
isMainDocument()
isProperty(String key)	Gets a value of boolean property.
notify()
notifyAll()
renew()	Reset device to initial state for whole document.
renewForMerge(boolean mainDocument)
reset()	Reset the device to initial state for a page.
rotate(double theta)	Rotate the current transformation matrix.
rotate(double theta, double x, double y)	Rotate the current transformation matrix around a point.
scale(double x, double y)	Scales the current transformation matrix.
setBackground(Color background)	Specifies current background of the page.
setCharTM(AffineTransform charTM)	Specifies characters transform.
setClip(Shape clipPath)	Specifies the clip of the device.
setCreator(String creator)	Specifies creator of resulting device output.
setFont(ITrFont font)	Specifies a font.
setOpacity(float opacity)	Specifies opacity.
setOpacityMask(Paint opacityMask)	Specifies a opacity mask.
setPaint(Paint paint)	Specifies a paint.
setProperties(UserProperties props)	Specifies device properties including metadata.
setSaveOptions(SaveOptions options)	Specifies options for managing rendering process.
setSize(Dimension size)	Specifies size of page.
setStroke(Stroke stroke)	Specifies a stroke.
setTextRenderingMode(TextRenderingMode textRenderingMode)	Specifies text rendering mode.
setTextStrokeWidth(float textStrokeWidth)	Specifies text stroke width.
setTransform(AffineTransform transform)	Specifies current transform.
shear(double shx, double shy)	Shears the current transformation matrix.
startDocument()	Makes necessary preparation of device before start rendering of document.
toString()	Returns the name of device type.
transform(AffineTransform transform)	Transforms the current transformation matrix.
translate(double x, double y)	Translates the current transformation matrix.
wait()
wait(long arg0)
wait(long arg0, int arg1)
writeComment(String comment)	Writes a comment.
writeString(ITrFont font, String str)	Writes out string with specified font.

Device(Dimension pageSize)

public Device(Dimension pageSize)

Creates the new instance of Device with a size of a page.

Parameters:

Parameter	Type	Description
pageSize	java.awt.Dimension	Page size.

DEFAULT_SIZE

public static final Dimension DEFAULT_SIZE

VERSION

public static String VERSION

Current device version.

create()

public Device create()

Creates a copy of this device.

Returns: Device - Copy of this device.

dispose()

public void dispose()

Disposes the device.

draw(Shape path)

public void draw(Shape path)

Draws a path.

Parameters:

Parameter	Type	Description
path	java.awt.Shape	A path to be drawn.

drawArc(float x, float y, float width, float height, float startAngle, float arcAngle)

public void drawArc(float x, float y, float width, float height, float startAngle, float arcAngle)

Draws an arc.

Parameters:

Parameter	Type	Description
x	float	X coordinate of center of the arc.
y	float	Y coordinate of center of the arc.
width	float	A width of circumscribed rectangle.
height	float	A height of circumscribed rectangle.
startAngle	float	A start angle of the arc.
arcAngle	float	An angle of the arc.

drawImage(BufferedImage image, AffineTransform transform, Color bkg)

public void drawImage(BufferedImage image, AffineTransform transform, Color bkg)

Draws an image with assigned transform and background.

Parameters:

Parameter	Type	Description
image	java.awt.image.BufferedImage	An image to be drawn.
transform	java.awt.geom.AffineTransform	A transform.
bkg	java.awt.Color	A background color.

drawLine(float x1, float y1, float x2, float y2)

public void drawLine(float x1, float y1, float x2, float y2)

Draws a line segment.

Parameters:

Parameter	Type	Description
x1	float	X coordinate of the beginning of segment.
y1	float	Y coordinate of the beginning of segment.
x2	float	X coordinate of the end of segment.
y2	float	Y coordinate of the end of segment.

drawOval(float x, float y, float width, float height)

public void drawOval(float x, float y, float width, float height)

Draws an oval.

Parameters:

Parameter	Type	Description
x	float	X coordinate of center of the oval.
y	float	Y coordinate of center of the oval.
width	float	A width of circumscribed rectangle.
height	float	A height of circumscribed rectangle.

drawPolygon(float[] xPoints, float[] yPoints, int nPoints)

public void drawPolygon(float[] xPoints, float[] yPoints, int nPoints)

Draws a polygon.

Parameters:

Parameter	Type	Description
xPoints	float[]	X coordinates of points.
yPoints	float[]	Y coordinate of points.
nPoints	int	The number of points.

drawPolygon(int[] xPoints, int[] yPoints, int nPoints)

public void drawPolygon(int[] xPoints, int[] yPoints, int nPoints)

Draws a polygon.

Parameters:

Parameter	Type	Description
xPoints	int[]	X coordinates of points.
yPoints	int[]	Y coordinate of points.
nPoints	int	The number of points.

drawPolyline(float[] xPoints, float[] yPoints, int nPoints)

public void drawPolyline(float[] xPoints, float[] yPoints, int nPoints)

Draws a polyline.

Parameters:

Parameter	Type	Description
xPoints	float[]	X coordinates of points.
yPoints	float[]	Y coordinate of points.
nPoints	int	The number of points.

drawPolyline(int[] xPoints, int[] yPoints, int nPoints)

public void drawPolyline(int[] xPoints, int[] yPoints, int nPoints)

Draws a polyline.

Parameters:

Parameter	Type	Description
xPoints	int[]	X coordinates of points.
yPoints	int[]	Y coordinate of points.
nPoints	int	The number of points.

drawRect(float x, float y, float width, float height)

public void drawRect(float x, float y, float width, float height)

Draws a rectangle.

Parameters:

Parameter	Type	Description
x	float	X coordinate of upper left corner of the rectangle.
y	float	Y coordinate of upper left corner of the rectangle.
width	float	A width of the rectangle.
height	float	A height of the rectangle.

drawRoundRect(float x, float y, float width, float height, float arcWidth, float arcHeight)

public void drawRoundRect(float x, float y, float width, float height, float arcWidth, float arcHeight)

Draws a round rectangle.

Parameters:

Parameter	Type	Description
x	float	X coordinate of upper left corner of the rectangle.
y	float	Y coordinate of upper left corner of the rectangle.
width	float	A width of the rectangle.
height	float	A height of the rectangle.
arcWidth	float	A width of circumscribed rectangle of the arc that rounds an angle of the rectangle.
arcHeight	float	A height of circumscribed rectangle of the arc that rounds an angle of the rectangle.

drawString(String str, float x, float y)

public void drawString(String str, float x, float y)

Draws a string at given point.

Parameters:

Parameter	Type	Description
str	java.lang.String	A string to be drawn.
x	float	X coordinate of point.
y	float	Y coordinate of point.

endDocument()

public void endDocument()

Makes necessary preparation of device after the document has been rendered.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

fill(Shape path)

public void fill(Shape path)

Fills a path.

Parameters:

Parameter	Type	Description
path	java.awt.Shape	A path to be filled.

fillArc(float x, float y, float width, float height, float startAngle, float arcAngle)

public void fillArc(float x, float y, float width, float height, float startAngle, float arcAngle)

Fills an arc.

Parameters:

Parameter	Type	Description
x	float	X coordinate of center of the arc.
y	float	Y coordinate of center of the arc.
width	float	A width of circumscribed rectangle.
height	float	A height of circumscribed rectangle.
startAngle	float	A start angle of the arc.
arcAngle	float	An angle of the arc.

fillOval(float x, float y, float width, float height)

public void fillOval(float x, float y, float width, float height)

Fills an oval.

Parameters:

Parameter	Type	Description
x	float	X coordinate of center of the oval.
y	float	Y coordinate of center of the oval.
width	float	A width of circumscribed rectangle.
height	float	A height of circumscribed rectangle.

fillPolygon(float[] xPoints, float[] yPoints, int nPoints)

public void fillPolygon(float[] xPoints, float[] yPoints, int nPoints)

Fills a polygon.

Parameters:

Parameter	Type	Description
xPoints	float[]	X coordinates of points.
yPoints	float[]	Y coordinate of points.
nPoints	int	The number of points.

fillPolygon(int[] xPoints, int[] yPoints, int nPoints)

public void fillPolygon(int[] xPoints, int[] yPoints, int nPoints)

Fills a polygon.

Parameters:

Parameter	Type	Description
xPoints	int[]	X coordinates of points.
yPoints	int[]	Y coordinate of points.
nPoints	int	The number of points.

fillRect(float x, float y, float width, float height)

public void fillRect(float x, float y, float width, float height)

Fills a rectangle.

Parameters:

Parameter	Type	Description
x	float	X coordinate of upper left corner of the rectangle.
y	float	Y coordinate of upper left corner of the rectangle.
width	float	A width of the rectangle.
height	float	A height of the rectangle.

fillRoundRect(float x, float y, float width, float height, float arcWidth, float arcHeight)

public void fillRoundRect(float x, float y, float width, float height, float arcWidth, float arcHeight)

Draws a round rectangle.

Parameters:

Parameter	Type	Description
x	float	X coordinate of upper left corner of the rectangle.
y	float	Y coordinate of upper left corner of the rectangle.
width	float	A width of the rectangle.
height	float	A height of the rectangle.
arcWidth	float	A width of circumscribed rectangle of the arc that rounds an angle of the rectangle.
arcHeight	float	A height of circumscribed rectangle of the arc that rounds an angle of the rectangle.

getBackground()

public Color getBackground()

Gets current background of the page.

Returns: java.awt.Color - Current background of the page

getCharTM()

public AffineTransform getCharTM()

Gets current characters transform.

Returns: java.awt.geom.AffineTransform - Current characters transform.

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getCreator()

public String getCreator()

Gets creator of resulting device output.

Returns: java.lang.String - A creator value.

getFont()

public ITrFont getFont()

Gets current font.

Returns: ITrFont - Current font.

getOpacity()

public float getOpacity()

Gets current opacity.

Returns: float - Current opacity.

getOpacityMask()

public Paint getOpacityMask()

Gets current opacity mask.

Returns: java.awt.Paint - Current opacity mask.

getPaint()

public Paint getPaint()

Gets current paint.

Returns: java.awt.Paint - Current paint.

getProperties()

public UserProperties getProperties()

Gets device properties including metadata.

Returns: UserProperties - Device properties.

getProperty(String key)

public String getProperty(String key)

Gets a value of string property.

Parameters:

Parameter	Type	Description
key	java.lang.String	The name of property.

Returns: java.lang.String - The property value.

getPropertyColor(String key)

public Color getPropertyColor(String key)

Gets a value of color property.

Parameters:

Parameter	Type	Description
key	java.lang.String	The name of property.

Returns: java.awt.Color - The property value.

getPropertyDouble(String key)

public double getPropertyDouble(String key)

Gets a value of double property.

Parameters:

Parameter	Type	Description
key	java.lang.String	The name of property.

Returns: double - The property value.

getPropertyInt(String key)

public int getPropertyInt(String key)

Gets a value of integer property.

Parameters:

Parameter	Type	Description
key	java.lang.String	The name of property.

Returns: int - The property value.

getPropertyMargins(String key)

public Insets getPropertyMargins(String key)

Gets a value of margins property.

Parameters:

Parameter	Type	Description
key	java.lang.String	The name of property.

Returns: java.awt.Insets - The property value.

getPropertyMatrix(String key)

public AffineTransform getPropertyMatrix(String key)

Gets a value of matrix property.

Parameters:

Parameter	Type	Description
key	java.lang.String	The name of property.

Returns: java.awt.geom.AffineTransform - The property value.

getPropertyRectangle(String key)

public Rectangle getPropertyRectangle(String key)

Gets a value of rectangle property.

Parameters:

Parameter	Type	Description
key	java.lang.String	The name of property.

Returns: java.awt.Rectangle - The property value.

getPropertySize(String key)

public Dimension getPropertySize(String key)

Gets a value of size property.

Parameters:

Parameter	Type	Description
key	java.lang.String	The name of property.

Returns: java.awt.Dimension - The property value.

getSaveOptions()

public SaveOptions getSaveOptions()

Returns save options.

Returns: SaveOptions - The save options.

getSize()

public Dimension getSize()

Gets a size of the page.

Returns: java.awt.Dimension - Size of page.

getStroke()

public Stroke getStroke()

Gets current stroke.

Returns: java.awt.Stroke - Current stroke.

getTextRenderingMode()

public TextRenderingMode getTextRenderingMode()

Gets current text rendering mode.

Returns: TextRenderingMode - Current text rendering mode.

getTextStrokeWidth()

public float getTextStrokeWidth()

Gets current text stroke width.

Returns: float - Current text stroke width.

getTransform()

public AffineTransform getTransform()

Gets current transform.

Returns: java.awt.geom.AffineTransform - Current transform.

hashCode()

public native int hashCode()

Returns: int

initClip()

public void initClip()

Initializes clip of the device.

isDirectRGB()

public boolean isDirectRGB()

Indicates whether device uses direct RGB mode, that is RGB.

Returns: boolean - True if direct RGB mode and false otherwise, that is BGR.

isMainDocument()

public boolean isMainDocument()

Returns: boolean

isProperty(String key)

public boolean isProperty(String key)

Gets a value of boolean property.

Parameters:

Parameter	Type	Description
key	java.lang.String	The name of property.

Returns: boolean - The property value.

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

renew()

public void renew()

Reset device to initial state for whole document. Used for reseting output stream.

renewForMerge(boolean mainDocument)

public void renewForMerge(boolean mainDocument)

Parameters:

Parameter	Type	Description
mainDocument	boolean

reset()

public void reset()

Reset the device to initial state for a page.

rotate(double theta)

public void rotate(double theta)

Rotate the current transformation matrix. Calls writeTransform(Transform). Rotating with a positive angle theta rotates points on the positive x axis toward the positive y axis.

Parameters:

Parameter	Type	Description
theta	double	Angle in radians over which to rotate.

rotate(double theta, double x, double y)

public void rotate(double theta, double x, double y)

Rotate the current transformation matrix around a point.

Parameters:

Parameter	Type	Description
theta	double	An angle of rotation in radians.
x	double	X coordinate of point.
y	double	Y coordinate of point.

scale(double x, double y)

public void scale(double x, double y)

Scales the current transformation matrix. Calls writeTransform(Transform).

Parameters:

Parameter	Type	Description
x	double	A scale in X axis.
y	double	A scale in Y axis.

setBackground(Color background)

public void setBackground(Color background)

Specifies current background of the page.

Parameters:

Parameter	Type	Description
background	java.awt.Color	A background of the page.

setCharTM(AffineTransform charTM)

public void setCharTM(AffineTransform charTM)

Specifies characters transform.

Parameters:

Parameter	Type	Description
charTM	java.awt.geom.AffineTransform	\u0421haracters transform.

setClip(Shape clipPath)

public void setClip(Shape clipPath)

Specifies the clip of the device.

Parameters:

Parameter	Type	Description
clipPath	java.awt.Shape	A clipping path.

setCreator(String creator)

public void setCreator(String creator)

Specifies creator of resulting device output.

Parameters:

Parameter	Type	Description
creator	java.lang.String	A creator value.

setFont(ITrFont font)

public void setFont(ITrFont font)

Specifies a font.

Parameters:

Parameter	Type	Description
font	ITrFont	A font.

setOpacity(float opacity)

public void setOpacity(float opacity)

Specifies opacity.

Parameters:

Parameter	Type	Description
opacity	float	An opacity.

setOpacityMask(Paint opacityMask)

public void setOpacityMask(Paint opacityMask)

Specifies a opacity mask.

Parameters:

Parameter	Type	Description
opacityMask	java.awt.Paint	A opacity mask.

setPaint(Paint paint)

public void setPaint(Paint paint)

Specifies a paint.

Parameters:

Parameter	Type	Description
paint	java.awt.Paint	A paint.

setProperties(UserProperties props)

public void setProperties(UserProperties props)

Specifies device properties including metadata.

Parameters:

Parameter	Type	Description
props	UserProperties	Device properties.

setSaveOptions(SaveOptions options)

public void setSaveOptions(SaveOptions options)

Specifies options for managing rendering process.

Parameters:

Parameter	Type	Description
options	SaveOptions	Options for managing rendering process.

setSize(Dimension size)

public void setSize(Dimension size)

Specifies size of page.

Parameters:

Parameter	Type	Description
size	java.awt.Dimension	Size of page.

setStroke(Stroke stroke)

public void setStroke(Stroke stroke)

Specifies a stroke.

Parameters:

Parameter	Type	Description
stroke	java.awt.Stroke	A stroke.

setTextRenderingMode(TextRenderingMode textRenderingMode)

public void setTextRenderingMode(TextRenderingMode textRenderingMode)

Specifies text rendering mode.

Parameters:

Parameter	Type	Description
textRenderingMode	TextRenderingMode	Text rendering mode.

setTextStrokeWidth(float textStrokeWidth)

public void setTextStrokeWidth(float textStrokeWidth)

Specifies text stroke width.

Parameters:

Parameter	Type	Description
textStrokeWidth	float	Text stroke width.

setTransform(AffineTransform transform)

public void setTransform(AffineTransform transform)

Specifies current transform.

Parameters:

Parameter	Type	Description
transform	java.awt.geom.AffineTransform	A transform..

shear(double shx, double shy)

public void shear(double shx, double shy)

Shears the current transformation matrix. Calls writeTransform(Transform).

Parameters:

Parameter	Type	Description
shx	double	A shear in X axis.
shy	double	A shear in Y axis.

startDocument()

public void startDocument()

Makes necessary preparation of device before start rendering of document.

toString()

public String toString()

Returns the name of device type.

Returns: java.lang.String - Type name.

transform(AffineTransform transform)

public void transform(AffineTransform transform)

Transforms the current transformation matrix. Calls writeTransform(Transform).

Parameters:

Parameter	Type	Description
transform	java.awt.geom.AffineTransform	Transform to be applied.

translate(double x, double y)

public void translate(double x, double y)

Translates the current transformation matrix. Calls writeTransform(Transform).

Parameters:

Parameter	Type	Description
x	double	Translation in X axis.
y	double	Translation in Y axis.

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int

writeComment(String comment)

public void writeComment(String comment)

Writes a comment.

Parameters:

Parameter	Type	Description
comment	java.lang.String	A comment to be written.

writeString(ITrFont font, String str)

public void writeString(ITrFont font, String str)

Writes out string with specified font.

Parameters:

Parameter	Type	Description
font	ITrFont	Specified font.
str	java.lang.String	The string.

AsposePageException DimensionF