|
||||||||||
PREV NEXT | FRAMES NO FRAMES |
Packages that use Dockable | |
---|---|
com.vlsolutions.swing.docking | The VL Docking Framework for JFC "Swing" applications. |
com.vlsolutions.swing.docking.event | Events Package of the VLDocking Framework. |
Uses of Dockable in com.vlsolutions.swing.docking |
---|
Classes in com.vlsolutions.swing.docking that implement Dockable | |
---|---|
class |
CompoundDockable
Describes a Dockable that can contain sub-dockables. |
class |
DockablePanel
A basic implementation of Dockable. |
Fields in com.vlsolutions.swing.docking declared as Dockable | |
---|---|
protected Dockable |
DockView.dockable
the dockable managed by this view |
Methods in com.vlsolutions.swing.docking that return Dockable | |
---|---|
Dockable |
DockViewAsTab.TabHeader.getDockable()
|
Dockable |
DockTabbedPane.getDockable()
Returns the Dockable component this source is for |
Dockable |
DockViewTitleBar.getDockable()
Returns the Dockable component this source is for |
Dockable |
AutoHideExpandPanel.getDockable()
|
Dockable |
DockableDragSource.getDockable()
Returns the Dockable component this source is for |
Dockable |
AutoHideButton.getDockable()
Returns the dockable this button is for |
Dockable |
DockableStoreButton.getDockable()
Return the dockable currently stored (may be null) |
Dockable |
DockableState.getDockable()
Returns the dockable this state is for |
Dockable |
DockView.getDockable()
Returns the contained component Returns the dockable this container is displaying |
Dockable |
SingleDockableContainer.getDockable()
Returns the dockable this container is displaying |
Dockable |
DockTabbedPane.getDockableAt(int index)
Returns the dockable at the index tab |
Dockable |
TabbedDockableContainer.getDockableAt(int index)
Returns the dockable at the index tab |
Dockable |
DockingContext.getDockableByKey(java.lang.String dockKey)
Returns the (registered) dockable corresponding to the given key id, or null if not found |
Dockable |
DockingDesktop.getMaximizedDockable()
returns the currently maximized dockable (or null if no dockable is in that state) |
Dockable |
DockTabbedPane.getSelectedDockable()
Returns the currently selected (front) dockable |
Dockable |
TabbedDockableContainer.getSelectedDockable()
Returns the currently selected (front) dockable |
Dockable |
DockingDesktop.getSelectedDockable()
Returns the currently selected dockable, or null if none is selected. |
Dockable |
DockableResolver.resolveDockable(java.lang.String keyName)
Returns the dockable which should be associated to this DockKey identifier, or null if not found. |
Methods in com.vlsolutions.swing.docking with parameters of type Dockable | |
---|---|
void |
DockingDesktop.addDockable(CompoundDockable base,
Dockable dockable)
Adds a dockable inside a compound dockable. |
void |
DockingDesktop.addDockable(Dockable dockable)
Adds a dockable in the docking desktop. |
void |
DockTabbedPane.addDockable(Dockable dockable,
int tab)
Adds a new tab respecting the presentation and constraints of the component. |
void |
TabbedDockableContainer.addDockable(Dockable dockable,
int index)
Adds a dockable to the given index tab. |
void |
DockingDesktop.addDockable(Dockable dockable,
RelativeDockablePosition position)
Adds a dockable in the docking desktop, and tries to respect the relative positionning provided. |
void |
DockingDesktop.addHiddenDockable(Dockable dockable,
RelativeDockablePosition dockedPosition)
Registers and add a dockable on an auto-hide border. |
void |
DockingDesktop.addToTabbedGroup(Dockable base,
Dockable newTab)
Registers a dockable as belonging to a tab group. |
void |
DockingContext.close(Dockable dockable)
Close this dockable |
void |
DockingDesktop.close(Dockable dockable)
Disposes the dockable container of this dockable. |
void |
DockingDesktop.closeAllDockablesInTab(Dockable base)
Convenience method to close all dockables of the tabbedContainer containing "base" (including the base dockable). |
void |
DockingDesktop.closeAllOtherDockablesInTab(Dockable exception)
Convenience method to close all dockables of a TabbedDockableContainer except one. |
static javax.swing.Action |
TabbedContainerActions.createAttachTabAction(Dockable dockable,
DockingDesktop desktop)
returns an action suitable for attaching a dockable contained in a floating tab. |
static javax.swing.Action |
TabbedContainerActions.createCloseAction(Dockable dockable,
DockingDesktop desktop)
returns an action suitable for closing a dockable contained in a tab. |
static javax.swing.Action |
TabbedContainerActions.createCloseAllAction(Dockable base,
DockingDesktop desktop)
returns an action suitable for closing every dockable contained in a tab. |
static javax.swing.Action |
TabbedContainerActions.createCloseAllOtherAction(Dockable exception,
DockingDesktop desktop)
returns an action suitable for closing every dockable contained in a tab excepted the current one. |
SingleDockableContainer |
DockableContainerFactory.createDockableContainer(Dockable dockable,
boolean c)
Deprecated. use the other createDockableContainer method ( DockableContainerFactory.createDockableContainer(Dockable, int) |
SingleDockableContainer |
TabFactory.createDockableContainer(Dockable dockable,
int parentType)
|
abstract SingleDockableContainer |
DockableContainerFactory.createDockableContainer(Dockable dockable,
int parentType)
This method is called by the DockingDesktop whenever a dockable is inserted in its containment hierachy. |
SingleDockableContainer |
DefaultDockableContainerFactory.createDockableContainer(Dockable dockable,
int parentType)
Returns the component used to modify the expand panel size when expanded from the top. |
protected FloatingDockableContainer |
DockingDesktop.createFloatingDockableContainer(Dockable dockable)
Creates a floating JDialog to be used with this dockable. |
static javax.swing.Action |
TabbedContainerActions.createFloatTabAction(Dockable dockable,
DockingDesktop desktop)
returns an action suitable for floating (detach) a dockable contained in a tab. |
static javax.swing.Action |
TabbedContainerActions.createHideTabAction(Dockable dockable,
DockingDesktop desktop)
returns an action suitable for hiding a dockable contained in a tab. |
static javax.swing.Action |
TabbedContainerActions.createMaximizeTabAction(Dockable dockable,
DockingDesktop desktop)
returns an action suitable for maximizing a dockable contained in a tab. |
void |
DockingDesktop.createTab(Dockable base,
Dockable dockable,
int order)
Adds a view in a tab, or create it if it doesn't exist. |
void |
DockingDesktop.createTab(Dockable base,
Dockable dockable,
int order,
boolean select)
Add a view in a tab, or create it if it doesn't exist. |
static java.awt.Container |
DockingUtilities.findCompoundAncestorContainer(Dockable dockable)
searches up the dockable container hierarchy and returns the first ancestor which is a CompoundDockable (or null if not found). |
static DockableContainer |
DockingUtilities.findDockableContainer(Dockable dockable)
returns the first DockableContainer which is parent of this dockable component |
static SingleDockableContainer |
DockingUtilities.findSingleDockableContainer(Dockable dockable)
returns the first DockableContainer which is parent of this dockable component |
static TabbedDockableContainer |
DockingUtilities.findTabbedDockableContainer(Dockable dockable)
Returns the first TabbedDockableContainer which is parent of this dockable component, or null is there isn't any. |
AnchorConstraints |
AnchorManager.getDockableConstraints(Dockable dockable)
Returns the anchor constraints associated to a given dockable |
DockableState |
DockingContext.getDockableState(Dockable dockable)
Returns the current state of a dockable (CLOSED, HIDDEN, DOCKED, MAXIMIZED, FLOATING) |
DockableState |
DockingDesktop.getDockableState(Dockable dockable)
Returns the current state of a dockable (CLOSED, HIDDEN, DOCKED, MAXIMIZED, FLOATING) |
DockableState |
DockingDesktop.getPreviousDockableState(Dockable dockable)
Returns the previous state of a hidden or floating dockable (when that dockable was in the DOCKED state. |
static SplitContainer |
DockingUtilities.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 |
DockingUtilities.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). |
int |
DockTabbedPane.indexOfDockable(Dockable dockable)
Returns the index of the given dockable |
int |
TabbedDockableContainer.indexOfDockable(Dockable dockable)
Returns the index of the given dockable |
void |
AutoHideButton.init(Dockable dockable,
int zone)
Initialize the button for a Dockable and a border zone |
static boolean |
DockingUtilities.isChildOfCompoundDockable(Dockable dockable)
checks if this dockable is a child of a compound dockable |
void |
DockingDesktop.maximize(Dockable dockable)
Extends the size of this dockable to fill the docking panel. |
void |
DockingDesktop.move(Dockable base,
Dockable dockable,
DockingConstants.Split position)
Moves a dockable to another position (relative to a destination dockable) |
void |
AnchorManager.putDockableContraints(Dockable dockable,
AnchorConstraints constraints)
Associates an anchor constraints to a given dockable |
void |
DockingContext.registerDockable(Dockable dockable)
Every dockable must be registered in order to be managed by a DockingDesktop. |
void |
DockingDesktop.registerDockable(Dockable dockable)
Every dockable must be registered in order to be shown in the DockingDesktop. |
void |
AutoHideExpandPanel.remove(Dockable dockable)
Removes a dockable (if it was the currently expanded one) |
void |
DockingDesktop.remove(Dockable dockable)
Removes a visible dockable from the containment hierarchy (including autohide border buttons). |
void |
DockTabbedPane.removeDockable(Dockable dockable)
Removes a dockable from the tabs |
void |
TabbedDockableContainer.removeDockable(Dockable dockable)
Removes a dockable from the tabs |
AnchorConstraints |
AnchorManager.removeDockableConstraints(Dockable dockable)
Removes an anchor constraints to a given dockable |
void |
DockingDesktop.removeFromTabbedGroup(Dockable dockable)
Unregisters a dockable from its current tab group (when it's removed from it). |
void |
DockingDesktop.replace(Dockable base,
Dockable replacer)
Replaces a dockable by another one. |
void |
RelativeDockablePosition.resetRelativePosition(java.awt.Container relativeAncestorContainer,
Dockable dockable)
Updates the current relative ancestor container and anchor positionning |
void |
DockingDesktop.restore(Dockable dockable)
Restore the dockable to the docking position it was before beeing maximized. |
void |
DockingDesktop.setAutoHide(Dockable dockable,
boolean hide)
Toggles the position of a view between hidden (true) and docked (false). |
void |
DockingDesktop.setAutoResizableDockable(Dockable dockable)
Deprecated. use setResizeWeight() in every dockKey for a better resizing behaviour |
void |
DockViewAsTab.setDockable(Dockable d)
|
void |
DockViewTitleBar.setDockable(Dockable dockable)
Changes the dockable this title bar is for |
void |
DockableStoreButton.setDockable(Dockable dockable)
|
void |
DockView.setDockable(Dockable dockable)
Adds the dockable's component to this DockView. |
void |
DockViewAsTab.setDockableAsTab(Dockable d)
|
void |
DockingDesktop.setDockableHeight(Dockable dockable,
double height)
Changes the height of a dockable (the dockable must already be visible). |
void |
DockingContext.setDockableState(Dockable dockable,
DockableState state)
Updates the current state of a dockable |
void |
DockingDesktop.setDockableWidth(Dockable dockable,
double width)
Changes the width of a dockable (the dockable must already be visible). |
void |
DockingDesktop.setFloating(Dockable dockable,
boolean floating)
Detach or attach the dockable from/to the desktop. |
void |
DockingDesktop.setFloating(Dockable dockable,
boolean floating,
java.awt.Point screenPosition)
Detach or attach the dockable from/to the desktop. |
void |
FloatingDockableContainer.setInitialDockable(Dockable dockable)
adds the initial dockable to this top-level container |
void |
FloatingDialog.setInitialDockable(Dockable dockable)
|
void |
DockTabbedPane.setSelectedDockable(Dockable dockable)
Change the tab selection to display this dockable |
void |
TabbedDockableContainer.setSelectedDockable(Dockable dockable)
Change the tab selection to display this dockable |
void |
DockingDesktop.split(Dockable base,
Dockable newDockable,
DockingConstants.Split position)
Splits a Dockable in 2 parts, if possible. |
void |
DockingDesktop.splitComponent(java.awt.Component base,
Dockable dockable,
DockingConstants.Split position)
Replaces the base component by a split pane oriented according to position, and put dockable at position. |
void |
DockingContext.unregisterDockable(Dockable dockable)
Unregisters the dockable, which can be garbage collected (no longer used by docking desktops. |
void |
DockingDesktop.unregisterDockable(Dockable dockable)
Unregisters the dockable, which can be garbage collected (no longer used by the docking desktop. |
void |
DockableActionCustomizer.visitSingleDockableTitleBarPopUp(javax.swing.JPopupMenu popUpMenu,
Dockable dockable)
Override this method to add contextual items at the end of the pop-up menu which can be triggered on the title bar of a single dockable. |
void |
DockableActionCustomizer.visitTabSelectorPopUp(javax.swing.JPopupMenu popUpMenu,
Dockable tabbedDockable)
Override this method to add contextual items at the end of the pop-up menu which can be triggered on a tab selector. |
Constructors in com.vlsolutions.swing.docking with parameters of type Dockable | |
---|---|
DetachedDockView(Dockable dockable)
|
|
DockableState(DockingDesktop desktop,
Dockable dockable,
int state)
|
|
DockableState(DockingDesktop desktop,
Dockable dockable,
int state,
RelativeDockablePosition position)
|
|
DockView(Dockable dockable)
Constructs a new DockView for the given dockable. |
|
DockView(Dockable dockable,
boolean showTitle)
Constructs a new DockView for the given dockable. |
|
DockViewAsTab(Dockable dockable)
|
|
DockViewTitleBar(Dockable dockable)
Constructs a title bar for the specified dockable. |
|
MaximizedDockView(Dockable dockable)
|
|
MaximizedDockViewAsTab(Dockable dockable)
|
|
TabbedDockView(Dockable dockable)
|
Uses of Dockable in com.vlsolutions.swing.docking.event |
---|
Methods in com.vlsolutions.swing.docking.event that return Dockable | |
---|---|
Dockable |
DockingActionSplitDockableEvent.getBase()
Returns the dockable which will be used as a base for the splitting |
Dockable |
DockingActionCreateTabEvent.getBase()
Returns the dockable used as a reference to create a tab (may already belong to a tab) |
Dockable |
DockingActionDockableEvent.getDockable()
|
Dockable |
DockableSelectionEvent.getSelectedDockable()
Returns the currently selected Dockable |
Methods in com.vlsolutions.swing.docking.event with parameters of type Dockable | |
---|---|
void |
DockingActionDockableEvent.setDockable(Dockable dockable)
|
Constructors in com.vlsolutions.swing.docking.event with parameters of type Dockable | |
---|---|
DockableSelectionEvent(Dockable selectedDockable)
|
|
DockingActionAddDockableEvent(DockingDesktop desktop,
Dockable dockable,
int initialState,
int nextState,
java.awt.Container parentContainer)
Constructor for a DockingActionAddDockableEvent |
|
DockingActionCloseEvent(DockingDesktop desktop,
Dockable dockable,
int initialState)
|
|
DockingActionCreateTabEvent(DockingDesktop desktop,
Dockable dockable,
int initialState,
int nextState,
Dockable base,
int order)
|
|
DockingActionDockableEvent(DockingDesktop desktop,
Dockable dockable,
int initialState,
int nextState,
int actionType)
|
|
DockingActionSimpleStateChangeEvent(DockingDesktop desktop,
Dockable dockable,
int initialState,
int nextState)
Constructs a new event |
|
DockingActionSplitComponentEvent(DockingDesktop desktop,
Dockable dockable,
int initialState,
int nextState,
java.awt.Component base,
DockingConstants.Split splitPosition,
float dividorLocation)
Constructs a new event |
|
DockingActionSplitComponentEvent(DockingDesktop desktop,
Dockable dockable,
int initialState,
int nextState,
java.awt.Component base,
DockingConstants.Split splitPosition,
float dividorLocation,
float parentDividorLocation)
Constructs a new event. |
|
DockingActionSplitDockableEvent(DockingDesktop desktop,
Dockable dockable,
int initialState,
int nextState,
Dockable base,
DockingConstants.Split splitPosition,
float dividorLocation)
Constructs a new event |
|
||||||||||
PREV NEXT | FRAMES NO FRAMES |