com.datagis.com4j

Class GenericNativeWindow<T extends com4j.Com4jObject,E extends ComEventListener>

java.lang.Object

com.datagis.com4j.ComObject<T>

com.datagis.com4j.ComEventObject<T>

com.datagis.com4j.GenericNativeWindow<T,E>

Type Parameters:

T -

E -

All Implemented Interfaces:

Disposable, NativeWindow

Direct Known Subclasses:

Map3DWindow

public abstract class GenericNativeWindow<T extends com4j.Com4jObject,E extends ComEventListener>
extends ComEventObject<T>
implements NativeWindow

A GenericNativeWindow is a top-level native window with a title and a border. This class implements the NativeWindow interface.

The size of the native window includes any area designated for the border. The dimensions of the border area may be obtained using the getInsets method, however, since these dimensions are platform-dependent, a valid insets value cannot be obtained until the native window is displayed by calling setVisible. Since the border area is included in the overall size of the frame, the border effectively obscures a portion of the frame, constraining the area available for rendering and/or displaying subcomponents to the rectangle which has an upper-left corner location of (insets.left, insets.top), and has a size of width - (insets.left + insets.right) by height - (insets.top + insets.bottom).

A native window may have its native decorations (i.e. Frame and Titlebar) turned off with setUndecorated. In contrast to Java AWT frames, this can not only be done while the frame is not displayed, but regardless or whether the window is displayer or not.

In a virtual device multi-screen environment in which the desktop area could span multiple physical screen devices, the bounds of all configurations are relative to the virtual-coordinate system. The origin of the virtual-coordinate system is at the upper left-hand corner of the primary physical screen. Depending on the location of the primary screen in the virtual device, negative coordinates are possible, as shown in the following figure.

In such an environment, when calling setLocation, you must pass a virtual coordinate to this method. Similarly, calling getLocationOnScreen on a NativeWindow returns virtual device coordinates.

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 native 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

A native COM window consists of two distinct parts, which are provided through two distinct interfaces in COM and two classes in Java. One class is this abstract GenericNativeWindow class, which implements the NativeWindow interface, and the other class is the actual descendant of this class. The latter provides the methods that deal with the capabilities and functions implemented in the native window, the first deals with the window itself. Since the functional class derives from this class, it actually provides all the methods available for the native window.

This class fully implements the NativeWindow interface, which does'nt make use of the generic parameters T and E. Using the NativeWindow interface wherever possible, is highly recommended.

Since:

TEJ1.0

Author:

Carsten Klein

See Also:

NativeWindow

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	GenericNativeWindow.EventInvocationCache This HashMap derived class provides a fast mapping mechanism between the name of an event method invoked on the native event interface and the corresponding method to be invoked on a registered NativeWindowListener together with its event id.
protected class	GenericNativeWindow.EventInvocationItem Represents an item stored in the event invocation cache EventInvocationCache.
protected class	GenericNativeWindow.NativeWindowEventDispatcher The class NativeWindowEventDispatcher implements a custom layer to handle native window events as defined in NativeWindowListener.

Field Summary

Fields

Modifier and Type	Field and Description
protected NativeSystemColor	DEFAULT_BACKGROUND_COLOR The default background color of a native window represented as a NativeSystemColor enum constant.

Fields inherited from class com.datagis.com4j.ComEventObject

events

Fields inherited from class com.datagis.com4j.ComObject

base, hashCode, toString

Fields inherited from interface com.datagis.com4j.NativeWindow

ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, NORMAL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GenericNativeWindow(T base, Class<E> eventInterface) Constructs a new GenericNativeWindow object by using the COM object's proxy class specified.

Method Summary

Modifier and Type	Method and Description
void	addNativeWindowListener(NativeWindowListener listener) Adds the specified native window listener to receive window events from the underlying native window.
void	dispose() Releases the reference to the underlying native window represented by this GenericNativeWindow object.
Color	getBackground() Gets the background color of this native window.
Rectangle	getBounds() Gets the bounds of this native window in the form of a Rectangle object.
Rectangle	getBounds(Rectangle rv) Stores the bounds of this native window into "return value" rv and return rv.
int	getExtendedState() Gets the state of this native window.
int	getHeight() Returns the current height of this native window.
Insets	getInsets() Determines the insets of this native window, which indicate the size of the window's border.
Point	getLocation() Gets the location of this native window in the form of a point specifying the native window's top-left corner.
Point	getLocation(Point rv) Stores the x,y origin of this native window into "return value" rv and return rv.
Point	getLocationOnScreen() Gets the location of this native window in the form of a point specifying the native window's top-left corner in the screen's coordinate space.
String	getName() Returns the native name of the window.
NativeWindowListener[]	getNativeWindowListeners() Returns an array of all the native window listeners registered on this GenericNativeWindow instance.
Container	getParent() Gets the parent of this component.
Dimension	getSize() Returns the size of this native window in the form of a Dimension object.
Dimension	getSize(Dimension rv) Stores the width/height of this native window into "return value" rv and return rv.
int	getState() Gets the state of this native window (obsolete).
String	getTitle() Gets the title of this native window.
int	getWidth() Returns the current width of this native window.
int	getX() Returns the current x coordinate of the native window's origin.
int	getY() Returns the current y coordinate of the native window's origin.
boolean	isActive() Returns whether this native window is active.
boolean	isAlwaysOnTop() Returns whether this native window is an always-on-top window.
boolean	isEnabled() Determines whether this native window is enabled.
boolean	isFocused() Returns whether this native window is focused.
boolean	isNativeWindowListener(NativeWindowListener listener) Indicates whether the specified native window listener listener is registered on this GenericNativeWindow instance.
boolean	isResizable() Indicates whether this native window is resizable by the user.
boolean	isShowing() Determines whether this component is native window on screen.
boolean	isUndecorated() Indicates whether this native window is undecorated.
boolean	isVisible() Indicates whether this native window is visible.
void	removeNativeWindowListener(NativeWindowListener listener) Removes the specified native window listener, so that it no longer receives window events from the underlying native window.
void	requestFocus() Requests that this native window become the focused window.
void	setAlwaysOnTop(boolean alwaysOnTop) Changes the always-on-top window state of this native window.
void	setBackground(Color c) Sets the background color of this native window.
void	setBackground(NativeSystemColor c) Sets the background color of this native window.
void	setBounds(int x, int y, int width, int height) Moves and resizes this native window.
void	setBounds(Point p, Dimension d) Moves and resizes this native window.
void	setBounds(Rectangle r) Moves and resizes this native window to conform to the new bounding rectangle r.
void	setEnabled(boolean enabled) Enables or disables this native window, depending on the value of the parameter enabled.
void	setExtendedState(int state) Sets the state of this frame.
void	setLocation(int x, int y) Moves this native window to a new location.
void	setLocation(Point p) Moves this native window to a new location.
void	setResizable(boolean resizable) Sets whether this native window is resizable by the user.
void	setSize(Dimension d) Resizes this native window so that it has width d.width and height d.height.
void	setSize(int width, int height) Resizes this native window so that it has width width and height height.
void	setState(int state) Sets the state of this native window (obsolete).
void	setTitle(String title) Sets the title for this native window to the specified string.
void	setUndecorated(boolean undecorated) Disables or enables decorations for this native window.
void	setVisible(boolean visible) Shows or hides this native window depending on the value of parameter visible.
void	toBack() If this native window is visible, sends this native window to the back and may cause it to lose focus or activation if it is the focused or active window.
void	toFront() If this native window is visible, brings this native window to the front and may make it the focused window.

Methods inherited from class com.datagis.com4j.ComEventObject

addComEventListener, comEventListeners, getComEventListeners, isComEventListener, removeComEventListener

Methods inherited from class com.datagis.com4j.ComObject

clone, equals, hashCode, isDisposed, isInstanceOf, referenceEquals, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.datagis.com4j.NativeWindow

isDisposed

Field Detail

DEFAULT_BACKGROUND_COLOR

protected final NativeSystemColor DEFAULT_BACKGROUND_COLOR

The default background color of a native window represented as a NativeSystemColor enum constant.

Constructor Detail

GenericNativeWindow

protected GenericNativeWindow(T base,
                              Class<E> eventInterface)

Constructs a new GenericNativeWindow object by using the COM object's proxy class specified.

Parameters:

base - the native COM object's proxy class

eventInterface - the native COM interface, that implements the window event methods for this native window

Method Detail

getName

public String getName()

Returns the native name of the window.

Specified by:

getName in interface NativeWindow

Returns:

the native name of the window

getTitle

public String getTitle()

Gets the title of this native window. The title is displayed in the window's border.

Specified by:

getTitle in interface NativeWindow

Returns:

the title of this native window, or an empty string ("") if this window doesn't have a title.

See Also:

setTitle(java.lang.String)

setTitle

public void setTitle(String title)

Sets the title for this native window to the specified string.

Specified by:

setTitle in interface NativeWindow

Parameters:

title - the title to be displayed in the window's border. A null value is treated as an empty string, "".

See Also:

getTitle()

getX

public int getX()

Returns the current x coordinate of the native window's origin. This method is preferable to writing window.getBounds().x, or window.getLocation().x because it doesn't cause any heap allocations.

Specified by:

getX in interface NativeWindow

Returns:

the current x coordinate of the native window's origin

getY

public int getY()

Returns the current y coordinate of the native window's origin. This method is preferable to writing window.getBounds().y, or window.getLocation().y because it doesn't cause any heap allocations.

Specified by:

getY in interface NativeWindow

Returns:

the current y coordinate of the native window's origin

getWidth

public int getWidth()

Returns the current width of this native window. This method is preferable to writing window.getBounds().width, or window.getSize().width because it doesn't cause any heap allocations.

Specified by:

getWidth in interface NativeWindow

Returns:

the current width of this native window

getHeight

public int getHeight()

Returns the current height of this native window. This method is preferable to writing window.getBounds().height, or window.getSize().height because it doesn't cause any heap allocations.

Specified by:

getHeight in interface NativeWindow

Returns:

the current height of this native window

getParent

public Container getParent()

Gets the parent of this component. Since native window is a top-level component, this method will always return null.

Specified by:

getParent in interface NativeWindow

Returns:

the parent container of this component

isShowing

public boolean isShowing()

Determines whether this component is native window on screen. This means that the component must be visible.

Specified by:

isShowing in interface NativeWindow

Returns:

true if this native window is showing, false otherwise

See Also:

setVisible(boolean)

isVisible

public boolean isVisible()

Indicates whether this native window is visible.

Specified by:

isVisible in interface NativeWindow

Returns:

true if this native window is visible, false otherwise

See Also:

setVisible(boolean)

setVisible

public void setVisible(boolean visible)

Shows or hides this native window depending on the value of parameter visible.

Specified by:

setVisible in interface NativeWindow

Parameters:

visible - if true, shows this native window; otherwise, hides this native window

See Also:

isVisible()

getBounds

public Rectangle getBounds()

Gets the bounds of this native window in the form of a Rectangle object. The bounds specify this native window's width, height, and location relative to its parent.

Specified by:

getBounds in interface NativeWindow

Returns:

a rectangle indicating this native window's bounds

See Also:

setBounds(int, int, int, int), getLocation(java.awt.Point), getSize()

getBounds

public Rectangle getBounds(Rectangle rv)

Stores the bounds of this native window into "return value" rv and return rv. If rv is null a new Rectangle is allocated. This version of getBounds is useful if the caller wants to avoid allocating a new Rectangle object on the heap.

Specified by:

getBounds in interface NativeWindow

Parameters:

rv - the return value, modified to the native window's bounds

Returns:

rv the bounds of the native window

setBounds

public void setBounds(int x,
                      int y,
                      int width,
                      int height)

Moves and resizes this native window. The new location of the top-left corner is specified by x and y, and the new size is specified by width and height.

Specified by:

setBounds in interface NativeWindow

Parameters:

x - the new x-coordinate of this native window

y - the new y-coordinate of this native window

width - the new width of this native window

height - the new height of this native window

See Also:

getBounds(), setLocation(int, int), setLocation(Point), setSize(int, int), setSize(Dimension)

setBounds

public void setBounds(Rectangle r)

Moves and resizes this native window to conform to the new bounding rectangle r. This native window's new position is specified by r.x and r.y, and its new size is specified by r.width and r.height

Specified by:

setBounds in interface NativeWindow

Parameters:

r - the new bounding rectangle for this component

See Also:

getBounds(), setLocation(int, int), setLocation(Point), setSize(int, int), setSize(Dimension)

setBounds

public void setBounds(Point p,
                      Dimension d)

Moves and resizes this native window. The new location of the top-left corner is specified by p.x and p.y, and the new size is specified by d.width and d.height.

Specified by:

setBounds in interface NativeWindow

Parameters:

p - the point defining the top-left corner of the new location

d - the dimension specifying the new size of this component

See Also:

getBounds(), setLocation(int, int), setLocation(Point), setSize(int, int), setSize(Dimension)

getLocation

public Point getLocation(Point rv)

