|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DockAction
A DockAction is an object that represents an action which can be triggered by the user. Every
DockAction has a graphical representation which is shown at many places, for example
on a DockTitle
or in a popupmenu.
A DockAction may choose its own graphical representation, or use the
ActionViewConverter
to get the default-representations.
Every DockAction is associated with some Dockables. The bind(Dockable)
-method will be invoked
before a representation is shown, and the unbind(Dockable)
when a representation is no
longer shown.
Method Summary | ||
---|---|---|
void |
bind(Dockable dockable)
Informs this DockAction that icons, text, and other stuff like that, will be requested from this DockAction. |
|
|
createView(ViewTarget<V> target,
ActionViewConverter converter,
Dockable dockable)
Creates a view for this action, for the platform target and
with help of converter . |
|
boolean |
trigger(Dockable dockable)
Does the appropriate action that can be done respecting the current state of this action. |
|
void |
unbind(Dockable dockable)
Invoked only if the dockable was bound
to this DockAction, and if the dockable will no longer be
used for any method calls (except bind ) on
this DockAction. |
Method Detail |
---|
<V> V createView(ViewTarget<V> target, ActionViewConverter converter, Dockable dockable)
target
and
with help of converter
. Clients might use their own
code to create a new view, but the preferred way is to call
ActionViewConverter.createView(ActionType, DockAction, ViewTarget, Dockable)
with an ActionType
that fits to this DockAction.
V
- the type of view requestedtarget
- The platform on which the view will be usedconverter
- A set of methods that can be used to create a viewdockable
- The Dockable for which the view will be shown. Note that
this action may not yet be bound
to this action.
void bind(Dockable dockable)
dockable
- the Dockable
that may be used in the futureunbind(Dockable)
void unbind(Dockable dockable)
dockable
was bound
to this DockAction, and if the dockable
will no longer be
used for any method calls (except bind
) on
this DockAction.
dockable
- The Dockable
that will never be seen again, except
it is maybe bind
again.boolean trigger(Dockable dockable)
dockable
- the element for which this action is called
true
if this action could do anything, false
if this action was not able to react in any way to the event.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |