edu.rice.cs.drjava.ui.config
Class StringOptionComponent

java.lang.Object
  edu.rice.cs.drjava.ui.config.OptionComponent<String>
      edu.rice.cs.drjava.ui.config.StringOptionComponent

All Implemented Interfaces:

Serializable

public class StringOptionComponent
extends OptionComponent<String>

Graphical form of a StringOption.

Version:

$Id: StringOptionComponent.java 4691 2008-12-02 23:33:27Z dlsmith $

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class edu.rice.cs.drjava.ui.config.OptionComponent

OptionComponent.ChangeListener

Field Summary

Fields inherited from class edu.rice.cs.drjava.ui.config.OptionComponent

_entireColumn, _label, _labelText, _option, _parent

Constructor Summary

StringOptionComponent(StringOption opt, String text, SwingFrame parent)

StringOptionComponent(StringOption opt, String text, SwingFrame parent, String description)
Constructor that allows for a tooltip description.

Method Summary

JComponent	getComponent() Return's this OptionComponent's configurable component.
void	setDescription(String description) Sets the tooltip description text for this option.
void	setValue(String value) Displays the given value.
boolean	updateConfig() Updates the config object with the new setting.

Methods inherited from class edu.rice.cs.drjava.ui.config.OptionComponent

addChangeListener, getEntireColumn, getLabel, getLabelText, getOption, notifyChangeListeners, removeChangeListener, resetToCurrent, resetToDefault, setEntireColumn, showErrorMessage, showErrorMessage, useEntireColumn

Methods inherited from class java.lang.Object

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

Constructor Detail

StringOptionComponent

public StringOptionComponent(StringOption opt,
                             String text,
                             SwingFrame parent)

StringOptionComponent

public StringOptionComponent(StringOption opt,
                             String text,
                             SwingFrame parent,
                             String description)

Constructor that allows for a tooltip description.

Method Detail

setDescription

public void setDescription(String description)

Sets the tooltip description text for this option.

Specified by:

setDescription in class OptionComponent<String>

Parameters:

description - the tooltip text

updateConfig

public boolean updateConfig()

Updates the config object with the new setting. Should run in event thread.

Specified by:

updateConfig in class OptionComponent<String>

Returns:

true if the new value is set successfully

setValue

public void setValue(String value)

Displays the given value.

Specified by:

setValue in class OptionComponent<String>

getComponent

public JComponent getComponent()

Return's this OptionComponent's configurable component.

Specified by:

getComponent in class OptionComponent<String>