Stores the x,y origin of this native window into "return value" rv and return rv. If rv is null a new Point is allocated. This version of getLocation is useful if the caller wants to avoid allocating a new Point object on the heap.

Specified by:

getLocation in interface NativeWindow

Parameters:

rv - the return value, modified to the native window's location

Returns:

the location of the native window

getLocation

public Point getLocation()

Gets the location of this native window in the form of a point specifying the native window's top-left corner. The location will be relative to the parent's coordinate space.

Specified by:

getLocation in interface NativeWindow

Returns:

an instance of Point representing the top-left corner of the native window's bounds in the coordinate space of the native window's parent

See Also:

setLocation(int, int), getLocationOnScreen()

getLocationOnScreen

public Point getLocationOnScreen()

Gets the location of this native window in the form of a point specifying the native window's top-left corner in the screen's coordinate space.

Specified by:

getLocationOnScreen in interface NativeWindow

Returns:

an instance of Point representing the top-left corner of the native window's bounds in the coordinate space of the screen

See Also:

setLocation(int, int), getLocation(java.awt.Point)

setLocation

public void setLocation(int x,
                        int y)

Moves this native window to a new location. The top-left corner of the new location is specified by the x and y parameters in the coordinate space of this native window's parent.

Specified by:

setLocation in interface NativeWindow

Parameters:

x - the x-coordinate of the new location's top-left corner in the parent's coordinate space

y - the y-coordinate of the new location's top-left corner in the parent's coordinate space

See Also:

getLocation(java.awt.Point), setBounds(int, int, int, int)

setLocation

public void setLocation(Point p)

Moves this native window to a new location. The top-left corner of the new location is specified by point p. Point p is given in the parent's coordinate space.

Specified by:

setLocation in interface NativeWindow

Parameters:

p - the point defining the top-left corner of the new location, given in the coordinate space of this native window's parent

See Also:

getLocation(java.awt.Point), setBounds(int, int, int, int)

getSize

public Dimension getSize()

Returns the size of this native window in the form of a Dimension object. The height field of the Dimension object contains this native window's height, and the width field of the Dimension object contains this native window's width.

Specified by:

getSize in interface NativeWindow

Returns:

a Dimension object that indicates the size of this native window

See Also:

setSize(int, int)

getSize

public Dimension getSize(Dimension rv)

Stores the width/height of this native window into "return value" rv and return rv. If rv is null a new Dimension object is allocated. This version of getSize is useful if the caller wants to avoid allocating a new Dimension object on the heap.

Specified by:

getSize in interface NativeWindow

Parameters:

rv - the return value, modified to the native window's size

Returns:

the size of the native window

setSize

public void setSize(int width,
                    int height)

Resizes this native window so that it has width width and height height.

Specified by:

setSize in interface NativeWindow

Parameters:

width - the new width of this native window in pixels

height - the new height of this native window in pixels

See Also:

getSize(), setBounds(int, int, int, int)

setSize

public void setSize(Dimension d)

Resizes this native window so that it has width d.width and height d.height.

Specified by:

setSize in interface NativeWindow

Parameters:

d - the dimension specifying the new size of this native window

See Also:

setSize(int, int), setBounds(int, int, int, int)

isEnabled

public boolean isEnabled()

Determines whether this native window is enabled. An enabled native window can respond to user input and generate events. Native windows are enabled initially by default. A native window may be enabled or disabled by calling its setEnabled method.

Specified by:

isEnabled in interface NativeWindow

Returns:

true if the native window is enabled; false otherwise

See Also:

setEnabled(boolean)

setEnabled

public void setEnabled(boolean enabled)

Enables or disables this native window, depending on the value of the parameter enabled. An enabled native window can respond to user input and generate events. Native windows are enabled initially by default.

Specified by:

setEnabled in interface NativeWindow

Parameters:

enabled - if true, this native window is enabled; otherwise this native window is disabled

See Also:

isEnabled()

getBackground

public Color getBackground()

Gets the background color of this native window.

Specified by:

getBackground in interface NativeWindow

Returns:

this native window's background color

See Also:

setBackground(java.awt.Color)

setBackground

public void setBackground(Color c)

Sets the background color of this native window.

Specified by:

setBackground in interface NativeWindow

Parameters:

c - the color to become this native window's color; if this parameter is null, then this native window will get the operation system's default window background color

See Also:

getBackground()

setBackground

public void setBackground(NativeSystemColor c)

