net.infonode.docking
public abstract class DockingWindow extends BasePanel
Warning: the non-public methods in this class can be changed in non-compatible ways in future versions.
Version: $Revision: 1.120 $
Constructor Summary | |
---|---|
protected | DockingWindow(WindowItem windowItem) |
Method Summary | |
---|---|
protected DropAction | acceptChildDrop(Point p, DockingWindow window) |
protected DropAction | acceptInteriorDrop(Point p, DockingWindow window) |
protected boolean | acceptsSplitWith(DockingWindow window) |
protected DropAction | acceptSplitDrop(Point p, DockingWindow window, int splitDistance) |
void | addListener(DockingWindowListener listener)
Adds a listener which will reveive events for this window and all child windows.
|
void | addTabMouseButtonListener(MouseButtonListener listenerDocking) Adds a listener that receives mouse button events for window tabs. |
protected DockingWindow | addWindow(DockingWindow window) |
protected void | addWindowItem(DockingWindow w, int index) |
protected void | afterWindowRemoved(DockingWindow window) |
protected void | beforeDrop(DockingWindow target) |
protected static void | beginOptimize(DockingWindow window) |
protected static void | beginUpdateModel() |
protected boolean | childInsideTab() |
protected void | childRemoved(DockingWindow child) |
protected void | cleanUpModel() |
protected void | clearChildrenFocus(DockingWindow child, View view) |
protected void | clearFocus(View view) |
void | close() Removes this window from it's window parent. |
void | closeWithAbort()
Same as close, but the windowClosing method of
the window listeners will be called before closing the window, giving them the possibility to abort the close
operation.
|
protected abstract PropertyMap | createPropertyObject() |
protected DropAction | createTabWindow(DockingWindow window) |
protected void | detach() |
protected DropAction | doAcceptDrop(Point p, DockingWindow window) |
void | dock() Docks the window to the RootWindow to the location it had before it was undocked. If the window can't be docked to the exact same location, a good approximation is performed. |
void | dockWithAbort()
Same as dock, but the windowDocking method of
the window listeners will be called before docking the window, giving them the possibility to abort the dock
operation.
|
protected abstract void | doRemoveWindow(DockingWindow window) |
protected abstract void | doReplace(DockingWindow oldWindow, DockingWindow newWindow) |
protected static void | endOptimize() |
protected static void | endUpdateModel() |
protected void | fireTitleChanged() |
protected void | fireViewFocusChanged(View previouslyFocusedView, View focusedView) |
protected void | fireWindowHidden(DockingWindow window) |
protected void | fireWindowShown(DockingWindow window) |
protected DockingWindow[] | getAncestors() |
protected DockingWindow | getBestFittedWindow(DockingWindow parentWindow) |
protected int | getChildEdgeDepth(DockingWindow window, Direction dir) |
abstract DockingWindow | getChildWindow(int index)
Returns the child window with index index.
|
abstract int | getChildWindowCount()
Returns the number of child windows.
|
int | getChildWindowIndex(DockingWindow window)
Returns the index of a child windows.
|
protected DockingWindow | getContentWindow(DockingWindow parent) |
protected int | getEdgeDepth(Direction dir) |
abstract Icon | getIcon()
Returns the icon for this window.
|
DockingWindow | getLastFocusedChildWindow()
Returns the child window that last contained focus.
|
protected DockingWindow | getLocationWindow() |
protected DockingWindow | getOptimizedWindow()
Returns the result after removing unnecessary tab windows which contains only one tab.
|
WindowPopupMenuFactory | getPopupMenuFactory()
Returns the popup menu factory for this window. |
protected DockingWindow | getPreferredFocusChild() |
Direction | getPreferredMinimizeDirection() Gets the preferred minimize direction of this window. |
protected abstract PropertyMap | getPropertyObject() |
RootWindow | getRootWindow()
Returns the RootWindow which contains this window, null if there is none.
|
String | getTitle()
Returns the title of this window.
|
protected boolean | getUpdateModel() |
protected WindowItem | getWindowItem() |
DockingWindow | getWindowParent()
Returns the window parent of this window.
|
DockingWindowProperties | getWindowProperties()
Returns the properties for this window.
|
protected boolean | hasParent(DockingWindow w) |
protected void | init() |
protected boolean | insideTab() |
protected void | internalClose() |
protected DockingWindow | internalReplaceChildWindow(DockingWindow oldWindow, DockingWindow newWindow) |
protected boolean | isChildShowingInRootWindow(DockingWindow child) |
boolean | isClosable()
Returns true if this window can be closed by the user.
|
boolean | isDockable()
Returns true if this window can be docked to the root window from a floating window.
|
boolean | isMaximizable()
Returns true if this window can be maximized by the user.
|
boolean | isMaximized()
Returns true if this window has a root window and is maximized in that root window or in a floating window.
|
boolean | isMinimizable()
Returns true if this window can be minimized by the user.
|
boolean | isMinimized()
Returns true if this window is minimized, ie located in a WindowBar.
|
boolean | isRestorable()
Returns true if this window can be restored by the user.
|
protected boolean | isShowingInRootWindow() |
boolean | isUndockable()
Returns true if this window can be undocked to a floating window.
|
boolean | isUndocked() |
void | makeVisible()
Makes this window visible. |
void | maximize()
Maximizes this window in its root window or in its floating window. |
void | maximizeWithAbort()
Same as maximize, but the windowMaximized method of
the window listeners will be called before maximizing the window, giving them the possibility to abort the maximize
operation.
|
void | minimize()
Minimizes this window. |
void | minimize(Direction direction)
Minimizes this window to a WindowBarlocated in direction. |
void | minimizeWithAbort()
Same as minimize, but the windowMinimizing method of
the window listeners will be called before minimizing the window, giving them the possibility to abort the minimize
operation.
|
void | minimizeWithAbort(Direction direction)
Same as minimize, but the windowMinimizing method of
the window listeners will be called before minimizing the window, giving them the possibility to abort the minimize
operation.
|
protected boolean | needsTitleWindow() |
protected void | notifyListeners(WindowAncestors ancestors) |
protected DockingWindow | oldRead(ObjectInputStream in, ReadContext context) |
protected static void | optimizeAfter(DockingWindow window, Runnable runnable) |
protected void | optimizeWindowLayout() |
protected void | readLocations(ObjectInputStream in, RootWindow rootWindow, int version) |
protected void | removeChildWindow(DockingWindow window) |
void | removeListener(DockingWindowListener listener)
Removes a previously added listener.
|
void | removeTabMouseButtonListener(MouseButtonListener listenerDocking)
Removes a mouse button listener that has been previously added using the
addTabMouseButtonListener.
|
protected void | removeWindow(DockingWindow window) |
void | replaceChildWindow(DockingWindow oldWindow, DockingWindow newWindow)
Replaces a child window with another window.
|
void | restore()
Restores this window to the location before it was minimized, maximized or closed.
|
void | restoreFocus()
Requests that the last focused child window becomes visible and that focus is restored to the last focused
component in that window. |
void | restoreWithAbort()
Same as restore, but the windowRestoring method of
the window listeners will be called before restoring the window, giving them the possibility to abort the restore
operation.
|
protected void | rootChanged(RootWindow oldRoot, RootWindow newRoot) |
protected void | setFocused(boolean focused) |
protected void | setLastMinimizedDirection(Direction direction) |
void | setPopupMenuFactory(WindowPopupMenuFactory popupMenuFactory)
Sets the popup menu factory for this window. |
void | setPreferredMinimizeDirection(Direction direction) Sets the preferred minimize direction of this window. |
protected void | showChildWindow(DockingWindow window) |
protected boolean | showsWindowTitle() |
SplitWindow | split(DockingWindow splitWithWindow, Direction direction, float dividerLocation)
Splits this window in the given direction. |
protected DropAction | split(DockingWindow window, Direction splitDir) |
DockingWindowDragger | startDrag(RootWindow dropTarget)
Starts a drag and drop operation for this window.
|
protected WindowAncestors | storeAncestors() |
String | toString() |
FloatingWindow | undock(Point location) Undocks this window from it's window parent i.e. creates a FloatingWindow containing this window. The window can be docked again by calling dock. This method will call the windowUndocked method of all the listeners of this window and all window ancestors. |
FloatingWindow | undockWithAbort(Point location)
Same as undock, but the windowUndocking method of
the window listeners will be called before undocking the window, giving them the possibility to abort the undock
operation.
|
protected abstract void | update() |
protected void | updateButtonVisibility() |
protected void | updateWindowItem(DockingWindow w) |
protected void | updateWindowItem(RootWindow rootWindow) |
protected void | updateWindowItems() |
protected void | write(ObjectOutputStream out, WriteContext context, ViewWriter viewWriter) |
protected void | writeLocations(ObjectOutputStream out) |
Parameters: listener the listener
Since: IDW 1.1.0
Adds a listener that receives mouse button events for window tabs. The listener will be called when a mouse button is pressed, clicked or released on a window tab of this window or a descendant of this window.
The listeners are called in the reverse order they were added, so the last added listener will be called first. When all the listeners of this window has been called, the event is propagated up to the window parent of this window, if there is one.
The MouseEventsource is the docking window connected to the tab in which the mouse event occured. The event point is the mouse coordinate where the event occured relative to the window.
Parameters: listenerDocking the listener
Since: IDW 1.3.0
Returns: true if the child windows are inside tabs __exclude__
Removes this window from it's window parent. If the window parent is a split window or a tab window with one child, it will be removed as well.
The location of this window is saved and the window can be restored to that location using the restore method.
This method will call the windowClosed method of all the listeners of this window and all window ancestors. The listeners of child windows will not be notified, for example closing a tab window containing views will not notify the listeners of views in that tab window.
Throws: OperationAbortedException if the close operation was aborted by a window listener
Since: IDW 1.1.0
See Also: close windowClosing
Docks the window to the RootWindow to the location it had before it was undocked.
If the window can't be docked to the exact same location, a good approximation is performed. It's not guaranteed that the window is shown anywhere after this method has returned.
This method will call the windowDocked method of all the listeners of this window and all window ancestors. The listeners of child windows will not be notified, for example docking a tab window containing views will not notify the listeners of views in that tab window.
Since: IDW 1.4.0
Throws: OperationAbortedException if the dock operation was aborted by a window listener
Since: IDW 1.4.0
See Also: dock windowDocking
Parameters: index the child window index
Returns: the child window
Returns: the number of child windows
Parameters: window the child window
Returns: the index of the child window, -1 if the window is not a child of this window
Returns: the icon
Returns: the child window that last contained focus, null if no child window has contained focus or the child has been removed from this window
Returns: the result after removing unnecessary tab windows which contains only one tab
Returns: the popup menu factory for this window, null if there is none
Gets the preferred minimize direction of this window. See setPreferredMinimizeDirection for more information.
Returns: the preferred minimize direction of this window, null if the closest WindowBar is used
Since: IDW 1.3.0
Returns: the RootWindow, null if there is none
Returns: the window title
Returns: the window parent of this window
Returns: the properties for this window
Returns: true if this window is inside a tab __exclude__
Returns: true if this window can be closed
Since: IDW 1.2.0
See Also: close closeWithAbort
Returns: true if this window can be docked
Since: IDW 1.4.0
See Also: dock
Returns: true if this window can be maximized
Since: IDW 1.2.0
See Also: maximize
Returns: true if this window has a root window and is maximized in that root window or in a floating window
Since: IDW 1.1.0
Returns: true if this window can be minimized
See Also: minimize
Returns: true if this window is minimized
Returns: true if this window can be restored
Since: IDW 1.2.0
See Also: restore
Returns: true if this window can be undocked
Since: IDW 1.4.0
See Also: undock
Since: IDW 1.1.0
The location of this window is saved and the window can be restored to that location using the restore method.
Since: IDW 1.1.0
Throws: OperationAbortedException if the maximize operation was aborted by a window listener
Since: IDW 1.4.0
See Also: maximize windowMinimizing
The location of this window is saved and the window can be restored to that location using the restore method.
The location of this window is saved and the window can be restored to that location using the restore method.
Parameters: direction the direction in which the window bar to be minimized to is located
Throws: OperationAbortedException if the minimize operation was aborted by a window listener
Since: IDW 1.4.0
See Also: minimize windowMinimizing
Throws: OperationAbortedException if the minimize operation was aborted by a window listener
Since: IDW 1.4.0
See Also: minimize windowMinimizing
Parameters: listener the listener
Since: IDW 1.1.0
Parameters: listenerDocking the listener
Since: IDW 1.3.0
Parameters: oldWindow the child window to replaceChildWindow newWindow the window to replaceChildWindow it with
Since: IDW 1.1.0
Throws: OperationAbortedException if the restore operation was aborted by a window listener
Since: IDW 1.4.0
See Also: restore windowMinimizing
Parameters: popupMenuFactory the popup menu factory, null if no popup menu should be shown
Sets the preferred minimize direction of this window. If the WindowBar in this direction is enabled this window will be placed on that bar when minimize is called.
Note that a window will "remember" the last WindowBar it was added to so the preferred minimize direction is changed when the window is added to another WindowBar.
Parameters: direction the preferred minimize direction of this window, null (which is default value) means use the closest, enabled WindowBar
Since: IDW 1.3.0
Parameters: splitWithWindow the splitWithWindow which to split with direction the split direction dividerLocation the relative split divider location (0 - 1)
Returns: the resulting split window
Parameters: dropTarget the RootWindow in which the window can be dropped
Returns: an DockingWindowDragger object which controls the drag and drop operation
Since: IDW 1.3.0
Undocks this window from it's window parent i.e. creates a FloatingWindow containing this window.
The window can be docked again by calling dock.
This method will call the windowUndocked method of all the listeners of this window and all window ancestors. The listeners of child windows will not be notified, for example undocking a tab window containing views will not notify the listeners of views in that tab window.
Parameters: location floating window location in screen coordinates
Returns: the floating window containing the undocked window
Since: IDW 1.4.0
Parameters: location floating window location in screen coordinates
Returns: the floating window containing the undocked window
Throws: OperationAbortedException if the undock operation was aborted by a window listener
Since: IDW 1.4.0
See Also: undock windowClosing