Package bibliothek.gui.dock.common.action.predefined

Class CCloseAction

java.lang.Object

bibliothek.gui.dock.common.action.CAction

bibliothek.gui.dock.common.intern.action.CDecorateableAction<A>

bibliothek.gui.dock.common.intern.action.CDropDownItem<CCloseAction.Action>

bibliothek.gui.dock.common.action.predefined.CCloseAction

@EclipseTabDockAction
public class CCloseAction
extends CDropDownItem<CCloseAction.Action>

An action that can close any CDockable by calling CDockable.setVisible(boolean). Clients can either create one CCloseAction for each CDockable or use one action for many CDockables at the same time.

Author:

Benjamin Sigg

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	CCloseAction.Action	Internal representation of the CCloseAction, just calls close(CDockable) when triggered.

Constructor Summary

Constructors

Constructor	Description
CCloseAction(CControl control)	Creates a new action

Method Summary

Modifier and Type	Method	Description
void	close(CDockable dockable)	Closes dockable now.
protected CCloseAction.Action	createAction()	Creates the action that is used for CDecorateableAction.intern().

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

isDropDownSelectable, isDropDownTriggerableNotSelected, isDropDownTriggerableSelected, setDropDownSelectable, setDropDownTriggerableNotSelected, setDropDownTriggerableSelected

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

addDecorateableActionListener, getAccelerator, getDisabledHoverIcon, getDisabledIcon, getDisabledPressedIcon, getHoverIcon, getIcon, getPressedIcon, getText, getTooltip, init, intern, isAcceleratorGlobal, isEnabled, isShowTextOnButtons, removeDecorateableActionListener, setAccelerator, setAcceleratorIsGlobal, setDisabledHoverIcon, setDisabledIcon, setDisabledPressedIcon, setEnabled, setHoverIcon, setIcon, setPressedIcon, setShowTextOnButtons, setText, setTooltip

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

init

Methods inherited from class java.lang.Object

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

Constructor Details

CCloseAction

public CCloseAction(CControl control)

Creates a new action

Parameters:

control - the control for which this action will be used

Method Details

createAction

protected CCloseAction.Action createAction()

Creates the action that is used for CDecorateableAction.intern().

Returns:

the internal representation of this action

close

public void close(CDockable dockable)

Closes dockable now. This method is always called when this action is triggered, so this is the optimal method to be overridden and extended with new features like a JOptionPane asking whether dockable should really be closed.
Note: Consider using the CVetoClosingListener instead, it can handle all kind of closing events.

Parameters:

dockable - the element to close