Sets the background color of this native window.

Specified by:

setBackground in interface NativeWindow

Parameters:

c - the color to become this native window's color; if this parameter is null, then this native window will get the operation system's default window background color

See Also:

getBackground()

getExtendedState

public int getExtendedState()

Gets the state of this 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.

Specified by:

getExtendedState in interface NativeWindow

Returns:

a bitwise mask of the native window state constants

See Also:

setExtendedState(int)

setExtendedState

public void setExtendedState(int state)

Sets the state of this frame. 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.

Note that if the state is not supported on a given platform, nothing will happen. The application may determine if a specific state is available via the java.awt.Toolkit#isFrameStateSupported(int state) method.

Specified by:

setExtendedState in interface NativeWindow

Parameters:

state - a bitwise mask of frame state constants

See Also:

getExtendedState(), Toolkit.isFrameStateSupported(int)

getState

public int getState()

Gets the state of this native window (obsolete).

For compatibility with old programs this method still returns NativeWindow.NORMAL and NativeWindow.ICONIFIED but it only reports the iconic state of the native window, other aspects of native window state are not reported by this method.

Specified by:

getState in interface NativeWindow

Returns:

NativeWindow.NORMAL or NativeWindow.ICONIFIED.

See Also:

setState(int), getExtendedState()

setState

public void setState(int state)

Sets the state of this native window (obsolete).

For compatibility with old programs this method still accepts NativeWindow.NORMAL and NativeWindow.ICONIFIED but it only changes the iconic state of the native window, other aspects of native window state are not affected by this method.

Specified by:

setState in interface NativeWindow

Parameters:

state - either NativeWindow.NORMAL or NativeWindow.ICONIFIED.

See Also:

getState(), setExtendedState(int)

isAlwaysOnTop

public boolean isAlwaysOnTop()

Returns whether this native window is an always-on-top window.

Specified by:

isAlwaysOnTop in interface NativeWindow

Returns:

true, if this native window is in always-on-top state, false otherwise

See Also:

setAlwaysOnTop(boolean)

setAlwaysOnTop

public void setAlwaysOnTop(boolean alwaysOnTop)

Changes the always-on-top window state of this native window. An always-on-top window is a window that stays above all other windows except maybe other always-on-top windows. If there are several always-on-top windows the order in which they stay relative to each other is not specified and is platform dependent.

If some other window already is always-on-top then the relative order between these windows is unspecified (depends on platform). No window can be brought to be over always-on-top window except maybe another always-on-top window.

This method makes this native window always-on-top if alwaysOnTop is true. If the window is visible, this includes bringing window toFront, then "sticking" it to the top-most position. If the window is not visible it does nothing other than setting the always-on-top property. If later the window is shown, it will be always-on-top. If the window is already always-on-top, this call does nothing.

If alwaysOnTop is false this method changes the state from always-on-top to normal. The window remains top-most but its z-order can be changed in the normal way as for any other window. Does nothing if this window is not always-on-top. Has no effect on relative z-order of windows if there are no other always-on-top windows.

Specified by:

setAlwaysOnTop in interface NativeWindow

Parameters:

alwaysOnTop - new value of always-on-top state of the native window

See Also:

isAlwaysOnTop(), toFront(), toBack()

toBack

public void toBack()

If this native window is visible, sends this native window to the back and may cause it to lose focus or activation if it is the focused or active window.

Places this native window at the bottom of the stacking order and shows it behind any other windows in this VM. No action will take place if this window is not visible.

Specified by:

toBack in interface NativeWindow

See Also:

toFront()

toFront

public void toFront()

If this native window is visible, brings this native window to the front and may make it the focused window.

Places this native window at the top of the stacking order and shows it in front of any other windows in this VM. No action will take place if this window is not visible.

Specified by:

toFront in interface NativeWindow

See Also:

toBack()

requestFocus

public void requestFocus()

Requests that this native window become the focused window. The window must be visible for the request to be granted. Every effort will be made to honor the request; however, in some cases it may be impossible to do so. Developers must never assume that this native window is the focus owner until it receives a FOCUS_GAINED event.

Specified by:

requestFocus in interface NativeWindow

isActive

public boolean isActive()

Returns whether this native window is active. 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 top-level native window that is the owner of the focused window.

Specified by:

isActive in interface NativeWindow

Returns:

true, if this native window is currently active, false otherwise

See Also:

isFocused()

isFocused

public boolean isFocused()

Returns whether this native window is focused. If there exists a focus owner, the focused window is the window that is, or contains, that focus owner. If there is no focus owner, then no window is focused.

The focused native window is also the active native window.

Specified by:

isFocused in interface NativeWindow

Returns:

true, if this native window is currently the focused window, false otherwise

See Also:

isActive()

isUndecorated

public boolean isUndecorated()

Indicates whether this native window is undecorated. By default, all native windows are initially decorated.

Specified by:

isUndecorated in interface NativeWindow

Returns:

true if native window is undecorated; false otherwise.

See Also:

setUndecorated(boolean)

setUndecorated

public void setUndecorated(boolean undecorated)

Disables or enables decorations for this native window.

Specified by:

setUndecorated in interface NativeWindow

Parameters:

undecorated - true if no frame decorations are to be enabled; false if frame decorations are to be enabled.

See Also:

isUndecorated()

isResizable

public boolean isResizable()

Indicates whether this native window is resizable by the user. By default, all native windows are initially resizable.

Specified by:

isResizable in interface NativeWindow

Returns:

true if the user can resize this native window; false otherwise.

See Also:

setResizable(boolean)

setResizable

public void setResizable(boolean resizable)

Sets whether this native window is resizable by the user.

Specified by:

setResizable in interface NativeWindow

Parameters:

resizable - true if this native window is resizable; false otherwise.

See Also:

isResizable()

getInsets

public Insets getInsets()

Determines the insets of this native window, which indicate the size of the window's border.

A NativeWindow object, for example, has a top inset that corresponds to the height of the window's title bar.

Specified by:

getInsets in interface NativeWindow

Returns:

the insets of this native window.

See Also:

Insets

addNativeWindowListener

public void addNativeWindowListener(NativeWindowListener listener)

Adds the specified native window listener to receive window events from the underlying native window. If listener is null, no exception is thrown and no action is performed.

Specified by:

addNativeWindowListener in interface NativeWindow

Parameters:

listener - the native window listener to be added

See Also:

removeNativeWindowListener(NativeWindowListener), getNativeWindowListeners(), NativeWindowListener, NativeWindowAdapter

removeNativeWindowListener

public void removeNativeWindowListener(NativeWindowListener listener)

Removes the specified native window listener, so that it no longer receives window events from the underlying native window. This method performs no action, nor does it throw an exception, if either the listener specified by the argument is null or was not previously added to this GenericNativeWindowinstance.

Specified by:

removeNativeWindowListener in interface NativeWindow

Parameters:

listener - the native window listener to be removed

See Also:

addNativeWindowListener(NativeWindowListener), getNativeWindowListeners(), NativeWindowListener, NativeWindowAdapter

getNativeWindowListeners

public NativeWindowListener[] getNativeWindowListeners()

Returns an array of all the native window listeners registered on this GenericNativeWindow instance.

Specified by:

getNativeWindowListeners in interface NativeWindow

Returns:

all of this native window's NativeWindowListeners or an empty array if no native window listeners are currently registered

See Also:

addNativeWindowListener(NativeWindowListener), removeNativeWindowListener(NativeWindowListener)

isNativeWindowListener

public boolean isNativeWindowListener(NativeWindowListener listener)

Indicates whether the specified native window listener listener is registered on this GenericNativeWindow instance.

Specified by:

isNativeWindowListener in interface NativeWindow

Parameters:

listener - the native window listener to test

Returns:

true if the specified native window listener listener is registered with this GenericNativeWindow instance; false otherwise.

See Also:

addNativeWindowListener(NativeWindowListener), removeNativeWindowListener(NativeWindowListener), getNativeWindowListeners()

dispose

public void dispose()

Releases the reference to the underlying native window represented by this GenericNativeWindow object. Although, dispose can be called on a COM object multiple times, regardless whether the object is already disposed, method isDisposed may be used to determine, whether an object is disposed or not.

Since Java objects tend to live longer in memory until they are garbage collected, and applications have generally no control over when this happens, calling the dispose method at any time enables applications to dispose the underlying native windows deterministically.

After having disposed a native window, one has no longer access to the window's methods nor will any events be delivered to any event listener that still may be registered. Accessing methods of a disposed native window will throw an IllegalStateException.

Specified by:

dispose in interface Disposable

Specified by:

dispose in interface NativeWindow

Overrides:

dispose in class ComEventObject<T extends com4j.Com4jObject>

See Also:

ComObject.isDisposed()