Interface DockingWindowListener
-
- All Known Implementing Classes:
DockingWindowAdapter
public interface DockingWindowListener
A listener for
DockingWindow
events. All events are propagated upwards in the window tree, so a listener will receive events for the window that it was added to and all descendants of that window.Note: New methods might be added to this interface in the future. To ensure future compatibility inherit from
DockingWindowAdapter
instead of directly implementing this interface.- Since:
- IDW 1.1.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods 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.
-
-
-
Method Detail
-
windowAdded
void windowAdded(DockingWindow addedToWindow, DockingWindow addedWindow)
Called when a window has been added.- Parameters:
addedToWindow
- the parent window that the window was added toaddedWindow
- the window that was added- Since:
- IDW 1.3.0
-
windowRemoved
void windowRemoved(DockingWindow removedFromWindow, DockingWindow removedWindow)
Called when a window has been removed.- Parameters:
removedFromWindow
- the parent window that the window was removed fromremovedWindow
- the window that was removed- Since:
- IDW 1.3.0
-
windowShown
void windowShown(DockingWindow window)
Called when a window is shown, for example when it is selected in a TabWindow.- Parameters:
window
- the window that was shown- Since:
- IDW 1.3.0
-
windowHidden
void windowHidden(DockingWindow window)
Called when a window is hidden, for example when it is deselected in a TabWindow.- Parameters:
window
- the window that was hidden- Since:
- IDW 1.3.0
-
viewFocusChanged
void viewFocusChanged(View previouslyFocusedView, View focusedView)
Called when the focus moves from one view to another view.- Parameters:
previouslyFocusedView
- the view that had focus before the focus moved, null means no view had focusfocusedView
- the view that got focus, null means no view got focus- Since:
- IDW 1.3.0
-
windowClosing
void windowClosing(DockingWindow window) throws OperationAbortedException
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 anOperationAbortedException
will cause the close operation to be aborted.- Parameters:
window
- the window that is closing- Throws:
OperationAbortedException
- if this exception is thrown the close operation will be aborted
-
windowClosed
void windowClosed(DockingWindow window)
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()
orDockingWindow.closeWithAbort()
is called explicitly, not when a window is implicitly closed as a result of another method call.- Parameters:
window
- the window that has been closed
-
windowUndocking
void windowUndocking(DockingWindow window) throws OperationAbortedException
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 anOperationAbortedException
will cause the undock operation to be aborted.- Parameters:
window
- the window that is undocking- Throws:
OperationAbortedException
- if this exception is thrown the undock operation will be aborted- Since:
- IDW 1.4.0
-
windowUndocked
void windowUndocked(DockingWindow window)
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.- Parameters:
window
- the window that has been undocked- Since:
- IDW 1.4.0
-
windowDocking
void windowDocking(DockingWindow window) throws OperationAbortedException
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 anOperationAbortedException
will cause the dock operation to be aborted.- 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- Since:
- IDW 1.4.0
-
windowDocked
void windowDocked(DockingWindow window)
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.
- Parameters:
window
- the view that has been docked- Since:
- IDW 1.4.0
-
windowMinimizing
void windowMinimizing(DockingWindow window) throws OperationAbortedException
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 anOperationAbortedException
will cause the minimize operation to be aborted.- Parameters:
window
- the window that is minimizing- Throws:
OperationAbortedException
- if this exception is thrown the minimize operation will be aborted- Since:
- IDW 1.4.0
-
windowMinimized
void windowMinimized(DockingWindow window)
Called after the window that this listener is added to, or a child window of that window, has been minimized.- Parameters:
window
- the window that has been minimized- Since:
- IDW 1.4.0
-
windowMaximizing
void windowMaximizing(DockingWindow window) throws OperationAbortedException
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 anOperationAbortedException
will cause the maximize operation to be aborted.- Parameters:
window
- the window that is maximizing- Throws:
OperationAbortedException
- if this exception is thrown the maximize operation will be aborted- Since:
- IDW 1.4.0
-
windowMaximized
void windowMaximized(DockingWindow window)
Called after the window that this listener is added to, or a child window of that window, has been maximized.- Parameters:
window
- the window that has been maximized- Since:
- IDW 1.4.0
-
windowRestoring
void windowRestoring(DockingWindow window) throws OperationAbortedException
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 anOperationAbortedException
will cause the restore operation to be aborted.- Parameters:
window
- the window that is restoring- Throws:
OperationAbortedException
- if this exception is thrown the restore operation will be aborted- Since:
- IDW 1.4.0
-
windowRestored
void windowRestored(DockingWindow window)
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.- Parameters:
window
- the window that has been restored- Since:
- IDW 1.4.0
-
-