net.sf.jguiraffe.gui.platform.swing.builder.window

Class WindowAdapter

java.lang.Object

net.sf.jguiraffe.gui.platform.swing.builder.window.WindowAdapter

All Implemented Interfaces:

Window, WindowWrapper, SwingWindow

public abstract class WindowAdapter
extends Object
implements SwingWindow, WindowWrapper

Abstract base class for Swing Window implementations that are based on java.awt.Window.

This class wraps an instance of java.awt.Window and implements parts of the methods required by the Window interface in a way that they access this window's properties. Concrete sub classes will have to implement the properties that are not supported by the java.awt.Window class.

Version:

$Id: WindowAdapter.java 205 2012-01-29 18:29:57Z oheger $

Author:

Oliver Heger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WindowAdapter(Window wrappedWindow, boolean center) Creates a new instance of WindowAdapter and initializes it with the wrapped window.

Method Summary

Modifier and Type	Method and Description
void	addMouseListener(FormMouseListener l) Adds a mouse listener to this window.
void	addWindowListener(WindowListener l) Registers the specified window listener at this window.
boolean	close(boolean force) Closes this window.
Component	getComponent() Returns the underlying component.
int	getHeight() Returns the window's height.
Window	getParentWindow() Returns the window's parent.
int	getWidth() Returns the window's width.
Window	getWindow() Returns the wrapped window object.
WindowClosingStrategy	getWindowClosingStrategy() Returns the window's closing strategy.
Object	getWindowController() Returns the window's controller.
net.sf.jguiraffe.gui.platform.swing.builder.window.WindowHelper	getWindowHelper() Returns the window helper object used by this window.
Collection<WindowListener>	getWindowListeners() Returns a collection with all registered window listeners.
Object	getWrappedWindow() Returns the wrapped (AWT) window.
int	getXPos() Returns the window's x pos.
int	getYPos() Returns the window's y pos.
boolean	isVisible() Checks if this window is visible.
void	open() Opens this window.
void	packWindow() Packs the window.
void	registerAutoCloseListener() Registers a window listener that closes the underlying window if the user hits the close icon in the title bar.
void	removeMouseListener(FormMouseListener l) Removes a mouse listener from this window.
void	removeWindowListener(WindowListener l) Removes the specified window listener from this window.
void	setBounds(int x, int y, int w, int h) Sets all coordinates for this window.
void	setParentWindow(Window parent) Sets the window's parent.
void	setVisible(boolean f) Sets the visible flag for this window.
void	setWindowClosingStrategy(WindowClosingStrategy windowClosingStrategy) Sets the window's closing strategy.
void	setWindowController(Object ctrl) Allows to set the window's controller.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.jguiraffe.gui.platform.swing.builder.window.SwingWindow

dispose, getRootPane

Methods inherited from interface net.sf.jguiraffe.gui.builder.window.Window

getRootContainer, getTitle, setTitle

Constructor Detail

WindowAdapter

protected WindowAdapter(Window wrappedWindow,
                        boolean center)

Creates a new instance of WindowAdapter and initializes it with the wrapped window.

Parameters:

wrappedWindow - the (AWT) window to wrap

center - a flag whether the window should be centered

Method Detail

getWindowHelper

public net.sf.jguiraffe.gui.platform.swing.builder.window.WindowHelper getWindowHelper()

Returns the window helper object used by this window.

Specified by:

getWindowHelper in interface SwingWindow

Returns:

the window helper

getWindow

public Window getWindow()

Returns the wrapped window object.

Returns:

the wrapped (AWT) window

isVisible

public boolean isVisible()

Checks if this window is visible.

Specified by:

isVisible in interface Window

Returns:

the visible flag

setVisible

public void setVisible(boolean f)

Sets the visible flag for this window.

Specified by:

setVisible in interface Window

Parameters:

f - the flag's value

open

public void open()

Opens this window. This implementation ensures that this action is performed on the event dispatching thread, but synchronously.

Specified by:

open in interface Window

close

