GraphicsState (org.jpedal:OpenViewerFX 7.12.28 API)

java.lang.Object
- org.jpedal.objects.GraphicsState

public class GraphicsState
extends Object

holds the graphics state as stream decoded

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CLIPTEXT`
`float[][]`	`CTM` CTM which is used for plotting (see pdf spec for explanation
`static int`	`FILL`
`static int`	`FILLSTROKE`
`static int`	`INVISIBLE`
`float[][]`	`lastCTM` copy used for images
`GenericColorSpace`	`nonstrokeColorSpace` nonstroke colorspace
`float[][]`	`scaleFactor`
`PdfObject`	`SMask`
`static int`	`STROKE`
`GenericColorSpace`	`strokeColorSpace` stroke colorspace
`float`	`x`
`float`	`y`

Constructor Summary

Constructors
Constructor and Description

GraphicsState()

GraphicsState(GraphicsState gs)

GraphicsState(int minX, int minY)
initialise the GraphicsState

Constructors
Constructor and Description
`GraphicsState()`
`GraphicsState(GraphicsState gs)`
`GraphicsState(int minX, int minY)` initialise the GraphicsState

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addClip(Area current_area)` add to clip (used for TR 7)
`void`	`applyFXStroke(javafx.scene.shape.Shape shape)` Applies the stroke stored in the GraphicsState to the shape being passed in
`void`	`checkWholePageClip(int max_y)` check whole page clip (if whole page set clip to null)
`GraphicsState`	`deepCopy()` custom clone method
`float`	`getAlpha(int type)` use STROKE or FILL
`float`	`getAlphaMax(int type)` use STROKE or FILL
`int`	`getBMValue()`
`Area`	`getClippingShape()` get clipping shape
`float`	`getCTMAdjustedLineWidth()` get the stroke width after being adjusted by the CTM
`int`	`getFillType()` get fill type
`javafx.scene.shape.Shape`	`getFXClippingShape()`
`float`	`getLineWidth()` get line width
`PdfPaint`	`getNonstrokeColor()`
`boolean`	`getNonStrokeOP()` get stroke op
`float`	`getOPM()` get stroke op
`int`	`getOutputLineWidth()` get line width for HTML/SVG etc.
`Stroke`	`getStroke()` get the current stroke to be used - basic solid line or pattern
`PdfPaint`	`getStrokeColor()`
`int`	`getTextRenderType()` set text render type
`TextState`	`getTextState()`
`Object[]`	`getTR()`
`boolean`	`hasClipChanged()` tell software if clip has changed and return
`void`	`resetColorSpaces(int strokeColorData, int nonStrokeColorData)`
`void`	`setAlpha(int type, float value)`
`void`	`setBMValue(int bm)`
`void`	`setCapStyle(int cap_style)` set line join style
`void`	`setClippingShape(Area new_clip)` set clipping shape
`void`	`setCTMAdjustedLineWidth(float width)` get the stroke width after being adjusted by the CTM
`void`	`setDashArray(float[] current_line_dash_array)` set dash array
`void`	`setDashPhase(int current_line_dash_phase)` set dash phase
`void`	`setFillType(int fill_type)` set fill type
`void`	`setJoinStyle(int join_style)` set line join style
`void`	`setLineWidth(float current_line_width)` set line width
`void`	`setMaxAlpha(int type, float value)`
`void`	`setMitreLimit(int mitre_limit)` set mitre limit
`void`	`setMode(PdfObject GS)` read GS settings and set supported values
`void`	`setNonstrokeColor(PdfPaint currentNonstrokeColor)`
`void`	`setOutputLineWidth(int output_line_width)` set line width for HTML/SVG etc.
`void`	`setStrokeColor(PdfPaint strokeColor)`
`void`	`setTextRenderType(int text_render_type)` set text render type
`void`	`setTextState(TextState currentTextState)`
`String`	`toString()`
`void`	`updateClip(Area current_area)` update clip
`void`	`updateClip(Object fxPath)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - x
```
public float x
```
  - y
```
public float y
```
  - lastCTM
```
public final float[][] lastCTM
```
    copy used for images
  - SMask
```
public PdfObject SMask
```
  - strokeColorSpace
```
public GenericColorSpace strokeColorSpace
```
    stroke colorspace
  - nonstrokeColorSpace
```
public GenericColorSpace nonstrokeColorSpace
```
    nonstroke colorspace
  - CTM
```
public float[][] CTM
```
    CTM which is used for plotting (see pdf spec for explanation
  - scaleFactor
```
public float[][] scaleFactor
```
  - STROKE
```
public static final int STROKE
```
    See Also:
    
    Constant Field Values
  - FILL
```
public static final int FILL
```
    See Also:
    
    Constant Field Values
  - FILLSTROKE
```
public static final int FILLSTROKE
```
    See Also:
    
    Constant Field Values
  - INVISIBLE
```
public static final int INVISIBLE
```
    See Also:
    
    Constant Field Values
  - CLIPTEXT
```
public static final int CLIPTEXT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GraphicsState
```
public GraphicsState(GraphicsState gs)
```
  - GraphicsState
```
public GraphicsState()
```
  - GraphicsState
```
public GraphicsState(int minX,
                     int minY)
```
    initialise the GraphicsState
    
    Parameters:
    
    minX -
    
    minY -
- Method Detail
  - setMaxAlpha
```
public void setMaxAlpha(int type,
                        float value)
```
  - setAlpha
```
public void setAlpha(int type,
                     float value)
```
  - getAlpha
```
public float getAlpha(int type)
```
    use STROKE or FILL
    
    Parameters:
    
    type -
    
    Returns:
  - getAlphaMax
```
public float getAlphaMax(int type)
```
    use STROKE or FILL
    
    Parameters:
    
    type -
    
    Returns:
  - getNonStrokeOP
```
public boolean getNonStrokeOP()
```
    get stroke op
    
    Returns:
  - getOPM
```
public float getOPM()
```
    get stroke op
    
    Returns:
  - getTR
```
public Object[] getTR()
```
  - setTextRenderType
```
public final void setTextRenderType(int text_render_type)
```
    set text render type
    
    Parameters:
    
    text_render_type -
  - getTextRenderType
```
public final int getTextRenderType()
```
    set text render type
    
    Returns:
  - setMitreLimit
```
public final void setMitreLimit(int mitre_limit)
```
    set mitre limit
    
    Parameters:
    
    mitre_limit -
  - getLineWidth
```
public final float getLineWidth()
```
    get line width
    
    Returns:
  - getOutputLineWidth
```
public final int getOutputLineWidth()
```
    get line width for HTML/SVG etc. value is -1 if not set.
    
    Returns:
  - setFillType
```
public final void setFillType(int fill_type)
```
    set fill type
    
    Parameters:
    
    fill_type -
  - updateClip
```
public final void updateClip(Area current_area)
```
    update clip
    
    Parameters:
    
    current_area -
  - addClip
```
public final void addClip(Area current_area)
```
    add to clip (used for TR 7)
    
    Parameters:
    
    current_area -
  - getStroke
```
public final Stroke getStroke()
```
    get the current stroke to be used - basic solid line or pattern
    
    Returns:
  - applyFXStroke
```
public final void applyFXStroke(javafx.scene.shape.Shape shape)
```
    Applies the stroke stored in the GraphicsState to the shape being passed in
    
    Parameters:
    
    shape -
  - getCTMAdjustedLineWidth
```
public float getCTMAdjustedLineWidth()
```
    get the stroke width after being adjusted by the CTM
    
    Returns:
  - setLineWidth
```
public final void setLineWidth(float current_line_width)
```
    set line width
    
    Parameters:
    
    current_line_width -
  - setCTMAdjustedLineWidth
```
public void setCTMAdjustedLineWidth(float width)
```
    get the stroke width after being adjusted by the CTM
    
    Parameters:
    
    width - CTM adjusted line width
  - setOutputLineWidth
