|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Dockable
A Dockable
is a window which can be dragged around by the user. Dockable
s
need to have a DockStation
as parent, otherwise they are not visible.
Several properties are associated with a Dockable
:
DockTitle
s is managed by the parent of this Dockable
. The icon and the title-text
of this Dockable
might be painted on that title.DockAction
s is stored in a DockActionSource
. These actions are displayed
on the title(s) and allow users to execute operations that belong to this Dockable
Component
which represents the contents of this Dockable
DefaultDockable
or extending AbstractDockable
.
Method Summary | |
---|---|
boolean |
accept(DockStation station)
Tells whether station is an accepted parent for this
Dockable or not. |
boolean |
accept(DockStation base,
Dockable neighbor)
Tells whether base could be the parent of a combination
between this Dockable and neighbor . |
void |
addDockableListener(DockableListener listener)
Adds a listener to this Dockable. |
void |
addDockableStateListener(DockableStateListener listener)
Adds listener to this Dockable . |
void |
addDockHierarchyListener(DockHierarchyListener listener)
Adds a hierarchy-listener to this Dockable. |
void |
addMouseInputListener(MouseInputListener listener)
Adds a MouseInputListener to the component of this Dockable . |
void |
bind(DockTitle title)
Called by clients which want to show a title of this Dockable . |
void |
configureDisplayerHints(DockableDisplayerHints hints)
Orders this Dockable to configure hints which will
be used by the parent component of this element. |
Component |
getComponent()
Gets the Component which represents this Dockable . |
DockController |
getController()
Gets the current controller, the argument of the last call of setController(DockController) . |
DockStation |
getDockParent()
Gets the current parent, which is the latest argument of setDockParent(DockStation) . |
DockActionSource |
getGlobalActionOffers()
Gets a list of all DockAction s which
might be triggered while this Dockable is visible. |
DockActionSource |
getLocalActionOffers()
Gets a list of DockAction s which should be triggerable if
this Dockable is visible. |
Icon |
getTitleIcon()
Gets the current icon of this Dockable . |
String |
getTitleText()
Gets the current title-text of this Dockable . |
String |
getTitleToolTip()
Gets a tooltip that is associated with this Dockable and
that should be shown on any DockTitle . |
boolean |
isDockableShowing()
Tells whether this Dockable can be seen by the user. |
boolean |
isDockableVisible()
Deprecated. replaced by isDockableShowing() , this method will be removed in a future release |
DockTitle[] |
listBoundTitles()
Gets a list of all DockTitles which are currently
bound to this Dockable . |
void |
removeDockableListener(DockableListener listener)
Removes a listener from this Dockable. |
void |
removeDockableStateListener(DockableStateListener listener)
Removes listener from this element. |
void |
removeDockHierarchyListener(DockHierarchyListener listener)
Removes a hierarchy-listener from this Dockable. Note: when using a DockHierarchyObserver ,
forward the call directly to DockHierarchyObserver.removeDockHierarchyListener(DockHierarchyListener) |
void |
removeMouseInputListener(MouseInputListener listener)
Removes a listener that was earlier added to this Dockable . |
void |
requestDisplayer(DisplayerRequest request)
Invoked to get DockableDisplayer for this Dockable . |
void |
requestDockTitle(DockTitleRequest request)
Invoked to get a graphical representation of a title for this Dockable . |
void |
setController(DockController controller)
Sets the controller in whose realm this Dockable is. |
void |
setDockParent(DockStation station)
Sets the parent property. |
void |
unbind(DockTitle title)
Clients should call this method if a DockTitle is no longer
needed. |
Methods inherited from interface bibliothek.gui.dock.DockElement |
---|
asDockable, asDockStation, getFactoryID |
Methods inherited from interface bibliothek.gui.dock.component.DockComponentRoot |
---|
getComponentConfiguration, setComponentConfiguration |
Methods inherited from interface bibliothek.gui.dock.DockElementRepresentative |
---|
getElement, getPopupLocation, isUsedAsTitle, shouldFocus, shouldTransfersFocus |
Methods inherited from interface bibliothek.gui.dock.station.support.PlaceholderListItem |
---|
asDockable |
Method Detail |
---|
void setDockParent(DockStation station)
station
.DockHierarchyEvent
.DockHierarchyObserver
, invoke
DockHierarchyObserver.update()
after the
property has changed, it will automatically fire a DockHierarchyEvent
if necessary.
station
- the parent, may be null
if this Dockable
is not visible at all.DockStation getDockParent()
setDockParent(DockStation)
.
null
@Deprecated @Todo(compatibility=BREAK_MAJOR, priority=ENHANCEMENT, target=VERSION_1_1_3, description="remove this method") boolean isDockableVisible()
isDockableShowing()
, this method will be removed in a future release
Dockable
can be seen by the user. A Dockable
at least needs
to be registered as root-station on a DockController
, or be a child of a root-station
to be visible.Component
s which are displayable
are
are visible to the user.
true
if the user can actually see this dockable, false
otherwiseboolean isDockableShowing()
Dockable
can be seen by the user. A Dockable
at least needs
to be registered as root-station on a DockController
, or be a child of a root-station
to be visible.Component
s which are displayable
are
are visible to the user.
true
if the user can actually see this dockable, false
otherwisevoid setController(DockController controller)
null
means that this Dockable
is not managed by a controller.DockHierarchyListener
s about the change.DockHierarchyObserver
, invoke
DockHierarchyObserver.controllerChanged(DockController)
controller
- the owner, may be null
DockController getController()
setController(DockController)
.
getController
in interface DockElement
null
void addDockableListener(DockableListener listener)
listener
- the new listenervoid removeDockableListener(DockableListener listener)
listener
- the listener to removevoid addDockHierarchyListener(DockHierarchyListener listener)
DockHierarchyObserver
to implement this feature in an easy way. Subclasses then only have
to call DockHierarchyObserver.update()
whenever the parent
of this Dockable
changes.DockHierarchyObserver
,
forward the call directly to DockHierarchyObserver.addDockHierarchyListener(DockHierarchyListener)
listener
- the new listenervoid removeDockHierarchyListener(DockHierarchyListener listener)
DockHierarchyObserver
,
forward the call directly to DockHierarchyObserver.removeDockHierarchyListener(DockHierarchyListener)
listener
- the listener to removeaddDockableListener(DockableListener)
void addDockableStateListener(DockableStateListener listener)
listener
to this Dockable
. The listener will be informed about
various events concerning the position and visibility of this dockable.
listener
- the new listener, not null
void removeDockableStateListener(DockableStateListener listener)
listener
from this element.
listener
- the listener to removevoid addMouseInputListener(MouseInputListener listener)
MouseInputListener
to the component
of this Dockable
.
A Dockable
has to decide by itself which Components
should be observer, but generally all free areas should be covered.
It's also possible just to ignore the listener, but that's not the
preferred behavior.
addMouseInputListener
in interface DockElementRepresentative
listener
- the mouse listenervoid removeMouseInputListener(MouseInputListener listener)
Dockable
.
removeMouseInputListener
in interface DockElementRepresentative
listener
- The listener to removeboolean accept(DockStation station)
station
is an accepted parent for this
Dockable
or not. The user is not able to drag a Dockable
to a station
which is not accepted.
station
- a possible parent
station
could be a parent or notboolean accept(DockStation base, Dockable neighbor)
base
could be the parent of a combination
between this Dockable
and neighbor
. The user is not able
to make a combination between this Dockable
and neighbor
if this method does not accept the operation.
base
- the future parent of the combinationneighbor
- a Dockable
whose parent will be the same parent as
the parent of this Dockable
true
if the combination is allowed, false
otherwiseComponent getComponent()
Component
which represents this Dockable
. Note that
the component should be a focus cycle root
getComponent
in interface DockElementRepresentative
String getTitleText()
Dockable
.
String getTitleToolTip()
Dockable
and
that should be shown on any DockTitle
.
null
Icon getTitleIcon()
Dockable
.
null
void requestDockTitle(DockTitleRequest request)
Dockable
. This method is
called either when a title first is required, or when this Dockable
invoked the DockableListener.titleExchanged(Dockable, DockTitle)
method of its
current observers. Dockable
might decide to answer the request by calling
DockTitleRequest.answer(DockTitle)
, any title, including null
are
valid answers. If this Dockable
does not answer the request the associated
DockTitleFactory
(as described by DockTitleVersion.getFactory()
) is
asked to answer the request.target
must be this Dockable
.
request
- which title is required. If this Dockable does not have
a special rule for the given request it just ignores the callvoid requestDisplayer(DisplayerRequest request)
DockableDisplayer
for this Dockable
. This method may be called when
this Dockable
is dropped onto a new DockStation
, a theme was exchanged, or an existing
DockableDisplayer
was discarded.
request
- callback used to set a new DockableDisplayer
void bind(DockTitle title)
Dockable
. The
method DockTitle.bind()
will be called automatically by the
controller.title
was bound. However, the method DockTitle.bind()
must not
be invoked by this method.title
must be returned by listBoundTitles()
unless unbind(DockTitle)
is called.
title
- the title which will be show some things of this Dockable
IllegalArgumentException
- if the title is already boundunbind(DockTitle)
void unbind(DockTitle title)
DockTitle
is no longer
needed. The controller will call DockTitle.unbind()
at an appropriate
time.title
is no longer bound. However, this method must not call
DockTitle.unbind()
.title
must no longer be returned when calling listBoundTitles()
title
- the title which will be no longer connected to this Dockable
IllegalArgumentException
- if the title is not known to this Dockable
bind(DockTitle)
DockTitle[] listBoundTitles()
DockTitles
which are currently
bound to this Dockable
. That are titles for which bind(DockTitle)
was called, but not yet unbind(DockTitle)
.
DockActionSource getLocalActionOffers()
DockAction
s which should be triggerable if
this Dockable
is visible. The list contains only actions which are
directly bound to this Dockable
(the actions which are not changed when
the parent-station of this Dockable
is exchanged).
The list can be modified by this Dockable
at every time, clients have
to react on these changes by adding a DockActionSourceListener
to the result.
null
if no actions
are availableDockActionSource getGlobalActionOffers()
DockAction
s which
might be triggered while this Dockable
is visible. The list must contain
all actions which are related in any way to this Dockable
. Subclasses
might use a HierarchyDockActionSource
or the method
DockController.listOffers(Dockable)
to implement this functionality
null
void configureDisplayerHints(DockableDisplayerHints hints)
Dockable
to configure hints
which will
be used by the parent component of this element. This Dockable
can store a reference to hints
and use it to change the
hints whenever it is appropriate. This method will be called with null
if the link should be broken.
hints
- the hints to configure or null
if the last
hints
should no longer be configured by this element
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |