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

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

All Implemented Interfaces:

Serializable

public class LabelComponent
extends OptionComponent<Object>

Displays a label in the form of an option component, to be displayed in a config panel.

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

LabelComponent(String text, SwingFrame parent)

LabelComponent(String text, SwingFrame parent, boolean left)

LabelComponent(String text, SwingFrame parent, String description)

LabelComponent(String text, SwingFrame parent, String description, boolean left)

Method Summary

JComponent	getComponent() Return's this OptionComponent's configurable component.
void	setDescription(String description) Sets the detailed description text for all components in this OptionComponent.
void	setValue(Object 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

LabelComponent

public LabelComponent(String text,
                      SwingFrame parent,
                      boolean left)

LabelComponent

public LabelComponent(String text,
                      SwingFrame parent,
                      String description,
                      boolean left)

LabelComponent

public LabelComponent(String text,
                      SwingFrame parent)

LabelComponent

public LabelComponent(String text,
                      SwingFrame parent,
                      String description)

Method Detail

setDescription

public void setDescription(String description)

Description copied from class: OptionComponent

Sets the detailed description text for all components in this OptionComponent. Should be called by subclasses that wish to display a description.

Specified by:

setDescription in class OptionComponent<Object>

Parameters:

description - the description of the component

updateConfig

public boolean updateConfig()

Updates the config object with the new setting. (Does nothing.)

Specified by:

updateConfig in class OptionComponent<Object>

Returns:

true if the new value is set successfully

setValue

public void setValue(Object value)

Displays the given value. (Never changes.)

Specified by:

setValue in class OptionComponent<Object>

getComponent

public JComponent getComponent()

Return's this OptionComponent's configurable component.

Specified by:

getComponent in class OptionComponent<Object>