|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@FrameworkOnly public interface SharingStandardDockAction
A SharingStandardDockAction
is a StandardDockAction
whose properties are
shared by all Dockable
s and whose properties can be modified by the client.
Field Summary |
---|
Fields inherited from interface bibliothek.gui.dock.action.DockAction |
---|
BUTTON_CONTENT_FILTER |
Method Summary | |
---|---|
KeyStroke |
getAccelerator()
Gets the type of KeyEvent that must happen to trigger this
action. |
Icon |
getDisabledIcon()
Gets the icon that is shown when this action is not enabled. |
Dockable |
getDockableRepresentation()
Gets the Dockable which is represented by this DockAction . |
Icon |
getIcon()
Gets the default-icon that is shown for this action. |
Icon |
getIcon(ActionContentModifier modifier)
Gets the icon that is used if the conditions of modifier are met. |
String |
getText()
Gets the text that is shown for this action. |
String |
getTooltip()
Gets the first part of the toopltip-text that is shown for this action. |
String |
getTooltipText()
Gets the text that should be shown as tooltip of this action. |
boolean |
isEnabled()
Gets the enabled-state for this action. |
void |
setAccelerator(KeyStroke accelerator)
Sets the type of event that will trigger this action. |
void |
setDisabledIcon(Icon disabledIcon)
Sets an icon that will be shown when this action is not enabled. |
void |
setDockableRepresentation(Dockable dockable)
Sets the Dockable which is represented by this DockAction . |
void |
setEnabled(boolean enabled)
Sets the enabled-state of this action. |
void |
setIcon(ActionContentModifier modifier,
Icon icon)
Sets the icon which is to be used if the conditions of modifier are met. |
void |
setIcon(Icon icon)
Sets the default- icon for this action. |
void |
setText(String text)
Sets the text which is shown for this action. |
void |
setTooltip(String tooltip)
Sets the first part of the tooltip-text which is shown for this action. |
Methods inherited from interface bibliothek.gui.dock.action.StandardDockAction |
---|
addDockActionListener, getDockableRepresentation, getIcon, getIconContexts, getText, getTooltipText, isEnabled, removeDockActionListener |
Methods inherited from interface bibliothek.gui.dock.action.DockAction |
---|
bind, createView, trigger, unbind |
Method Detail |
---|
String getText()
null
setText(String)
void setText(String text)
text
which is shown for this action.
text
- The text to show, or null
void setTooltip(String tooltip)
tooltip
- The client defined part of the tooltip for this actionString getTooltip()
setTooltip(String)
String getTooltipText()
getTooltip()
, but also additional information
like the accelerator
boolean isEnabled()
true
if this action can be triggered,
false
otherwisesetEnabled(boolean)
void setEnabled(boolean enabled)
enabled
- The stateIcon getIcon()
null
setIcon(Icon)
void setIcon(Icon icon)
icon
for this action. This icon
will be shown when no other icon fits the current states of
the action.
icon
- The icon, can be null
Icon getDisabledIcon()
null
setDisabledIcon(Icon)
,
isEnabled()
void setDisabledIcon(Icon disabledIcon)
disabledIcon
- The disabled-icon, can be null
setEnabled(boolean)
Icon getIcon(ActionContentModifier modifier)
modifier
are met.
modifier
- the key for the icon
null
void setIcon(ActionContentModifier modifier, Icon icon)
modifier
are met.
modifier
- the key of the iconicon
- the new icon or null
void setDockableRepresentation(Dockable dockable)
Dockable
which is represented by this DockAction
. Some views of
this DockAction
will register themselves as DockElementRepresentative
representing
dockable
.
dockable
- the new representation, can be null
Dockable getDockableRepresentation()
Dockable
which is represented by this DockAction
.
null
StandardDockAction.getDockableRepresentation(Dockable)
KeyStroke getAccelerator()
KeyEvent
that must happen to trigger this
action.
null
void setAccelerator(KeyStroke accelerator)
accelerator
- the type of event or null
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |