Package org.eclipse.jface.preference

Class BooleanPropertyAction

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.jface.action.AbstractAction

org.eclipse.jface.action.Action

org.eclipse.jface.preference.BooleanPropertyAction

All Implemented Interfaces:

IAction

public class BooleanPropertyAction
extends Action

The BooleanPropertyAction is an action that set the values of a boolean property in the preference store.

Field Summary

Fields inherited from interface org.eclipse.jface.action.IAction

AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, AS_RADIO_BUTTON, AS_UNSPECIFIED, CHECKED, DESCRIPTION, ENABLED, HANDLED, IMAGE, RESULT, TEXT, TOOL_TIP_TEXT

Constructor Summary

Constructors

Constructor	Description
BooleanPropertyAction(String title, IPreferenceStore preferenceStore, String property)	Create a new instance of the receiver.

Method Summary

Modifier and Type	Method	Description
void	run()	The default implementation of this IAction method does nothing.

Methods inherited from class org.eclipse.jface.action.Action

convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, isHandled, notifyResult, removeAcceleratorText, removeMnemonics, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText

Methods inherited from class org.eclipse.jface.action.AbstractAction

addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener

Methods inherited from class org.eclipse.core.commands.common.EventManager

addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

Methods inherited from class java.lang.Object

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

Constructor Details

BooleanPropertyAction

public BooleanPropertyAction(String title,
 IPreferenceStore preferenceStore,
 String property)
                      throws IllegalArgumentException

Create a new instance of the receiver.

Parameters:

title - The displayable name of the action.

preferenceStore - The preference store to propogate changes to

property - The property that is being updated

Throws:

IllegalArgumentException - Thrown if preferenceStore or property are null.

Method Details

run

public void run()

Description copied from class: Action

The default implementation of this IAction method does nothing. Subclasses should override this method if they do not need information from the triggering event, or override runWithEvent(Event) if they do.

Specified by:

run in interface IAction

Overrides:

run in class Action

See Also:

• How radio buttons are handled
• How check boxes are handled