net.infonode.docking
Class FloatingWindow

java.lang.Object
  java.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
                              net.infonode.docking.FloatingWindow

All Implemented Interfaces:

Accessible, ImageObserver, MenuContainer, Serializable

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);
 

Since:

IDW 1.4.0

Version:

$Revision: 1.51 $

See Also:

Serialized Form

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	close() Removes this window from it's window parent.
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.
Icon	getIcon() Returns the icon for this window.
DockingWindow	getMaximizedWindow() Returns the maximized window in this floating window.
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
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.

Methods inherited from class net.infonode.docking.DockingWindow

addListener, addTabMouseButtonListener, closeWithAbort, dock, dockWithAbort, getChildWindowIndex, getLastFocusedChildWindow, getPopupMenuFactory, getPreferredMinimizeDirection, getRootWindow, getTitle, getWindowParent, isClosable, isMaximized, isMinimized, makeVisible, maximize, maximizeWithAbort, minimizeWithAbort, minimizeWithAbort, removeListener, removeTabMouseButtonListener, replaceChildWindow, restore, restoreFocus, restoreWithAbort, setPopupMenuFactory, setPreferredMinimizeDirection, split, startDrag, toString, undock, undockWithAbort

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 javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getWidth, getVisibleRect, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

setWindow

public void setWindow(DockingWindow newWindow)

Sets the top level docking window inside this floating window.

Parameters:

newWindow - the top level docking window, null for no window i.e. empty floating window

getWindow

public DockingWindow getWindow()

Returns the top level docking window inside this floating window.

Returns:

the top level docking window inside this floating window

setMaximizedWindow

public void setMaximizedWindow(DockingWindow window)

Sets the maximized window in this floating window.

Parameters:

window - the window to maximize, must be a member of the window tree inside this floating window

getMaximizedWindow

public DockingWindow getMaximizedWindow()

Returns the maximized window in this floating window.

Returns:

maximized window or null if no window is maximized

getFloatingWindowProperties

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.

Returns:

the property values for this floating window

getWindowProperties

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.

Overrides:

getWindowProperties in class DockingWindow

Returns:

the properties for this window

minimize

public void minimize()

Floating window cannot be minimized

Overrides:

minimize in class DockingWindow

minimize

public void minimize(Direction direction)

Floating window cannot be minimized

Overrides:

minimize in class DockingWindow

Parameters:

direction -

isDockable

public boolean isDockable()

Description copied from class: DockingWindow

Returns true if this window can be docked to the root window from a floating window.

Overrides:

isDockable in class DockingWindow

Returns:

true if this window can be docked

See Also:

DockingWindow.dock()

isMaximizable

public boolean isMaximizable()

Description copied from class: DockingWindow

Returns true if this window can be maximized by the user.

Overrides:

isMaximizable in class DockingWindow

Returns:

true if this window can be maximized

See Also:

DockingWindow.maximize()

isMinimizable

public boolean isMinimizable()

Description copied from class: DockingWindow

Returns true if this window can be minimized by the user.

Overrides:

isMinimizable in class DockingWindow

Returns:

true if this window can be minimized

See Also:

DockingWindow.minimize()

isRestorable

public boolean isRestorable()

Description copied from class: DockingWindow

Returns true if this window can be restored by the user.

Overrides:

isRestorable in class DockingWindow

Returns:

true if this window can be restored

See Also:

DockingWindow.restore()

isUndockable

public boolean isUndockable()

Description copied from class: DockingWindow

Returns true if this window can be undocked to a floating window.

Overrides:

isUndockable in class DockingWindow

Returns:

true if this window can be undocked

See Also:

DockingWindow.undock(Point)

close

public void close()

Description copied from class: 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.

Overrides:

close in class DockingWindow

getIcon

public Icon getIcon()

Description copied from class: DockingWindow

Returns the icon for this window.

Specified by:

getIcon in class DockingWindow

Returns:

the icon

getChildWindow

public DockingWindow getChildWindow(int index)

Description copied from class: DockingWindow

Returns the child window with index index.

Specified by:

getChildWindow in class DockingWindow

Parameters:

index - the child window index

Returns:

the child window

getChildWindowCount

public int getChildWindowCount()

Description copied from class: DockingWindow

Returns the number of child windows.

Specified by:

getChildWindowCount in class DockingWindow

Returns:

the number of child windows

isUndocked

public boolean isUndocked()

Overrides:

isUndocked in class DockingWindow