```
public final void setOutputLineWidth(int output_line_width)
```
    set line width for HTML/SVG etc. value is -1 if not set.
  - getClippingShape
```
public final Area getClippingShape()
```
    get clipping shape
    
    Returns:
  - setMode
```
public void setMode(PdfObject GS)
```
    read GS settings and set supported values
    
    Parameters:
    
    GS -
  - setCapStyle
```
public final void setCapStyle(int cap_style)
```
    set line join style
    
    Parameters:
    
    cap_style -
  - setJoinStyle
```
public final void setJoinStyle(int join_style)
```
    set line join style
    
    Parameters:
    
    join_style -
  - checkWholePageClip
```
public final void checkWholePageClip(int max_y)
```
    check whole page clip (if whole page set clip to null)
    
    Parameters:
    
    max_y -
  - setDashArray
```
public final void setDashArray(float[] current_line_dash_array)
```
    set dash array
    
    Parameters:
    
    current_line_dash_array -
  - deepCopy
```
public final GraphicsState deepCopy()
```
    custom clone method
  - setDashPhase
```
public final void setDashPhase(int current_line_dash_phase)
```
    set dash phase
    
    Parameters:
    
    current_line_dash_phase -
  - getFillType
```
public final int getFillType()
```
    get fill type
    
    Returns:
  - setClippingShape
```
public final void setClippingShape(Area new_clip)
```
    set clipping shape
    
    Parameters:
    
    new_clip -
  - getNonstrokeColor
```
public PdfPaint getNonstrokeColor()
```
    Returns:
    
    Returns the currentNonstrokeColor.
  - setNonstrokeColor
```
public void setNonstrokeColor(PdfPaint currentNonstrokeColor)
```
    Parameters:
    
    currentNonstrokeColor - The currentNonstrokeColor to set.
  - getStrokeColor
```
public PdfPaint getStrokeColor()
```
    Returns:
    
    Returns the strokeColor.
  - setStrokeColor
```
public void setStrokeColor(PdfPaint strokeColor)
```
    Parameters:
    
    strokeColor - The strokeColor to set.
  - hasClipChanged
```
public boolean hasClipChanged()
```
    tell software if clip has changed and return
    
    Returns:
  - setTextState
```
public void setTextState(TextState currentTextState)
```
  - getTextState
```
public TextState getTextState()
```
  - updateClip
```
public void updateClip(Object fxPath)
```
  - getFXClippingShape
```
public javafx.scene.shape.Shape getFXClippingShape()
```
  - getBMValue
```
public int getBMValue()
```
  - setBMValue
```
public void setBMValue(int bm)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - resetColorSpaces
```
public void resetColorSpaces(int strokeColorData,
                             int nonStrokeColorData)
```

Class GraphicsState

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

x

y

lastCTM

SMask

strokeColorSpace

nonstrokeColorSpace

CTM

scaleFactor

STROKE

FILL

FILLSTROKE

INVISIBLE

CLIPTEXT

Constructor Detail

GraphicsState

GraphicsState

GraphicsState

Method Detail

setMaxAlpha

setAlpha

getAlpha

getAlphaMax

getNonStrokeOP

getOPM

getTR

setTextRenderType

getTextRenderType

setMitreLimit

getLineWidth

getOutputLineWidth

setFillType

updateClip

addClip

getStroke

applyFXStroke

getCTMAdjustedLineWidth

setLineWidth

setCTMAdjustedLineWidth

setOutputLineWidth

getClippingShape

setMode

setCapStyle

setJoinStyle

checkWholePageClip

setDashArray

deepCopy

setDashPhase

getFillType

setClippingShape

getNonstrokeColor

setNonstrokeColor

getStrokeColor

setStrokeColor

hasClipChanged

setTextState

getTextState

updateClip

getFXClippingShape

getBMValue

setBMValue

toString

resetColorSpaces