bibliothek.gui.dock.action.actions
Class SimpleDockAction

java.lang.Object
  extended by bibliothek.gui.dock.action.actions.AbstractStandardDockAction
      extended by bibliothek.gui.dock.action.actions.SimpleDockAction
All Implemented Interfaces:
DockAction, StandardDockAction
Direct Known Subclasses:
SimpleDropDownAction, SimpleDropDownItemAction, SimpleMenuAction

public abstract class SimpleDockAction
extends AbstractStandardDockAction

A simple implementation of DockAction. This action uses for all associated Dockables the same settings.

Author:
Benjamin Sigg

Field Summary
private  javax.swing.Icon disabledIcon
          Icon shown if the action is not enabled
private  boolean enabled
          Whether this action can be triggered or not
private  javax.swing.Icon icon
          Icon shown if the action is enabled
private  java.lang.String text
          Text of the action
private  java.lang.String tooltip
          Tooltip for buttons showing this action
 
Fields inherited from class bibliothek.gui.dock.action.actions.AbstractStandardDockAction
listeners
 
Constructor Summary
SimpleDockAction()
           
 
Method Summary
 javax.swing.Icon getDisabledIcon()
          Gets the icon that is shown when this action is not enabled.
 javax.swing.Icon getDisabledIcon(Dockable dockable)
          Gets the Icon of this DockAction, when this DockAction is shown together with dockable and is not enabled.
 javax.swing.Icon getIcon()
          Gets the default-icon that is shown for this action.
 javax.swing.Icon getIcon(Dockable dockable)
          Gets the Icon of this DockAction, when this DockAction is shown together with dockable.
 java.lang.String getText()
          Gets the text that is shown for this action.
 java.lang.String getText(Dockable dockable)
          Gets the text of this DockActon, when this DockAction is shown together with dockable.
 java.lang.String getTooltipText()
          Gets the toopltip-text that is shown for this action.
 java.lang.String getTooltipText(Dockable dockable)
          Gets a tooltip for this DockActon, when this DockAction is shown together with dockable.
 boolean isEnabled()
          Gets the enabled-state for this action.
 boolean isEnabled(Dockable dockable)
          Tells whether this DockAction can be triggered together with the dockable.
 void setDisabledIcon(javax.swing.Icon disabledIcon)
          Sets an icon that will be shown when this action is not enabled.
 void setEnabled(boolean enabled)
          Sets the enabled-state of this action.
 void setIcon(javax.swing.Icon icon)
          Sets the default-icon for this action.
 void setText(java.lang.String text)
          Sets the text which is shown for this action.
 void setTooltipText(java.lang.String tooltip)
          Sets the tooltip-text which is shown for this action.
 
Methods inherited from class bibliothek.gui.dock.action.actions.AbstractStandardDockAction
addDockActionListener, bind, binded, fireActionDisabledIconChanged, fireActionEnabledChanged, fireActionIconChanged, fireActionTextChanged, fireActionTooltipTextChanged, getBindeds, isBinded, removeDockActionListener, unbind, unbinded
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface bibliothek.gui.dock.action.DockAction
createView
 

Field Detail

icon

private javax.swing.Icon icon
Icon shown if the action is enabled


disabledIcon

private javax.swing.Icon disabledIcon
Icon shown if the action is not enabled


text

private java.lang.String text
Text of the action


tooltip

private java.lang.String tooltip
Tooltip for buttons showing this action


enabled

private boolean enabled
Whether this action can be triggered or not

Constructor Detail

SimpleDockAction

public SimpleDockAction()
Method Detail

getIcon

public javax.swing.Icon getIcon(Dockable dockable)
Description copied from interface: StandardDockAction
Gets the Icon of this DockAction, when this DockAction is shown together with dockable.

Parameters:
dockable - The Dockable for which the action-icon should be chosen.
Returns:
The icon to show for this action when the action is associated with dockable, or null.

getText

public java.lang.String getText(Dockable dockable)
Description copied from interface: StandardDockAction
Gets the text of this DockActon, when this DockAction is shown together with dockable.

Parameters:
dockable - The Dockable for which the action-text should be chosen.
Returns:
The text to show for this action when the action is associated with dockable, or null.

getText

public java.lang.String getText()
Gets the text that is shown for this action.

Returns:
The text of this action, may be null
See Also:
setText(String)

setText

public void setText(java.lang.String text)
Sets the text which is shown for this action.

Parameters:
text - The text to show, or null

getTooltipText

public java.lang.String getTooltipText(Dockable dockable)
Description copied from interface: StandardDockAction
Gets a tooltip for this DockActon, when this DockAction is shown together with dockable.

Parameters:
dockable - The Dockable for which the action-tooltip should be chosen.
Returns:
The tooltip to show for this action when the action is associated with dockable, or null.

getTooltipText

public java.lang.String getTooltipText()
Gets the toopltip-text that is shown for this action.

Returns:
The tooltip
See Also:
setTooltipText(String)

setTooltipText

public void setTooltipText(java.lang.String tooltip)
Sets the tooltip-text which is shown for this action.

Parameters:
tooltip - The tooltip for this action

isEnabled

public boolean isEnabled(Dockable dockable)
Description copied from interface: StandardDockAction
Tells whether this DockAction can be triggered together with the dockable.

Parameters:
dockable - The Dockable for which this action maybe triggered.
Returns:
true if the user should be able to trigger this action, false otherwise

isEnabled

public boolean isEnabled()
Gets the enabled-state for this action. Only an action that is enabled can be triggered.

Returns:
true if this action can be triggered, false otherwise
See Also:
setEnabled(boolean)

setEnabled

public void setEnabled(boolean enabled)
Sets the enabled-state of this action. This action can be triggered only if it is enabled.

Parameters:
enabled - The state

getIcon

public javax.swing.Icon getIcon()
Gets the default-icon that is shown for this action.

Returns:
The icon, may be null
See Also:
setIcon(Icon)

setIcon

public void setIcon(javax.swing.Icon icon)
Sets the default-icon for this action. This icon will be shown when no other icon fits the current states of the action.

Parameters:
icon - The icon, can be null

getDisabledIcon

public javax.swing.Icon getDisabledIcon()
Gets the icon that is shown when this action is not enabled.

Returns:
The disabled-icon, may be null
See Also:
setDisabledIcon(Icon), isEnabled()

getDisabledIcon

public javax.swing.Icon getDisabledIcon(Dockable dockable)
Description copied from interface: StandardDockAction
Gets the Icon of this DockAction, when this DockAction is shown together with dockable and is not enabled.

Parameters:
dockable - The Dockable for which the action-icon should be chosen.
Returns:
The icon to show for this action when the action is associated with dockable, or null.

setDisabledIcon

public void setDisabledIcon(javax.swing.Icon disabledIcon)
Sets an icon that will be shown when this action is not enabled.

Parameters:
disabledIcon - The disabled-icon, can be null
See Also:
setEnabled(boolean)