org.jppf.ui.options
Class TextAreaOption

java.lang.Object
  org.jppf.ui.options.AbstractOptionProperties
      org.jppf.ui.options.AbstractOptionElement
          org.jppf.ui.options.AbstractOption
              org.jppf.ui.options.TextAreaOption

All Implemented Interfaces:

Serializable, Option, OptionElement, OptionProperties

public class TextAreaOption
extends AbstractOption

An option that uses a JTextArea to edit its value.

Author:

Laurent Cohen

See Also:

Serialized Form

Field Summary

Fields inherited from class org.jppf.ui.options.AbstractOption

listeners, persistent, value

Fields inherited from class org.jppf.ui.options.AbstractOptionElement

parent, root

Fields inherited from class org.jppf.ui.options.AbstractOptionProperties

bordered, componentConstraints, eventsEnabled, finalizer, iconPath, initializer, label, layoutConstraints, name, scripts, scrollable, toolTipText, UIComponent

Constructor Summary

TextAreaOption()
Constructor provided as a convenience to facilitate the creation of option elements through reflexion.

TextAreaOption(String name, String label, String tooltip, String value)
Initialize this text area option with the specified parameters.

Method Summary

void	append(String value) Set the current value for this option.
void	createUI() Create the UI components for this option.
JTextArea	getTextArea() Get the underlying JTextArea.
Object	getValue() Get the current value for this option.
boolean	isEditable() Determine whether the text area is editable.
void	setEditable(boolean editable) Specifiy whether the text area is editable.
void	setEnabled(boolean enabled) Enable or disable this option.
protected void	setupValueChangeNotifications() Add a listener to the underlying text document, to receive and propagate change events.
void	setValue(Object value) Set the current value for this option.

Methods inherited from class org.jppf.ui.options.AbstractOption

addValueChangeListener, fireValueChanged, isPersistent, layoutComponents, layoutComponents, removeValueChangeListener, setPersistent

Methods inherited from class org.jppf.ui.options.AbstractOptionElement

findAll, findAllWithName, findElement, findFirstWithName, findLastWithName, getChildForName, getParent, getPath, getRoot, getStringPath, setParent, toString

Methods inherited from class org.jppf.ui.options.AbstractOptionProperties

getComponentConstraints, getFinalizer, getIconPath, getInitializer, getLabel, getLayoutConstraints, getName, getScripts, getToolTipText, getUIComponent, isBordered, isEventsEnabled, isScrollable, setBordered, setComponentConstraints, setEventsEnabled, setFinalizer, setIconPath, setInitializer, setLabel, setLayoutConstraints, setName, setScrollable, setToolTipText, setUIComponent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jppf.ui.options.OptionElement

findAllWithName, findElement, findFirstWithName, findLastWithName, getParent, getPath, getRoot, getStringPath

Methods inherited from interface org.jppf.ui.options.OptionProperties

getComponentConstraints, getFinalizer, getIconPath, getInitializer, getLabel, getLayoutConstraints, getName, getScripts, getToolTipText, getUIComponent, isBordered, isEventsEnabled, isScrollable, setComponentConstraints, setEventsEnabled, setLayoutConstraints

Constructor Detail

TextAreaOption

public TextAreaOption()

Constructor provided as a convenience to facilitate the creation of option elements through reflexion.

TextAreaOption

public TextAreaOption(String name,
                      String label,
                      String tooltip,
                      String value)

Initialize this text area option with the specified parameters.

Parameters:

name - - this component's name.

label - - the label displayed with the text area.

tooltip - - the tooltip associated with the text area.

value - - the initial value of this component.

Method Detail

createUI

public void createUI()

Create the UI components for this option.

Specified by:

createUI in class AbstractOptionProperties

getValue

public Object getValue()

Get the current value for this option.

Specified by:

getValue in interface Option

Overrides:

getValue in class AbstractOption

Returns:

a String instance.

See Also:

AbstractOption.getValue()

setValue

public void setValue(Object value)

Set the current value for this option.

Overrides:

setValue in class AbstractOption

Parameters:

value - a String instance.

See Also:

AbstractOption.setValue(java.lang.Object)

append

public void append(String value)

Set the current value for this option.

Parameters:

value - a String instance.

See Also:

AbstractOption.setValue(java.lang.Object)

setupValueChangeNotifications

protected void setupValueChangeNotifications()

Add a listener to the underlying text document, to receive and propagate change events.

Specified by:

setupValueChangeNotifications in class AbstractOption

See Also:

AbstractOption.setupValueChangeNotifications()

isEditable

public boolean isEditable()

Determine whether the text area is editable.

Returns:

true if the text area is editable, false otherwise.

setEditable

public void setEditable(boolean editable)

Specifiy whether the text area is editable.

Specified by:

setEditable in interface OptionProperties

Overrides:

setEditable in class AbstractOptionProperties

Parameters:

editable - true if the text area is editable, false otherwise.

setEnabled

public void setEnabled(boolean enabled)

Enable or disable this option.

Parameters:

enabled - true to enable this option, false to disable it.

See Also:

OptionProperties.setEnabled(boolean)

getTextArea

public JTextArea getTextArea()

Get the underlying JTextArea.

Returns:

an instance of JTextArea.