com.vlsolutions.swing.docking
public class DockingUtilities extends Object
This class is not inteded for API users, it should be let to framework developpers.
Method Summary | |
---|---|
static boolean | canUseMouseInfo() Returns whether we can use the secured and 1.5 MouseInfo class |
static void | dispose(FloatingDockableContainer fdc) disposes a detached dockable, regardless of its type (frame or dialog) |
static Container | findCompoundAncestorContainer(Dockable dockable) searches up the dockable container hierarchy and returns the first ancestor
which is a CompoundDockable (or null if not found). |
static ArrayList | findCompoundDockableChildren(CompoundDockable compoundDockable) Creates a list of all dockable children contained in the given compound dockable.
|
static DockableContainer | findDockableContainer(Dockable dockable) returns the first DockableContainer which is parent of this dockable component |
static SingleDockableContainer | findSingleDockableContainer(Dockable dockable) returns the first DockableContainer which is parent of this dockable component |
static SingleDockableContainer | findSingleDockableContainerAncestor(Component component) A utility method to find the first single dockable container ancestor of the given component.
|
static TabbedDockableContainer | findTabbedDockableContainer(Dockable dockable) Returns the first TabbedDockableContainer which is parent of this dockable component, or
null is there isn't any.
|
static int | getDockableStateFromHierarchy(Component comp) Returns a DockableState value corresponding to this component or -1 if not found.
|
static Point | getMouseLocation() Returns the mouse location on screen or null if ran in an untrusted environement/ java 1.4 |
static JRootPane | getRootPane(FloatingDockableContainer fdc) returns the root pane used by this detached dockable container, regardless of its type (frame or dialog) |
static SplitContainer | getSplitPane(Dockable dockable, int orientation) Returns the split pane containing this dockable (if any), or null if this dockable
isn't contained in a splitpane.
|
static int | getTopMostAncestorContainerState(Dockable dockable) searches up the dockable container hierarchy and returns the dockable state of the
last (top most) ancestor which is a CompoundDockable (or -1 if not found). |
static boolean | isChildOfCompoundDockable(Dockable dockable) checks if this dockable is a child of a compound dockable |
static boolean | isHeavyWeightComponent(Component comp) Utility method to find out if a component is heavyweight (of if it contains a heavyweight comp) |
static void | pack(FloatingDockableContainer fdc) packs a detached dockable, regardless of its type (frame or dialog) |
static void | replaceChild(Container parent, Component child, Component newChild) Child replacement |
static void | setLocation(FloatingDockableContainer fdc, Point location) positions a detached dockable, regardless of its type (frame or dialog) |
static void | setLocationRelativeTo(FloatingDockableContainer fdc, Component rel) positions a detached dockable, regardless of its type (frame or dialog) |
static void | setSize(FloatingDockableContainer fdc, Dimension size) resizes a detached dockable, regardless of its type (frame or dialog) |
static void | setVisible(FloatingDockableContainer fdc, boolean visible) shows a detached dockable, regardless of its type (frame or dialog) |
static void | swapComponents(Component comp1, Component comp2) Swaps two toplevel DockableContainers (their parent must be a SplitContainer) |
static void | updateResizeWeights(DockingPanel dockingPanel) Invoked every time the layout is changed, to rebuild the weighting of split containers |
static void | validate(FloatingDockableContainer fdc) validates a detached dockable, regardless of its type (frame or dialog) |
If the compound dockable contains another compound dockable this one is also added, along with its own children.
Returns: an ArrayList of Dockable
This method may return null if no SingleDockableContainer ancestor is found.
Two states are currently managed : docked and floating (not hidden/maximized/closed).
If the dockable is nested in a TabbedDockableContainer, the split pane returned will be the one containing the tabbed container (if any).