Package net.infonode.docking

Class DockingWindowAdapter

java.lang.Object

net.infonode.docking.DockingWindowAdapter

All Implemented Interfaces:

DockingWindowListener

public class DockingWindowAdapter
extends java.lang.Object
implements DockingWindowListener

Adapter class which implements the DockingWindowListener methods with empty bodies.

Since:

IDW 1.1.0

Constructor Summary

Constructors

Constructor	Description
DockingWindowAdapter()

Method Summary

Modifier and Type	Method	Description
void	viewFocusChanged(View previouslyFocusedView, View focusedView)	Called when the focus moves from one view to another view.
void	windowAdded(DockingWindow addedToWindow, DockingWindow addedWindow)	Called when a window has been added.
void	windowClosed(DockingWindow window)	Called after the window that this listener is added to, or a child window of that window, has been closed.
void	windowClosing(DockingWindow window)	Called before the window that this listener is added to, or a child window of that window, is closed.
void	windowDocked(DockingWindow window)	Called when a view has been docked in the root window.
void	windowDocking(DockingWindow window)	Called before the window that this listener is added to, or a child window of that window, is docked.
void	windowHidden(DockingWindow window)	Called when a window is hidden, for example when it is deselected in a TabWindow.
void	windowMaximized(DockingWindow window)	Called after the window that this listener is added to, or a child window of that window, has been maximized.
void	windowMaximizing(DockingWindow window)	Called before the window that this listener is added to, or a child window of that window, is maximized.
void	windowMinimized(DockingWindow window)	Called after the window that this listener is added to, or a child window of that window, has been minimized.
void	windowMinimizing(DockingWindow window)	Called before the window that this listener is added to, or a child window of that window, is minimized.
void	windowRemoved(DockingWindow removedFromWindow, DockingWindow removedWindow)	Called when a window has been removed.
void	windowRestored(DockingWindow window)	Called after the window that this listener is added to, or a child window of that window, has been restored.
void	windowRestoring(DockingWindow window)	Called before the window that this listener is added to, or a child window of that window, is restored.
void	windowShown(DockingWindow window)	Called when a window is shown, for example when it is selected in a TabWindow.
void	windowUndocked(DockingWindow window)	Called after the window that this listener is added to, or a child window of that window, has been undocked.
void	windowUndocking(DockingWindow window)	Called before the window that this listener is added to, or a child window of that window, is undocked.

Methods inherited from class java.lang.Object

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

Constructor Detail

DockingWindowAdapter

public DockingWindowAdapter()

Method Detail

windowShown

public void windowShown(DockingWindow window)

Description copied from interface: DockingWindowListener

Called when a window is shown, for example when it is selected in a TabWindow.

Specified by:

windowShown in interface DockingWindowListener

Parameters:

window - the window that was shown

windowHidden

public void windowHidden(DockingWindow window)

Description copied from interface: DockingWindowListener

Called when a window is hidden, for example when it is deselected in a TabWindow.

Specified by:

windowHidden in interface DockingWindowListener

Parameters:

window - the window that was hidden

viewFocusChanged

public void viewFocusChanged(View previouslyFocusedView,
                             View focusedView)

Description copied from interface: DockingWindowListener

Called when the focus moves from one view to another view.

Specified by:

viewFocusChanged in interface DockingWindowListener

Parameters:

previouslyFocusedView - the view that had focus before the focus moved, null means no view had focus

focusedView - the view that got focus, null means no view got focus

windowAdded

public void windowAdded(DockingWindow addedToWindow,
                        DockingWindow addedWindow)

Description copied from interface: DockingWindowListener

Called when a window has been added.

Specified by:

windowAdded in interface DockingWindowListener

Parameters:

addedToWindow - the parent window that the window was added to

addedWindow - the window that was added

windowRemoved

public void windowRemoved(DockingWindow removedFromWindow,
                          DockingWindow removedWindow)

Description copied from interface: DockingWindowListener

Called when a window has been removed.

Specified by:

windowRemoved in interface DockingWindowListener

Parameters:

removedFromWindow - the parent window that the window was removed from

removedWindow - the window that was removed

windowClosing

public void windowClosing(DockingWindow window)
                   throws OperationAbortedException

Description copied from interface: DockingWindowListener

Called before the window that this listener is added to, or a child window of that window, is closed.

Note that this method is only called when DockingWindow.closeWithAbort() is called explicitly, not when a window is implicitly closed as a result of another method call. Throwing an OperationAbortedException will cause the close operation to be aborted.

Specified by:

windowClosing in interface DockingWindowListener

Parameters:

window - the window that is closing

Throws:

OperationAbortedException - if this exception is thrown the close operation will be aborted

windowClosed

public void windowClosed(DockingWindow window)

Description copied from interface: DockingWindowListener

Called after the window that this listener is added to, or a child window of that window, has been closed.

