|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
net.infonode.gui.panel.BaseContainer
net.infonode.gui.panel.BasePanel
net.infonode.docking.DockingWindow
This is the base class for all types of docking windows. The windows are structured in a tree, typically with a
RootWindow
at the root. Each DockingWindow has a window parent and a number of child windows.
Warning: the non-public methods in this class can be changed in non-compatible ways in future versions.
Nested Class Summary |
Nested classes inherited from class javax.swing.JComponent |
JComponent.AccessibleJComponent |
Field Summary |
Fields inherited from class javax.swing.JComponent |
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW |
Fields inherited from class java.awt.Component |
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
Fields inherited from interface java.awt.image.ImageObserver |
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Method Summary | |
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. |
void |
close()
Removes this window from it's window parent. |
void |
closeWithAbort()
Same as close() , but the DockingWindowListener.windowClosing(DockingWindow) method of
the window listeners will be called before closing the window, giving them the possibility to abort the close
operation. |
void |
dock()
Docks the window to the RootWindow to the location it had before it was undocked. |
void |
dockWithAbort()
Same as dock() , but the DockingWindowListener.windowDocking(DockingWindow) method of
the window listeners will be called before docking the window, giving them the possibility to abort the dock
operation. |
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. |
abstract Icon |
getIcon()
Returns the icon for this window. |
DockingWindow |
getLastFocusedChildWindow()
Returns the child window that last contained focus. |
WindowPopupMenuFactory |
getPopupMenuFactory()
Returns the popup menu factory for this window. |
Direction |
getPreferredMinimizeDirection()
Gets the preferred minimize direction of this window. |
RootWindow |
getRootWindow()
Returns the RootWindow which contains this window, null if there is none. |
String |
getTitle()
Returns the title of this window. |
DockingWindow |
getWindowParent()
Returns the window parent of this window. |
DockingWindowProperties |
getWindowProperties()
Returns the properties for this window. |
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. |
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 DockingWindowListener.windowMaximized(DockingWindow) 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 WindowBar located in direction. |
void |
minimizeWithAbort()
Same as minimize() , but the DockingWindowListener.windowMinimizing(DockingWindow) 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(Direction) , but the DockingWindowListener.windowMinimizing(DockingWindow) method of
the window listeners will be called before minimizing the window, giving them the possibility to abort the minimize
operation. |
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(MouseButtonListener) . |
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 DockingWindowListener.windowRestoring(DockingWindow) method of
the window listeners will be called before restoring the window, giving them the possibility to abort the restore
operation. |
void |
setPopupMenuFactory(WindowPopupMenuFactory popupMenuFactory)
Sets the popup menu factory for this window. |
void |
setPreferredMinimizeDirection(Direction direction)
Sets the preferred minimize direction of this window. |
SplitWindow |
split(DockingWindow splitWithWindow,
Direction direction,
float dividerLocation)
Splits this window in the given direction. |
DockingWindowDragger |
startDrag(RootWindow dropTarget)
Starts a drag and drop operation for this window. |
String |
toString()
|
FloatingWindow |
undock(Point location)
Undocks this window from it's window parent i.e. creates a FloatingWindow containing this window. |
FloatingWindow |
undockWithAbort(Point location)
Same as undock(Point) , but the DockingWindowListener.windowUndocking(DockingWindow) method of
the window listeners will be called before undocking the window, giving them the possibility to abort the undock
operation. |
Methods inherited from class net.infonode.gui.panel.BaseContainer |
setBackground, setFont, setForeground, setOpaque, setUI |
Methods inherited from class javax.swing.JPanel |
getAccessibleContext, getUI, getUIClassID, updateUI |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
public abstract Icon getIcon()
public abstract DockingWindow getChildWindow(int index)
index
- the child window index
public abstract int getChildWindowCount()
public void setPreferredMinimizeDirection(Direction direction)
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
.
direction
- the preferred minimize direction of this window, null (which is default value) means use the
closest, enabled WindowBar
public Direction getPreferredMinimizeDirection()
Gets the preferred minimize direction of this window. See setPreferredMinimizeDirection(net.infonode.util.Direction)
for more information.
WindowBar
is usedpublic boolean isUndocked()
public void addTabMouseButtonListener(MouseButtonListener listenerDocking)
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 MouseEvent
source 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.
listenerDocking
- the listenerpublic void removeTabMouseButtonListener(MouseButtonListener listenerDocking)
addTabMouseButtonListener(MouseButtonListener)
.
listenerDocking
- the listenerpublic void addListener(DockingWindowListener listener)
listener
- the listenerpublic void removeListener(DockingWindowListener listener)
listener
- the listenerpublic DockingWindow getWindowParent()
public SplitWindow split(DockingWindow splitWithWindow, Direction direction, float dividerLocation)
splitWithWindow
- the splitWithWindow which to split withdirection
- the split directiondividerLocation
- the relative split divider location (0 - 1)
public DockingWindowDragger startDrag(RootWindow dropTarget)
dropTarget
- the RootWindow
in which the window can be dropped
DockingWindowDragger
object which controls the drag and drop operationpublic DockingWindowProperties getWindowProperties()
public RootWindow getRootWindow()
RootWindow
which contains this window, null if there is none.
RootWindow
, null if there is nonepublic void restoreWithAbort() throws OperationAbortedException
restore()
, but the DockingWindowListener.windowRestoring(DockingWindow)
method of
the window listeners will be called before restoring the window, giving them the possibility to abort the restore
operation.
OperationAbortedException
- if the restore operation was aborted by a window listenerrestore()
,
DockingWindowListener.windowMinimizing(DockingWindow)
public void restore()
public void close()
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 DockingWindowListener.windowClosed(DockingWindow)
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.
public void closeWithAbort() throws OperationAbortedException
close()
, but the DockingWindowListener.windowClosing(DockingWindow)
method of
the window listeners will be called before closing the window, giving them the possibility to abort the close
operation.
OperationAbortedException
- if the close operation was aborted by a window listenerclose()
,
DockingWindowListener.windowClosing(DockingWindow)
public 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 DockingWindowListener.windowUndocked(DockingWindow)
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.
location
- floating window location in screen coordinates
public FloatingWindow undockWithAbort(Point location) throws OperationAbortedException
undock(Point)
, but the DockingWindowListener.windowUndocking(DockingWindow)
method of
the window listeners will be called before undocking the window, giving them the possibility to abort the undock
operation.
location
- floating window location in screen coordinates
OperationAbortedException
- if the undock operation was aborted by a window listenerundock(Point)
,
DockingWindowListener.windowClosing(DockingWindow)
public 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. It's not guaranteed that the window is shown anywhere after this method has returned.
This method will call the DockingWindowListener.windowDocked(DockingWindow)
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.
public void dockWithAbort() throws OperationAbortedException
dock()
, but the DockingWindowListener.windowDocking(DockingWindow)
method of
the window listeners will be called before docking the window, giving them the possibility to abort the dock
operation.
OperationAbortedException
- if the dock operation was aborted by a window listenerdock()
,
DockingWindowListener.windowDocking(DockingWindow)
public int getChildWindowIndex(DockingWindow window)
window
- the child window
public WindowPopupMenuFactory getPopupMenuFactory()
public void setPopupMenuFactory(WindowPopupMenuFactory popupMenuFactory)
popupMenuFactory
- the popup menu factory, null if no popup menu should be shownpublic boolean isMinimized()
WindowBar
.
public DockingWindow getLastFocusedChildWindow()
public final void maximize()
The location of this window is saved and the window can be restored to that location using the
restore()
method.
public void maximizeWithAbort() throws OperationAbortedException
maximize()
, but the DockingWindowListener.windowMaximized(DockingWindow)
method of
the window listeners will be called before maximizing the window, giving them the possibility to abort the maximize
operation.
OperationAbortedException
- if the maximize operation was aborted by a window listenermaximize()
,
DockingWindowListener.windowMinimizing(DockingWindow)
public boolean isMaximized()
public void minimize()
WindowBar
in the preferred minimize direction,
see setPreferredMinimizeDirection(net.infonode.util.Direction)
and getPreferredMinimizeDirection()
.
If the WindowBar
in that direction is not enabled, or the direction is null, thiw window is placed on the
closest enabled WindowBar
.
If no suitable WindowBar
was found or this window already is minimized, no action is performed.
The location of this window is saved and the window can be restored to that location using the
restore()
method.
public void minimize(Direction direction)
WindowBar
located in direction. If no suitable WindowBar
was
found or this window already is minimized, no action is performed.
The location of this window is saved and the window can be restored to that location using the
restore()
method.
direction
- the direction in which the window bar to be minimized to is locatedpublic void minimizeWithAbort() throws OperationAbortedException
minimize()
, but the DockingWindowListener.windowMinimizing(DockingWindow)
method of
the window listeners will be called before minimizing the window, giving them the possibility to abort the minimize
operation.
OperationAbortedException
- if the minimize operation was aborted by a window listenerminimize()
,
DockingWindowListener.windowMinimizing(DockingWindow)
public void minimizeWithAbort(Direction direction) throws OperationAbortedException
minimize(Direction)
, but the DockingWindowListener.windowMinimizing(DockingWindow)
method of
the window listeners will be called before minimizing the window, giving them the possibility to abort the minimize
operation.
OperationAbortedException
- if the minimize operation was aborted by a window listenerminimize(Direction)
,
DockingWindowListener.windowMinimizing(DockingWindow)
public boolean isMinimizable()
minimize()
public boolean isMaximizable()
maximize()
public boolean isClosable()
close()
,
closeWithAbort()
public boolean isRestorable()
restore()
public boolean isUndockable()
undock(Point)
public boolean isDockable()
dock()
public void replaceChildWindow(DockingWindow oldWindow, DockingWindow newWindow)
oldWindow
- the child window to replaceChildWindownewWindow
- the window to replaceChildWindow it withpublic String getTitle()
public String toString()
public void makeVisible()
TabWindow
parents containing this
window to be selected.
public void restoreFocus()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |