com.borland.primetime.editor
Class EditorOption

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

public abstract class EditorOption
extends GlobalProperty

An EditorOption object defines an option related to the editor.


Field Summary
protected  EditorOptionCategory category
          Options always belong to a category.
protected  java.lang.String text
          The text that represents this option.
 
Fields inherited from class com.borland.primetime.properties.GlobalProperty
defaultValue
 
Fields inherited from class com.borland.primetime.properties.Property
name
 
Constructor Summary
EditorOption(java.lang.String key, EditorOptionCategory category, java.lang.String text)
          Creates a new EditorOption object.
EditorOption(java.lang.String key, EditorOptionCategory category, java.lang.String text, java.lang.String defaultValue)
          Creates a new EditorOption object.
 
Method Summary
 EditorOptionCategory getCategory()
          Get the category for this option.
 java.lang.String getKey()
          The key that is associated with this option, and is supplied when this option is created.
 java.lang.String getText()
          Get the text that describes this option.
 
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
 

Field Detail

category

protected EditorOptionCategory category
Options always belong to a category.
See Also:
EditorOptionCategory

text

protected java.lang.String text
The text that represents this option.
Constructor Detail

EditorOption

public EditorOption(java.lang.String key,
                    EditorOptionCategory category,
                    java.lang.String text)
Creates a new EditorOption 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.

EditorOption

public EditorOption(java.lang.String key,
                    EditorOptionCategory category,
                    java.lang.String text,
                    java.lang.String defaultValue)
Creates a new EditorOption 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.
defaultValue - The defaultValue of the option.
Method Detail

getKey

public java.lang.String getKey()
The key that is associated with this option, and is supplied when this option is created.
Returns:
the key of this option.

getCategory

public EditorOptionCategory getCategory()
Get the category for this option.
Returns:
the category of this option.

getText

public java.lang.String getText()
Get the text that describes this option.
Returns:
the text describing this option.