public class SeparatorAction extends java.lang.Object implements DockAction
Modifier and Type | Field and Description |
---|---|
static SeparatorAction |
MENU_SEPARATOR
A separator that is only visible on menus
|
static SeparatorAction |
SEPARATOR
A separator that is visible on menus and on titles
|
static SeparatorAction |
TITLE_SEPARATOR
A separator which is only visible on titles
|
BUTTON_CONTENT_FILTER
Constructor and Description |
---|
SeparatorAction(ViewTarget<?>... targets)
Creates a new separator.
|
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 |
shouldDisplay(ViewTarget<?> target)
Tells whether the separator should be shown or not.
|
boolean |
trigger(Dockable dockable)
Does the appropriate action that can be done respecting the current
state of this action.
|
void |
unbind(Dockable dockable)
|
public static final SeparatorAction SEPARATOR
public static final SeparatorAction MENU_SEPARATOR
public static final SeparatorAction TITLE_SEPARATOR
public SeparatorAction(ViewTarget<?>... targets)
targets
- the targets on which this separator should be visiblepublic boolean shouldDisplay(ViewTarget<?> target)
target
- the target on which the separator might be made visibletrue
if the separator should be shown, false
otherwise.public void bind(Dockable dockable)
DockAction
bind
in interface DockAction
dockable
- the Dockable
that may be used in the futureDockAction.unbind(Dockable)
public void unbind(Dockable dockable)
DockAction
dockable
was bound
to this DockAction, and if the dockable
will no longer be
used for any method calls (except bind
) on
this DockAction.unbind
in interface DockAction
dockable
- The Dockable
that will never be seen again, except
it is maybe bind
again.public <V> V createView(ViewTarget<V> target, ActionViewConverter converter, Dockable dockable)
DockAction
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.createView
in interface 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.public boolean trigger(Dockable dockable)
DockAction
trigger
in interface DockAction
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.