public boolean close(boolean force)

Closes this window. This implementation delegates to the WindowHelper.

Specified by:

close in interface Window

Parameters:

force - the force flag

Returns:

a flag whether the window could be closed

getXPos

public int getXPos()

Returns the window's x pos.

Specified by:

getXPos in interface Window

Returns:

the x pos

getYPos

public int getYPos()

Returns the window's y pos.

Specified by:

getYPos in interface Window

Returns:

the y pos

getWidth

public int getWidth()

Returns the window's width.

Specified by:

getWidth in interface Window

Returns:

the width

getHeight

public int getHeight()

Returns the window's height.

Specified by:

getHeight in interface Window

Returns:

the height

setBounds

public void setBounds(int x,
                      int y,
                      int w,
                      int h)

Sets all coordinates for this window.

Specified by:

setBounds in interface Window

Parameters:

x - the x pos

y - the y pos

w - the width

h - the height

getParentWindow

public Window getParentWindow()

Returns the window's parent.

Specified by:

getParentWindow in interface Window

Returns:

the parent window

setParentWindow

public void setParentWindow(Window parent)

Sets the window's parent.

Specified by:

setParentWindow in interface SwingWindow

Parameters:

parent - the parent window

addWindowListener

public void addWindowListener(WindowListener l)

Registers the specified window listener at this window. This is only done if this listener has not been registered before.

Specified by:

addWindowListener in interface Window

Parameters:

l - the listener to register

removeWindowListener

public void removeWindowListener(WindowListener l)

Removes the specified window listener from this window. If this listener is not registered at this window, this operation has no effect.

Specified by:

removeWindowListener in interface Window

Parameters:

l - the listener to remove

getWindowListeners

public Collection<WindowListener> getWindowListeners()

Returns a collection with all registered window listeners.

Specified by:

getWindowListeners in interface SwingWindow

Returns:

a collection with the registered window listeners

getWindowClosingStrategy

public WindowClosingStrategy getWindowClosingStrategy()

Returns the window's closing strategy. This implementation will never return null. If no closing strategy has been set, a default instance will be returned.

Specified by:

getWindowClosingStrategy in interface Window

Returns:

the window closing strategy

setWindowClosingStrategy

public void setWindowClosingStrategy(WindowClosingStrategy windowClosingStrategy)

Sets the window's closing strategy.

Specified by:

setWindowClosingStrategy in interface Window

Parameters:

windowClosingStrategy - the new closing strategy

getWindowController

public Object getWindowController()

Returns the window's controller.

Specified by:

getWindowController in interface Window

Returns:

the window's controller

setWindowController

public void setWindowController(Object ctrl)

Allows to set the window's controller.

Specified by:

setWindowController in interface SwingWindow

Parameters:

ctrl - the new controller

getWrappedWindow

public Object getWrappedWindow()

Returns the wrapped (AWT) window.

Specified by:

getWrappedWindow in interface WindowWrapper

Returns:

the wrapped window

getComponent

public Component getComponent()

Returns the underlying component.

Specified by:

getComponent in interface SwingWindow

Returns:

the component

packWindow

public void packWindow()

Packs the window. This implementation delegates to the pack() method of java.awt.Window.

Specified by:

packWindow in interface SwingWindow

addMouseListener

public void addMouseListener(FormMouseListener l)

Adds a mouse listener to this window. This implementation delegates to the WindowHelper.

Specified by:

addMouseListener in interface Window

Parameters:

l - the listener to be added

removeMouseListener

public void removeMouseListener(FormMouseListener l)

Removes a mouse listener from this window. This implementation delegates to the WindowHelper.

Specified by:

removeMouseListener in interface Window

Parameters:

l - the listener to be removed

registerAutoCloseListener

public void registerAutoCloseListener()

Registers a window listener that closes the underlying window if the user hits the close icon in the title bar. This implementation registers a listener that reacts on the window closing event. If this event is received, the window helper is asked to close this window.

Specified by:

registerAutoCloseListener in interface SwingWindow