CanvasGraphicsState (iText 7 7.1.12 API)

java.lang.Object
- com.itextpdf.kernel.pdf.canvas.CanvasGraphicsState

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ParserGraphicsState
```
public class CanvasGraphicsState
extends Object
implements Serializable
```
This class is designed for internal usage.
Use PdfExtGState class and PdfCanvas#setExtGState() method for setting extended graphics properties.

See Also:

Serialized Form

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`CanvasGraphicsState()` Internal empty and default constructor.
	`CanvasGraphicsState(CanvasGraphicsState source)` Copy constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getAlphaIsShape()`
`boolean`	`getAutomaticStrokeAdjustment()`
`PdfObject`	`getBlackGenerationFunction()`
`PdfObject`	`getBlackGenerationFunction2()`
`PdfObject`	`getBlendMode()`
`float`	`getCharSpacing()`
`Matrix`	`getCtm()`
`PdfArray`	`getDashPattern()`
`Color`	`getFillColor()`
`float`	`getFillOpacity()`
`boolean`	`getFillOverprint()`
`float`	`getFlatnessTolerance()`
`PdfFont`	`getFont()`
`float`	`getFontSize()`
`PdfObject`	`getHalftone()`
`float`	`getHorizontalScaling()`
`PdfObject`	`getHTP()`
`float`	`getLeading()`
`int`	`getLineCapStyle()`
`int`	`getLineJoinStyle()`
`float`	`getLineWidth()`
`float`	`getMiterLimit()`
`int`	`getOverprintMode()`
`PdfName`	`getRenderingIntent()`
`Float`	`getSmoothnessTolerance()`
`PdfObject`	`getSoftMask()`
`Color`	`getStrokeColor()`
`float`	`getStrokeOpacity()`
`boolean`	`getStrokeOverprint()`
`boolean`	`getTextKnockout()`
`int`	`getTextRenderingMode()`
`float`	`getTextRise()`
`PdfObject`	`getTransferFunction()`
`PdfObject`	`getTransferFunction2()`
`PdfObject`	`getUnderColorRemovalFunction()`
`PdfObject`	`getUnderColorRemovalFunction2()`
`float`	`getWordSpacing()`
`void`	`setCharSpacing(float characterSpacing)`
`void`	`setDashPattern(PdfArray dashPattern)`
`void`	`setFillColor(Color fillColor)`
`void`	`setFlatnessTolerance(float flatnessTolerance)`
`void`	`setFont(PdfFont font)`
`void`	`setFontSize(float fontSize)`
`void`	`setHorizontalScaling(float scale)`
`void`	`setLeading(float leading)`
`void`	`setLineCapStyle(int lineCapStyle)`
`void`	`setLineJoinStyle(int lineJoinStyle)`
`void`	`setLineWidth(float lineWidth)`
`void`	`setMiterLimit(float miterLimit)`
`void`	`setRenderingIntent(PdfName renderingIntent)`
`void`	`setStrokeColor(Color strokeColor)`
`void`	`setTextRenderingMode(int textRenderingMode)`
`void`	`setTextRise(float textRise)`
`void`	`setWordSpacing(float wordSpacing)`
`void`	`updateCtm(float a, float b, float c, float d, float e, float f)` Updates current transformation matrix.
`void`	`updateCtm(Matrix newCtm)` Updates current transformation matrix.
`void`	`updateFromExtGState(PdfDictionary extGState)` Updates this object with the values from a dictionary.
`void`	`updateFromExtGState(PdfExtGState extGState)` Updates current graphic state with values from extended graphic state dictionary.

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

Constructor Detail
- CanvasGraphicsState
```
protected CanvasGraphicsState()
```
  Internal empty and default constructor.
- CanvasGraphicsState
```
public CanvasGraphicsState(CanvasGraphicsState source)
```
  Copy constructor.
  
  Parameters:
  
  source - the Graphics State to copy from

Method Detail

updateFromExtGState
```
public void updateFromExtGState(PdfDictionary extGState)
```
Updates this object with the values from a dictionary.

Parameters:

extGState - the dictionary containing source parameters

getCtm
```
public Matrix getCtm()
```
Returns:

current transformation matrix.

updateCtm
```
public void updateCtm(float a,
                      float b,
                      float c,
                      float d,
                      float e,
                      float f)
```
Updates current transformation matrix. The third column will always be [0 0 1]

Parameters:

a - element at (1,1) of the transformation matrix

b - element at (1,2) of the transformation matrix

c - element at (2,1) of the transformation matrix

d - element at (2,2) of the transformation matrix

e - element at (3,1) of the transformation matrix

f - element at (3,2) of the transformation matrix

updateCtm
```
public void updateCtm(Matrix newCtm)
```
Updates current transformation matrix.

Parameters:

newCtm - new current transformation matrix.

getFillColor
```
public Color getFillColor()
```

setFillColor

public void setFillColor(Color fillColor)

getStrokeColor
```
public Color getStrokeColor()
```

setStrokeColor

public void setStrokeColor(Color strokeColor)

getLineWidth
```
public float getLineWidth()
```

setLineWidth

public void setLineWidth(float lineWidth)

getLineCapStyle
```
public int getLineCapStyle()
```

setLineCapStyle

public void setLineCapStyle(int lineCapStyle)

getLineJoinStyle
```
public int getLineJoinStyle()
```

setLineJoinStyle

public void setLineJoinStyle(int lineJoinStyle)

getMiterLimit
```
public float getMiterLimit()
```

setMiterLimit

public void setMiterLimit(float miterLimit)

getDashPattern
```
public PdfArray getDashPattern()
```

setDashPattern

public void setDashPattern(PdfArray dashPattern)

getRenderingIntent
```
public PdfName getRenderingIntent()
```

setRenderingIntent

public void setRenderingIntent(PdfName renderingIntent)

getFontSize
```
public float getFontSize()
```

setFontSize

public void setFontSize(float fontSize)

getFont
```
public PdfFont getFont()
```

setFont
```
public void setFont(PdfFont font)
```

getTextRenderingMode
```
public int getTextRenderingMode()
```

setTextRenderingMode

public void setTextRenderingMode(int textRenderingMode)

getTextRise
```
public float getTextRise()
```

setTextRise

public void setTextRise(float textRise)

getFlatnessTolerance
```
public float getFlatnessTolerance()
```

setFlatnessTolerance

public void setFlatnessTolerance(float flatnessTolerance)

setWordSpacing

public void setWordSpacing(float wordSpacing)

getWordSpacing
```
public float getWordSpacing()
```

setCharSpacing

public void setCharSpacing(float characterSpacing)

getCharSpacing
```
public float getCharSpacing()
```

getLeading
```
public float getLeading()
```

setLeading

public void setLeading(float leading)

getHorizontalScaling
```
public float getHorizontalScaling()
```

setHorizontalScaling

public void setHorizontalScaling(float scale)

getStrokeOverprint
```
public boolean getStrokeOverprint()
```

getFillOverprint
```
public boolean getFillOverprint()
```

getOverprintMode
```
public int getOverprintMode()
```

getBlackGenerationFunction

public PdfObject getBlackGenerationFunction()

getBlackGenerationFunction2

public PdfObject getBlackGenerationFunction2()

getUnderColorRemovalFunction

public PdfObject getUnderColorRemovalFunction()

getUnderColorRemovalFunction2

public PdfObject getUnderColorRemovalFunction2()

getTransferFunction

public PdfObject getTransferFunction()

getTransferFunction2

public PdfObject getTransferFunction2()

getHalftone
```
public PdfObject getHalftone()
```

getSmoothnessTolerance
```
public Float getSmoothnessTolerance()
```

getAutomaticStrokeAdjustment

public boolean getAutomaticStrokeAdjustment()

getBlendMode
```
public PdfObject getBlendMode()
```

getSoftMask
```
public PdfObject getSoftMask()
```

getStrokeOpacity
```
public float getStrokeOpacity()
```

getFillOpacity
```
public float getFillOpacity()
```

getAlphaIsShape
```
public boolean getAlphaIsShape()
```

getTextKnockout
```
public boolean getTextKnockout()
```

getHTP
```
public PdfObject getHTP()
```

updateFromExtGState
```
public void updateFromExtGState(PdfExtGState extGState)
```
Updates current graphic state with values from extended graphic state dictionary.

Parameters:

extGState - the wrapper around the extended graphic state dictionary

Class CanvasGraphicsState

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CanvasGraphicsState

CanvasGraphicsState

Method Detail

updateFromExtGState

getCtm

updateCtm

updateCtm

getFillColor

setFillColor

getStrokeColor

setStrokeColor

getLineWidth

setLineWidth

getLineCapStyle

setLineCapStyle

getLineJoinStyle

setLineJoinStyle

getMiterLimit

setMiterLimit

getDashPattern

setDashPattern

getRenderingIntent

setRenderingIntent

getFontSize

setFontSize

getFont

setFont

getTextRenderingMode

setTextRenderingMode

getTextRise

setTextRise

getFlatnessTolerance

setFlatnessTolerance

setWordSpacing

getWordSpacing

setCharSpacing

getCharSpacing

getLeading

setLeading

getHorizontalScaling

setHorizontalScaling

getStrokeOverprint

getFillOverprint

getOverprintMode

getBlackGenerationFunction

getBlackGenerationFunction2

getUnderColorRemovalFunction

getUnderColorRemovalFunction2

getTransferFunction

getTransferFunction2

getHalftone

getSmoothnessTolerance

getAutomaticStrokeAdjustment

getBlendMode

getSoftMask

getStrokeOpacity

getFillOpacity

getAlphaIsShape

getTextKnockout

getHTP

updateFromExtGState