GraphicState Class Documentation

class GraphicState

Namespace:com::datalogics::PDFL

Detailed Description

The graphic state is an internal data structure in a PDF file. The graphics state holds the parameters that describe graphics within that file.

These parameters define how individual graphics are presented on the page, including layers and transparencies.

Constructor & Destructor Documentation

GraphicState

GraphicState()

Create a new default GraphicState.

Member Function Documentation

delete

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized void delete()

Returns:

synchronized void

finalize

void finalize()

Returns:

void

getDashPattern

java.util.List< Double > getDashPattern()

Returns:

java.util.List< Double >

A list containing the dash phase followed by the contents of the DashPattern.

The line DashPattern controls the pattern of dashes and gaps used to stroke paths. It is specified by a dash phase and then a series of elements of a DashPattern list. The DashPattern's members are numbers that specify the lengths of alternating dashes and gaps; the numbers must be nonnegative and not all zero. The dash phase specifies the distance into the dash pattern at which to start the dash. The elements of both the DashPattern List and the dash phase are expressed in user space units. This retrieves the DashPattern used by the Pattern list current graphic state.

getExtendedGraphicState

ExtendedGraphicState getExtendedGraphicState()

Returns:

ExtendedGraphicState

The ExtendedGraphicState, or null if none is set.

The ExtendedGraphicState associated with this GraphicState.

The ExtendedGraphicState can contain additional parameters such as transparency, blend mode, and overprint settings that are not part of the basic GraphicState.

getFillColor

Color getFillColor()

Returns:

Color

The current fill color.

The color used for filling operations in the current GraphicState.

getLineCap

LineCap getLineCap()

Returns:

LineCap

The current line cap style.

The line cap style used by the current GraphicState, specifying the shape at the ends of open subpaths when stroked.

getLineFlatness

double getLineFlatness()

Returns:

double

The current line flatness value.

The line flatness tolerance in the current GraphicState, corresponding to the i operator. Default is 1.0.

Flatness controls the maximum distance (in device pixels) between a curve and the flattened line segments that approximate it.

getLineJoin

LineJoin getLineJoin()

Returns:

LineJoin

The current line join style.

The line join style used by the current GraphicState, specifying the shape at the corners where consecutive segments of a path connect at an angle.

getMiterLimit

double getMiterLimit()

Returns:

double

The current miter limit.

The miter limit for line joins in the current GraphicState, corresponding to the M operator. Default is 10.0.

When two line segments meet at a sharp angle and mitered joins have been specified, the miter limit controls when the join is beveled instead.

getRenderIntent

RenderIntent getRenderIntent()

Returns:

RenderIntent

The current rendering intent.

The color rendering intent for the current GraphicState, corresponding to the Intent key in the image dictionary. The default is RelColorimetric.

getStrokeColor

Color getStrokeColor()

Returns:

Color

The current stroke color.

The color used for stroking operations in the current GraphicState.

getWidth

double getWidth()

Returns:

double

The current line width.

The line width used for stroking operations by the current GraphicState, in user space units.

setDashPattern

void setDashPattern(java.util.List< Double > DashPattern)

Parameters

DashPattern: java.util.List< Double >

A list containing the dash phase followed by the contents of the DashPattern.

Returns:

void

The line DashPattern controls the pattern of dashes and gaps used to stroke paths. It is specified by a dash phase and then a series of elements of a DashPattern list. The DashPattern's members are numbers that specify the lengths of alternating dashes and gaps; the numbers must be nonnegative and not all zero. The dash phase specifies the distance into the dash pattern at which to start the dash. The elements of both the DashPattern List and the dash phase are expressed in user space units. This retrieves the DashPattern used by the Pattern list current graphic state.

setExtendedGraphicState

void setExtendedGraphicState(ExtendedGraphicState extendedGraphicState)

Parameters

extendedGraphicState: ExtendedGraphicState

The new ExtendedGraphicState, or null to remove it.

Returns:

void

The ExtendedGraphicState associated with this GraphicState.

The ExtendedGraphicState can contain additional parameters such as transparency, blend mode, and overprint settings that are not part of the basic GraphicState.

setFillColor

void setFillColor(Color fillcolor)

Parameters

fillcolor: Color

The new fill color.

Returns:

void

The color used for filling operations in the current GraphicState.

The color may be specified in DeviceGray, DeviceRGB, or DeviceCMYK color spaces.

setLineCap

void setLineCap(LineCap LineCap)

Parameters

LineCap: LineCap

The new line cap style.

Returns:

void

The line cap style used by the current GraphicState, specifying the shape at the ends of open subpaths when stroked.

setLineFlatness

void setLineFlatness(double flatness)

Parameters

flatness: double

The new flatness value.

Returns:

void

The line flatness tolerance in the current GraphicState, corresponding to the i operator. Default is 1.0.

setLineJoin

void setLineJoin(LineJoin LineJoin)

Parameters

LineJoin: LineJoin

The new line join style.

Returns:

void

The line join style to be used by the current GraphicState, specifying the shape at the corners where consecutive segments of a path connect at an angle.

setMiterLimit

void setMiterLimit(double miterLimit)

Parameters

miterLimit: double

The new miter limit value.

Returns:

void

The miter limit for line joins in the current GraphicState, corresponding to the M operator. Default is 10.0.

setRenderIntent

void setRenderIntent(RenderIntent renderingIntent)

Parameters

renderingIntent: RenderIntent

The new rendering intent.

Returns:

void

The color rendering intent for the current GraphicState, corresponding to the Intent key in the image dictionary. The default is RelColorimetric.

setStrokeColor

void setStrokeColor(Color strokecolor)

Parameters

strokecolor: Color

The new stroke color.

Returns:

void

The color used for stroking operations in the current GraphicState.

The color may be specified in DeviceGray, DeviceRGB, or DeviceCMYK color spaces.

setWidth

void setWidth(double width)

Parameters

width: double

The new line width.

Returns:

void

The line width used for stroking operations by the current GraphicState, in user space units.