public interface DockAction
DockTitle
or in a popupmenu.ActionViewConverter
to get the default-representations.bind(Dockable)
-method will be invoked
before a representation is shown, and the unbind(Dockable)
when a representation is no
longer shown.Modifier and Type | Field and Description |
---|---|
static PropertyKey<ButtonContentFilter> |
BUTTON_CONTENT_FILTER
The
ButtonContentFilter decides whether text is shown on buttons that represent DockAction s. |
Modifier and Type | Method and Description |
---|---|
void |
bind(Dockable dockable)
Informs this DockAction that icons, text, and other stuff like that,
will be requested from this DockAction.
|
<V> V |
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)
|
static final PropertyKey<ButtonContentFilter> BUTTON_CONTENT_FILTER
ButtonContentFilter
decides whether text is shown on buttons that represent DockAction
s.<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)
boolean trigger(Dockable dockable)
dockable
- the element for which this action is calledtrue
if this action could do anything, false
if this action was not able to react in any way to the event.