javax.media.nativewindow
Interface NativeWindow

All Superinterfaces:
NativeSurface, SurfaceUpdatedListener
All Known Subinterfaces:
Window
All Known Implementing Classes:
GLWindow

public interface NativeWindow
extends NativeSurface

Extend the NativeSurface interface with windowing information such as window handle and position.

A window toolkit such as the AWT may either implement this interface directly with one of its components, or provide and register an implementation of NativeWindowFactory which can create NativeWindow objects for its components.


Field Summary
 
Fields inherited from interface javax.media.nativewindow.NativeSurface
LOCK_SUCCESS, LOCK_SURFACE_CHANGED, LOCK_SURFACE_NOT_READY, LOCK_SURFACE_UNLOCKED
 
Method Summary
 void destroy()
          destroys the window and releases windowing related resources.
 Point getLocationOnScreen(Point point)
          Returns the current absolute location of this window.
 NativeWindow getParent()
           
 long getWindowHandle()
          Returns the window handle for this NativeWindow.
 int getX()
          Returns the current x position of this window, relative to it's parent.
 int getY()
          Returns the current y position of this window, relative to it's parent.
 
Methods inherited from interface javax.media.nativewindow.NativeSurface
getDisplayHandle, getGraphicsConfiguration, getHeight, getScreenIndex, getSurfaceHandle, getSurfaceLockOwner, getWidth, isSurfaceLocked, isSurfaceLockedByOtherThread, lockSurface, surfaceSwap, unlockSurface
 
Methods inherited from interface javax.media.nativewindow.SurfaceUpdatedListener
surfaceUpdated
 

Method Detail

destroy

void destroy()
destroys the window and releases windowing related resources.


getParent

NativeWindow getParent()
Returns:
The parent NativeWindow, or null if this NativeWindow is top level.

getWindowHandle

long getWindowHandle()
Returns the window handle for this NativeWindow.

The window handle shall reflect the platform one for all window related operations, e.g. open, close, resize.

On X11 this returns an entity of type Window.
On Microsoft Windows this returns an entity of type HWND.


getX

int getX()
Returns the current x position of this window, relative to it's parent.


getY

int getY()
Returns the current y position of this window, relative to it's parent.


getLocationOnScreen

Point getLocationOnScreen(Point point)
Returns the current absolute location of this window.

Parameters:
point - if not null, Point.translate(javax.media.nativewindow.util.Point) the passed Point by this location on the screen and return it.
Returns:
either the passed non null translated point by the screen location of this NativeWindow, or a new instance with the screen location of this NativeWindow.


Copyright 2010 JogAmp Community.