Path Class Documentation

classPath : Element

Namespace:com::datalogics::PDFL

Inherits from:
Element

Detailed Description

A path in a PDF file defines shapes. Paths in PDF files are used to draw lines, define filled areas, and define boundaries for clipping graphics. A path is composed of straight and curved line segments.

Referenced by

Path

Constructor & Destructor Documentation

Path

Path()

Create a path.

Path

Path(GraphicStategraphicState)

Parameters

graphicState: GraphicState

the initial graphic state for the path

Create a path with a given graphic state.

Member Function Documentation

DisposeChildren

voidDisposeChildren()

Returns:

void

[static initializer]

static void[static initializer]()

addCurve

voidaddCurve(PointPoint1, PointPoint2, PointPoint3)

Parameters

Point1: Point

first Bezier control point

Point2: Point

second Bezier control point

Point3: Point

the ending Point of the Bezier curve which will also be the current point of the current path.

Returns:

void

Adds a Bezier curve from the current path using the first two points specified as Bezier control points ending at the third point. The new current point is then set to the third point.

addCurveV

voidaddCurveV(PointPoint1, PointPoint2)

Parameters

Point1: Point

first Bezier control point

Point2: Point

the ending Point of the Bezier curve which will also be the new current point of the path.

Returns:

void

Adds a Bezier curve from the current path. This extends from the current path to the point Point2 using the current point and the first point specified as Bezier control points ending at the second point. The new current point is then set to the second point.

addCurveY

voidaddCurveY(PointPoint1, PointPoint2)

Parameters

Point1: Point

first Bezier control point

Point2: Point

second Bezier control point and the ending Point of the Bezier curve which will also be the new current point of the path.

Returns:

void

Adds a Bezier curve from the current path. This extends from the current path to the point Point2 using the two points specified as Bezier control points ending at the second point. The new current point is then set to the second point.

addLine

voidaddLine(PointPoint)

Parameters

Point: Point

Returns:

void

Adds a line to the current path from the current path position. The given point becomes the new current position.

addRect

voidaddRect(PointPoint, doubleWidth, doubleHeight)

Parameters

Point: Point
Width: double

the width of the new rectangle.

Height: double

the height of the new rectangle.

Returns:

void

Adds a rectangle to the current path with the lower left corner at the give point, and with the width and height specified.

clone

Pathclone()

Returns:

The copied path.

Makes a copy of the path.

Make a copy of an path to obtain a new path that has a distinct set of attributes.

clone

Pathclone(java.util.EnumSet< ElementCloneFlags >cloneFlags)

Parameters

cloneFlags: java.util.EnumSet< ElementCloneFlags >

Flags that modify the cloning operation.

Returns:

The copied path.

Makes a copy of the path.

Make a copy of an path to obtain a new path that has a distinct set of attributes.

closePath

voidclosePath()

Returns:

void

Closes the current subpath.

colorConvert

PathcolorConvert(Documentdocument, ColorProfileprof, RenderIntentintent, booleanembed)

Parameters

document: Document

The document the element belongs to.

prof: ColorProfile

The ICC ColorProfile to be applied.

intent: RenderIntent

The ICC Rendering Intent for the ColorProfile

embed: boolean

If true, embed the color space and make the object calibrated. If it is false and the target profile is CMYK, RGB, or Gray, the colors space of the resulting object, after conversion, will be DeviceCMYK, DeviceRGB, or DeviceGray, respectively.

Returns:

A new Path with the applied ICC ColorProfile.

Applies the specified ICC ColorProfile to the Path

delete

synchronized voiddelete(Booleandisposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized voiddelete()

Returns:

synchronized void

finalize

voidfinalize()

Returns:

void

getBoundingBox

RectgetBoundingBox()

Returns:

The bounding box for this element. The coordinates of the bounding box are specified in user space coordinates, relative to the element's Content. Note that user space coordinates correspond to unrotated pages; any rotation specified in the page dictionary is not taken into account.

The bounding box for this element.

The bounding box is a rectangle that is guaranteed to encompass the element, but it is not guaranteed to be the smallest box that could contain the element. For example, if the element is a Path that contains an arc, the bounding box encompasses the bezier control points, and not just the curve itself.

getClip

ClipgetClip()

Returns:

- The current Clip for this Element.

Gets the current Clip for an Element.

getGraphicState

GraphicStategetGraphicState()

Returns:

GraphicState

Get the graphic state of the current path.

May return null if this element does not have a GraphicState.

getMatrix

MatrixgetMatrix()

Returns:

Matrix

The transformation matrix for the element.

getPaintOp

java.util.EnumSet< PathPaintOpFlags >getPaintOp()

Returns:

the PathPaintOpFlags flags describing the fill and stroke attributes.

Gets the fill and stroke attributes of a path.

moveTo

voidmoveTo(PointPoint)

Parameters

Point: Point

Returns:

void

Moves the current point of the path to the given point.

rotate

voidrotate(doubletheta)

Parameters

theta: double

Returns:

void

Rotate an element by T degrees counterclockwise units using the matrix [ cos T sin T -sin T cos T 0 0 ].

scale

voidscale(doublesx, doublesy)

Parameters

sx: double
sy: double

Returns:

void

Scale an element by (sx,sy) units using the matrix [ sx 0 0 sy 0 0 ].

setClip

voidsetClip(Clipclip)

Parameters

clip: Clip

The clip to set as the current clip for this element.

Returns:

void

Sets the current Clip for an Element.

setGraphicState

voidsetGraphicState(GraphicStategstate)

Parameters

gstate: GraphicState

the new/updated Graphic State for the path.

Returns:

void

Set the Graphic State of the current path.

setMatrix

voidsetMatrix(Matrixmatrix)

Parameters

matrix: Matrix

the transformation matrix for the element.

Returns:

void

Set the transformation matrix for the element.

setPaintOp

voidsetPaintOp(java.util.EnumSet< PathPaintOpFlags >paintops)

Parameters

paintops: java.util.EnumSet< PathPaintOpFlags >

the flags describing the fill and stroke attributes.

Returns:

void

Sets the fill and stroke attributes of a path.

translate

voidtranslate(doubletx, doublety)

Parameters

tx: double
ty: double

Returns:

void

Translate an element by (tx,ty) units using the matrix [ 1 0 0 1 tx ty ].