com.openfin.desktop.win32

Class ExternalWindowObserver

java.lang.Object

com.openfin.desktop.win32.ExternalWindowObserver

All Implemented Interfaces:

DesktopStateListener

public class ExternalWindowObserver
extends Object
implements DesktopStateListener

Integrates a window outside of the desktop for interaction and control with the API. An integrated window is controlled in the same way as an HTML window running in the desktop. It can be controlled and queried by the API, generate events that are subscribed to by addEventListener, and join/merge groups with other windows for docking. Created by wche on 3/11/15.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ExternalWindowObserver.WINDOWPOS
static class	ExternalWindowObserver.WINDOWPOS2 Structure of WindowPos
static class	ExternalWindowObserver.WINDOWRECT

Field Summary

Fields

Modifier and Type	Field and Description
static int	SIZE_MAXHIDE
static int	SIZE_MAXIMIZED
static int	SIZE_MAXSHOW
static int	SIZE_MINIMIZED
static int	SIZE_RESTORED

Constructor Summary

Constructors

Constructor and Description
ExternalWindowObserver(int port, String parentAppUuid, String name, javafx.stage.Stage stage, AckListener listener)
ExternalWindowObserver(int port, String parentAppUuid, String name, Window window, AckListener listener) Establishes a connection and registers the window identified by hWnd with the Runtime.

Method Summary

Modifier and Type	Method and Description
void	dispose() Ensures this window is deregistered on disposal
void	enterSizeMove() Simulate WM_ENTERSIZEMOVE
void	exitSizeMove() Simulate WM_EXITSIZEMOVE
String	getAppUuid() Get UUID of parent application
DesktopConnection	getDesktopConnection()
String	getName() Get name of this window
void	onClose(String error) DesktopStateListener.onClose
void	onError(String reason) DesktopStateListener.onError
void	onMessage(String message) DesktopStateListener.onMessage
boolean	onMoving(WindowBounds bounds, Point mousePosition) Simulate WM_MOVING event
void	onOutgoingMessage(String message) DesktopStateListener.onOutgoingMessage
void	onReady() DesktopStateListener.onReady
void	setHasFrame(com.sun.jna.platform.win32.WinDef.HWND hwnd, boolean hasFrame) Enable or disable window frame
void	setWindowOptions(WindowOptions windowOptions) Set options for the window
void	start()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SIZE_MAXHIDE

public static final int SIZE_MAXHIDE

See Also:

Constant Field Values

SIZE_MAXIMIZED

public static final int SIZE_MAXIMIZED

See Also:

Constant Field Values

SIZE_MAXSHOW

public static final int SIZE_MAXSHOW

See Also:

Constant Field Values

SIZE_MINIMIZED

public static final int SIZE_MINIMIZED

See Also:

Constant Field Values

SIZE_RESTORED

public static final int SIZE_RESTORED

See Also:

Constant Field Values

Constructor Detail

ExternalWindowObserver

public ExternalWindowObserver(int port,
                              String parentAppUuid,
                              String name,
                              Window window,
                              AckListener listener)
                       throws DesktopException

Establishes a connection and registers the window identified by hWnd with the Runtime.

Parameters:

port - The host that the desktop is running on

parentAppUuid - The UUID of the application to create register this window as a child of

name - The unique name for this window as a child window

window - The HWND of the window to control/observe

listener - AckListener for external registering

Throws:

DesktopException - if registration fails

ExternalWindowObserver

public ExternalWindowObserver(int port,
                              String parentAppUuid,
                              String name,
                              javafx.stage.Stage stage,
                              AckListener listener)
                       throws DesktopException

Throws:

DesktopException

Method Detail

start

public void start()
           throws Exception

Throws:

Exception

getAppUuid

public String getAppUuid()

Get UUID of parent application

Returns:

UUID

getName

public String getName()

Get name of this window

Returns:

name

setWindowOptions

public void setWindowOptions(WindowOptions windowOptions)

Set options for the window

Parameters:

windowOptions - options

dispose

public void dispose()
             throws DesktopException

Ensures this window is deregistered on disposal

Throws:

DesktopException - if errors are caught during cleanup

setHasFrame

public void setHasFrame(com.sun.jna.platform.win32.WinDef.HWND hwnd,
                        boolean hasFrame)

Enable or disable window frame

Parameters:

hwnd - Window handle

hasFrame - hasFrame

onMoving

public boolean onMoving(WindowBounds bounds,
                        Point mousePosition)

Simulate WM_MOVING event

Parameters:

bounds - current window bounds

mousePosition - current mouse position

Returns:

true if the event is consumed by this class. false if the event should be processed by the caller

enterSizeMove

public void enterSizeMove()

Simulate WM_ENTERSIZEMOVE

exitSizeMove

public void exitSizeMove()

Simulate WM_EXITSIZEMOVE

onReady

public void onReady()

DesktopStateListener.onReady

Specified by:

onReady in interface DesktopStateListener

onClose

public void onClose(String error)

DesktopStateListener.onClose

Specified by:

onClose in interface DesktopStateListener

Parameters:

error - Error message. null for normal close

onError

public void onError(String reason)

DesktopStateListener.onError

Specified by:

onError in interface DesktopStateListener

Parameters:

reason - Error message

onMessage

public void onMessage(String message)

DesktopStateListener.onMessage

Specified by:

onMessage in interface DesktopStateListener

Parameters:

message - Message text

onOutgoingMessage

public void onOutgoingMessage(String message)

DesktopStateListener.onOutgoingMessage

Specified by:

onOutgoingMessage in interface DesktopStateListener

Parameters:

message - Message text

getDesktopConnection

public DesktopConnection getDesktopConnection()