com.borland.primetime.editor
Class BooleanEditorOption

java.lang.Object
  |
  +--com.borland.primetime.properties.Property
        |
        +--com.borland.primetime.properties.GlobalProperty
              |
              +--com.borland.primetime.editor.EditorOption
                    |
                    +--com.borland.primetime.editor.BooleanEditorOption
All Implemented Interfaces:
java.lang.Comparable

public class BooleanEditorOption
extends EditorOption

A BooleanEditorOption object defines a binary option related to the editor.

An EditorOption is presented to the user on the EditorPropertySheet as a node in a JTree. The category property specifies the branch of the tree under which the option appears, and the text property specifies the display text of the option itself. For example, two BooleanEditorOptions with the same category might appear like this:


 EditorOptions
 -- Smart Key Options
    -- [] SmartHome
    -- [] SmartEnd

 

See Also:
EditorOptionCategory

Fields inherited from class com.borland.primetime.editor.EditorOption
category, text
 
Fields inherited from class com.borland.primetime.properties.GlobalProperty
defaultValue
 
Fields inherited from class com.borland.primetime.properties.Property
name
 
Constructor Summary
BooleanEditorOption(java.lang.String key, EditorOptionCategory category, java.lang.String text, boolean initialValue)
          Creates a new BooleanEditorOption object.
 
Method Summary
 boolean getBoolean()
          Fetches the current value of the boolean property.
 boolean setBoolean(boolean value)
          Changes the current value of the boolean property.
 
Methods inherited from class com.borland.primetime.editor.EditorOption
getCategory, getKey, getText
 
Methods inherited from class com.borland.primetime.properties.GlobalProperty
addPropertyListener, firePropertyChange, getValue, getVersion, readProperties, readProperties, removePropertyListener, setValue, writeProperties, writeProperties
 
Methods inherited from class com.borland.primetime.properties.Property
compareTo, equals, getPropertyCategory, getPropertyName, hashCode, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

BooleanEditorOption

public BooleanEditorOption(java.lang.String key,
                           EditorOptionCategory category,
                           java.lang.String text,
                           boolean initialValue)
Creates a new BooleanEditorOption object.
Parameters:
key - The key to use for this object.
category - The EditorOptionCategory to use for this object.
text - The text to display for the option itself.
initialValue - the initial boolean value for this option.
See Also:
EditorOption, EditorOptionCategory
Method Detail

getBoolean

public boolean getBoolean()
Fetches the current value of the boolean property.
Returns:
The boolean value.

setBoolean

public boolean setBoolean(boolean value)
Changes the current value of the boolean property.
Parameters:
value - The desired boolean value.
Returns:
True if the property value was changed as a result, false if the property was already set to this value.