DynamicVectorRenderer (org.jpedal:OpenViewerFX 7.12.28 API)

All Known Subinterfaces:

T3Renderer

All Known Implementing Classes:

BaseDisplay, FXDisplay, FXDisplayForRasterizing, G2Display, ImageDisplay, PatternDisplay, SwingDisplay, T3Display
```
public interface DynamicVectorRenderer
```

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AF`
`static int`	`ALT_BACKGROUND_COLOR` Keys for use with set value
`static int`	`ALT_FOREGROUND_COLOR`
`static int`	`BLENDMODE`
`static int`	`CLIP`
`static int`	`COLOR`
`static int`	`COLOR_REPLACEMENT_THRESHOLD`
`static int`	`CREATE_EPOS`
`static int`	`CREATE_HTML`
`static int`	`CREATE_PATTERN`
`static int`	`CREATE_SVG`
`static int`	`CREATE_T3`
`static int`	`CUSTOM`
`static int`	`CUSTOM_COLOR_HANDLER`
`static int`	`CUSTOM_IMAGE_HANDLER`
`static boolean`	`debugPaint` flag to enable debugging of painting
`static int`	`DISPLAY_IMAGE`
`static int`	`DISPLAY_SCREEN` various types of DVR which we have
`static int`	`ENHANCE_FRACTIONAL_LINES`
`static int`	`FILLCOLOR`
`static int`	`FILLEDSHAPE`
`static int`	`FILLOPACITY`
`static int`	`FLUSH`
`static int`	`FLUSH_ADDITIONAL_OBJECTS_ON_PAGE`
`static int`	`FontMode`
`static int`	`FONTSIZE`
`static int`	`FOREGROUND_INCLUDE_LINEART`
`static int`	`IMAGE`
`static int`	`IsRealText`
`static int`	`IsSVGMode`
`static int`	`IsTextSelectable`
`static int`	`LINEWIDTH`
`static int`	`MARKER`
`static int`	`PAGE_DECODING_FINISHED`
`static int`	`PAINT_BACKGROUND`
`static int`	`RESET_COLORSPACE`
`static int`	`REUSED_IMAGE`
`static int`	`SAVE_EMBEDDED_FONT`
`static int`	`SHAPE`
`static int`	`STRING`
`static int`	`STROKE`
`static int`	`STROKECOLOR`
`static int`	`STROKEDSHAPE`
`static int`	`STROKEOPACITY`
`static int`	`TEXT`
`static int`	`TEXT_STRUCTURE_CLOSE`
`static int`	`TEXT_STRUCTURE_OPEN`
`static int`	`TEXTCOLOR`
`static int`	`TOKEN_NUMBER`
`static int`	`TR`
`static int`	`TRUETYPE`
`static int`	`TYPE1C`
`static int`	`TYPE3`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`drawAdditionalObjectsOverPage(int[] type, Color[] colors, Object[] obj)` Method to add Shape, Text or image to main display on page over PDF - will be flushed on redraw
`void`	`drawClip(GraphicsState currentGraphicsState, Shape defaultClip, boolean alwaysApply)`
`void`	`drawEmbeddedText(float[][] Trm, int fontSize, PdfGlyph embeddedGlyph, Object javaGlyph, int type, GraphicsState gs, double[] at, String glyf, PdfFont currentFontData, float glyfWidth)` Store glyph info
`int`	`drawImage(int pageNumber, BufferedImage image, GraphicsState currentGraphicsState, boolean alreadyCached, String name, int previousUse)` save image in array to draw
`void`	`drawShape(Object currentShape, GraphicsState currentGraphicsState)` Used by FX to Draw shape
`void`	`drawShape(PdfShape currentShape, GraphicsState currentGraphicsState, int cmd)` Used by Swing to Draw shape
`void`	`drawText(float[][] Trm, String text, GraphicsState currentGraphicsState, float x, float y, Font javaFont)` Saves text object with attributes for rendering
`void`	`drawTR(int value)`
`void`	`eliminateHiddenText(Shape currentShape, GraphicsState gs, int segmentCount, boolean ignoreScaling)`
`boolean`	`getBooleanValue(int key)` Generic method to access boolean flags
`int`	`getValue(int key)` Generic method to access int values
`void`	`init(int width, int height, Color backgroundColor)` Set page values
`boolean`	`isHTMLorSVG()` Allows generic code to identify if it is doing HTML/SVG conversion
`void`	`paint(Rectangle[] highlights, AffineTransform viewScaling, Rectangle userAnnot)` Renders all the objects onto the g2 surface for screen display
`void`	`saveAdvanceWidth(int fontObjID, String glyphName, int potentialWidth)` Passes in width value for font glyphs - only used in HTML5 and SVG conversion
`byte[]`	`serializeToByteArray(Set<String> fontsAlreadyOnClient)` Turn object into byte[] so we can move across this way should be much faster than the stadard Java serialise.
`void`	`setG2(Graphics2D g2)` Used to pass in Graphics2D for all versions
`void`	`setGraphicsState(int fillType, float value, int BM)` save opacity settings
`void`	`setScalingValues(double cropX, double cropH, float scaling)`
`void`	`setValue(int key, int i)` Generic method to set int values
`void`	`writeCustom(int key, Object obj)` Generic method to set any values as an object

- Field Detail
  - FontMode
```
static final int FontMode
```
    See Also:
    
    Constant Field Values
  - TEXT
```
static final int TEXT
```
    See Also:
    
    Constant Field Values
  - SHAPE
```
static final int SHAPE
```
    See Also:
    
    Constant Field Values
  - IMAGE
```
static final int IMAGE
```
    See Also:
    
    Constant Field Values
  - TRUETYPE
```
static final int TRUETYPE
```
    See Also:
    
    Constant Field Values
  - TYPE1C
```
static final int TYPE1C
```
    See Also:
    
    Constant Field Values
  - TYPE3
```
static final int TYPE3
```
    See Also:
    
    Constant Field Values
  - CLIP
```
static final int CLIP
```
    See Also:
    
    Constant Field Values
  - COLOR
```
static final int COLOR
```
    See Also:
    
    Constant Field Values
  - AF
```
static final int AF
```
    See Also:
    
    Constant Field Values
  - TEXTCOLOR
```
static final int TEXTCOLOR
```
    See Also:
    
    Constant Field Values
  - FILLCOLOR
```
static final int FILLCOLOR
```
    See Also:
    
    Constant Field Values
  - STROKECOLOR
```
static final int STROKECOLOR
```
    See Also:
    
    Constant Field Values
  - STROKE
```
static final int STROKE
```
    See Also:
    
    Constant Field Values
  - TR
```
static final int TR
```
    See Also:
    
    Constant Field Values
  - STRING
```
static final int STRING
```
    See Also:
    
    Constant Field Values
  - STROKEOPACITY
```
static final int STROKEOPACITY
```
    See Also:
    
    Constant Field Values
  - FILLOPACITY
```
static final int FILLOPACITY
```
    See Also:
    
    Constant Field Values
  - STROKEDSHAPE
```
static final int STROKEDSHAPE
```
    See Also:
    
    Constant Field Values
  - FILLEDSHAPE
```
static final int FILLEDSHAPE
```
    See Also:
    
    Constant Field Values
  - FONTSIZE
```
static final int FONTSIZE
```
    See Also:
    
    Constant Field Values
  - LINEWIDTH
```
static final int LINEWIDTH
```
    See Also:
    
    Constant Field Values
  - CUSTOM
```
static final int CUSTOM
```
    See Also:
    
    Constant Field Values
  - REUSED_IMAGE
```
static final int REUSED_IMAGE
```
    See Also:
    
    Constant Field Values
  - BLENDMODE
```
static final int BLENDMODE
```
    See Also:
    
    Constant Field Values
  - SAVE_EMBEDDED_FONT
```
static final int SAVE_EMBEDDED_FONT
```
    See Also:
    
    Constant Field Values
  - TEXT_STRUCTURE_OPEN
```
static final int TEXT_STRUCTURE_OPEN
```
    See Also:
    
    Constant Field Values
  - TEXT_STRUCTURE_CLOSE
```
static final int TEXT_STRUCTURE_CLOSE
```
    See Also:
    
    Constant Field Values
  - IsSVGMode
```
static final int IsSVGMode
```
    See Also:
    
    Constant Field Values
  - IsTextSelectable
```
static final int IsTextSelectable
```
    See Also:
    
    Constant Field Values
  - IsRealText
```
static final int IsRealText
```
    See Also:
    
    Constant Field Values
  - MARKER
```
static final int MARKER
```
    See Also:
    
    Constant Field Values
  - debugPaint
```
static final boolean debugPaint
```
    flag to enable debugging of painting
    
    See Also:
    
    Constant Field Values
  - DISPLAY_SCREEN
```
static final int DISPLAY_SCREEN
```
    various types of DVR which we have
    
    See Also:
    
    Constant Field Values
  - DISPLAY_IMAGE
```
static final int DISPLAY_IMAGE
```
    See Also:
    
    Constant Field Values
  - CREATE_PATTERN
```
static final int CREATE_PATTERN
```
    See Also:
    
    Constant Field Values
  - CREATE_HTML
```
static final int CREATE_HTML
```
    See Also:
    
    Constant Field Values
  - CREATE_SVG
```
static final int CREATE_SVG
```
    See Also:
    
    Constant Field Values
  - CREATE_EPOS
```
static final int CREATE_EPOS
```
    See Also:
    
    Constant Field Values
  - CREATE_T3
```
static final int CREATE_T3
```
    See Also:
    
    Constant Field Values
  - ALT_BACKGROUND_COLOR
```
static final int ALT_BACKGROUND_COLOR
```
    Keys for use with set value
    
    See Also:
    
    Constant Field Values
  - ALT_FOREGROUND_COLOR
```
static final int ALT_FOREGROUND_COLOR
```
    See Also:
    
    Constant Field Values
  - FOREGROUND_INCLUDE_LINEART
```
static final int FOREGROUND_INCLUDE_LINEART
```
    See Also:
    
    Constant Field Values
  - COLOR_REPLACEMENT_THRESHOLD
```
static final int COLOR_REPLACEMENT_THRESHOLD
```
    See Also:
    
    Constant Field Values
  - ENHANCE_FRACTIONAL_LINES
```
static final int ENHANCE_FRACTIONAL_LINES
```
    See Also:
    
    Constant Field Values
  - TOKEN_NUMBER
```
static final int TOKEN_NUMBER
```
    See Also:
    
    Constant Field Values
  - CUSTOM_IMAGE_HANDLER
```
static final int CUSTOM_IMAGE_HANDLER
```
    See Also:
    
    Constant Field Values
  - CUSTOM_COLOR_HANDLER
```
static final int CUSTOM_COLOR_HANDLER
```
    See Also:
    
    Constant Field Values
  - FLUSH
```
static final int FLUSH
```
    See Also:
    
    Constant Field Values
  - FLUSH_ADDITIONAL_OBJECTS_ON_PAGE
```
static final int FLUSH_ADDITIONAL_OBJECTS_ON_PAGE
```
    See Also:
    
    Constant Field Values
  - PAINT_BACKGROUND
```
static final int PAINT_BACKGROUND
```
    See Also:
    
    Constant Field Values
  - PAGE_DECODING_FINISHED
```
static final int PAGE_DECODING_FINISHED
```
    See Also:
    
    Constant Field Values
  - RESET_COLORSPACE
```
static final int RESET_COLORSPACE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - setG2
```
void setG2(Graphics2D g2)
```
    Used to pass in Graphics2D for all versions
    
    Parameters:
    
    g2 -
  - eliminateHiddenText
```
void eliminateHiddenText(Shape currentShape,
                         GraphicsState gs,
                         int segmentCount,
                         boolean ignoreScaling)
```
  - paint
```
void paint(Rectangle[] highlights,
           AffineTransform viewScaling,
           Rectangle userAnnot)
```
    Renders all the objects onto the g2 surface for screen display
    
    Parameters:
    
    highlights -
    
    viewScaling -
    
    userAnnot -
  - drawText
```
void drawText(float[][] Trm,
              String text,
              GraphicsState currentGraphicsState,
              float x,
              float y,
              Font javaFont)
```
    Saves text object with attributes for rendering
    
    Parameters:
    
    Trm -
    
    text -
    
    currentGraphicsState -
    
    x -
    
    y -
    
    javaFont -
  - init
```
void init(int width,
          int height,
          Color backgroundColor)
```
    Set page values
    
    Parameters:
    
    width -
    
    height -
    
    backgroundColor -
  - drawImage
```
int drawImage(int pageNumber,
              BufferedImage image,
              GraphicsState currentGraphicsState,
              boolean alreadyCached,
              String name,
              int previousUse)
```
    save image in array to draw
    
    Parameters:
    
    pageNumber -
    
    image -
    
    currentGraphicsState -
    
    alreadyCached -
    
    name -
    
    previousUse -
    
    Returns:
  - drawShape
```
void drawShape(PdfShape currentShape,
               GraphicsState currentGraphicsState,
               int cmd)
```
    Used by Swing to Draw shape
    
    Parameters:
    
    currentShape -
    
    currentGraphicsState -
    
    cmd -
  - drawShape
```
void drawShape(Object currentShape,
               GraphicsState currentGraphicsState)
```
    Used by FX to Draw shape
    
    Parameters:
    
    currentShape -
    
    currentGraphicsState -
  - setGraphicsState
```
void setGraphicsState(int fillType,
                      float value,
                      int BM)
```
    save opacity settings
    
    Parameters:
    
    fillType -
    
    value -
    
    BM -
  - drawAdditionalObjectsOverPage
```
void drawAdditionalObjectsOverPage(int[] type,
                                   Color[] colors,
                                   Object[] obj)
                            throws PdfException
```
    Method to add Shape, Text or image to main display on page over PDF - will be flushed on redraw
    
    Parameters:
    
    type -
    
    colors -
    
    obj -
    
    Throws:
    
    PdfException
  - drawTR
```
void drawTR(int value)
```
    Parameters:
    
    value -
  - drawClip
```
void drawClip(GraphicsState currentGraphicsState,
              Shape defaultClip,
              boolean alwaysApply)
```
    Parameters:
    
    currentGraphicsState -
    
    defaultClip -
    
    alwaysApply -
  - drawEmbeddedText
```
void drawEmbeddedText(float[][] Trm,
                      int fontSize,
                      PdfGlyph embeddedGlyph,
                      Object javaGlyph,
                      int type,
                      GraphicsState gs,
                      double[] at,
                      String glyf,
                      PdfFont currentFontData,
                      float glyfWidth)
```
    Store glyph info
    
    Parameters:
    
    Trm -
    
    fontSize -
    
    embeddedGlyph -
    
    javaGlyph -
    
    type -
    
    gs -
    
    at -
    
    glyf -
    
    currentFontData -
    
    glyfWidth -
  - setScalingValues
```
void setScalingValues(double cropX,
                      double cropH,
                      float scaling)
```
    Parameters:
    
    cropX -
    
    cropH -
    
    scaling -
  - serializeToByteArray
```
byte[] serializeToByteArray(Set<String> fontsAlreadyOnClient)
                     throws IOException
```
    Turn object into byte[] so we can move across this way should be much faster than the stadard Java serialise.
    NOT PART OF API and subject to change (DO NOT USE)
    
    Parameters:
    
    fontsAlreadyOnClient -
    
    Returns:
    
    Throws:
    
    IOException
  - writeCustom
```
void writeCustom(int key,
                 Object obj)
```
    Generic method to set any values as an object
    
    Parameters:
    
    key - key value defined in this interface or inheriting class
    
    obj - value for key settings
  - setValue
```
void setValue(int key,
              int i)
```
    Generic method to set int values
    
    Parameters:
    
    key - key value defined in this interface or inheriting class
    
    i - value for key settings
  - getValue
```
int getValue(int key)
```
    Generic method to access int values
    
    Parameters:
    
    key - - int key value defined in this interface or inheriting class
    
    Returns:
    
    - an int value
  - getBooleanValue
```
boolean getBooleanValue(int key)
```
    Generic method to access boolean flags
    
    Parameters:
    
    key - - int key value defined in this interface or inheriting class
    
    Returns:
    
    true/false boolean
  - saveAdvanceWidth
```
void saveAdvanceWidth(int fontObjID,
                      String glyphName,
                      int potentialWidth)
```
    Passes in width value for font glyphs - only used in HTML5 and SVG conversion
    
    Parameters:
    
    fontObjID -
    
    glyphName -
    
    potentialWidth -
  - isHTMLorSVG
```
boolean isHTMLorSVG()
```
    Allows generic code to identify if it is doing HTML/SVG conversion
    
    Returns:
    
    boolean which will be true for HTML/SVG conversion and otherwise false

Interface DynamicVectorRenderer

Field Summary

Method Summary

Field Detail

FontMode

TEXT

SHAPE

IMAGE

TRUETYPE

TYPE1C

TYPE3

CLIP

COLOR

AF

TEXTCOLOR

FILLCOLOR

STROKECOLOR

STROKE

TR

STRING

STROKEOPACITY

FILLOPACITY

STROKEDSHAPE

FILLEDSHAPE

FONTSIZE

LINEWIDTH

CUSTOM

REUSED_IMAGE

BLENDMODE

SAVE_EMBEDDED_FONT

TEXT_STRUCTURE_OPEN

TEXT_STRUCTURE_CLOSE

IsSVGMode

IsTextSelectable

IsRealText

MARKER

debugPaint

DISPLAY_SCREEN

DISPLAY_IMAGE

CREATE_PATTERN

CREATE_HTML

CREATE_SVG

CREATE_EPOS

CREATE_T3

ALT_BACKGROUND_COLOR

ALT_FOREGROUND_COLOR

FOREGROUND_INCLUDE_LINEART

COLOR_REPLACEMENT_THRESHOLD

ENHANCE_FRACTIONAL_LINES

TOKEN_NUMBER

CUSTOM_IMAGE_HANDLER

CUSTOM_COLOR_HANDLER

FLUSH

FLUSH_ADDITIONAL_OBJECTS_ON_PAGE

PAINT_BACKGROUND

PAGE_DECODING_FINISHED

RESET_COLORSPACE

Method Detail

setG2

eliminateHiddenText

paint

drawText

init

drawImage

drawShape

drawShape

setGraphicsState

drawAdditionalObjectsOverPage

drawTR

drawClip

drawEmbeddedText

setScalingValues

serializeToByteArray

writeCustom

setValue

getValue

getBooleanValue

saveAdvanceWidth

isHTMLorSVG