XpsPath

Inheritance: java.lang.Object, com.aspose.xps.XpsObject, com.aspose.xps.XpsElement, com.aspose.xps.XpsHyperlinkElement, com.aspose.xps.XpsContentElement

public final class XpsPath extends XpsContentElement

Class incapsulating Path element features. This element is the sole means of adding vector graphics and images to a fixed page. It defines a single vector graphic to be rendered on a page.

Methods

Method	Description
deepClone()	Clones this path.
equals(Object arg0)
get(int i)	Provides access to element’s children by index i .
getClass()
getClip()	Returns the path geometry limiting the rendered region of the element.
getData()	Returns the geometry of the path.
getFill()	Returns the brush used to paint the geometry specified by the Data property of the path.
getHyperlinkTarget()	Returns hyperlink target object.
getOpacity()	Returns the value defining the uniform transparency of the element.
getOpacityMask()	Returns the brush specifying a mask of alpha values that is applied to the element in the same fashion as the Opacity attribute, but allowing different alpha values for different areas of the element.
getRenderTransform()	Returns the affine transformation matrix establishing a new coordinate frame for all attributes of the element and for all child elements (if any).
getStroke()	Returns the brush used to draw the stroke.
getStrokeDashArray()	Returns the array specifying the length of dashes and gaps of the outline stroke.
getStrokeDashCap()	Returns the value specifying how the ends of each dash are drawn.
getStrokeDashOffset()	Returns the start point for repeating the dash array pattern.
getStrokeEndLineCap()	Returns the value defining the shape of the end of the last dash in a stroke.
getStrokeLineJoin()	Returns the value defining the shape of the beginning of the first dash in a stroke.
getStrokeMiterLimit()	Returns the ratio between the maximum miter length and half of the stroke thickness.
getStrokeStartLineCap()	Returns the value defining the shape of the beginning of the first dash in a stroke.
getStrokeThickness()	Returns the thickness of a stroke, in units of the effective coordinate space (includes the path’s render transform).
hashCode()
iterator()	Implementation of Iterable interface.
notify()
notifyAll()
setClip(XpsPathGeometry value)	Sets the path geometry limiting the rendered region of the element.
setData(XpsPathGeometry value)	Sets the geometry of the path.
setFill(XpsBrush value)	Sets the brush used to paint the geometry specified by the Data property of the path.
setHyperlinkTarget(XpsHyperlinkTarget value)	Sets hyperlink target object.
setOpacity(float value)	Sets the value defining the uniform transparency of the element.
setOpacityMask(XpsBrush value)	Sets the brush specifying a mask of alpha values that is applied to the element in the same fashion as the Opacity attribute, but allowing different alpha values for different areas of the element.
setRenderTransform(XpsMatrix value)	Sets the affine transformation matrix establishing a new coordinate frame for all attributes of the element and for all child elements (if any).
setStroke(XpsBrush value)	Sets the brush used to draw the stroke.
setStrokeDashArray(float[] value)	Sets the array specifying the length of dashes and gaps of the outline stroke.
setStrokeDashCap(XpsDashCap value)	Sets the value specifying how the ends of each dash are drawn.
setStrokeDashOffset(float value)	Sets the start point for repeating the dash array pattern.
setStrokeEndLineCap(XpsLineCap value)	Sets the value defining the shape of the end of the last dash in a stroke.
setStrokeLineJoin(XpsLineJoin value)	Sets the value defining the shape of the beginning of the first dash in a stroke.
setStrokeMiterLimit(float value)	Sets the ratio between the maximum miter length and half of the stroke thickness.
setStrokeStartLineCap(XpsLineCap value)	Sets the value defining the shape of the beginning of the first dash in a stroke.
setStrokeThickness(float value)	Sets the thickness of a stroke, in units of the effective coordinate space (includes the path’s render transform).
size()	Returns the number of child elements.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

deepClone()

public XpsPath deepClone()

Clones this path.

Returns: XpsPath - Clone this path.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

get(int i)

public XpsContentElement get(int i)

Provides access to element’s children by index i .

Parameters:

Parameter	Type	Description
i	int	Index of child element.

Returns: XpsContentElement - Child element at i position.

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getClip()

public XpsPathGeometry getClip()

