intarsys PDF library API

de.intarsys.pdf.content
Class TextState

java.lang.Object
  extended by de.intarsys.pdf.content.TextState

public class TextState
extends Object

This class summarizes all state information that is used to render characters in the current context, such as font, font size etc.


Field Summary
static int RENDERING_MODE_CLIP
           
static int RENDERING_MODE_FILL
           
static int RENDERING_MODE_FILL_CLIP
           
static int RENDERING_MODE_FILL_STROKE
           
static int RENDERING_MODE_FILL_STROKE_CLIP
           
static int RENDERING_MODE_NONE
           
static int RENDERING_MODE_STROKE
           
static int RENDERING_MODE_STROKE_CLIP
           
 
Constructor Summary
TextState()
           
 
Method Summary
 void begin()
           
 TextState copy()
           
 void end()
           
 float getCharSpacing()
           
 PDFont getFont()
           
 float getFontSize()
           
 float getHorizontalScaling()
           
 float getHorizontalScalingFactor()
           
 float getLeading()
           
 int getRenderingMode()
           
 float getRise()
           
 AffineTransform getTextLineMatrix()
           
 AffineTransform getTextMatrix()
           
 float getWordSpacing()
           
 boolean isFont(PDFont queryFont, float queryFontSize)
          Answer true if the actual font in the text state is equal to queryFont and queryFontSize.
 boolean isKnockout()
           
 void setCharSpacing(float paramCharSpacing)
           
 void setFont(PDFont paramFont, float size)
           
 void setHorizontalScaling(float paramHorizontalScaling)
           
 void setKnockout(boolean paramKnockout)
           
 void setLeading(float paramLeading)
           
 void setRenderingMode(int paramRenderingMode)
           
 void setRise(float paramRise)
           
 void setTransform(float a, float b, float c, float d, float e, float f)
           
 void setWordSpacing(float paramWordSpacing)
           
 void tlmMove(float dx, float dy)
           
 void tmMove(float dx, float dy)
           
 void tmMoveTo(float x, float y)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RENDERING_MODE_CLIP

public static final int RENDERING_MODE_CLIP
See Also:
Constant Field Values

RENDERING_MODE_FILL

public static final int RENDERING_MODE_FILL
See Also:
Constant Field Values

RENDERING_MODE_FILL_CLIP

public static final int RENDERING_MODE_FILL_CLIP
See Also:
Constant Field Values

RENDERING_MODE_FILL_STROKE

public static final int RENDERING_MODE_FILL_STROKE
See Also:
Constant Field Values

RENDERING_MODE_FILL_STROKE_CLIP

public static final int RENDERING_MODE_FILL_STROKE_CLIP
See Also:
Constant Field Values

RENDERING_MODE_NONE

public static final int RENDERING_MODE_NONE
See Also:
Constant Field Values

RENDERING_MODE_STROKE

public static final int RENDERING_MODE_STROKE
See Also:
Constant Field Values

RENDERING_MODE_STROKE_CLIP

public static final int RENDERING_MODE_STROKE_CLIP
See Also:
Constant Field Values
Constructor Detail

TextState

public TextState()
Method Detail

begin

public void begin()

copy

public TextState copy()

end

public void end()

getCharSpacing

public float getCharSpacing()

getFont

public PDFont getFont()

getFontSize

public float getFontSize()

getHorizontalScaling

public float getHorizontalScaling()

getHorizontalScalingFactor

public float getHorizontalScalingFactor()

getLeading

public float getLeading()

getRenderingMode

public int getRenderingMode()

getRise

public float getRise()

getTextMatrix

public AffineTransform getTextMatrix()

getTextLineMatrix

public AffineTransform getTextLineMatrix()

getWordSpacing

public float getWordSpacing()

isFont

public boolean isFont(PDFont queryFont,
                      float queryFontSize)
Answer true if the actual font in the text state is equal to queryFont and queryFontSize.

Parameters:
queryFont - the font to be compared
queryFontSize - the font size to be compared
Returns:
True if the actual font is equal.

isKnockout

public boolean isKnockout()

tlmMove

public void tlmMove(float dx,
                    float dy)

tmMove

public void tmMove(float dx,
                   float dy)

tmMoveTo

public void tmMoveTo(float x,
                     float y)

setCharSpacing

public void setCharSpacing(float paramCharSpacing)

setFont

public void setFont(PDFont paramFont,
                    float size)

setHorizontalScaling

public void setHorizontalScaling(float paramHorizontalScaling)

setKnockout

public void setKnockout(boolean paramKnockout)

setLeading

public void setLeading(float paramLeading)

setRenderingMode

public void setRenderingMode(int paramRenderingMode)

setRise

public void setRise(float paramRise)

setTransform

public void setTransform(float a,
                         float b,
                         float c,
                         float d,
                         float e,
                         float f)

setWordSpacing

public void setWordSpacing(float paramWordSpacing)

intarsys PDF library API

Copyright © 2006 intarsys consulting GmbH. All Rights Reserved.