GUIDisplay (org.jpedal:OpenViewerFX 7.12.28 API)

java.lang.Object
- org.jpedal.display.GUIDisplay

All Implemented Interfaces:

Display

Direct Known Subclasses:

SingleDisplayFX
```
public class GUIDisplay
extends Object
implements Display
```
hold code generic to Swing or FX

Nested Class Summary
- Nested classes/interfaces inherited from interface org.jpedal.display.Display
  Display.BoolValue

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`accelerationAlwaysRedraw`
`static boolean`	`allowChangeCursor` Flag if we should allow cursor to change
`int`	`crh` used to draw demo cross
`double`	`cropH`
`double`	`cropW`
`double`	`cropX`
`double`	`cropY`
`int`	`crw` used to draw demo cross
`int`	`crx` used to draw demo cross
`int`	`cry` used to draw demo cross
`DynamicVectorRenderer`	`currentDisplay`
`PageOffsets`	`currentOffset`
`RenderChangeListener`	`customRenderChangeListener` Normally null - user object to listen to paint events
`static boolean`	`default_separateCover`
`static boolean`	`default_turnoverOn`
`protected DisplayOffsets`	`displayOffsets`
`int`	`displayRotation` local copies
`protected double[]`	`displayScalingDbl`
`int`	`displayView` local copies
`boolean`	`ignoreScalingForAcceleration`
`protected double`	`indent`
`int`	`insetH`
`int`	`insetW`
`boolean`	`isInitialised`
`boolean[]`	`isRotated`
`int`	`lastDisplayRotation`
`protected int`	`lastEnd`
`protected int`	`lastFormPage`
`protected int`	`lastIndent` tracks indent so changing to continuous does not disturb display
`float`	`lastScaling`
`protected int`	`lastStart`
`MultiDisplayOptions`	`multiDisplayOptions`
`float`	`oldRotation` any scaling factor being used to convert co-ords into correct values and to alter image size
`float`	`oldScaling` any scaling factor being used to convert co-ords into correct values and to alter image size
`DecoderOptions`	`options`
`boolean`	`overRideAcceleration` flag to switch back to unaccelerate screen if no enough memory for scaling
`PdfPageData`	`pageData`
`int`	`pageNumber`
`int[]`	`pageOffsetH` Keep a record of cumulative offsets for SINGLE_PAGE mode
`int[]`	`pageOffsetW` Keep a record of cumulative offsets for SINGLE_PAGE mode
`protected int`	`pageUsedForTransform`
`int`	`rh`
`int`	`rw`
`int`	`rx`
`int`	`ry`
`float`	`scaling`
`protected GUIThumbnailPanel`	`thumbnails`
`int`	`topH`
`int`	`topW`
`boolean`	`useAcceleration` render screen using hardware acceleration

Fields inherited from interface org.jpedal.display.Display
CONTINUOUS, CONTINUOUS_FACING, debugLayout, DISPLAY_CENTERED, DISPLAY_LEFT_ALIGNED, FACING, NODISPLAY, PAGEFLOW, PORTFOLIO_DETAIL, PORTFOLIO_TILE, SINGLE_PAGE

Constructor Summary

Constructors
Constructor and Description

GUIDisplay()

