y.option
Class StringOptionItem

java.lang.Object
  |
  +--y.option.OptionItem
        |
        +--y.option.StringOptionItem

public class StringOptionItem

extends OptionItem

An option item for Strings.

Provides an editor based on JTextComponent.

Field Summary

Fields inherited from class y.option.OptionItem

COLOR_UNDEFINED, name, UNDEFINED

Constructor Summary

StringOptionItem(String name, String value)
Creates a new instance of StringOptionItem.

StringOptionItem(String name, String value, int rows)
Creates a bew instance of StringOptionItem.

Method Summary

boolean	adoptEditorValue() Adopts the value from the editor component to the item.
JComponent	getEditor() Returns the editor component for the this option item.
String	getType() Returns "String"
Object	getValue() Returns the value of this option item
void	resetValue() Resets the value of this item to its initial value.
void	setValue(Object v) Sets the value of this option item

Methods inherited from class y.option.OptionItem

checkEditorValue, getClassType, getEditor, getName, getStringValue, getTipText, isValueUndefined, setClassType, setStringValue, setTipText, setValueUndefined, wantsVisibleName

Methods inherited from class java.lang.Object

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

Constructor Detail

StringOptionItem

public StringOptionItem(String name,
                        String value,
                        int rows)

Creates a bew instance of StringOptionItem.

Parameters:

name - the name of the item

value - the initial value of the item

rows - the number of text rows of the option editor.

StringOptionItem

public StringOptionItem(String name,
                        String value)

Creates a new instance of StringOptionItem.

Parameters:

name - the name of the item

value - the initial value of the item

Method Detail

getType

public String getType()

Returns "String"

Specified by:

getType in class OptionItem

getValue

public Object getValue()

Description copied from class: OptionItem

Returns the value of this option item

Specified by:

getValue in class OptionItem

setValue

public void setValue(Object v)

Description copied from class: OptionItem

Sets the value of this option item

Specified by:

setValue in class OptionItem

adoptEditorValue

public boolean adoptEditorValue()

Description copied from class: OptionItem

Adopts the value from the editor component to the item.

Specified by:

adoptEditorValue in class OptionItem

resetValue

public void resetValue()

Description copied from class: OptionItem

Resets the value of this item to its initial value.

Specified by:

resetValue in class OptionItem

getEditor

public JComponent getEditor()

Description copied from class: OptionItem

Returns the editor component for the this option item. Note: Use the getEditor(GuiFactory,String) variant instead.

Specified by:

getEditor in class OptionItem