|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface StandardDockAction
A StandardDockAction is an object that is shown as graphical interface (like a button)
on some Components. The user can trigger an action, for example by pressing
a button.
StandardDockActions are linked with one or many Dockables
.
Note: this interface allows that one action is used for many Dockables with
unspecified type. However, some implementations may have restrictions, read
the documentation of those actions carefully.
Field Summary |
---|
Fields inherited from interface bibliothek.gui.dock.action.DockAction |
---|
BUTTON_CONTENT_FILTER |
Method Summary | |
---|---|
void |
addDockActionListener(StandardDockActionListener listener)
Adds a listener to this DockAction. |
Dockable |
getDockableRepresentation(Dockable dockable)
Tells whether this DockAction represents a Dockable . |
Icon |
getIcon(Dockable dockable,
ActionContentModifier modifier)
Gets the Icon of this DockAction, when this DockAction is shown together with dockable . |
ActionContentModifier[] |
getIconContexts(Dockable dockable)
Gets all the ActionContentModifier s for which getIcon(Dockable, ActionContentModifier) would
return a value other than null . |
String |
getText(Dockable dockable)
Gets the text of this DockActon, when this DockAction is shown together with dockable . |
String |
getTooltipText(Dockable dockable)
Gets a tooltip for this DockActon, when this DockAction is shown together with dockable . |
boolean |
isEnabled(Dockable dockable)
Tells whether this DockAction can be triggered together with the dockable . |
void |
removeDockActionListener(StandardDockActionListener listener)
Removes a listener from this DockStation. |
Methods inherited from interface bibliothek.gui.dock.action.DockAction |
---|
bind, createView, trigger, unbind |
Method Detail |
---|
Icon getIcon(Dockable dockable, ActionContentModifier modifier)
dockable
. This method must ignore the
backup property
of modifier
.
dockable
- The Dockable
for which the action-icon
should be chosen.modifier
- how the icon will be used
dockable
, or null
.ActionContentModifier[] getIconContexts(Dockable dockable)
ActionContentModifier
s for which getIcon(Dockable, ActionContentModifier)
would
return a value other than null
.
dockable
- the Dockable
for which the action-icons may be chosen.
String getText(Dockable dockable)
dockable
.
dockable
- The Dockable
for which the action-text
should be chosen.
dockable
, or null
.String getTooltipText(Dockable dockable)
dockable
.
dockable
- The Dockable
for which the action-tooltip
should be chosen.
dockable
, or null
.void addDockActionListener(StandardDockActionListener listener)
listener
- The listener to addvoid removeDockActionListener(StandardDockActionListener listener)
listener
- The listener to removeboolean isEnabled(Dockable dockable)
dockable
.
dockable
- The Dockable
for which this action maybe
triggered.
true
if the user should be able to trigger
this action, false
otherwiseDockable getDockableRepresentation(Dockable dockable)
DockAction
represents a Dockable
. If so, the framework
may register views for this action as DockElementRepresentative
.
dockable
- The Dockable
for which this action may be triggered
Dockable
which is represented by this action, can be null
.
Normally dockable
should not be the result.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |