Class DockableComponentWrapper
- All Implemented Interfaces:
EventListener
,Dockable
,DockingListener
,DockingMonitor
Dockable
implementation for wrapping a
Component
. It is essentially the simplest means to turning a generic
Component
into a Dockable
instance. Compound
Dockables
may have separate child components that are responsible for
drag initiation, whereas another component is the actual drag source. This is
shown in the manner that a JInternalFrame
would be a draggable
component, while the frame's title pane is the actual drag initiator.
The class, conversely, deals with the simple case, where a
Component
itself must be docking-enabled.
DockableComponentWrapper
wraps a Component
and implements the
Dockable
interface. Since the Component
itself is being
docking-enabled, it serves as both the drag source and drag initiator. Thus,
getComponent()
will return a reference to 'this'
and
getDragSources()
return a List
containing the same
self-reference Component
.
This class may be used by application code to enable docking capabilities on
a given Component
. However, it is recommended that
DockingManager.registerDockable(Component evtSrc, String desc)
be
used as a more automated, less invasive means of enabling docking on a
component.
DockingManager.registerDockable(Component evtSrc, String desc)
will
automatically create a DockableComponentWrapper
instance and register
the required drag listeners.
- Author:
- Chris Butler
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.flexdock.docking.event.DockingListener
DockingListener.Stub
-
Field Summary
Fields inherited from interface org.flexdock.docking.Dockable
DOCKABLE_INDICATOR
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addDockingListener
(DockingListener listener) Adds aDockingListener
to observe docking events for thisDockable
.void
Adds a PropertyChangeListener to the listener list.static DockableComponentWrapper
Creates aDockableComponentWrapper
instance using the specified source component, persistent ID, and docking description.static DockableComponentWrapper
create
(DockingAdapter adapter) static DockableComponentWrapper
create
(DockingStub stub) boolean
Provides the defaultDockable
implementation ofdock(Dockable dockable)
by calling and returningDockingManager.dock(Dockable dockable, Dockable parent)
.boolean
Provides the defaultDockable
implementation ofdock(Dockable dockable, String relativeRegion)
by calling and returningDockingManager.dock(Dockable dockable, Dockable parent, String region)
.boolean
Provides the defaultDockable
implementation ofdock(Dockable dockable, String relativeRegion, float ratio)
by calling and returningDockingManager.dock(Dockable dockable, Dockable parent, String region, float proportion)
.void
No operation.void
No operation.void
dragStarted
(DockingEvent evt) No operation.void
dropStarted
(DockingEvent evt) No operation.getClientProperty
(Object key) Returns the value of the property with the specified key.Returns theComponent
used to create thisDockableComponentWrapper
instance.Returns an array of allDockingListeners
added to thisDockable
.Returns theDockingPort
within which thisDockable
is currently docked.Returns aDockablePropertySet
instance associated with thisDockable
.Returns aList
ofComponents
used to initiate drag-to-dock operation.Returns aHashSet
ofComponents
used as frame drag sources when thisDockable
is floating in a non-decorated external dialog.Returns the persistent ID of thisDockableComponentWrapper
instance provided when this object was instantiated.void
putClientProperty
(Object key, Object value) Adds an arbitrary key/value "client property" to thisDockable
.void
removeDockingListener
(DockingListener listener) Removes the specifiedDockingListener
from thisDockable
.void
Removes a PropertyChangeListener from the listener list.void
No operation.void
No operation.
-
Method Details
-
create
Creates aDockableComponentWrapper
instance using the specified source component, persistent ID, and docking description. This method is used to createDockable
instances for simpleComponents
where the drag source and drag initiator are the sameComponent
.If
src
orid
arenull
, then this method returns anull
reference.src
will be theComponent
returned by invokinggetComponent()
on the resultingDockable
and will be included in theList
returned bygetDragSources()
.id
will be the value returned by invokinggetPersistentId()
on the resultingDockable
.desc
may be used by theDockable
for descriptive purposes (such as tab-text in a tabbed layout). It is not recommended to supply anull
value fordesc
, but doing so is not illegal.- Parameters:
src
- the source componentid
- the persistent ID for the Dockable instancedesc
- the docking description- Returns:
- a new
DockableComponentWrapper
instance - See Also:
-
create
-
create
-
getComponent
Returns theComponent
used to create thisDockableComponentWrapper
instance.- Specified by:
getComponent
in interfaceDockable
- Returns:
- the
Component
used to create thisDockableComponentWrapper
instance. - See Also:
-
getDragSources
Returns aList
ofComponents
used to initiate drag-to-dock operation. By default, the returnedList
contains theComponent
returned bygetComponent()
.- Specified by:
getDragSources
in interfaceDockable
- Returns:
- a
List
ofComponents
used to initiate drag-to-dock operation. - See Also:
-
getPersistentId
Returns the persistent ID of thisDockableComponentWrapper
instance provided when this object was instantiated.- Specified by:
getPersistentId
in interfaceDockable
- Returns:
- the persistent ID of this
DockableComponentWrapper
- See Also:
-
getFrameDragSources
Returns aHashSet
ofComponents
used as frame drag sources when thisDockable
is floating in a non-decorated external dialog. TheHashSet
returned by this method is initially empty. Because it is mutable, however, newComponents
may be added to it.- Specified by:
getFrameDragSources
in interfaceDockable
- Returns:
- a
HashSet
ofComponents
used as frame drag sources when thisDockable
is floating in a non-decorated external dialog. - See Also:
-
addDockingListener
Adds aDockingListener
to observe docking events for thisDockable
.null
arguments are ignored.- Specified by:
addDockingListener
in interfaceDockingMonitor
- Parameters:
listener
- theDockingListener
to add to thisDockable
.- See Also:
-
getDockingListeners
Returns an array of allDockingListeners
added to thisDockable
. If there are no listeners present for thisDockable
, then a zero-length array is returned.- Specified by:
getDockingListeners
in interfaceDockingMonitor
- Returns:
- an array of all
DockingListeners
added to thisDockable
. - See Also:
-
removeDockingListener
Removes the specifiedDockingListener
from thisDockable
. If the specifiedDockingListener
isnull
, or the listener has not previously been added to thisDockable
, then noException
is thrown and no action is taken.- Specified by:
removeDockingListener
in interfaceDockingMonitor
- Parameters:
listener
- theDockingListener
to remove from thisDockable
- See Also:
-
dockingCanceled
No operation. Provided as a method stub to fulfull theDockingListener
interface contract.- Specified by:
dockingCanceled
in interfaceDockingListener
- Parameters:
evt
- theDockingEvent
to respond to.- See Also:
-
dockingComplete
No operation. Provided as a method stub to fulfull theDockingListener
interface contract.- Specified by:
dockingComplete
in interfaceDockingListener
- Parameters:
evt
- theDockingEvent
to respond to.- See Also:
-
undockingComplete
No operation. Provided as a method stub to fulfull theDockingListener
interface contract.- Specified by:
undockingComplete
in interfaceDockingListener
- Parameters:
evt
- theDockingEvent
to respond to.- See Also:
-
undockingStarted
No operation. Provided as a method stub to fulfull theDockingListener
interface contract.- Specified by:
undockingStarted
in interfaceDockingListener
- Parameters:
evt
- theDockingEvent
to respond to.- See Also:
-
dragStarted
No operation. Provided as a method stub to fulfull theDockingListener
interface contract.- Specified by:
dragStarted
in interfaceDockingListener
- Parameters:
evt
- theDockingEvent
to respond to.- See Also:
-
dropStarted
No operation. Provided as a method stub to fulfull theDockingListener
interface contract.- Specified by:
dropStarted
in interfaceDockingListener
- Parameters:
evt
- theDockingEvent
to respond to.- See Also:
-
getClientProperty
Returns the value of the property with the specified key. Only properties added withputClientProperty
will return a non-null
value. Ifkey
isnull
, anull
reference is returned.If the
Component
returned bygetComponent()
is an instance ofJComponent
, then this method will dispatch to thatJComponent's
getClientProperty(Object, Object)
method. Otherwise, thisDockableComponentWrapper
will provide its own internal mapping of client properties.- Specified by:
getClientProperty
in interfaceDockable
- Parameters:
key
- the key that is being queried- Returns:
- the value of this property or
null
- See Also:
-
putClientProperty
Adds an arbitrary key/value "client property" to thisDockable
.null
values are allowed. Ifkey
isnull
, then no action is taken.If the
Component
returned bygetComponent()
is an instance ofJComponent
, then this method will dispatch to thatJComponent's
putClientProperty(Object, Object)
method. Otherwise, thisDockableComponentWrapper
will provide its own internal mapping of client properties.- Specified by:
putClientProperty
in interfaceDockable
- Parameters:
key
- the new client property keyvalue
- the new client property value; ifnull
this method will remove the property- See Also:
-
getDockingProperties
Returns aDockablePropertySet
instance associated with thisDockable
. This method returns the default implementation supplied by the framework by invokinggetDockablePropertySet(Dockable dockable)
onorg.flexdock.docking.props.PropertyManager
and supplying an argument ofthis
.- Specified by:
getDockingProperties
in interfaceDockable
- Returns:
- the
DockablePropertySet
associated with thisDockable
. This method will not return anull
reference. - See Also:
-
getDockingPort
Returns theDockingPort
within which thisDockable
is currently docked. If not currently docked, this method will returnnull
.This method defers processing to
getDockingPort(Dockable dockable)
, passing an argument ofthis
.- Specified by:
getDockingPort
in interfaceDockable
- Returns:
- the
DockingPort
within which thisDockable
is currently docked. - See Also:
-
dock
Provides the defaultDockable
implementation ofdock(Dockable dockable)
by calling and returningDockingManager.dock(Dockable dockable, Dockable parent)
.'this'
is passed as theparent
parameter. -
dock
Provides the defaultDockable
implementation ofdock(Dockable dockable, String relativeRegion)
by calling and returningDockingManager.dock(Dockable dockable, Dockable parent, String region)
.'this'
is passed as theparent
parameter. -
dock
Provides the defaultDockable
implementation ofdock(Dockable dockable, String relativeRegion, float ratio)
by calling and returningDockingManager.dock(Dockable dockable, Dockable parent, String region, float proportion)
.'this'
is passed as theparent
parameter.- Specified by:
dock
in interfaceDockable
- Parameters:
dockable
- theDockable
to dock relative to thisDockable
relativeRegion
- the docking region into which to dock the specifiedDockable
ratio
- the proportion of available space in the resulting layout to allot to the new siblingDockable
.- Returns:
true
if the docking operation was successful;false
otherwise.- See Also:
-
addPropertyChangeListener
Description copied from interface:Dockable
Adds a PropertyChangeListener to the listener list. The listener is registered for all bound properties of this class. Note that if this Dockable is inheriting a bound property, then no event will be fired in response to a change in the inherited property.If listener is null, no exception is thrown and no action is performed.
- Specified by:
addPropertyChangeListener
in interfaceDockable
- Parameters:
listener
- the PropertyChangeListener to be added- See Also:
-
removePropertyChangeListener
Description copied from interface:Dockable
Removes a PropertyChangeListener from the listener list. This method should be used to remove PropertyChangeListeners that were registered for all bound properties of this class.If listener is null, no exception is thrown and no action is performed.
- Specified by:
removePropertyChangeListener
in interfaceDockable
- Parameters:
listener
- the PropertyChangeListener to be removed- See Also:
-