|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Window
Specifying the public Window functionality for the
using a Window and for shadowing one like GLWindow
.
Nested Class Summary | |
---|---|
static interface |
Window.FocusRunnable
|
static interface |
Window.ReparentAction
Defining ids for the reparenting strategy |
Field Summary | |
---|---|
static boolean |
DEBUG_IMPLEMENTATION
|
static boolean |
DEBUG_KEY_EVENT
|
static boolean |
DEBUG_MOUSE_EVENT
|
static boolean |
DEBUG_WINDOW_EVENT
|
static long |
TIMEOUT_NATIVEWINDOW
A 1s timeout while waiting for a native action response, ie setVisible(boolean) . |
Fields inherited from interface javax.media.nativewindow.NativeSurface |
---|
LOCK_SUCCESS, LOCK_SURFACE_CHANGED, LOCK_SURFACE_NOT_READY, LOCK_SURFACE_UNLOCKED |
Fields inherited from interface javax.media.nativewindow.WindowClosingProtocol |
---|
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE |
Method Summary | |
---|---|
void |
addChild(NativeWindow win)
|
void |
addKeyListener(int index,
KeyListener l)
Inserts the given KeyListener at the
specified position in the list. |
void |
addKeyListener(KeyListener l)
Appends the given KeyListener to the end of
the list. |
void |
addMouseListener(int index,
MouseListener l)
Inserts the given MouseListener at the
specified position in the list. |
void |
addMouseListener(MouseListener l)
Appends the given MouseListener to the end of
the list. |
void |
addSurfaceUpdatedListener(int index,
SurfaceUpdatedListener l)
Inserts the given com.jogamp.newt.event.SurfaceUpdatedListener at the
specified position in the list. |
void |
addSurfaceUpdatedListener(SurfaceUpdatedListener l)
Appends the given com.jogamp.newt.event.SurfaceUpdatedListener to the end of
the list. |
void |
addWindowListener(int index,
WindowListener l)
Inserts the given WindowListener at the
specified position in the list. |
void |
addWindowListener(WindowListener l)
Appends the given WindowListener to the end of
the list. |
void |
destroy()
Destroy the Window and it's children, incl. |
void |
enqueueEvent(boolean wait,
NEWTEvent event)
|
CapabilitiesImmutable |
getChosenCapabilities()
Gets an immutable set of chosen capabilities. |
int |
getHeight()
Returns the height of the client area of this window |
Insets |
getInsets()
Returns the insets for this native window (the difference between the size of the toplevel window with the decorations and the client area). |
KeyListener |
getKeyListener(int index)
|
KeyListener[] |
getKeyListeners()
|
MouseListener |
getMouseListener(int index)
|
MouseListener[] |
getMouseListeners()
|
CapabilitiesImmutable |
getRequestedCapabilities()
Gets an immutable set of requested capabilities. |
Screen |
getScreen()
|
SurfaceUpdatedListener |
getSurfaceUpdatedListener(int index)
|
SurfaceUpdatedListener[] |
getSurfaceUpdatedListeners()
|
String |
getTitle()
|
int |
getWidth()
Returns the width of the client area of this window |
WindowListener |
getWindowListener(int index)
|
WindowListener[] |
getWindowListeners()
|
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. |
boolean |
hasFocus()
|
void |
invalidate()
Destroys the Window via destroy() and clears all Object references,
eg. |
boolean |
isFullscreen()
|
boolean |
isNativeValid()
|
boolean |
isUndecorated()
|
boolean |
isValid()
|
boolean |
isVisible()
|
void |
removeAllSurfaceUpdatedListener()
|
void |
removeChild(NativeWindow win)
|
void |
removeKeyListener(KeyListener l)
|
void |
removeMouseListener(MouseListener l)
|
void |
removeSurfaceUpdatedListener(SurfaceUpdatedListener l)
|
void |
removeWindowListener(WindowListener l)
|
int |
reparentWindow(NativeWindow newParent)
Change this window's parent window. |
int |
reparentWindow(NativeWindow newParent,
boolean forceDestroyCreate)
|
void |
requestFocus()
|
void |
runOnEDTIfAvail(boolean wait,
Runnable task)
|
void |
sendWindowEvent(int eventType)
|
CapabilitiesChooser |
setCapabilitiesChooser(CapabilitiesChooser chooser)
Set the CapabilitiesChooser to help determine the native visual type. |
void |
setFocusAction(Window.FocusRunnable focusAction)
May set to a Window.FocusRunnable , Window.FocusRunnable.run() before Newt requests the native focus. |
boolean |
setFullscreen(boolean fullscreen)
|
void |
setPosition(int x,
int y)
Sets the location of the top left corner of the window, including decorations (so the client area will be placed at x+insets.left,y+insets.top .This call is ignored if in fullscreen mode. |
void |
setSize(int width,
int height)
Sets the size of the client area of the window, excluding decorations Total size of the window will be width+insets.left+insets.right, height+insets.top+insets.bottom |
void |
setTitle(String title)
|
void |
setUndecorated(boolean value)
|
void |
setVisible(boolean visible)
setVisible makes the window and children visible if visible is true,
otherwise the window and children becomes invisible. |
void |
windowRepaint(int x,
int y,
int width,
int height)
|
Methods inherited from interface javax.media.nativewindow.NativeWindow |
---|
getLocationOnScreen, getParent, getWindowHandle |
Methods inherited from interface javax.media.nativewindow.NativeSurface |
---|
getDisplayHandle, getGraphicsConfiguration, getScreenIndex, getSurfaceHandle, getSurfaceLockOwner, isSurfaceLocked, isSurfaceLockedByOtherThread, lockSurface, surfaceSwap, unlockSurface |
Methods inherited from interface javax.media.nativewindow.SurfaceUpdatedListener |
---|
surfaceUpdated |
Methods inherited from interface javax.media.nativewindow.WindowClosingProtocol |
---|
getDefaultCloseOperation, setDefaultCloseOperation |
Field Detail |
---|
static final boolean DEBUG_MOUSE_EVENT
static final boolean DEBUG_KEY_EVENT
static final boolean DEBUG_WINDOW_EVENT
static final boolean DEBUG_IMPLEMENTATION
static final long TIMEOUT_NATIVEWINDOW
setVisible(boolean)
.
Method Detail |
---|
boolean isValid()
destroy(true)
call.#destroy(boolean)
,
setVisible(boolean)
boolean isNativeValid()
setVisible(boolean)
,
#destroy(boolean)
Screen getScreen()
CapabilitiesChooser setCapabilitiesChooser(CapabilitiesChooser chooser)
chooser
- the new CapabilitiesChooser
CapabilitiesImmutable getRequestedCapabilities()
CapabilitiesImmutable getChosenCapabilities()
void destroy()
setVisible(true)
.
This method invokes Screen.removeReference()
after it's own destruction,
which will issue Screen.destroy()
if the reference count becomes 0.
This destruction sequence shall end up in Display.destroy()
, if all reference counts become 0.
destroy
in interface NativeWindow
invalidate()
,
setVisible(boolean)
void invalidate()
destroy()
and clears all Object references,
eg. all states, size, position, parent handles, list of child Windows and reference to it's Screen.
void setVisible(boolean visible)
setVisible
makes the window and children visible if visible
is true,
otherwise the window and children becomes invisible.
The setVisible(true)
is responsible to actual create the native window.
Zero size semantics are respected, see setSize(int,int)
:
if ( 0 == windowHandle && visible ) { this.visible = visible; if( 0In case this window is a child window and a parent
NativeWindow
is being used,
the parent'sNativeWindow
handle is retrieved viaNativeWindow.getWindowHandle()
.
If this action fails, ie if the parentNativeWindow
is not valid yet,
no native window is created yet andsetVisible(true)
shall be repeated when it is.
boolean isVisible()
void addChild(NativeWindow win)
void removeChild(NativeWindow win)
void setSize(int width, int height)
width+insets.left+insets.right, height+insets.top+insets.bottom
Zero size semantics are respected, see setVisible(boolean)
:
if ( 0 != windowHandle && 0>=width*height && visible ) { setVisible(false); } else if ( 0 == windowHandle && 0This call is ignored if in fullscreen mode.
- Parameters:
width
- of the client area of the windowheight
- of the client area of the window
int getWidth()
getWidth
in interface NativeSurface
int getHeight()
getHeight
in interface NativeSurface
int reparentWindow(NativeWindow newParent)
In case the old parent is not null and a Window,
this window is removed from it's list of children.
In case the new parent is not null and a Window,
this window is added to it's list of children.
newParent
- The new parent NativeWindow. If null, this Window becomes a top level window.
int reparentWindow(NativeWindow newParent, boolean forceDestroyCreate)
boolean setFullscreen(boolean fullscreen)
boolean isFullscreen()
void setPosition(int x, int y)
x+insets.left,y+insets.top
.
x
- coord of the top left cornery
- coord of the top left cornerint getX()
NativeWindow
getX
in interface NativeWindow
int getY()
NativeWindow
getY
in interface NativeWindow
Insets getInsets()
void setUndecorated(boolean value)
boolean isUndecorated()
void setTitle(String title)
String getTitle()
void setFocusAction(Window.FocusRunnable focusAction)
Window.FocusRunnable
, Window.FocusRunnable.run()
before Newt requests the native focus.
This allows notifying a covered window toolkit like AWT that the focus is requested,
hence focus traversal can be made transparent.
void requestFocus()
boolean hasFocus()
void windowRepaint(int x, int y, int width, int height)
void enqueueEvent(boolean wait, NEWTEvent event)
void runOnEDTIfAvail(boolean wait, Runnable task)
void addSurfaceUpdatedListener(SurfaceUpdatedListener l)
com.jogamp.newt.event.SurfaceUpdatedListener
to the end of
the list.
void addSurfaceUpdatedListener(int index, SurfaceUpdatedListener l) throws IndexOutOfBoundsException
com.jogamp.newt.event.SurfaceUpdatedListener
at the
specified position in the list.
index
- Position where the listener will be inserted.
Should be within (0 <= index && index <= size()).
An index value of -1 is interpreted as the end of the list, size().l
- The listener object to be inserted
IndexOutOfBoundsException
- If the index is not within (0 <= index && index <= size()), or -1void removeAllSurfaceUpdatedListener()
void removeSurfaceUpdatedListener(SurfaceUpdatedListener l)
SurfaceUpdatedListener getSurfaceUpdatedListener(int index)
SurfaceUpdatedListener[] getSurfaceUpdatedListeners()
void sendWindowEvent(int eventType)
void addWindowListener(WindowListener l)
WindowListener
to the end of
the list.
void addWindowListener(int index, WindowListener l) throws IndexOutOfBoundsException
WindowListener
at the
specified position in the list.
index
- Position where the listener will be inserted.
Should be within (0 <= index && index <= size()).
An index value of -1 is interpreted as the end of the list, size().l
- The listener object to be inserted
IndexOutOfBoundsException
- If the index is not within (0 <= index && index <= size()), or -1void removeWindowListener(WindowListener l)
WindowListener getWindowListener(int index)
WindowListener[] getWindowListeners()
void addKeyListener(KeyListener l)
KeyListener
to the end of
the list.
void addKeyListener(int index, KeyListener l)
KeyListener
at the
specified position in the list.
index
- Position where the listener will be inserted.
Should be within (0 <= index && index <= size()).
An index value of -1 is interpreted as the end of the list, size().l
- The listener object to be inserted
IndexOutOfBoundsException
- If the index is not within (0 <= index && index <= size()), or -1void removeKeyListener(KeyListener l)
KeyListener getKeyListener(int index)
KeyListener[] getKeyListeners()
void addMouseListener(MouseListener l)
MouseListener
to the end of
the list.
void addMouseListener(int index, MouseListener l)
MouseListener
at the
specified position in the list.
index
- Position where the listener will be inserted.
Should be within (0 <= index && index <= size()).
An index value of -1 is interpreted as the end of the list, size().l
- The listener object to be inserted
IndexOutOfBoundsException
- If the index is not within (0 <= index && index <= size()), or -1void removeMouseListener(MouseListener l)
MouseListener getMouseListener(int index)
MouseListener[] getMouseListeners()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |