bibliothek.gui.dock.common.intern.action
Class CExtendedModeAction

java.lang.Object
  bibliothek.gui.dock.common.action.CAction
      bibliothek.gui.dock.common.intern.action.CDecorateableAction
          bibliothek.gui.dock.common.intern.action.CDropDownItem
              bibliothek.gui.dock.common.intern.action.CExtendedModeAction

Direct Known Subclasses:

CExternalizeAction, CMaximizeAction, CMinimizeAction, CNormalizeAction, CUnexternalizeAction, CUnmaximizeExternalizedAction

@FrameworkOnly
public class CExtendedModeAction
extends CDropDownItem

This action is intended to change the ExtendedMode of a CDockable by calling CDockable.setExtendedMode(ExtendedMode).

Author:

Benjamin Sigg

Constructor Summary

protected

CExtendedModeAction(CControl control, ExtendedMode mode, String defaultIconKey, String iconKey, PropertyKey<KeyStroke> gotoStroke) Creates a new action.

Method Summary

void	action(CDockable dockable) This method actually changes the ExtendedMode of dockable to the mode that was given to this action in the constructor.
protected boolean	checkTrigger(KeyEvent event) Checks whether this action is able to trigger this action.
protected DockController	getController() Gets the controller from which this action currently reads its content.
protected void	setController(DockController controller) Exchanges all the properties such that they are read from controller
void	setIcon(Icon icon) Sets the icon of this action.

Methods inherited from class bibliothek.gui.dock.common.intern.action.CDropDownItem

init, isDropDownSelectable, isDropDownTriggerableNotSelected, isDropDownTriggerableSelected, setDropDownSelectable, setDropDownTriggerableNotSelected, setDropDownTriggerableSelected

Methods inherited from class bibliothek.gui.dock.common.intern.action.CDecorateableAction

getAccelerator, getDisabledIcon, getIcon, getText, getTooltip, init, isEnabled, setAccelerator, setDisabledIcon, setEnabled, setText, setTooltip

Methods inherited from class bibliothek.gui.dock.common.action.CAction

init, intern

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CExtendedModeAction

protected CExtendedModeAction(CControl control,
                              ExtendedMode mode,
                              String defaultIconKey,
                              String iconKey,
                              PropertyKey<KeyStroke> gotoStroke)

Creates a new action.

Parameters:

control - the control for which this action will be used

mode - the mode into which this action leads

defaultIconKey - the key of the icon when searching in Resources

iconKey - the key of the icon when searching in the IconManager

gotoStroke - the key to the KeyStroke that triggers this action

Method Detail

setIcon

public void setIcon(Icon icon)

Description copied from class: CDecorateableAction

Sets the icon of this action.

Overrides:

setIcon in class CDecorateableAction

Parameters:

icon - the icon, can be null

setController

protected void setController(DockController controller)

Exchanges all the properties such that they are read from controller

Parameters:

controller - the controller from which to read properties, or null

getController

protected DockController getController()

Gets the controller from which this action currently reads its content.

Returns:

the controller or null

checkTrigger

protected boolean checkTrigger(KeyEvent event)

Checks whether this action is able to trigger this action.

Parameters:

event - an event that matches the accelerator of this action

Returns:

true if this action really is triggered

action

public void action(CDockable dockable)

This method actually changes the ExtendedMode of dockable to the mode that was given to this action in the constructor. Every triggering of this action will finally call this method, so this method is the optimal point to be overridden and modified.

Parameters:

dockable - the element for which the action is executed