public class FloatingWindow extends DockingWindow
A window that is floating on-top of the root window and containing another docking window.
A window can be maximized inside the floating window just as in a root window.
After a floating window has been closed it shouldn't be reused again.
Floating window inherits its component properties and shaped panel properties from the root
window's window area. It is possible to set specific component and shaped panel properties for
a floating window in the FloatingWindowProperties
, see
getFloatingWindowProperties()
.
A floating window is created by calling the
RootWindow.createFloatingWindow(Point, Dimension, DockingWindow)
method or indirectly created by calling the
DockingWindow.undock(Point)
method.
It's possible to add a menu bar to the floating window. Just call:
myFloatingWindow.getRootPane().setJMenuBar(myMenuBar);
The floating window is placed as the BorderLayout.CENTER component of the content pane of the root pane. You can add additional components in the other BorderLayout positions. Example, add a status label at the bottom:
myFloatingWindow.getRootPane().getContentPane().add(myStstusLabel, BroderLayout.SOUTH);
javax.swing.JPanel.AccessibleJPanel
javax.swing.JComponent.AccessibleJComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Modifier and Type | Method and Description |
---|---|
protected DropAction |
acceptInteriorDrop(java.awt.Point p,
DockingWindow window) |
protected boolean |
acceptsSplitWith(DockingWindow window) |
protected void |
afterWindowRemoved(DockingWindow window) |
void |
close()
Removes this window from it's window parent.
|
protected PropertyMap |
createPropertyObject() |
protected DropAction |
doAcceptDrop(java.awt.Point p,
DockingWindow window) |
protected void |
doRemoveWindow(DockingWindow window) |
protected void |
doReplace(DockingWindow oldWindow,
DockingWindow newWindow) |
protected void |
fireTitleChanged() |
DockingWindow |
getChildWindow(int index)
Returns the child window with index index.
|
int |
getChildWindowCount()
Returns the number of child windows.
|
FloatingWindowProperties |
getFloatingWindowProperties()
Returns the property values for this floating window.
|
javax.swing.Icon |
getIcon()
Returns the icon for this window.
|
DockingWindow |
getMaximizedWindow()
Returns the maximized window in this floating window.
|
protected PropertyMap |
getPropertyObject() |
DockingWindow |
getWindow()
Returns the top level docking window inside this floating window.
|
DockingWindowProperties |
getWindowProperties()
Returns the properties for this window.
|
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 |
isMinimizable()
Returns true if this window can be minimized by the user.
|
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 |
minimize()
Floating window cannot be minimized
|
void |
minimize(Direction direction)
Floating window cannot be minimized
|
protected DockingWindow |
read(java.io.ObjectInputStream in,
ReadContext context,
ViewReader viewReader) |
void |
setMaximizedWindow(DockingWindow window)
Sets the maximized window in this floating window.
|
void |
setWindow(DockingWindow newWindow)
Sets the top level docking window inside this floating window.
|
protected void |
showChildWindow(DockingWindow window) |
protected void |
update() |
protected void |
write(java.io.ObjectOutputStream out,
WriteContext context,
ViewWriter viewWriter) |
acceptChildDrop, acceptSplitDrop, addListener, addTabMouseButtonListener, addWindow, addWindowItem, beforeDrop, beginOptimize, beginUpdateModel, childInsideTab, childRemoved, cleanUpModel, clearChildrenFocus, clearFocus, closeWithAbort, createTabWindow, detach, dock, dockWithAbort, endOptimize, endUpdateModel, fireViewFocusChanged, fireWindowHidden, fireWindowShown, getAncestors, getBestFittedWindow, getChildEdgeDepth, getChildWindowIndex, getContentWindow, getEdgeDepth, getLastFocusedChildWindow, getLocationWindow, getOptimizedWindow, getPopupMenuFactory, getPreferredFocusChild, getPreferredMinimizeDirection, getRootWindow, getTitle, getUpdateModel, getWindowItem, getWindowParent, hasParent, init, insideTab, internalClose, internalReplaceChildWindow, isChildShowingInRootWindow, isClosable, isMaximized, isMinimized, isShowingInRootWindow, makeVisible, maximize, maximizeWithAbort, minimizeWithAbort, minimizeWithAbort, needsTitleWindow, notifyListeners, oldRead, optimizeAfter, optimizeWindowLayout, readLocations, removeChildWindow, removeListener, removeTabMouseButtonListener, removeWindow, replaceChildWindow, restore, restoreFocus, restoreWithAbort, rootChanged, setFocused, setLastMinimizedDirection, setPopupMenuFactory, setPreferredMinimizeDirection, showsWindowTitle, split, split, startDrag, storeAncestors, toString, undock, undockWithAbort, updateButtonVisibility, updateWindowItem, updateWindowItem, updateWindowItems, writeLocations
setComponent, setSouthComponent
paintComponent, setBackground, setFont, setForeground, setOpaque, setUI
getAccessibleContext, getUI, getUIClassID, paramString, updateUI
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle
public void setWindow(DockingWindow newWindow)
newWindow
- the top level docking window, null for no window i.e. empty floating windowpublic DockingWindow getWindow()
public void setMaximizedWindow(DockingWindow window)
window
- the window to maximize, must be a member of the window tree inside this floating windowpublic DockingWindow getMaximizedWindow()
public FloatingWindowProperties getFloatingWindowProperties()
Returns the property values for this floating window.
Floating window inherits its component properties and shaped panel properties from the root
window's window area. It is possible to set specific component and shaped panel properties for
a floating window in the FloatingWindowProperties
.
public DockingWindowProperties getWindowProperties()
Returns the properties for this window.
Note: A floating window only uses the close enabled and title provider properties of the docking window properties.
getWindowProperties
in class DockingWindow
public void minimize()
minimize
in class DockingWindow
public void minimize(Direction direction)
minimize
in class DockingWindow
direction
- public boolean isDockable()
DockingWindow
isDockable
in class DockingWindow
DockingWindow.dock()
public boolean isMaximizable()
DockingWindow
isMaximizable
in class DockingWindow
DockingWindow.maximize()
public boolean isMinimizable()
DockingWindow
isMinimizable
in class DockingWindow
DockingWindow.minimize()
public boolean isRestorable()
DockingWindow
isRestorable
in class DockingWindow
DockingWindow.restore()
public boolean isUndockable()
DockingWindow
isUndockable
in class DockingWindow
DockingWindow.undock(Point)
public void close()
DockingWindow
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
DockingWindow.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.
close
in class DockingWindow
public javax.swing.Icon getIcon()
DockingWindow
getIcon
in class DockingWindow
public DockingWindow getChildWindow(int index)
DockingWindow
getChildWindow
in class DockingWindow
index
- the child window indexpublic int getChildWindowCount()
DockingWindow
getChildWindowCount
in class DockingWindow
public boolean isUndocked()
isUndocked
in class DockingWindow
protected void doReplace(DockingWindow oldWindow, DockingWindow newWindow)
doReplace
in class DockingWindow
protected void doRemoveWindow(DockingWindow window)
doRemoveWindow
in class DockingWindow
protected void afterWindowRemoved(DockingWindow window)
afterWindowRemoved
in class DockingWindow
protected boolean acceptsSplitWith(DockingWindow window)
acceptsSplitWith
in class DockingWindow
protected DropAction doAcceptDrop(java.awt.Point p, DockingWindow window)
doAcceptDrop
in class DockingWindow
protected DropAction acceptInteriorDrop(java.awt.Point p, DockingWindow window)
acceptInteriorDrop
in class DockingWindow
protected void update()
update
in class DockingWindow
protected void showChildWindow(DockingWindow window)
showChildWindow
in class DockingWindow
protected PropertyMap getPropertyObject()
getPropertyObject
in class DockingWindow
protected PropertyMap createPropertyObject()
createPropertyObject
in class DockingWindow
protected void fireTitleChanged()
fireTitleChanged
in class DockingWindow
protected DockingWindow read(java.io.ObjectInputStream in, ReadContext context, ViewReader viewReader) throws java.io.IOException
java.io.IOException
protected void write(java.io.ObjectOutputStream out, WriteContext context, ViewWriter viewWriter) throws java.io.IOException
write
in class DockingWindow
java.io.IOException