NativeWindowEvent (TerraExplorer Java Library 2.0)

java.lang.Object
- java.util.EventObject
- - com.datagis.com4j.NativeWindowEvent

All Implemented Interfaces:

Serializable
```
public class NativeWindowEvent
extends EventObject
```
A low-level event that indicates that a native window has changed its status. This low-level event is generated by a native window object when it is opened, closed, activated, deactivated, iconified, or deiconified, or when focus is transfered into or out of the native window.
The event is passed to every NativeWindowListener or NativeWindowAdapter object which registered to receive such events using the window's addNativeWindowListener method. Hence, NativeWindowAdapter objects implement the NativeWindowListener interface. Each such listener object gets this NativeWindowEvent when the event occurs.
Native windows are capable of generating the following types of NativeWindowEvents:
- WINDOW_OPENED
- WINDOW_CLOSING:
  If the program doesn't explicitly hide or dispose the window while processing this event, the window close operation is canceled.
- WINDOW_CLOSED
- WINDOW_ICONIFIED
- WINDOW_DEICONIFIED
- WINDOW_ACTIVATED
- WINDOW_DEACTIVATED
- WINDOW_GAINED_FOCUS
- WINDOW_LOST_FOCUS
- WINDOW_STATE_CHANGED
Since a native window somehow combines the features, which are provided though the distinct Java objects
- java.awt.Component,
- java.awt.Container,
- java.awt.Window,
- java.awt.Frame,
it also may generate four additional events, which in Java are generated by java.awt.Component. The numeric values of these constants are these defined in java.awt.ComponentEvent.
- WINDOW_MOVED = ComponentEvent.COMPONENT_MOVED
- WINDOW_RESIZED = ComponentEvent.COMPONENT_RESIZED
- WINDOW_SHOWN = ComponentEvent.COMPONENT_SHOWN
- WINDOW_HIDDEN = ComponentEvent.COMPONENT_HIDDEN
Since:

TEJ1.0

Author:

Carsten Klein

See Also:

NativeWindowListener, NativeWindowAdapter, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`WINDOW_ACTIVATED` The window-activated event type.
`static int`	`WINDOW_CLOSED` The window closed event.
`static int`	`WINDOW_CLOSING` The "window is closing" event.
`static int`	`WINDOW_DEACTIVATED` The window-deactivated event type.
`static int`	`WINDOW_DEICONIFIED` The window deiconified event type.
`static int`	`WINDOW_FIRST` The first number in the range of ids used for window events.
`static int`	`WINDOW_GAINED_FOCUS` The window-gained-focus event type.
`static int`	`WINDOW_HIDDEN` This event indicates that the window was made invisible.
`static int`	`WINDOW_ICONIFIED` The window iconified event.
`static int`	`WINDOW_LAST` The last number in the range of ids used for window events.
`static int`	`WINDOW_LOST_FOCUS` The window-lost-focus event type.
`static int`	`WINDOW_MOVED` This event indicates that the window's position changed.
`static int`	`WINDOW_OPENED` The window opened event.
`static int`	`WINDOW_RESIZED` This event indicates that the window's size changed.
`static int`	`WINDOW_SHOWN` This event indicates that the window was made visible.
`static int`	`WINDOW_STATE_CHANGED` The window-state-changed event type.

Fields inherited from class java.util.EventObject
source

Constructor Summary

Constructors
Constructor and Description
`NativeWindowEvent(NativeWindow source, int id)` Constructs a `NativeWindowEvent` object.
`NativeWindowEvent(NativeWindow source, int id, int oldState, int newState)` Constructs a `NativeWindowEvent` object with the specified previous and new window states.
`NativeWindowEvent(NativeWindow source, int id, NativeWindow opposite)` Constructs a `NativeWindowEvent` object with the specified previous and new window states.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`consume()` Consumes this event, if this event can be consumed.
`int`	`getID()` Returns the event type.
`int`	`getNewState()` For `WINDOW_STATE_CHANGED` events returns the new state of the native window.
`int`	`getOldState()` For `WINDOW_STATE_CHANGED` events returns the previous state of the native window.
`NativeWindow`	`getOppositeWindow()` Returns the other native window involved in this focus or activation change.
`Object`	`getSource()` Returns the object on which the event initially occurred.
`NativeWindow`	`getWindow()` Returns the originator of the event.
`boolean`	`isConsumed()` Returns whether this event has been consumed.
`String`	`paramString()` Returns a parameter string identifying this event.
`String`	`toString()` Returns a String representation of this object.

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

- Field Detail
  - WINDOW_FIRST
```
public static final int WINDOW_FIRST
```
    The first number in the range of ids used for window events.
    
    See Also:
    
    Constant Field Values
  - WINDOW_OPENED
```
public static final int WINDOW_OPENED
```
    The window opened event. This event is delivered only the first time a window is made visible.
    
    See Also:
    
    Constant Field Values
  - WINDOW_CLOSING
```
public static final int WINDOW_CLOSING
```
    The "window is closing" event. This event is delivered when the user attempts to close the window from the window's system menu. If the program does not explicitly hide or dispose the window while processing this event, the window close operation will be cancelled.
    
    See Also:
    
    Constant Field Values
  - WINDOW_CLOSED
```
public static final int WINDOW_CLOSED
```
    The window closed event. This event is delivered after the window has been closed as the result of a call to dispose.
    
    See Also:
    
    Constant Field Values
  - WINDOW_ICONIFIED
```
public static final int WINDOW_ICONIFIED
```
    The window iconified event. This event is delivered when the window has been changed from a normal to a minimized state. For many platforms, a minimized window is displayed as the icon specified in the window's iconImage property.
    
    See Also:
    
    Frame.setIconImage(java.awt.Image), Constant Field Values
  - WINDOW_DEICONIFIED
```
public static final int WINDOW_DEICONIFIED
```
    The window deiconified event type. This event is delivered when the window has been changed from a minimized to a normal state.
    
    See Also:
    
    Constant Field Values
  - WINDOW_ACTIVATED
```
public static final int WINDOW_ACTIVATED
```
    The window-activated event type. This event is delivered when the window becomes the active window. Only a Frame or a Dialog can be the active window. The native windowing system may denote the active window or its children with special decorations, such as a highlighted title bar. The active window is always either the focused window, or the first Frame or Dialog that is an owner of the focused window.
    
    See Also:
    
    Constant Field Values
  - WINDOW_DEACTIVATED
```
public static final int WINDOW_DEACTIVATED
```
    The window-deactivated event type. This event is delivered when the window is no longer the active window. Only a Frame or a Dialog can be the active window. The native windowing system may denote the active window or its children with special decorations, such as a highlighted title bar. The active window is always either the focused window, or the first Frame or Dialog that is an owner of the focused window.
    
    See Also:
    
    Constant Field Values
  - WINDOW_GAINED_FOCUS
```
public static final int WINDOW_GAINED_FOCUS
```
    The window-gained-focus event type. This event is delivered when the window becomes the focused window, which means that the window, or one of its subcomponents, will receive keyboard events.
    
    See Also:
    
    Constant Field Values
  - WINDOW_LOST_FOCUS
```
public static final int WINDOW_LOST_FOCUS
```
    The window-lost-focus event type. This event is delivered when a window is no longer the focused window, which means keyboard events will no longer be delivered to the window or any of its subcomponents.
    
    See Also:
    
    Constant Field Values
  - WINDOW_STATE_CHANGED
```
public static final int WINDOW_STATE_CHANGED
```
    The window-state-changed event type. This event is delivered when a window's state is changed by virtue of it being iconified, maximized etc.
    
    See Also:
    
    Constant Field Values
  - WINDOW_LAST
```
public static final int WINDOW_LAST
```
    The last number in the range of ids used for window events.
    
    See Also:
    
    Constant Field Values
  - WINDOW_MOVED
```
public static final int WINDOW_MOVED
```
    This event indicates that the window's position changed.
    
    See Also:
    
    ComponentEvent.COMPONENT_MOVED, Constant Field Values
  - WINDOW_RESIZED
```
public static final int WINDOW_RESIZED
```
    This event indicates that the window's size changed.
    
    See Also:
    
    ComponentEvent.COMPONENT_RESIZED, Constant Field Values
  - WINDOW_SHOWN
```
public static final int WINDOW_SHOWN
```
    This event indicates that the window was made visible.
    
    See Also:
    
    ComponentEvent.COMPONENT_SHOWN, Constant Field Values
  - WINDOW_HIDDEN
```
public static final int WINDOW_HIDDEN
```
    This event indicates that the window was made invisible.
    
    See Also:
    
    ComponentEvent.COMPONENT_HIDDEN, Constant Field Values
- Constructor Detail
  - NativeWindowEvent
```
public NativeWindowEvent(NativeWindow source,
                         int id)
```
    Constructs a NativeWindowEvent object.
    Note that passing in an invalid id results in unspecified behavior. This method throws an IllegalArgumentException if source is null.
    
    Parameters:
    
    source - the NativeWindow object that originated the event
    
    id - an integer indicating the type of event
    
    Throws:
    
    IllegalArgumentException - if source is null
  - NativeWindowEvent
```
public NativeWindowEvent(NativeWindow source,
                         int id,
                         int oldState,
                         int newState)
```
    Constructs a NativeWindowEvent object with the specified previous and new window states.
    Note that passing in an invalid id results in unspecified behavior. This method throws an IllegalArgumentException if source is null.
    
    Parameters:
    
    source - the Window object that originated the event
    
    id - WINDOW_STATE_CHANGED event type. It is expected that this constructor will not be used for other NativeWindowEvent types, because the previous and new window states are meaningless for other event types.
    
    oldState - an integer representing the previous window state
    
    newState - an integer representing the new window state
    
    Throws:
    
    IllegalArgumentException - if source is null
  - NativeWindowEvent
```
public NativeWindowEvent(NativeWindow source,
                         int id,
                         NativeWindow opposite)
```
    Constructs a NativeWindowEvent object with the specified previous and new window states.
    Note that passing in an invalid id results in unspecified behavior. This method throws an IllegalArgumentException if source is null.
    
    Parameters:
    
    source - the Window object that originated the event
    
    id - WINDOW_STATE_CHANGED event type. It is expected that this constructor will not be used for other NativeWindowEvent types, because the previous and new window states are meaningless for other event types.
    
    opposite - an integer representing the previous window state
    
    Throws:
    
    IllegalArgumentException - if source is null
- Method Detail
  - getWindow
```
public NativeWindow getWindow()
```
    Returns the originator of the event.
    
    Returns:
    
    the native window object that originated the event
  - getOppositeWindow
```
public NativeWindow getOppositeWindow()
```
    Returns the other native window involved in this focus or activation change. For a WINDOW_ACTIVATED or WINDOW_GAINED_FOCUS event, this is the native window that lost activation or focus. For a WINDOW_DEACTIVATED or WINDOW_LOST_FOCUS event, this is the native window that gained activation or focus. For any other type of NativeWindowEvent, or if the focus or activation change occurs with a native application, with a non-native Java window int this or a different VM or context, or with no other native window, null is returned.
    
    Returns:
    
    the other native window involved in the focus or activation change, or null
  - getOldState
```
public int getOldState()
```
    For WINDOW_STATE_CHANGED events returns the previous state of the native window. The state is represented as a bitwise mask.
    - NORMAL
      Indicates that no state bits are set.
    - ICONIFIED
    - MAXIMIZED_HORIZ
    - MAXIMIZED_VERT
    - MAXIMIZED_BOTH
      Concatenates MAXIMIZED_HORIZ and MAXIMIZED_VERT.
    Returns:
    
    a bitwise mask of the previous native window state
    
    See Also:
    
    NativeWindow.getExtendedState()
  - getNewState
```
public int getNewState()
```
    For WINDOW_STATE_CHANGED events returns the new state of the native window. The state is represented as a bitwise mask.
    - NORMAL
      Indicates that no state bits are set.
    - ICONIFIED
    - MAXIMIZED_HORIZ
    - MAXIMIZED_VERT
    - MAXIMIZED_BOTH
      Concatenates MAXIMIZED_HORIZ and MAXIMIZED_VERT.
    Returns:
    
    a bitwise mask of the new native window state
    
    See Also:
    
    NativeWindow.getExtendedState()
  - paramString
```
public String paramString()
```
    Returns a parameter string identifying this event. This method is useful for event-logging and for debugging.
    
    Returns:
    
    a string identifying the event and its attributes
  - consume
```
public void consume()
```
    Consumes this event, if this event can be consumed. Only low-level, system events can be consumed
  - getID
```
public int getID()
```
    Returns the event type.
    
    Returns:
    
    the type of this event
  - isConsumed
```
public boolean isConsumed()
```
    Returns whether this event has been consumed.
    
    Returns:
    
    true if this event has been consumed; false otherwise.
  - toString
```
public String toString()
```
    Returns a String representation of this object.
    
    Overrides:
    
    toString in class EventObject
    
    Returns:
    
    a String representation of this object
  - getSource
```
public Object getSource()
```
    Returns the object on which the event initially occurred.
    
    Overrides:
    
    getSource in class EventObject
    
    Returns:
    
    the object on which the event initially occurred

Class NativeWindowEvent

Field Summary

Fields inherited from class java.util.EventObject

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WINDOW_FIRST

WINDOW_OPENED

WINDOW_CLOSING

WINDOW_CLOSED

WINDOW_ICONIFIED

WINDOW_DEICONIFIED

WINDOW_ACTIVATED

WINDOW_DEACTIVATED

WINDOW_GAINED_FOCUS

WINDOW_LOST_FOCUS

WINDOW_STATE_CHANGED

WINDOW_LAST

WINDOW_MOVED

WINDOW_RESIZED

WINDOW_SHOWN

WINDOW_HIDDEN

Constructor Detail

NativeWindowEvent

NativeWindowEvent

NativeWindowEvent

Method Detail

getWindow

getOppositeWindow

getOldState

getNewState

paramString

consume

getID

isConsumed

toString

getSource