Note that this method is only called when DockingWindow.close() or DockingWindow.closeWithAbort() is called explicitly, not when a window is implicitly closed as a result of another method call.

Specified by:

windowClosed in interface DockingWindowListener

Parameters:

window - the window that has been closed

windowUndocking

public void windowUndocking(DockingWindow window)
                     throws OperationAbortedException

Description copied from interface: DockingWindowListener

Called before the window that this listener is added to, or a child window of that window, is undocked.

Note that this method is only called when DockingWindow.undockWithAbort(java.awt.Point) is called explicitly, not when a window is implicitly undocked as a result of another method call. Throwing an OperationAbortedException will cause the undock operation to be aborted.

Specified by:

windowUndocking in interface DockingWindowListener

Parameters:

window - the window that is undocking

Throws:

OperationAbortedException - if this exception is thrown the undock operation will be aborted

windowUndocked

public void windowUndocked(DockingWindow window)

Description copied from interface: DockingWindowListener

Called after the window that this listener is added to, or a child window of that window, has been undocked.

This method is called when a window is undocked using DockingWindow.undock(java.awt.Point), DockingWindow.undockWithAbort(java.awt.Point) or is added to a window that is undocked.

Specified by:

windowUndocked in interface DockingWindowListener

Parameters:

window - the window that has been undocked

windowDocking

public void windowDocking(DockingWindow window)
                   throws OperationAbortedException

Description copied from interface: DockingWindowListener

Called before the window that this listener is added to, or a child window of that window, is docked.

Note: that this method is only called when DockingWindow.dockWithAbort() is called explicitly, not when a window is implicitly docked as a result of another method call. Throwing an OperationAbortedException will cause the dock operation to be aborted.

Specified by:

windowDocking in interface DockingWindowListener

Parameters:

window - the window that is docking

Throws:

OperationAbortedException - if this exception is thrown the dock operation will be aborted i.e. no views in the window will be docked

windowDocked

public void windowDocked(DockingWindow window)

Description copied from interface: DockingWindowListener

Called when a view has been docked in the root window.

Note: If a window containing more than one view was docked then this method will be called for each view after all views have been docked.

Specified by:

windowDocked in interface DockingWindowListener

Parameters:

window - the view that has been docked

windowMinimized

public void windowMinimized(DockingWindow window)

Description copied from interface: DockingWindowListener

Called after the window that this listener is added to, or a child window of that window, has been minimized.

Specified by:

windowMinimized in interface DockingWindowListener

Parameters:

window - the window that has been minimized

windowMaximized

public void windowMaximized(DockingWindow window)

Description copied from interface: DockingWindowListener

Called after the window that this listener is added to, or a child window of that window, has been maximized.

Specified by:

windowMaximized in interface DockingWindowListener

Parameters:

window - the window that has been maximized

windowRestored

public void windowRestored(DockingWindow window)

Description copied from interface: DockingWindowListener

Called after the window that this listener is added to, or a child window of that window, has been restored.

Note that this method is only called when DockingWindow.restore() is called explicitly, not when a window is implicitly restored as a result of another method call.

Specified by:

windowRestored in interface DockingWindowListener

Parameters:

window - the window that has been restored

windowMaximizing

public void windowMaximizing(DockingWindow window)
                      throws OperationAbortedException

Description copied from interface: DockingWindowListener

Called before the window that this listener is added to, or a child window of that window, is maximized.

Note: that this method is only called when DockingWindow.maximizeWithAbort() is called explicitly, not when a window is implicitly docked as a result of another method call. Throwing an OperationAbortedException will cause the maximize operation to be aborted.

Specified by:

windowMaximizing in interface DockingWindowListener

Parameters:

window - the window that is maximizing

Throws:

OperationAbortedException - if this exception is thrown the maximize operation will be aborted

windowMinimizing

public void windowMinimizing(DockingWindow window)
                      throws OperationAbortedException

Description copied from interface: DockingWindowListener

Called before the window that this listener is added to, or a child window of that window, is minimized.

Note: that this method is only called when DockingWindow.minimizeWithAbort() is called explicitly, not when a window is implicitly docked as a result of another method call. Throwing an OperationAbortedException will cause the minimize operation to be aborted.

Specified by:

windowMinimizing in interface DockingWindowListener

Parameters:

window - the window that is minimizing

Throws:

OperationAbortedException - if this exception is thrown the minimize operation will be aborted

windowRestoring

public void windowRestoring(DockingWindow window)
                     throws OperationAbortedException

Description copied from interface: DockingWindowListener

Called before the window that this listener is added to, or a child window of that window, is restored.

Note: that this method is only called when DockingWindow.restoreWithAbort() is called explicitly, not when a window is implicitly restored as a result of another method call. Throwing an OperationAbortedException will cause the restore operation to be aborted.

Specified by:

windowRestoring in interface DockingWindowListener

Parameters:

window - the window that is restoring

Throws:

OperationAbortedException - if this exception is thrown the restore operation will be aborted