Eclipse Platform
Release 3.0

org.eclipse.jface.preference
Class BooleanPropertyAction

java.lang.Object
  extended byorg.eclipse.jface.action.Action
      extended byorg.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, IMAGE, RESULT, TEXT, TOOL_TIP_TEXT
 
Constructor Summary
BooleanPropertyAction(String title, IPreferenceStore preferenceStore, String property)
          Create a new instance of the receiver.
 
Method Summary
 void run()
          The default implementation of this IAction method does nothing.
 
Methods inherited from class org.eclipse.jface.action.Action
addPropertyChangeListener, convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, firePropertyChange, firePropertyChange, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, notifyResult, removeAcceleratorText, removeMnemonics, removePropertyChangeListener, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

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.
IllegalArgumentException
Method Detail

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

Eclipse Platform
Release 3.0

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.