NativeWindowSurface

java.lang.Object
- eve.fx.gui.WindowSurface
- - eve.fx.gui.NativeWindowSurface

All Implemented Interfaces:

SIPConstants, WindowConstants, ISurface
```
public class NativeWindowSurface
extends WindowSurface
```
This class represents the platforms display object - for example a Window in Windows/Win32 or the entire screen on smaller devices.
The WindowSurface also is responsible for generating UI events like keyboard and pen/mouse events as well as paint and resize events.

Author:

Michael L Brereton

Nested Class Summary
- Nested classes/interfaces inherited from class eve.fx.gui.WindowSurface
  WindowSurface.RawEventFilter

Field Summary

Fields
Modifier and Type	Field and Description
`EveCanvas`	`_canvas`
`java.awt.Frame`	`_frame`
`EveWindow`	`_window`
`protected Countdown`	`cd`
`static int`	`ROTATION_180`
`static int`	`ROTATION_270`
`static int`	`ROTATION_90`
`static int`	`ROTATION_NONE`
`Vector`	`waitingEvents`

Fields inherited from class eve.fx.gui.WindowSurface
amCreated, applicationWindow, defaultIcon, defaultWindowTitle, invisibleMousePointer, mainSurface, nativeDialogCount, noCloseButtons, overlayer, screenId

Fields inherited from interface eve.fx.ISurface
IMAGE_SURFACE, PRINTERJOB_SURFACE, WINDOW_SURFACE

Fields inherited from interface eve.fx.gui.WindowConstants
FLAG_ACCEPTS_DROPPED_FILES, FLAG_ALWAYS_ENABLED, FLAG_ALWAYS_ON_TOP, FLAG_CAN_MAXIMIZE, FLAG_CAN_MINIMIZE, FLAG_CAN_RESIZE, FLAG_DONT_CLEAR_BACKGROUND, FLAG_FOR_SIZE_NO_CLOSE_BUTTON, FLAG_FOR_SIZE_NO_TITLE, FLAG_FULL_SCREEN, FLAG_HAS_CLOSE_BUTTON, FLAG_HAS_TASKBAR_ENTRY, FLAG_HAS_TITLE, FLAG_IS_DEFAULT_SIZE, FLAG_IS_DEFAULT_SURFACE, FLAG_IS_ICONIZED, FLAG_IS_MODAL, FLAG_IS_NOT_DEFAULT_SURFACE, FLAG_IS_VISIBLE, FLAG_MAXIMIZE, FLAG_MAXIMIZE_ON_PDA, FLAG_MINIMIZE, FLAG_SHOW_SIP_BUTTON, FLAG_VISIBLE_ON_TO_FRONT, GUI_FLAG_DONT_REPAINT_ON_RESIZE, GUI_FLAG_HAS_TASKBAR, GUI_FLAG_REPAINT_FULL_CONTROL, GUI_FLAG_REVERSE_OK_CANCEL, SPECIAL_MOUSE_MOVE, SPECIAL_MOUSE_RELEASE_CAPTURE, SPECIAL_MOUSE_RESIZE, STATE_ACCEPT_DROPPED_FILES, STATE_FULL_SCREEN, STATE_MAXIMIZED, STATE_MINIMIZED, STATE_NORMAL, STATE_REJECT_DROPPED_FILES, STATE_RESTORE, STATE_TO_FRONT, STATE_UNKNOWN

Fields inherited from interface eve.fx.gui.SIPConstants
SIP_CURRENT, SIP_FREEZE, SIP_IS_ON, SIP_LEAVE_BUTTON, SIP_LOCK, SIP_ON, SIP_OVERRIDE_USE_SIP, SIP_REMOVE_BUTTON, SIP_UNFREEZE

Constructor Summary

Constructors
Constructor and Description

NativeWindowSurface()

Constructors
Constructor and Description
`NativeWindowSurface()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canCapture()` This returns true if it is possible to read pixel data from the surface into an Image.
`static boolean`	`canCopyFrom()` Returns if it is possible to copy pixel data from a window.
`boolean`	`canMove()` This returns true if it is possible to move pixel within the surface.
`int`	`captureAppKeys(int options)`
`boolean`	`captureImage(Image dest, int x, int y, int width, int height)` Capture pixel data from the surface to an Image.
`void`	`clearCursorRegions()` Remove all set cursor regions.
`protected boolean`	`doCaptureMouse(boolean doGrab)`
`void`	`doClose()`
`protected void`	`doCreate(WindowCreationData wco)`
`ITaskbarEntry`	`doCreateTaskbarEntry()`
`boolean`	`doGetBounds(Rect dest)`
`boolean`	`doGetClientRect(Rect dest)`
`protected boolean`	`doGetDPI(double[] xyDpi)`
`boolean`	`doGetScreenRect(int screenId, Rect dest, boolean desktopOnly)`
`boolean`	`doSetBounds(int x, int y, int width, int height)`
`boolean`	`doSetClientRect(int x, int y, int width, int height)`
`void`	`drawImage(Image src, int clipX, int clipY, int clipWidth, int clipHeight, int destX, int destY, int width, int height)` This should always work for any surface and is the minimum functionality expected.
`void`	`freeNativeGraphics(Object g)`
`int`	`getAsyncKeyState(int keyCode)` Return the current press state of a particular key or mouse button at this instant in time.
`boolean`	`getBounds(Rect dest)` Get the bounds of the full window in the screen.
`boolean`	`getClientRect(Rect dest)` Get the rect of the client area within the full window.
`Image`	`getCompatibleImage(int width, int height)` Get an Image that is optimized for display on the surface.
`Object`	`getDroppedData(int dataID)`
`int`	`getFlagsForSize(int requestedWidth, int requestedHeight, int requestedSetFlags, int requestedClearFlags)` This is used during Window creation.
`Font`	`getFont()`
`Graphics`	`getGraphics()` This returns a new Graphics for use on the surface IF it is supported.
`Object`	`getInfo(int infoCode, Object parameters, Object dest, int options)`
`java.awt.Frame`	`getJavaFrame()`
`Object`	`getJavaSurface()`
`eve.fx.gui.NativeWindowSurface.javaWindow`	`getJavaWindow()`
`Object`	`getNativeGraphics()`
`boolean`	`getParentSize(Dimension dest)` If the Window is a child window, this returns the size of the parent Window.
`protected boolean`	`getRawEvent(long howLongToWait, RawEvent destination)`
`boolean`	`getScreenRect(int screenId, Rect dest, boolean desktopOnly)` Get the size of a particular screen.
`int`	`getState()`
`String`	`getTitle()` Get the title text of the window.
`boolean`	`hasPendingEvents()`
`boolean`	`isVisible()`
`boolean`	`moveImage(int srcX, int srcY, int srcWidth, int srcHeight, int destX, int destY)` Move pixel data within the surface.
`void`	`postRawEvent(RawEvent event)` This posts a copy of the data in the RawEvent.
`void`	`removeCursorRegion(int regionID)` Remove the specified cursor region.
`void`	`requestRepaint(int x, int y, int width, int height, boolean dontMerge)`
`boolean`	`setBounds(int x, int y, int width, int height)`
`boolean`	`setClientRect(int x, int y, int width, int height)`
`int`	`setFlags(int flagsToSet, int flagsToClear)` Set or get the Flags for a Window.
`boolean`	`setFont(Font font)`
`int`	`setGuiFlags(int flagsToset, int flagsToClear)` Set or get the GUI Flags for the device.
`boolean`	`setIcon(DeviceIcon icon)` Get the mouse pointer state at this point in time.
`boolean`	`setInfo(int infoCode, Object parameters, int options)`
`void`	`setState(int newState)`
`boolean`	`setTaskbarIcon(DeviceIcon icon)`
`void`	`setTitle(String title)` Set the title text of the window.
`void`	`setVisible(boolean visible)`
`boolean`	`specialOperation(int which, Object data)`
`static boolean`	`supportsMultiple()` Returns if the underlying system supports multiple windows for an application.
`protected void`	`takeKeyFocus()`

Methods inherited from class eve.fx.gui.WindowSurface
acceptDroppedFiles, addRawEventFilter, captureMouse, checkModalActive, clearScreenSizeInInches, clearScreenSizeInInches, close, create, createCursor, createCursor, createDefault, createDefaultWindow, createTaskbarEntry, doStartNativeInput, enterNativeDialog, eveMain, exitNativeDialog, expectRepaintIn, getCompatibleImagePoints, getDPI, getFlags, getFontMetrics, getGuiFlags, getMainSurface, getModal, getModalWindow, getNativeDialogCount, getNativeDrawable, getNew, getRawEvent, getReusedSurfaceEvent, getScreenDPI, getScreenDPI, getScreenIds, getScreenRect, getScreenRect, getScreenSizeInInches, getScreenSizeInInches, getSIP, getSIP, getSurfaceType, getWindowsLock, inNativeDialog, inNativeTextInput, isClosed, main, modalWindowHasPendingEvents, nativeGetSetSIP, postEvent, removeRawEventFilter, setCursor, setCursorRegion, setModal, setOverlays, setScreenSizeInInches, setScreenSizeInInches, setSIP, setSIP, setSIP, shutdown, startNativeInput

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

- Field Detail
  - _window
```
public EveWindow _window
```
  - _frame
```
public java.awt.Frame _frame
```
  - _canvas
```
public EveCanvas _canvas
```
  - ROTATION_NONE
```
public static final int ROTATION_NONE
```
    See Also:
    
    Constant Field Values
  - ROTATION_90
```
public static final int ROTATION_90
```
    See Also:
    
    Constant Field Values
  - ROTATION_180
```
public static final int ROTATION_180
```
    See Also:
    
    Constant Field Values
  - ROTATION_270
```
public static final int ROTATION_270
```
    See Also:
    
    Constant Field Values
  - waitingEvents
```
public Vector waitingEvents
```
  - cd
```
protected Countdown cd
```
- Constructor Detail
  - NativeWindowSurface
```
public NativeWindowSurface()
```
- Method Detail
  - getNativeGraphics
```
public Object getNativeGraphics()
```
  - freeNativeGraphics
```
public void freeNativeGraphics(Object g)
```
  - getGraphics
```
public Graphics getGraphics()
```
    Description copied from interface: ISurface
    
    This returns a new Graphics for use on the surface IF it is supported. Some surfaces do not support direct drawing and you must use the drawImage() method instead to write to the surface.
    
    Returns:
    
    a new Graphics for use on the surface IF it is supported, otherwise an UnsupportedOperationException is thrown.
  - clearCursorRegions
```
public void clearCursorRegions()
```
    Description copied from class: WindowSurface
    
    Remove all set cursor regions.
    
    Specified by:
    
    clearCursorRegions in class WindowSurface
  - removeCursorRegion
```
public void removeCursorRegion(int regionID)
```
    Description copied from class: WindowSurface
    
    Remove the specified cursor region.
    
    Specified by:
    
    removeCursorRegion in class WindowSurface
    
    Parameters:
    
    regionID - the ID of the cursor region as returned by setCursorRegion.
  - getJavaSurface
```
public Object getJavaSurface()
```
  - getJavaWindow
```
public eve.fx.gui.NativeWindowSurface.javaWindow getJavaWindow()
```
  - getJavaFrame
```
public java.awt.Frame getJavaFrame()
```
  - supportsMultiple
```
public static boolean supportsMultiple()
```
    Returns if the underlying system supports multiple windows for an application.
  - canCopyFrom
```
public static boolean canCopyFrom()
```
    Returns if it is possible to copy pixel data from a window.
  - setState
```
public void setState(int newState)
```
    Specified by:
    
    setState in class WindowSurface
  - requestRepaint
```
public void requestRepaint(int x,
                           int y,
                           int width,
                           int height,
                           boolean dontMerge)
```
    Specified by:
    
    requestRepaint in class WindowSurface
  - getState
```
public int getState()
```
    Specified by:
    
    getState in class WindowSurface
  - doClose
```
public void doClose()
```
    Specified by:
    
    doClose in class WindowSurface
  - setVisible
```
public void setVisible(boolean visible)
```
    Overrides:
    
    setVisible in class WindowSurface
  - isVisible
```
public boolean isVisible()
```
    Overrides:
    
    isVisible in class WindowSurface
  - getScreenRect
```
public final boolean getScreenRect(int screenId,
                                   Rect dest,
                                   boolean desktopOnly)
```
    Get the size of a particular screen.
    
    Specified by:
    
    getScreenRect in class WindowSurface
    
    Parameters:
    
    screenId - the id of the screen. 0 is the default screen.
    
    dest - a non-null destination Rect.
    
    desktopOnly - true to get the Rect representing the desktop area of the screen.
    
    Returns:
    
    true if successful, false if not.
  - getBounds
```
public final boolean getBounds(Rect dest)
```
    Description copied from class: WindowSurface
    
    Get the bounds of the full window in the screen.
    
    Specified by:
    
    getBounds in class WindowSurface
    
    Parameters:
    
    dest - a non-null destination Rect.
    
    Returns:
    
    true if succeeded, false if not.
  - setBounds
```
public final boolean setBounds(int x,
                               int y,
                               int width,
                               int height)
```
    Specified by:
    
    setBounds in class WindowSurface
  - getClientRect
```
public final boolean getClientRect(Rect dest)
```
    Description copied from class: WindowSurface
    
    Get the rect of the client area within the full window.
    
    Specified by:
    
    getClientRect in class WindowSurface
    
    Parameters:
    
    dest - a non-null destination Rect.
    
    Returns:
    
    true if succeeded, false if not.
  - setClientRect
```
public final boolean setClientRect(int x,
                                   int y,
                                   int width,
                                   int height)
```
    Specified by:
    
    setClientRect in class WindowSurface
  - doGetBounds
```
public boolean doGetBounds(Rect dest)
```
  - doSetBounds
```
public boolean doSetBounds(int x,
                           int y,
                           int width,
                           int height)
```
  - doCreate
```
protected void doCreate(WindowCreationData wco)
```
    Specified by:
    
    doCreate in class WindowSurface
  - getAsyncKeyState
```
public int getAsyncKeyState(int keyCode)
```
    Description copied from class: WindowSurface
    
    Return the current press state of a particular key or mouse button at this instant in time.
    
    Specified by:
    
    getAsyncKeyState in class WindowSurface
    
    Returns:
    
    If the key is pressed the value will have bit 0x8000 set and if the key has been pressed since the last call the 0x0001 bit will be set.
    
    See Also:
    
    IKeys
  - getInfo
```
public Object getInfo(int infoCode,
                      Object parameters,
                      Object dest,
                      int options)
```
    Specified by:
    
    getInfo in class WindowSurface
  - setInfo
```
public boolean setInfo(int infoCode,
                       Object parameters,
                       int options)
```
    Specified by:
    
    setInfo in class WindowSurface
  - doGetClientRect
```
public boolean doGetClientRect(Rect dest)
```
  - doSetClientRect
```
public boolean doSetClientRect(int x,
                               int y,
                               int width,
                               int height)
```
  - getParentSize
```
public boolean getParentSize(Dimension dest)
```
    Description copied from class: WindowSurface
    
    If the Window is a child window, this returns the size of the parent Window.
    
    Specified by:
    
    getParentSize in class WindowSurface
    
    Parameters:
    
    dest - a non-null destination Dimension object.
    
    Returns:
    
    true if the Window is a child window, false if it is not.
  - setFlags
```
public int setFlags(int flagsToSet,
                    int flagsToClear)
```
    Description copied from class: WindowSurface
    
    Set or get the Flags for a Window.
    
    Specified by:
    
    setFlags in class WindowSurface
    
    Parameters:
    
    flagsToSet - Flags to set.
    
    flagsToClear - Flags to clear.
    
    Returns:
    
    the new value of the Flags.
  - getFlagsForSize
```
public int getFlagsForSize(int requestedWidth,
                           int requestedHeight,
                           int requestedSetFlags,
                           int requestedClearFlags)
```
    Description copied from class: WindowSurface
    
    This is used during Window creation. It asks the underlying Window what flags would be apply to a Window if it were created for the requestedWidth and requestedHeight, with the specified Flags requested to be set and cleared.
    
    Specified by:
    
    getFlagsForSize in class WindowSurface
    
    Parameters:
    
    requestedWidth - the desired width of the Window.
    
    requestedHeight - the desired height of the Window.
    
    requestedSetFlags - the Flags to be set.
    
    requestedClearFlags - the Flags to be cleared.
    
    Returns:
    
    the Flags that would apply (e.g. FLAG_IS_DEFAULT_SIZE, FLAG_HAS_TITLE)
  - setIcon
```
public boolean setIcon(DeviceIcon icon)
```
    Description copied from class: WindowSurface
    
    Get the mouse pointer state at this point in time. This includes its position and button states.
    
    Specified by:
    
    setIcon in class WindowSurface
    
    Returns:
    
    true on success, false if the asynchronous state is not available. In this case only the mouse pointer events can be used to track the mouse state.
  - setTaskbarIcon
```
public boolean setTaskbarIcon(DeviceIcon icon)
```
    Specified by:
    
    setTaskbarIcon in class WindowSurface
  - getDroppedData
```
public Object getDroppedData(int dataID)
```
    Specified by:
    
    getDroppedData in class WindowSurface
  - getFont
```
public Font getFont()
```
    Specified by:
    
    getFont in class WindowSurface
  - setFont
```
public boolean setFont(Font font)
```
    Specified by:
    
    setFont in class WindowSurface
  - setGuiFlags
```
public int setGuiFlags(int flagsToset,
                       int flagsToClear)
```
    Description copied from class: WindowSurface
    
    Set or get the GUI Flags for the device.
    
    Specified by:
    
    setGuiFlags in class WindowSurface
    
    flagsToClear - flags to clear.
    
    Returns:
    
    the new value of the GUI flags.
  - getTitle
```
public String getTitle()
```
    Description copied from class: WindowSurface
    
    Get the title text of the window.
    
    Specified by:
    
    getTitle in class WindowSurface
  - setTitle
```
public void setTitle(String title)
```
    Description copied from class: WindowSurface
    
    Set the title text of the window.
    
    Specified by:
    
    setTitle in class WindowSurface
    
    Parameters:
    
    title - the new title for the window.
  - doGetScreenRect
```
public boolean doGetScreenRect(int screenId,
                               Rect dest,
                               boolean desktopOnly)
```
  - captureAppKeys
```
public int captureAppKeys(int options)
```
    Specified by:
    
    captureAppKeys in class WindowSurface
  - takeKeyFocus
```
protected void takeKeyFocus()
```
    Specified by:
    
    takeKeyFocus in class WindowSurface
  - getRawEvent
```
protected boolean getRawEvent(long howLongToWait,
                              RawEvent destination)
                       throws InterruptedException
```
    Specified by:
    
    getRawEvent in class WindowSurface
    
    Throws:
    
    InterruptedException
  - doCaptureMouse
```
protected boolean doCaptureMouse(boolean doGrab)
```
    Specified by:
    
    doCaptureMouse in class WindowSurface
  - postRawEvent
```
public void postRawEvent(RawEvent event)
```
    Description copied from class: WindowSurface
    
    This posts a copy of the data in the RawEvent. After the call you can discard or re-use the RawEvent.
    
    Specified by:
    
    postRawEvent in class WindowSurface
    
    Parameters:
    
    event - the event to post.
  - hasPendingEvents
```
public boolean hasPendingEvents()
```
    Specified by:
    
    hasPendingEvents in class WindowSurface
  - doCreateTaskbarEntry
```
public ITaskbarEntry doCreateTaskbarEntry()
```
    Specified by:
    
    doCreateTaskbarEntry in class WindowSurface
  - drawImage
```
public void drawImage(Image src,
                      int clipX,
                      int clipY,
                      int clipWidth,
                      int clipHeight,
                      int destX,
                      int destY,
                      int width,
                      int height)
```
    Description copied from interface: ISurface
    
    This should always work for any surface and is the minimum functionality expected. The clipXXX parameters specify a clipping area within the surface, no image data will be drawn outside this area. If you do not want a clipping area, then set this to be the same as destX, destY, width, height.
    Note that the image is not scaled. If width and height are smaller than the actual image dimensions, then the image is clipped.
    
    Parameters:
    
    src - The source image.
    
    clipX - The x co-ordinate of the clipping rectangle within the surface.
    
    clipY - The y co-ordinate of the clipping rectangle within the surface.
    
    clipWidth - The width of the clipping rectangle within the surface.
    
    clipHeight - The height of the clipping rectangle within the surface.
    
    destX - The destination x co-ordinate for the image.
    
    destY - The destination y co-ordinate for the image.
    
    width - The number of pixels horizontally to draw from the image.
    
    height - The number of pixels vertically to draw from the image.
  - captureImage
```
public boolean captureImage(Image dest,
                            int x,
                            int y,
                            int width,
                            int height)
```
    Description copied from interface: ISurface
    
    Capture pixel data from the surface to an Image. Only call this if canCapture() returns true.
    
    Returns:
  - moveImage
```
public boolean moveImage(int srcX,
                         int srcY,
                         int srcWidth,
                         int srcHeight,
                         int destX,
                         int destY)
```
    Description copied from interface: ISurface
    
    Move pixel data within the surface. Only call this if canMove() returns true.
    
    Returns:
  - canCapture
```
public boolean canCapture()
```
    Description copied from interface: ISurface
    
    This returns true if it is possible to read pixel data from the surface into an Image.
  - canMove
```
public boolean canMove()
```
    Description copied from interface: ISurface
    
    This returns true if it is possible to move pixel within the surface.
  - specialOperation
```
public boolean specialOperation(int which,
                                Object data)
```
    Specified by:
    
    specialOperation in class WindowSurface
  - getCompatibleImage
```
public Image getCompatibleImage(int width,
                                int height)
                         throws IllegalArgumentException
```
    Description copied from interface: ISurface
    
    Get an Image that is optimized for display on the surface.
    
    Parameters:
    
    width - the width of the image. This must be greater than or equal to 1.
    
    height - the height of the image. This must be greater than or equal to 1.
    
    Returns:
    
    an Image optimized for display on the surface.
    
    Throws:
    
    IllegalArgumentException - if the width or height is less than 1.
  - doGetDPI
```
protected boolean doGetDPI(double[] xyDpi)
```
    Specified by:
    
    doGetDPI in class WindowSurface

Class NativeWindowSurface

Nested Class Summary

Nested classes/interfaces inherited from class eve.fx.gui.WindowSurface

Field Summary

Fields inherited from class eve.fx.gui.WindowSurface

Fields inherited from interface eve.fx.ISurface

Fields inherited from interface eve.fx.gui.WindowConstants

Fields inherited from interface eve.fx.gui.SIPConstants

Constructor Summary

Method Summary

Methods inherited from class eve.fx.gui.WindowSurface

Methods inherited from class java.lang.Object

Field Detail

_window

_frame

_canvas

ROTATION_NONE

ROTATION_90

ROTATION_180

ROTATION_270

waitingEvents

cd

Constructor Detail

NativeWindowSurface

Method Detail

getNativeGraphics

freeNativeGraphics

getGraphics

clearCursorRegions

removeCursorRegion

getJavaSurface

getJavaWindow

getJavaFrame

supportsMultiple

canCopyFrom

setState

requestRepaint

getState

doClose

setVisible

isVisible

getScreenRect

getBounds

setBounds

getClientRect

setClientRect

doGetBounds

doSetBounds

doCreate

getAsyncKeyState

getInfo

setInfo

doGetClientRect

doSetClientRect

getParentSize

setFlags

getFlagsForSize

setIcon

setTaskbarIcon

getDroppedData

getFont

setFont

setGuiFlags

getTitle

setTitle

doGetScreenRect

captureAppKeys

takeKeyFocus

getRawEvent

doCaptureMouse

postRawEvent

hasPendingEvents

doCreateTaskbarEntry

drawImage

captureImage

moveImage

canCapture

canMove

specialOperation

getCompatibleImage