Returns the path geometry limiting the rendered region of the element.

Returns: XpsPathGeometry - The path geometry limiting the rendered region of the element.

getData()

public XpsPathGeometry getData()

Returns the geometry of the path.

Returns: XpsPathGeometry - The geometry of the path.

getFill()

public XpsBrush getFill()

Returns the brush used to paint the geometry specified by the Data property of the path.

Returns: XpsBrush - The brush used to paint the geometry specified

getHyperlinkTarget()

public XpsHyperlinkTarget getHyperlinkTarget()

Returns hyperlink target object.

Returns: XpsHyperlinkTarget - Hyperlink target object.

getOpacity()

public float getOpacity()

Returns the value defining the uniform transparency of the element.

Returns: float - The value defining the uniform transparency of the element.

getOpacityMask()

public XpsBrush getOpacityMask()

Returns the brush specifying a mask of alpha values that is applied to the element in the same fashion as the Opacity attribute, but allowing different alpha values for different areas of the element.

Returns: XpsBrush - The brush specifying a mask.

getRenderTransform()

public XpsMatrix getRenderTransform()

Returns the affine transformation matrix establishing a new coordinate frame for all attributes of the element and for all child elements (if any).

Returns: XpsMatrix - The affine transformation matrix.

getStroke()

public XpsBrush getStroke()

Returns the brush used to draw the stroke.

Returns: XpsBrush - The brush used to draw the stroke.

getStrokeDashArray()

public float[] getStrokeDashArray()

Returns the array specifying the length of dashes and gaps of the outline stroke.

Returns: float[] - The array specifying the length of dashes and gaps of the outline stroke.

getStrokeDashCap()

public XpsDashCap getStrokeDashCap()

Returns the value specifying how the ends of each dash are drawn.

Returns: XpsDashCap - The value specifying how the ends of each dash are drawn.

getStrokeDashOffset()

public float getStrokeDashOffset()

Returns the start point for repeating the dash array pattern. If this value is omitted, the dash array aligns with the origin of the stroke.

Returns: float - The start point for repeating the dash array pattern.

getStrokeEndLineCap()

public XpsLineCap getStrokeEndLineCap()

Returns the value defining the shape of the end of the last dash in a stroke.

Returns: XpsLineCap - The value defining the shape of the end of the last dash in a stroke.

getStrokeLineJoin()

public XpsLineJoin getStrokeLineJoin()

Returns the value defining the shape of the beginning of the first dash in a stroke.

Returns: XpsLineJoin - The value defining the shape of the beginning of the first dash in a stroke.

getStrokeMiterLimit()

public float getStrokeMiterLimit()

Returns the ratio between the maximum miter length and half of the stroke thickness. This value is significant only if the StrokeLineJoin attribute specifies Miter .

Returns: float - The ratio between the maximum miter length and half of the stroke thickness.

getStrokeStartLineCap()

public XpsLineCap getStrokeStartLineCap()

Returns the value defining the shape of the beginning of the first dash in a stroke.

Returns: XpsLineCap - The value defining the shape of the beginning of the first dash in a stroke.

getStrokeThickness()

public float getStrokeThickness()

Returns the thickness of a stroke, in units of the effective coordinate space (includes the path’s render transform). The stroke is drawn on top of the boundary of the geometry specified by the Path element\u2019s Data property. Half of the StrokeThickness extends outside of the geometry specified by the Data property and the other half extends inside of the geometry.

Returns: float - The thickness of a stroke.

hashCode()

public native int hashCode()

Returns: int

iterator()

public Iterator<XpsContentElement> iterator()

Implementation of Iterable interface.

Returns: java.util.Iterator<com.aspose.xps.XpsContentElement> - Returns enumerator for the list.

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setClip(XpsPathGeometry value)

public void setClip(XpsPathGeometry value)

Sets the path geometry limiting the rendered region of the element.

Parameters:

Parameter	Type	Description
value	XpsPathGeometry	The path geometry limiting the rendered region of the element.

setData(XpsPathGeometry value)

public void setData(XpsPathGeometry value)

Sets the geometry of the path.

Parameters:

Parameter	Type	Description
value	XpsPathGeometry	The geometry of the path.