Constructors
Constructor and Description
`GUIDisplay()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`decodeOtherPages(int pageNumber, int pageCount)`
`void`	`disableScreen()`
`void`	`dispose()`
`void`	`drawBorder()`
`void`	`drawCursor(Graphics g, float scaling)`
`void`	`drawFacing(Rectangle visibleRect)`
`void`	`flushPageCaches()`
`void`	`forceRedraw()`
`boolean`	`getBoolean(Display.BoolValue option)`
`int[]`	`getCursorBoxOnScreenAsArray()`
`Rectangle`	`getDisplayedRectangle()`
`Rectangle`	`getDisplayedRectangle(boolean isShowing, Rectangle userAnnot)`
`int`	`getDisplayRotation()`
`int`	`getEndPage()`
`int[]`	`getHighlightedImage()`
`double`	`getIndent()`
`int`	`getInsetH()`
`int`	`getInsetW()`
`float`	`getOldScaling()`
`int[]`	`getPageSize(int displayView)`
`int`	`getRh()`
`int`	`getRw()`
`int`	`getRx()`
`int`	`getRy()`
`int`	`getStartPage()`
`int`	`getXCordForPage(int page)`
`int`	`getYCordForPage(int page)`
`int`	`getYCordForPage(int page, float scaling)` used internally by multiple pages scaling -1 to ignore, -2 to force reset
`void`	`init(float scaling, int displayRotation, int pageNumber, DynamicVectorRenderer currentDisplay, boolean isInit)`
`void`	`paintPage(Graphics2D g2, AcroRenderer formRenderer, TextLines textLines)`
`void`	`refreshDisplay()`
`void`	`resetViewableArea()`
`void`	`setAcceleration(boolean enable)`
`void`	`setAccelerationAlwaysRedraw(boolean enable)`
`void`	`setBoolean(Display.BoolValue option, boolean value)`
`void`	`setCurrentDisplay(DynamicVectorRenderer pageView)`
`void`	`setHighlightedImage(int[] highlightedImage)`
`void`	`setObjectValue(int type, Object newHandler)` general method to pass in Objects - only takes RenderChangeListener at present
`void`	`setPageOffsets(int pageNumber)` workout offsets so we can draw pages
`void`	`setPageRotation(int newRotation)` initialise panel and set size to display during updates and update the AffineTransform to new values
`void`	`setPageSize(int pageNumber, float scaling)`
`void`	`setScaling(float scaling)`
`void`	`setThumbnailPanel(GUIThumbnailPanel thumbnails)`
`void`	`setup(boolean useAcceleration, PageOffsets currentOffset)`
`void`	`stopGeneratingPage()`
`void`	`updateCursorBoxOnScreen(int[] newOutlineRectangle, int outlineColor, int pageNumber, int x_size, int y_size)`

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

Field Detail

lastFormPage
```
protected int lastFormPage
```

lastStart
```
protected int lastStart
```

lastEnd
```
protected int lastEnd
```

pageUsedForTransform
```
protected int pageUsedForTransform
```

lastIndent
```
protected int lastIndent
```
tracks indent so changing to continuous does not disturb display

indent
```
protected double indent
```

customRenderChangeListener
```
public RenderChangeListener customRenderChangeListener
```
Normally null - user object to listen to paint events

rx
```
public int rx
```

ry
```
public int ry
```

rw
```
public int rw
```

rh
```
public int rh
```

displayOffsets

protected DisplayOffsets displayOffsets

options
```
public DecoderOptions options
```

allowChangeCursor
```
public static boolean allowChangeCursor
```
Flag if we should allow cursor to change

multiDisplayOptions

public final MultiDisplayOptions multiDisplayOptions

default_turnoverOn

public static boolean default_turnoverOn

default_separateCover

public static boolean default_separateCover

currentDisplay

public DynamicVectorRenderer currentDisplay

isInitialised
```
public boolean isInitialised
```

overRideAcceleration
```
public boolean overRideAcceleration
```
flag to switch back to unaccelerate screen if no enough memory for scaling

useAcceleration
```
public boolean useAcceleration
```
render screen using hardware acceleration

ignoreScalingForAcceleration

public boolean ignoreScalingForAcceleration

accelerationAlwaysRedraw

public boolean accelerationAlwaysRedraw

currentOffset
```
public PageOffsets currentOffset
```

thumbnails
```
protected GUIThumbnailPanel thumbnails
```

pageOffsetH
```
public int[] pageOffsetH
```
Keep a record of cumulative offsets for SINGLE_PAGE mode

pageOffsetW
```
public int[] pageOffsetW
```
Keep a record of cumulative offsets for SINGLE_PAGE mode

isRotated
```
public boolean[] isRotated
```

topW
```
public int topW
```

topH
```
public int topH
```

cropX
```
public double cropX
```

cropY
```
public double cropY
```

cropW
```
public double cropW
```

cropH
```
public double cropH
```

crx
```
public int crx
```
used to draw demo cross

cry
```
public int cry
```
used to draw demo cross

crw
```
public int crw
```
used to draw demo cross

crh
```
public int crh
```
used to draw demo cross

displayRotation
```
public int displayRotation
```
local copies

displayView
```
public int displayView
```
local copies

lastDisplayRotation
```
public int lastDisplayRotation
```

insetW
```
public int insetW
```

insetH
```
public int insetH
```

scaling
```
public float scaling
```

lastScaling
```
public float lastScaling
```

pageNumber
```
public int pageNumber
```

oldScaling
```
public float oldScaling
```
any scaling factor being used to convert co-ords into correct values and to alter image size

oldRotation
```
public float oldRotation
```
any scaling factor being used to convert co-ords into correct values and to alter image size

pageData
```
public PdfPageData pageData
```

displayScalingDbl
```
protected double[] displayScalingDbl
```

Constructor Detail
- GUIDisplay
```
public GUIDisplay()
```

Method Detail

getYCordForPage
```
public int getYCordForPage(int page,
                           float scaling)
```
used internally by multiple pages scaling -1 to ignore, -2 to force reset

Specified by:

getYCordForPage in interface Display

getBoolean

public boolean getBoolean(Display.BoolValue option)

Specified by:: getBoolean in interface Display

setBoolean

public void setBoolean(Display.BoolValue option,
                       boolean value)

Specified by:: setBoolean in interface Display

setObjectValue
```
public void setObjectValue(int type,
                           Object newHandler)
```
general method to pass in Objects - only takes RenderChangeListener at present

Specified by:

setObjectValue in interface Display

Parameters:

type -

newHandler -

getPageSize
```
public int[] getPageSize(int displayView)
```
Specified by:

getPageSize in interface Display

Parameters:

displayView - is of type int

Returns:

returns an int[] with 2 values ([0]width and [1]height) which we then use to create a Dimension object in current Swing code

setup

public void setup(boolean useAcceleration,
                  PageOffsets currentOffset)

Specified by:: setup in interface Display

setAcceleration
```
public void setAcceleration(boolean enable)
```
Specified by:

setAcceleration in interface Display

setAccelerationAlwaysRedraw
```
public void setAccelerationAlwaysRedraw(boolean enable)
```
Specified by:

setAccelerationAlwaysRedraw in interface Display

setPageSize

public void setPageSize(int pageNumber,
                        float scaling)

decodeOtherPages

public void decodeOtherPages(int pageNumber,
                             int pageCount)

Specified by:: decodeOtherPages in interface Display

disableScreen
```
public void disableScreen()
```
Specified by:

disableScreen in interface Display

getOldScaling
```
public float getOldScaling()
```
Specified by:

getOldScaling in interface Display

refreshDisplay
```
public void refreshDisplay()
```
Specified by:

refreshDisplay in interface Display

flushPageCaches
```
public void flushPageCaches()
```
Specified by:

flushPageCaches in interface Display

init

public void init(float scaling,
                 int displayRotation,
                 int pageNumber,
                 DynamicVectorRenderer currentDisplay,
                 boolean isInit)

Specified by:: init in interface Display

setThumbnailPanel
```
public void setThumbnailPanel(GUIThumbnailPanel thumbnails)
```
Specified by:

setThumbnailPanel in interface Display

stopGeneratingPage
```
public void stopGeneratingPage()
```
Specified by:

stopGeneratingPage in interface Display

getYCordForPage
```
public int getYCordForPage(int page)
```
Specified by:

getYCordForPage in interface Display

getStartPage
```
public int getStartPage()
```

getEndPage
```
public int getEndPage()
```

setScaling
```
public void setScaling(float scaling)
```
Specified by:

setScaling in interface Display

setHighlightedImage
```
public void setHighlightedImage(int[] highlightedImage)
```
Specified by:

setHighlightedImage in interface Display

getHighlightedImage
```
public int[] getHighlightedImage()
```
Specified by:

getHighlightedImage in interface Display

drawBorder
```
public void drawBorder()
```
Specified by:

drawBorder in interface Display

getXCordForPage
```
public int getXCordForPage(int page)
```
Specified by:

getXCordForPage in interface Display

setPageOffsets
```
public void setPageOffsets(int pageNumber)
```
workout offsets so we can draw pages

Specified by:

setPageOffsets in interface Display

dispose
```
public void dispose()
```
Specified by:

dispose in interface Display

getCursorBoxOnScreenAsArray
```
public int[] getCursorBoxOnScreenAsArray()
```
Specified by:

getCursorBoxOnScreenAsArray in interface Display

getIndent
```
public double getIndent()
```
Specified by:

getIndent in interface Display

forceRedraw
```
public void forceRedraw()
```
Specified by:

forceRedraw in interface Display

setPageRotation
```
public void setPageRotation(int newRotation)
```
initialise panel and set size to display during updates and update the AffineTransform to new values

Specified by:

setPageRotation in interface Display

resetViewableArea
```
public void resetViewableArea()
```
Specified by:

resetViewableArea in interface Display

paintPage

public void paintPage(Graphics2D g2,
                      AcroRenderer formRenderer,
                      TextLines textLines)

Specified by:: paintPage in interface Display

updateCursorBoxOnScreen

public void updateCursorBoxOnScreen(int[] newOutlineRectangle,
                                    int outlineColor,
                                    int pageNumber,
                                    int x_size,
                                    int y_size)

Specified by:: updateCursorBoxOnScreen in interface Display

drawCursor

public void drawCursor(Graphics g,
                       float scaling)

Specified by:: drawCursor in interface Display

drawFacing
```
public void drawFacing(Rectangle visibleRect)
```
Specified by:

drawFacing in interface Display

setCurrentDisplay

public void setCurrentDisplay(DynamicVectorRenderer pageView)

getDisplayRotation
```
public int getDisplayRotation()
```

getRx
```
public int getRx()
```

getRy
```
public int getRy()
```

getRw
```
public int getRw()
```

getRh
```
public int getRh()
```

getInsetW
```
public int getInsetW()
```

getInsetH
```
public int getInsetH()
```

getDisplayedRectangle
```
public Rectangle getDisplayedRectangle()
```
Specified by:

getDisplayedRectangle in interface Display

getDisplayedRectangle

public Rectangle getDisplayedRectangle(boolean isShowing,
                                       Rectangle userAnnot)

Class GUIDisplay

Nested Class Summary

Nested classes/interfaces inherited from interface org.jpedal.display.Display

Field Summary

Fields inherited from interface org.jpedal.display.Display

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

lastFormPage

lastStart

lastEnd

pageUsedForTransform

lastIndent

indent

customRenderChangeListener

rx

ry

rw

rh

displayOffsets

options

allowChangeCursor

multiDisplayOptions

default_turnoverOn

default_separateCover

currentDisplay

isInitialised

overRideAcceleration

useAcceleration

ignoreScalingForAcceleration

accelerationAlwaysRedraw

currentOffset

thumbnails

pageOffsetH

pageOffsetW

isRotated

topW

topH

cropX

cropY

cropW

cropH

crx

cry

crw

crh

displayRotation

displayView

lastDisplayRotation

insetW

insetH

scaling

lastScaling

pageNumber

oldScaling

oldRotation

pageData

displayScalingDbl

Constructor Detail

GUIDisplay

Method Detail

getYCordForPage

getBoolean

setBoolean

setObjectValue

getPageSize

setup

setAcceleration

setAccelerationAlwaysRedraw

setPageSize

decodeOtherPages

disableScreen

getOldScaling

refreshDisplay

flushPageCaches

init

setThumbnailPanel

stopGeneratingPage

getYCordForPage