DeviceXps

Inheritance: java.lang.Object, com.aspose.page.Device

public abstract class DeviceXps extends Device

Intermediate device class containing internal convenience members.

Constructors

ConstructorDescription
DeviceXps()Creates a new instance.
DeviceXps(Dimension pageSize)Creates a new instance with the specified media size.

Fields

FieldDescription
DEFAULT_SIZE
VERSIONCurrent device version.

Methods

MethodDescription
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.

DeviceXps()

public DeviceXps()

Creates a new instance.

DeviceXps(Dimension pageSize)

public DeviceXps(Dimension pageSize)

Creates a new instance with the specified media size.

Parameters:

ParameterTypeDescription
pageSizejava.awt.DimensionThe size of the device output media.

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:

ParameterTypeDescription
pathjava.awt.ShapeA 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:

ParameterTypeDescription
xfloatX coordinate of center of the arc.
yfloatY coordinate of center of the arc.
widthfloatA width of circumscribed rectangle.
heightfloatA height of circumscribed rectangle.
startAnglefloatA start angle of the arc.
arcAnglefloatAn 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:

ParameterTypeDescription
imagejava.awt.image.BufferedImageAn image to be drawn.
transformjava.awt.geom.AffineTransformA transform.
bkgjava.awt.ColorA 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:

ParameterTypeDescription
x1floatX coordinate of the beginning of segment.
y1floatY coordinate of the beginning of segment.
x2floatX coordinate of the end of segment.
y2floatY 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:

ParameterTypeDescription
xfloatX coordinate of center of the oval.
yfloatY coordinate of center of the oval.
widthfloatA width of circumscribed rectangle.
heightfloatA height of circumscribed rectangle.

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

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

Draws a polygon.

Parameters:

ParameterTypeDescription
xPointsfloat[]X coordinates of points.
yPointsfloat[]Y coordinate of points.
nPointsintThe number of points.

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

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

Draws a polygon.

Parameters:

ParameterTypeDescription
xPointsint[]X coordinates of points.
yPointsint[]Y coordinate of points.
nPointsintThe number of points.

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

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

Draws a polyline.

Parameters:

ParameterTypeDescription
xPointsfloat[]X coordinates of points.
yPointsfloat[]Y coordinate of points.
nPointsintThe number of points.

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

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

Draws a polyline.

Parameters:

ParameterTypeDescription
xPointsint[]X coordinates of points.
yPointsint[]Y coordinate of points.
nPointsintThe 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:

ParameterTypeDescription
xfloatX coordinate of upper left corner of the rectangle.
yfloatY coordinate of upper left corner of the rectangle.
widthfloatA width of the rectangle.
heightfloatA 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:

ParameterTypeDescription
xfloatX coordinate of upper left corner of the rectangle.
yfloatY coordinate of upper left corner of the rectangle.
widthfloatA width of the rectangle.
heightfloatA height of the rectangle.
arcWidthfloatA width of circumscribed rectangle of the arc that rounds an angle of the rectangle.
arcHeightfloatA 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:

ParameterTypeDescription
strjava.lang.StringA string to be drawn.
xfloatX coordinate of point.
yfloatY 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:

ParameterTypeDescription
arg0java.lang.Object

Returns: boolean

fill(Shape path)

public void fill(Shape path)

Fills a path.

Parameters:

ParameterTypeDescription
pathjava.awt.ShapeA 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:

ParameterTypeDescription
xfloatX coordinate of center of the arc.
yfloatY coordinate of center of the arc.
widthfloatA width of circumscribed rectangle.
heightfloatA height of circumscribed rectangle.
startAnglefloatA start angle of the arc.
arcAnglefloatAn 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:

ParameterTypeDescription
xfloatX coordinate of center of the oval.
yfloatY coordinate of center of the oval.
widthfloatA width of circumscribed rectangle.
heightfloatA height of circumscribed rectangle.

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

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

Fills a polygon.

Parameters:

ParameterTypeDescription
xPointsfloat[]X coordinates of points.
yPointsfloat[]Y coordinate of points.
nPointsintThe number of points.

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

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

Fills a polygon.

Parameters:

ParameterTypeDescription
xPointsint[]X coordinates of points.
yPointsint[]Y coordinate of points.
nPointsintThe 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:

ParameterTypeDescription
xfloatX coordinate of upper left corner of the rectangle.
yfloatY coordinate of upper left corner of the rectangle.
widthfloatA width of the rectangle.
heightfloatA 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:

ParameterTypeDescription
xfloatX coordinate of upper left corner of the rectangle.
yfloatY coordinate of upper left corner of the rectangle.
widthfloatA width of the rectangle.
heightfloatA height of the rectangle.
arcWidthfloatA width of circumscribed rectangle of the arc that rounds an angle of the rectangle.
arcHeightfloatA 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:

ParameterTypeDescription
keyjava.lang.StringThe 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:

ParameterTypeDescription
keyjava.lang.StringThe 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:

ParameterTypeDescription
keyjava.lang.StringThe name of property.

Returns: double - The property value.

getPropertyInt(String key)

public int getPropertyInt(String key)

Gets a value of integer property.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.

Returns: int - The property value.

getPropertyMargins(String key)

public Insets getPropertyMargins(String key)

Gets a value of margins property.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe 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:

ParameterTypeDescription
keyjava.lang.StringThe 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:

ParameterTypeDescription
keyjava.lang.StringThe 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:

ParameterTypeDescription
keyjava.lang.StringThe 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:

ParameterTypeDescription
keyjava.lang.StringThe 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:

ParameterTypeDescription
mainDocumentboolean

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:

ParameterTypeDescription
thetadoubleAngle 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:

ParameterTypeDescription
thetadoubleAn angle of rotation in radians.
xdoubleX coordinate of point.
ydoubleY coordinate of point.

scale(double x, double y)

public void scale(double x, double y)

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

Parameters:

ParameterTypeDescription
xdoubleA scale in X axis.
ydoubleA scale in Y axis.

setBackground(Color background)

public void setBackground(Color background)

Specifies current background of the page.

Parameters:

ParameterTypeDescription
backgroundjava.awt.ColorA background of the page.

setCharTM(AffineTransform charTM)

public void setCharTM(AffineTransform charTM)

Specifies characters transform.

Parameters:

ParameterTypeDescription
charTMjava.awt.geom.AffineTransform\u0421haracters transform.

setClip(Shape clipPath)

public void setClip(Shape clipPath)

Specifies the clip of the device.

Parameters:

ParameterTypeDescription
clipPathjava.awt.ShapeA clipping path.

setCreator(String creator)

public void setCreator(String creator)

Specifies creator of resulting device output.

Parameters:

ParameterTypeDescription
creatorjava.lang.StringA creator value.

setFont(ITrFont font)

public void setFont(ITrFont font)

Specifies a font.

Parameters:

ParameterTypeDescription
fontITrFontA font.

setOpacity(float opacity)

public void setOpacity(float opacity)

Specifies opacity.

Parameters:

ParameterTypeDescription
opacityfloatAn opacity.

setOpacityMask(Paint opacityMask)

public void setOpacityMask(Paint opacityMask)

Specifies a opacity mask.

Parameters:

ParameterTypeDescription
opacityMaskjava.awt.PaintA opacity mask.

setPaint(Paint paint)

public void setPaint(Paint paint)

Specifies a paint.

Parameters:

ParameterTypeDescription
paintjava.awt.PaintA paint.

setProperties(UserProperties props)

public void setProperties(UserProperties props)

Specifies device properties including metadata.

Parameters:

ParameterTypeDescription
propsUserPropertiesDevice properties.

setSaveOptions(SaveOptions options)

public void setSaveOptions(SaveOptions options)

Specifies options for managing rendering process.

Parameters:

ParameterTypeDescription
optionsSaveOptionsOptions for managing rendering process.

setSize(Dimension size)

public void setSize(Dimension size)

Specifies size of page.

Parameters:

ParameterTypeDescription
sizejava.awt.DimensionSize of page.

setStroke(Stroke stroke)

public void setStroke(Stroke stroke)

Specifies a stroke.

Parameters:

ParameterTypeDescription
strokejava.awt.StrokeA stroke.

setTextRenderingMode(TextRenderingMode textRenderingMode)

public void setTextRenderingMode(TextRenderingMode textRenderingMode)

Specifies text rendering mode.

Parameters:

ParameterTypeDescription
textRenderingModeTextRenderingModeText rendering mode.

setTextStrokeWidth(float textStrokeWidth)

public void setTextStrokeWidth(float textStrokeWidth)

Specifies text stroke width.

Parameters:

ParameterTypeDescription
textStrokeWidthfloatText stroke width.

setTransform(AffineTransform transform)

public void setTransform(AffineTransform transform)

Specifies current transform.

Parameters:

ParameterTypeDescription
transformjava.awt.geom.AffineTransformA transform..

shear(double shx, double shy)

public void shear(double shx, double shy)

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

Parameters:

ParameterTypeDescription
shxdoubleA shear in X axis.
shydoubleA 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:

ParameterTypeDescription
transformjava.awt.geom.AffineTransformTransform to be applied.

translate(double x, double y)

public void translate(double x, double y)

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

Parameters:

ParameterTypeDescription
xdoubleTranslation in X axis.
ydoubleTranslation in Y axis.

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

ParameterTypeDescription
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

ParameterTypeDescription
arg0long
arg1int

writeComment(String comment)

public void writeComment(String comment)

Writes a comment.

Parameters:

ParameterTypeDescription
commentjava.lang.StringA comment to be written.

writeString(ITrFont font, String str)

public void writeString(ITrFont font, String str)

Writes out string with specified font.

Parameters:

ParameterTypeDescription
fontITrFontSpecified font.
strjava.lang.StringThe string.