setFill(XpsBrush value)

public void setFill(XpsBrush value)

Sets the brush used to paint the geometry specified by the Data property of the path.

Parameters:

Parameter	Type	Description
value	XpsBrush	The brush used to paint the geometry specified

setHyperlinkTarget(XpsHyperlinkTarget value)

public void setHyperlinkTarget(XpsHyperlinkTarget value)

Sets hyperlink target object.

Parameters:

Parameter	Type	Description
value	XpsHyperlinkTarget	Hyperlink target object.

setOpacity(float value)

public void setOpacity(float value)

Sets the value defining the uniform transparency of the element.

Parameters:

Parameter	Type	Description
value	float	The value defining the uniform transparency of the element.

setOpacityMask(XpsBrush value)

public void setOpacityMask(XpsBrush value)

Sets the brush specifying a mask of alpha values that is applied to the element in the same fashion as the Opacity attribute, but allowing different alpha values for different areas of the element.

Parameters:

Parameter	Type	Description
value	XpsBrush	The brush specifying a mask.

setRenderTransform(XpsMatrix value)

public void setRenderTransform(XpsMatrix value)

Sets the affine transformation matrix establishing a new coordinate frame for all attributes of the element and for all child elements (if any).

Parameters:

Parameter	Type	Description
value	XpsMatrix	The affine transformation matrix.

setStroke(XpsBrush value)

public void setStroke(XpsBrush value)

Sets the brush used to draw the stroke.

Parameters:

Parameter	Type	Description
value	XpsBrush	The brush used to draw the stroke.

setStrokeDashArray(float[] value)

public void setStrokeDashArray(float[] value)

Sets the array specifying the length of dashes and gaps of the outline stroke.

Parameters:

Parameter	Type	Description
value	float[]	The array specifying the length of dashes and gaps of the outline stroke.

setStrokeDashCap(XpsDashCap value)

public void setStrokeDashCap(XpsDashCap value)

Sets the value specifying how the ends of each dash are drawn.

Parameters:

Parameter	Type	Description
value	XpsDashCap	The value specifying how the ends of each dash are drawn.

setStrokeDashOffset(float value)

public void setStrokeDashOffset(float value)

Sets the start point for repeating the dash array pattern. If this value is omitted, the dash array aligns with the origin of the stroke.

Parameters:

Parameter	Type	Description
value	float	The start point for repeating the dash array pattern.

setStrokeEndLineCap(XpsLineCap value)

public void setStrokeEndLineCap(XpsLineCap value)

Sets the value defining the shape of the end of the last dash in a stroke.

Parameters:

Parameter	Type	Description
value	XpsLineCap	The value defining the shape of the end of the last dash in a stroke.

setStrokeLineJoin(XpsLineJoin value)

public void setStrokeLineJoin(XpsLineJoin value)

Sets the value defining the shape of the beginning of the first dash in a stroke.

Parameters:

Parameter	Type	Description
value	XpsLineJoin	The value defining the shape of the beginning of the first dash in a stroke.

setStrokeMiterLimit(float value)

public void setStrokeMiterLimit(float value)

Sets the ratio between the maximum miter length and half of the stroke thickness. This value is significant only if the StrokeLineJoin attribute specifies Miter .

Parameters:

Parameter	Type	Description
value	float	The ratio between the maximum miter length and half of the stroke thickness.

setStrokeStartLineCap(XpsLineCap value)

public void setStrokeStartLineCap(XpsLineCap value)

Sets the value defining the shape of the beginning of the first dash in a stroke.

Parameters:

Parameter	Type	Description
value	XpsLineCap	The value defining the shape of the beginning of the first dash in a stroke.

setStrokeThickness(float value)

public void setStrokeThickness(float value)

Sets the thickness of a stroke, in units of the effective coordinate space (includes the path’s render transform). The stroke is drawn on top of the boundary of the geometry specified by the Path element\u2019s Data property. Half of the StrokeThickness extends outside of the geometry specified by the Data property and the other half extends inside of the geometry.

Parameters:

Parameter	Type	Description
value	float	The thickness of a stroke.

size()

public int size()

Returns the number of child elements.

Returns: int - The number of child elements.

toString()

public String toString()

Returns: java.lang.String

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