Invoked before a docking action is processed, to give a chance to the
listener to react to it and cancel it if needed.
Used by a DockDropReceiver to indicate that the drag operation is accepted
(mouse is over a droppable zone).
shortcut for acceptDrop(true).
notifies the event manager that docking is accepted.
The action corresponding to the drag and drop gesture
(actions can be seen as allowed docking gestures)
The action triggered when the clicks on the icon
Field associated to an addDockable action
Field associated to a closing action
Field associated to a createTab action
Field associated to a split component action
Field associated to a split dockable action
Field associated to a multipurpose (API internals) splut container action
A multipurpose action used to describe maximize, hide and detach actions
Adds a new button to this toolbar
Adds a new AutoHideButton.
Adds a new toolbar respecting the given positionning constraints.
Overriden to track AbstractButton added
Overriden to track component constraints
Adds a new button to this toolbar
Adds a new toolbar respecting the given positionning constraints.
Adds a new JToolBar to the Panel at the given row.
Adds a new listener to the animator
Adds a desktop to this context
Adds a new desktop to this workspace
Adds a dockable inside a compound dockable.
Adds a dockable in the docking desktop.
Adds a dockable in the docking desktop, and tries to respect the relative
positionning provided.
Adds a new tab respecting the presentation and constraints of the component.
Adds a dockable to the given index tab.
Adds the first dockable to this desktop.
Adds a dockable into a compound dockable
Adds a new DockableSelectionListener to this desktop.
Adds a new DockableSelectionListener to this desktop.
Adds a new DockableStateChangeListener to this desktop.
Adds a new DockableStateChangeListener to this desktop.
Adds a new DockableStateWillChangeListener to this desktop.
Adds a new DockableStateWillChangeListener to this desktop.
Adds a new DockingActionListener to this desktop.
Registers and add a dockable on an auto-hide border.
Adds a new dockable (and stores its return-to-docked position)
Hook for property change notification
Hook for property change notification
Hook for property change notification
Adds a new separator to this toolbar
Registers a dockable as belonging to a tab group.
Registers a dockable as belonging to a tab group.
Ancestor listener used to install different borders depending on the usage
of the dock view (docked, maximized, tabbed).
Field describing a dockable anchored to the BOTTOM border of its ancestor container
Field describing a dockable anchored to the LEFT border of its ancestor container
Field describing a dockable anchored to the RIGHT border of its ancestor container
Field describing a dockable anchored to the TOP border of its ancestor container
A constraint used to specify how a dockable is tied (anchored) to its containing parent .
Constructor for an immutable contraints
A helper class used to specify and enforce constraints within a container
(DockingPanel or CompoundDockingPanel).
Constructs a new AnchorManager responsible for a container (desktop or compound)
This method is invoked when the animation state change.
state identifying the end of an animation
state identifying a change in the animation (the component has changed of bounds)
state identifying the beginning of an animation
An Event describing the state of an animation
The AnimationListener interface is used to notify listeners about the state
of an animation process (animation start and end).
Applies this workspace to the given docking context (this is equivalent as loading a
workspace file from DockingContext.readXML() : it removes every dockable from the context and
associated desktops, and clears their dockable states, then it reloads the dockables as specified
by this workspace layout.
Invoked when the button is pressed : applies the workspace to the associated context
Invoked when the button is pressed : applies the workspace to the associated context
convenience method to check compatibility between groups
A Layout Manager for auto-hide borders.
The button used to show Dockables in auto-hide borders.
A Swing panel used as a toolbar for autohide buttons.
Constructs a new AutoHideButtonPanel, with a shared expandPanel, and for
a specified border zone.
The UI associated with the AutoHideButtonPanel.
The UI delegate for AutoHideButtons.
A component used to show the currently expanded view.
The UI delegate for the AutoHideExpandPanel component.
This class holds preferences on default autohiding behaviour.
Closing state of the dialog when the user has selected the cancel option
Cancels the animation (the component is not reset to its initial location/size)
Refuse the change of dockable state.
Returns whether we can use the secured and 1.5 MouseInfo class
Cleanup for this manager : removes references and listeners
Clears the state of this expand panel.
removes every dockables from this desktop
Removes the contained desktops
removes all information stored into this desktop, which becomes ready to
be reused.
Disposes the dockable container of this dockable.
Convenience method to close all dockables of the tabbedContainer
containing "base" (including the base dockable).
Convenience method to close all dockables of a TabbedDockableContainer except one.
This method is invoked to hide the pop-up that could still be visible
(To avoid a visible pop-up for an invisible component)
This method is invoked to hide the pop-up that could still be visible
(To avoid a visible pop-up for an invisible component)
Collapse the expand panel (making it unvisible)
The VL Docking Framework for JFC "Swing" applications.
Swing Components Animation.
The animation package provides classes and interface requiered in
component animations for the docking framework.
Events Package of the VLDocking Framework.
UI Package of the docking framework.
This package contains classes related to UI management (look and feel classes). This package contains classes allowing to embed buttons into the tabs of a jtabbedpane.
The VLToolBars.
This packages contains an independant set of components allowing multiple draggable toolbars
to be positionned around a central component.
Comparable interface, used to sort components by name order.
Utility class used to perform move/resize animation for awt/swing components.
Reusable component animator.
Single-shot animator (use another ComponentAnimator for a new animation).
Describes a Dockable that can contain sub-dockables.
Constructs a new CompoundDockable with a given key
A specialized container used to nest dockables inside that sub-part of the
desktop.
Constructs a new CompoundDockingPanel, for a given dockable
installs the icons and tooltip suitable for an attach button
This method is invoked upon adding a button to the toolbar.
Update the buttons to track state changes (for example, the maximize button can become "restore"
when the view is maximized.
installs the icons and tooltip suitable for a close button
installs the icons and tooltip suitable for a dock button
installs the icons and tooltip suitable for a float button
installs the icons and tooltip suitable for a hide button
installs the icons and tooltip suitable for a maximize button
installs the icons and tooltip suitable for a restore button.
Closing state of the dialog when the user has selected the confirm option
Creates a shalow copy of this icon
returns an action suitable for attaching a dockable contained in a floating tab.
Creates the autohide expand panel to be used in this desktop.
returns an action suitable for closing a dockable contained in a tab.
returns an action suitable for closing every dockable contained in a tab.
returns an action suitable for closing every dockable contained in a tab excepted the current one.
Creates a default ToolBarContainer with preinstalled toolbar panels on the borders with
the LEADING alignment.
Creates a default ToolBarContainer with preinstalled toolbar panels on the borders with
the specified alignment
The value of the alignment argument must be one of
FlowLayout.LEFT
, FlowLayout.RIGHT
,
FlowLayout.CENTER
, FlowLayout.LEADING
, or
FlowLayout.TRAILING
.
Creates the default divider.
Returns the component used to modify the expand panel size when expanded from the top.
This method is called by the DockingDesktop whenever a dockable is inserted
in its containment hierachy.
Returns the component used to modify the expand panel size when expanded from the top.
Creates a floating JDialog to be used with this dockable.
Creates a floating JDialog to be used for a whole TabbedDockableContainer.
This method is called when a dockable is detached from the DockingDesktop and put
in the FLOATING state.
This method is called when a dockable is detached from the DockingDesktop and put
in the FLOATING state.
returns an action suitable for floating (detach) a dockable contained in a tab.
returns an action suitable for hiding a dockable contained in a tab.
returns an action suitable for maximizing a dockable contained in a tab.
Adds a view in a tab, or create it if it doesn't exist.
Add a view in a tab, or create it if it doesn't exist.
Creates a tab containing baseTab and newTab (if baseTab is already into a Tab, then
newTab will just be added at the "order" position.
Returns the container used for tabbed docking.
This method is called when a tab insertion is requested by the DockingDesktop.
creates the shared title bar for all expanded panels
This implementation of the factory method return a default DockViewTitleBar
object.
This method is invoked when a dockable container needs to install a title bar.
Creates the component used as a header to drag the window
Creates a new DockingSplitPaneUI instance
Creates a UI for the given component (shared instance)
Creates a new DockingSplitPaneUI instance
Default implementation of the DockableContainerFactory.
the default icon (enabled/visible)
Rejects the drag, but allows the docking system to search for othet drop receiver
in ancestors.
The docking desktop which is the destination of the drag and drop gesture
the desktop managing this view
A DockView suitable for detached dockables (in their own window).
Constructs a new DockView for the given dockable.
The UI of the "detached" (floating) dockview.
the icon for the disabled effect
disposes a detached dockable, regardless of its type (frame or dialog)
Interface describing a component (AWT/Swing) that can be managed by the
DockingDesktop.
the dockable managed by this view
An objet that can provide actions relative to a dockable.
A DockableContainer is the base interface of GUI components used to
display Dockable
components.
An abstract factory used by the DockingDesktop
to create instance
of Dockable containers.
An interface implemented by visual components used for drag and drop operations
on a DockableContainer.
A basic implementation of Dockable.
An interface used to find a dockable (when read from an input stream like XML)
when the only information given is its DockKey id.
An event for tracking selection changes of dockables.
This interface describes a listener for dockable selection changes.
General information about the current state of a dockable component.
Creates a dockable state based on an existing state, with another relative positionning
this method will be called after a dockable component has changed of state
(closed, hidden, docked)
An event triggered after a change of dockable state.
Interface implemented by classes that need to be notified of
a state change of a dockable.
inner state of the dockables
invoked before a dockable state change.
An event triggered before a change of dockable state.
Interface implemented by classes that need to be notified of
a state change of a dockable before it is processed.
A Button that can be used to store a dockable (for example to allow moving a dockable
between two workspaces).
An event describing a drag operation occuring for docking purpose.
Creates an event based on a drag source and a mouse event.
An event send to a dockDropReceiver to complete a drop operation
This event is used by API extenders to manage drag and drop action related to
docking.
An interface implemented by components that can accept docking action with mouse drag and drop.
Abstract superclass of drag and drop docking events.
Constructor for dock events.
This class describes a logical group of Dockables.
Constructs a new dockgroup with a given name.
Constructs a new dockgroup with a given name and a parent group.
A DockingActionEvent describing the first insertion of a dockable either inside a desktop
docking panel (main panel) or into a compoundDockable (nested) container.
Constructor for a DockingActionAddDockableEvent
A DockingActionEvent describing the closing of a dockable
A DockingActionEvent describing a tab insertion (or movement).
A DockingActionEvent involving a single dockable as source of the action.
An abstract event class describing a docking action.
Constructs a new DockingActionEvent
A listener to docking actions.
Invoked once a docking action has been performed.
An event describing a basic state change.
A DockingActionEvent describing a split action (from a base component (splitcontainer, tab...)).
A split event : split a base component in two, and puts a dockable container
in the other split position.
A DockingActionEvent describing a split action (from a base dockable).
A layout adapted to autohide panels.
Constants used by the DockingDesktop to position Dockables.
A context that can be shared by multiple docking desktops.
Constructs a new DockingContext
The DockingDesktop is the main class of the VLDocking Framework.
Constructs a DockingDesktop with a default name (suitable for single-desktop applications).
Constructs a DockingDesktop with a given name (suitable for multiple-desktop applications).
Constructs a DockingDesktop with a given name (suitable for multiple-desktop applications).
This class is responsible for the containment of a Dockable component.
main central container for dockables
This is the centralized settings repository for managing docking look and feel.
A Helper class providing information about the visibility of user components.
Constructor for Dialog parent window.
Constructor for Frame parent window.
A specific UI for removing border effects of the JSplitPanes used for docking.
Central class to manage Look and feel settings for the docking framework.
Utility class implementing search/replace algorithms used by the framework.
Provides a unique identification for a Dockable and runtime properties, like icon, name,
tooltip, preferred audohide-zone...
JavaBeans constructor : If used, also think to set the dockKey property.
Constructs a DockKey with dockKey (unique key) and name set to the same value
Constructs a DockKey with dockKey (unique key) and a displayed name
Constructs a DockKey with dockKey (unique key), a displayed name and a tooltip
Constructs a DockKey with dockKey (unique key), a displayed name, a tooltip and
an icon.
Constructs a DockKey with dockKey (unique key), a displayed name, a tooltip, an icon
and a default autohide border.
A JTabbedPane customized for integration with the docking framework.
DefaultImplementation of the SingleDockableContainer.
Constructs an empty DockView.
Constructs a new DockView for the given dockable.
Constructs a new DockView for the given dockable.
This component is used to display single dockables like if they were in a tabbed pane.
Constructs a new DockView for the given dockable.
A title bar, associated to a DockView (container of a single user component).
Constructs an empty title bar (no dockable yet associated).
Constructs a title bar for the specified dockable.
This is the UI delegate for the DockView class.
Removes a visible dockable : called from a drag and drop operation.
the animation duration in seconds
Returns the action customizer associated to this dockkey (may return null)
Returns a field describing the action (ACTION_CLOSE...).
Returns the alignment of this layout (FlowLayout.LEADING, TRAILING
...)
Returns the anchor value of this contraints object.
Returns an integer value representing the anchoring of the dockable relatively to
its ancestor container.
Returns the autohide border of this dockable, or null if not set
Returns the autohide border of this dockable, or null if not set
Returns the optional background painter for this toolbar panel (may be null)
Returns the dockable used as a reference to create a tab (may already belong to a tab)
Returns the dockable which will be used as a base for the splitting
Returns the dockable which will be used as a base for the splitting
Returns the border this panel is for.
Returns the component used to modify the expand panel size when expanded from the top
Returns the users close choice as CONFIRM or CANCEL (remember this dialog is modal).
Returns the component used by this dockable.
returns the component wrapped.
Returns the component for a given BorderLayout constraints
Returns and ordered array of the contained components
Returns the BorderLayout constraints of the given component
Returns the docking context used by this desktop (might be shared with other desktop).
this method will return null when the event is triggered for initial docking
Returns the default gap between border components
Returns the default hide border (used when not specified in a DockKey)
Returns the desktop currently using this dockable, or null if none
Returns a reference of the desktop in which the docking event takes place.
Returns the desktop used as a receiver (target) of the docking action.
Returns the desktop associated to this title bar, if one has been registered
with #installDocking(DockingDesktop), or null.
Returns the index-th desktop contained
Returns a desktop identified by its name or null if not found
Return the number of desktops contained in this workspace (default is 1 )
Returns a list of the desktops sharing this context
Returns the name of this desktop (used by workspace management)
Returns the name of this desktop (which must match the name of a real desktop if more than one desktops are used )
Returns the disabled icon
Returns the dockable this button is for
Returns the dockable this container is displaying
Returns the compound dockable this container is for
Returns the Dockable
component this source is for
Returns the dockable this state is for
Return the dockable currently stored (may be null)
Returns the contained component
Returns the dockable this container is displaying
Returns the dockable at the index tab
Returns the (registered) dockable corresponding to the given key id,
or null if not found
Note : since VLDocking 2.1.2, this method also tries to use its DockableResolver
if null would have been returned.
Returns the anchor constraints associated to a given dockable
returns the DockableContainer responsible for displaying the associated dockable
returns the DockableContainer responsible for displaying the associated dockable
returns the DockableContainer responsible for displaying the associated dockable
Returns the container of the dockable's component
Returns the tab index of the dockable corresponding to the given key, or null if the dockable
doesn't belong to this tab.
Returns the dockable resolver used by this context (or null if none defined)
Creates and returns an array of all registered dockable with their current
state.
Creates and returns an array of all registered dockable with their current
state.
constructs and returns the list of dockables corresponding to a desktop, at a specific state
returns the current visible dockableState of the dockable (see DockableState.STATE_ for enumaration values)
Returns the current state of a dockable (CLOSED, HIDDEN, DOCKED, MAXIMIZED, FLOATING)
Returns the current state of a dockable (CLOSED, HIDDEN, DOCKED, MAXIMIZED, FLOATING)
Returns a DockableState value corresponding to this component or -1 if not found.
returns the dockGroup of this dockable
Returns the DockingActionEvent corresponding to the drag and drop gesture
Returns the docking context used by this button
Returns the docking context used by this menu item
Returns a String containing the release date of the current version.
Returns a String containing the version of the docking framework in the format M.m.r
where M is the major , m the minor and r the release.
recalculates and returns the insets taken by autoexpand
borders around the docking panel.
Returns the key used to describe this dockable
returns the unique key identifying the docked element
Returns the border used during drag and drop or the toolbar
Returns a reference to the drag source of this event.
Returns the shape to display if drag is accepted.
Returns the duration of the animation
Returns the Icon used with this button when no dockable is selected
Returns the text used for this button when no dockable is stored
Returns the text used as tooltip for this button when no dockable is stored
Returns the end bounds of the components.
Returns the expand mode in use.
Returns the expansion duration (in millis)
Returns the current factory.
returns the button used for floating (detach) the view.
Returns the text used for this button when a dockable is stored
Returns the text used for as tooltip this button when a dockable is stored
Returns the future (proposed) state of the dockable.
Returns the relative height of the dockable
returns the button used for hiding or docking the view.
Returns the icon displayed in title bars
Returns the height of this icon
Returns the width of this icon
Returns one of the DockableState states reflecting the state of the dockable before the action
Returns a proposed TooBarContraints for a given insertion point
returns the list of toolbars that were successfully loaded from the toolbarIO operation
returns the singleton instance used to store and install UI settings for the framework
Returns the key of the dockable
Returns the unique id designating the user component.
returns the inner key of this object (which must match a DockKey's 'key' instance variable)
Returns the component used to modify the expand panel size when expanded from the right
Return the local tooltip of this icon (the one associated with inner mouse movements)
returns the currently maximized dockable
(or null if no dockable is in that state)
returns the button used for maximizing or restoring the view.
Returns the MouseEvent which is the cause of this DockEvent.
Returns the mouse location on screen or null if ran in an untrusted environement/ java 1.4
returns the name of this group (which is used as an internal key)
Returns the name (or title) displayed in title bars
returns the new state of the dockable
Returns one of the DockableState states reflecting the state of the dockable after the action
returns the list of toolbars that weren't loaded from the stream (but registered)
Returns the order of insertion in the tabbed container
Returns the orientation of this gripper (SwingConstants.HORIZONTAL/VERTICAL)
Returns the orientation of this toolbarpanel
returns the parent of this group (may be null)
Returns the parent container into which this dockable will be added
returns a dividor location value for the parent split container, or -1 if not needed
This value is used to express inserting a component with same orientation of the
parent split container (like : transform A|B into [A|child]|B : we need to adjust
A|child dividor, and also [] | B dividor).
Returns the singleton instance of this class
Returns the relative restore position of the dockable when it is not shown (auto-hide
or closed).
Evaluates and returns the preferred size of the desktop, according to
its contents and auto-hide borders.
Returns the previous state of a hidden or floating dockable (when that dockable
was in the DOCKED state.
returns the previous state of the dockable, or null if the component
wasn't known to the docking desktop before.
returns a property associated to this name, or null if the property is undefined
Returns the list of currently registered toolbars.
Returns the ancestor container used as a reference for the relative potionning
This can be a DockingPanel (top level ancestor) or CompoundDockingPanel (intermediate ancestor)
Returns the component used to modify the expand panel size when expanded from the right
Returns the rollover icon
Returns the rollover trigger delay (in millis)
returns the root pane used by this detached dockable container, regardless of its type (frame or dialog)
Returns the currently selected Dockable
Returns the currently selected dockable, or null if none is selected.
Returns the currently selected (front) dockable
returns the source of animation
Returns the split pane containing this dockable (if any), or null if this dockable
isn't contained in a splitpane.
Returns the start bounds of the component.
returns the state of the animation (ANIMATION_START, ANIMATION_FRAME or ANIMATION_END)
Returns the current state of the dockable (CLOSED, DOCKED, HIDDEN...).
Returns a litteral representation of the given state
Returs the current tab count (which is also the current dockable count)
Returns the tab name (or tab title) displayed when the component is contained into a tabbed container.
Returns a suitable name for when this container is the main child of a Tab (TabbedDockableContainer)
Returns (or creates) the title bar of this dockview
Returns the label used to display the dockkey name.
Returns the registered toolbar associated with the given name, or null if not found
Returns the ToolBarPanel for a given BorderLayout constraints
Returns the tooltip associated to the title bar
Return the tooltip of this icon
Returns the component used to modify the expand panel size when expanded from the bottom
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).
Overriden for custom UI delegation
Return the list of toolbars names (String) found in the stream but not registered
(these toolbars cannot be loaded, so the API can only report their name).
Returns the number of buttons currently displayed by this panel.
Returns the relative width of the dockable
Returns the workspace used by this button
Returns the workspace used by this menu item
Returns the relative x position of the dockable
Returns the relative y position of the dockable
Returns the border zone of this button
the "grip" (an alpha blended dot image, 3*3 pixels, hightlighted underneath )
Returns the index of the given dockable
initialisation of the title bar
Initialize the button for a Dockable and a border zone
Installs borders used to drag the expand panel around
Init the popup displayed as the title bar contextual menu
Init the popup displayed as the title bar contextual menu
Facade method used to allow mixing of lightweight and heavyweight components in the
desktop.
Facade method used to allow mixing of lightweight and heavyweight components in the
desktop.
Init the popup displayed as the title bar contextual menu
Init the popup displayed as the title bar contextual menu
installs the eyboard shortcuts
installs the autohide related properties
Installs the default background of the title bar
Installs the borders of this dialog and its title header
configure the title bar buttons
Install custom UI for this button : a light rollover effet and a custom rounded/shaded border.
installs the closable tabs properties
Installs or not the window decorations on this dialog.
installs the DockinDesktop related properties
This method is used by DockableContainers in order to register their
DockableDragSource(s) to the DragControler.
Installs multiple drag sources.
Invoked once after creation, in order to let this component register
its DockableDragSources to the DockingDesktop, and have a reference of this
Desktop.
This install method is invoked before adding the first dockable
installs the DockView related properties
installs the DockVieTitleBar related properties
installs the FloatingDialog related properties
installs icons used by the framework
Installs default on the titlebar label
Installs a border when the DockView target is unique on the desktop (mamimized, or alone)
Default is a shadow border without top and left shadows
Used internally to add a mouse listener to the button.
installs the components used for resizing (on left/right/bottom borders)
Installs a border when the DockView target is a SingleDockableContainer
(not nested in a tabbed container )
default is a shadowed border.
installs the splitpanes related properties
installs the tabbed pane related properties
Installs a border when the DockView target is included in a TabbedDockableContainer.
installs the border of the title bar
installs the toolbar related properties
Installs the UI settings.
Installs the component's UI
installs the UI and sets the preferred size of the gripper
Returns true if this panel is the ancestor of the focused component
Returns true if the dockable is the currently active one.
returns true if this group is the ancestor of group g.
Returns try if autohiding is enabled
checks if this dockable is a child of a compound dockable
Convenience method returning wether the dockable is in the CLOSED state
Returns true if this dockable can be closed
Return true is this toolbar is currently collapsed
Returns true if this toolbar is currently collapsed
Return true is this toolbar can be collapsed (default is true)
returns true is this group is compatible with the given parameter.
Convenience method returning wether the dockable is in the DOCKED state
returns true if drag is accepted.
If drag is not accepted, this method will be invoked to evaluate
a delegating event processing.
Indicates if the drop operation is accepted.
Returns the enabled state
Returns true if this dockable can be detached from its desktop
Convenience method returning wether the dockable is in the FLOATING state
Utility method to find out if a component is heavyweight (of if it contains a heavyweight comp)
Convenience method returning wether the dockable is in the HIDDEN state
Convenience method returning wether the dockable is in the MAXIMIZED state
Returns true if this dockable can be maximized
Returns true is a notification has been set.
Returns whether this desktop's contents are opaque or not.
Returns the pressed state
Returns the rollover state
Returns the state of the rolloverBorderPainted property
Returns the value of the rolloverContentAreaFilled property
True when the button is currently selected.
Field for installing settings only once
Returns wether this customizer is used in the context of a SingleDockableContainer
Returns wether this customizer is used in the context of a TabbedDockableContainer
Return the value of the useCustomUI property
Returns the visible state
packs a detached dockable, regardless of its type (frame or dialog)
overriden for a bug workaround reason
Overriden to paint properly the button on vertical sides.
Custom title bar painting : uses a gradient from the background color
to the control highlight color.
Overriden for optional background painting
paints the icon (and the associated label and sub-icons)
paints the appropriate icon according to its internal state (pressed, rollover...)
Constant used to describe the type of usage a SingleDockableContainer is for
Constant used to describe the type of usage a SingleDockableContainer is for
Constant used to describe the type of usage a SingleDockableContainer is for
Constant used to describe the type of usage a SingleDockableContainer is for
The pop-up menu used to provide fast "close" shortcuts (close all, close others)
the tab currently associated with the pop-up
the icno for the pressed effect
return state for floating dockables
The tab that was selected before the current one
act the same as a splitContainer : allow drop on the borders
when a dockable is dragged above this button, the button stores it as its new
target dockable.
The component is notified of a drag operation.
act the same as a splitContainer : allow drop on the borders
maximized dockable don't support drag and drop
Rejects the drop as this action isn't possible on this component
The component is requested to perform a docking drop action.
Please note that a drag into a DockView can also lead to create a DockTabbedPane.
maximized dockable don't support drag and drop
Please note that a drag into a DockView can also lead to create a DockTabbedPane.
Property name designating the autohide button selection
Key identifying a change in the autohideEnabled property
The property name associated with the "border" property
Key identifying a change in the closeEnabled property
Property name designating the close button selection
a constant designing the bound property DEFAULT_GAP
a constant designing the bound property DEFAULT_HIDE_BORDER
Key identifying a change in the dockable dockableState
Key identifying a change in the dockKey property
Property name designating a drag gesture beginning
a constant designing the bound property EXPAND_MODE
Constant for the Expanded property (a bound property)
a constant designing the bound property EXPANSION_DURATION
Property name designating the float button selection
Key identifying a change in the floatableEnabled property
Key identifying a change in the icon property
Key identifying a change in the maximizedEnabled property
Property name designating the maximized button selection
Key identifying a change in the name property
Key identifying a change in the notification property
Id for the orientation property
a constant designing the bound property ROLLOVER_TRIGGER_DELAY
Key identifying a change in the tabname property (title used by tabbed containers)
Key identifying a change in the tooltip property
property name associated to the "zone" (border) property
Listen to property changes in the DockKey or the title bar
Do not call directly as it a side effect of listening to the action changes.
Associates an anchor constraints to a given dockable
Allows any property to be stored in a map associated with this dockkey.
Reads an XML encoded stream as the new desktop configuration.
Reads an XML encoded stream as the new desktop configuration.
Reads an XML encoded stream as the toolbar configuration.
Every dockable must be registered in order to be managed by a DockingDesktop.
Every dockable must be registered in order to be shown in the DockingDesktop.
All dockables must be registered (even if not shown) in order to be processed
by the XML Parser or to be displayed in the DockingSelectorDialog
Used to reject the drag (e.g.
It is still time to reject a drop, although the standard way is by denying the
previous drag operation.
This class is an immutable object used to remember the relative positionning
of docked components.
Constructs an empty relative position (all fields are initialized with 0.0 values)
Constructs a relative position with a given location and size, relative to a container
Constructs a relative position with given location and size.
Removes an AutoHideButton
Removes a dockable (if it was the currently expanded one)
Removes a visible dockable from the containment hierarchy (including autohide border buttons).
Overriden to keep track of component constraints
Overriden to keep track of component constraints
Overriden to keep track of component constraints
Removes a dockable container.
Removes a desktop from this context
Removes a dockable from the tabs
Remove the dockable at specified index tab
Removes an anchor constraints to a given dockable
Removes a DockableSelectionListener from this desktop.
Removes a DockableSelectionListener from this desktop.
Removes a DockableStateChangeListener from this desktop.
Removes a DockableStateChangeListener from this desktop.
Removes a DockableStateWillChangeListener from this desktop.
Removes a DockableStateWillChangeListener from this desktop.
Removes a DockingActionListener from this desktop.
Unregisters a dockable from its current tab group (when it's removed from it).
Overriden as a means to unregister internal listeners, do not call directly
returns and removes a property associated to this name, or null if the property is undefined
Remove a property change notification
Remove a property change notification
Remove a property change notification
Replaces a dockable by another one.
Creates the default borders for the expand panel
Updates the current relative ancestor container and anchor positionning
Request this desktop to reset it's contained views to their preferred size, if
possible.
Resest recursively the left and right components to their preferred size
if possible.
Returns the dockable which should be associated to this DockKey identifier, or null if
not found.
Restore the dockable to the docking position it was before beeing maximized.
convenience field referencing the RIGHT border of the DockingDesktop
convenience field referencing the CENTER part of the RIGHT border of the DockingDesktop
panel used to display autohide buttons
A custom Icon to have a nice rollover effect for toolbar icons.
the icon for the rollover effect
Save the toolbar configuration.
Save the toolbar configuration.
Selects a button (may collapse a prevoiusly selected button)
This method is invoked when a new dockable is selected.
Updates the action customizer of this dockable
Updates the active property.
Toggles the position of a view between hidden (true) and docked (false).
Updates the autohide border property
Updates the autohide border property
Updates the autohideEnabled propety.
Updates the resizing behaviour of the desktop in order to resize
this dockable (and keep others at fixed size).
Change the cancel button text (hook for i18n)
Change the cancel button tootip text (hook for i18n)
Updates the closeEnabled propety.
Hides the toolbar (just showing the gripper)
Removes all contained components (normally no more than one), and
put this comp
on the center area of the BorderLayout.
Change the confirm button text (hook for i18n)
Change the confirm button tooltip text (hook for i18n)
Updates the docking context used by this desktop.
Another docking style with custom tiles between dockables.
Updates the gap (in pixels) between auto-hide buttons
Updates the default hide border.
Updates the desktop field (desktop using this dockable)
Updates the name of this desktop (used by workspace management)
Updates the name of this workspace desktop
Update the disabled icon property
Overriden for a bug workaround
Adds the dockable's component to this DockView.
Adds the dockable's component to this DockView.
Changes the dockable this title bar is for
Changes the height of a dockable (the dockable must already be visible).
Updates the dockable resolver used by this context (can be set to null)
Updates the current state of a dockable
updates the dockableState property.
Changes the width of a dockable (the dockable must already be visible).
Updates the dockGroup of this dockable.
Set the docking action corresponding to this drag and drop gesture.
Updates the docking context used by this button
Updates the docking context used by this menu item
Requiered to initialize this dialog.
Another docking style with ligh dots between dockables.
Changes the border used during drag and drop of the toolbar.
if true, the UI will paint shadowed dots along the split pane divider,
if false, the divider will remain empty.
Sets the duration of the animation.
Updates the icon used for this button when no dockable is stored
updates the text used for this button when no dockable is stored
Updates the text used as tooltip for this button when no dockable is stored
Sets the end bounds of the component.
Updates the expansion duration (time in millis)
Changes the factory to be used by DockingDesktop.
Convenience method to use the VLDocking 2.0 layout and border style.
Updates the floatEnabled propety.
Detach or attach the dockable from/to the desktop.
Detach or attach the dockable from/to the desktop.
Adds a new floating dockable
Returns the text used for this button when a dockable is stored
Updates the text used as tooltip for this button when no dockable is stored.
Updates the icon property.
Update the main icon (left) to be displayed on the tab
Update the default icon property
Specify which container will use this icon.
adds the initial dockable to this top-level container
adds the initial tabbdeddockablecontainer to this top-level container.
Allows replacement of the settings instance (used to override global look and feel
settings of the framework.
Updates the dockKey property.
Update the label to be displayed on the tab
A simple utility method to configure the docking framework to work properly with
heavyweight component.
positions a detached dockable, regardless of its type (frame or dialog)
positions a detached dockable, regardless of its type (frame or dialog)
Sets the maximized dockable of this desktop, (or null if no dockable maximized).
Updates the maximizeEnabled propety.
Updates the name property.
Updates the notification propety.
Set the desktop contents to be opaque or transparent.
Updates the orientation of this toolbar.
Updates the optional background painter for this toolbar panel
Updates the parent of this group
Update the pressed icon property
updates the resize weight of this dockable.
Update the rollover state
Updates the rolloverBorderPainted property.
Updates the rolloverContentAreaFilled property.
Update the rollover icon property
Updates the rollover trigger delay
Selects or unselects the button
Change the tab selection to display this dockable
Convenience method to use the VLDocking 1.0 layout and border style (with shadows around dockables)
Updates the singleDockableTitleBar property.
Notifies the framework that there is only one dockable that is heavyweight.
resizes a detached dockable, regardless of its type (frame or dialog)
Sets the start bounds of the component for animation.
Updates the tabname property.
Updates the tabSelectorDockableTitleBar property
Updates the tooltip property.
Update the tooltip of this icon
Updates the tooltip of the toolbar, and propagates it to the toolbar gripper.
Updates the useCustomUI property.
shows a detached dockable, regardless of its type (frame or dialog)
Change the wizard label text (an explanation of the behaviour of this dialog).
updates the workspace to be used by this button
updates the workspace to be used by this menu item
A border using a shadow on right-bottom sides.
Constructs a full shadow border (if paintTopLeft is true) or a half shadow border
(is false).
Returns true if this panel agrees to beeing hidden.
A SingleDockableContainer is a DockableContainer that can display
a single Dockable
component.
smart icon used to display the title
A sub component of JTabbedPaneSmartIcon, used to describe a button included in a tabbedpane.
Constructs a new button with an action.
Typesafe enumeration describing a split operation on the DockingDesktop.
Splits a Dockable in 2 parts, if possible.
This method should be overriden if the delegator doesn't belong to the
docking containment hierarchy after drop acceptance.
Splits a dockable (with a given split location)
Replaces the child component by a sub-split pane.
A constant describing a VERTICAL splitting operation where the new component
goes on the BOTTOM part
A constant describing an HORIZONTAL splitting operation where the new component
goes on the LEFT part
A constant describing an HORIZONTAL splitting operation where the new component
goes on the RIGHT part
A constant describing a VERTICAL splitting operation where the new component
goes on the TOP part
Replaces the base component by a split pane oriented according to position,
and put dockable at position.
Replaces the base component by a split pane oriented according to position,
and put the dockablesContainer at position.
A Specialized JSplitPane which accepts drag and drop of DockableContainer.
Constructs a vertically splitted SplitContainer
Constructs a SplitContainer with the given JSplitPane orientation.
the component's start bounds
Notifies this source that a drag operation has begun.
Notifies this source that a drag operation has begun.
A constant describing a Dockable that is not visible.
A constant describing a Dockable that is visible (displayed in a DockableContainer)
A constant describing a Dockable that is currently floating (detached from the desktop)
A constant describing a Dockable that is in auto-hide mode (reduced to a button)
A constant describing a Dockable that is currently maximized
Swaps two toplevel DockableContainers (their parent must be a SplitContainer)
An utility class providing default implementation of usefull actions for pop-up
menus in tab container selectors.
Interface describing a container that can be used to display more than
one Dockable in a Tabbed Pane fashion.
A DockView that can be nested into a TabbedDockableContainer
Constructs a new DockView for the given dockable.
groups of tabs (used to re-tab autohidden dockable)
groups of tabs (used to re-tab autohidden dockable)
A factory that replaces DockViews (with title headers) by tabbed panes with a single tab.
Class used as a title for dragging the window around
A border suitable for toolbar buttons.
Constraints to be used with the ToolBarLayout.
Constructs a new ToolBarConstraints at (0,0)
Constructs a new ToolBarConstraints at (majorOrder,minorOrder).
The container for toolbar panels.
The component used to have a "grip" action on a toolbar (Drag and Drop support)
The default UI for the toolbar gripper.
Constructs a new gripper UI
A utility class used to save and restore toolbars to/from an XML configuration.
Constructs a new ToolBarIO utility based on the given container
Descriptor of the loading operation of toolbars.
The toolbar panel is able to receive multiple toolbars and arrange them in
many columns or rows (depending on the horizontal/vertical orientation).
Constructs a new toobar panel with a LEADING alignment.
Constructs a new ToolBarPanel
with the specified
alignment.
Constructs a new ToolBarPanel
with the specified
alignment and background painter.
This is an optional class that can be used as a border for toolbar panels.
The layout of a VLToolBarPanel
This class contains methods to keep a set of toolbars persistent.
Construct a new set of persistent toolbars.
the tooltip associated with the button
convenience field referencing the TOP border of the DockingDesktop
convenience field referencing the CENTER part of TOP border of the DockingDesktop
convenience field referencing the TOP-LEFT corner of the DockingDesktop
convenience field referencing the TOP-RIGHT corner of the DockingDesktop
panel used to display autohide buttons
Returns a readeable String representing this title bar
Returns a meaningfull string representation of this RelativeDockablePosition
Returns a readable String representing this SplitContainer
Returns a description of these constraints.