Package 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, detachable, eventsEnabled, finalizer, horizontalScrollbar, iconPath, initializer, label, layoutConstraints, mouseListener, name, scripts, scrollable, toolTipText, UIComponent, verticalScrollbar

Constructor Summary

Constructors

Constructor	Description
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

Modifier and Type	Method	Description
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.
String	getTimestampFormat()	Get the format of an optional timestamp displayed before the message.
Object	getValue()	Get the current value for this option.
boolean	isEditable()	Determine whether the text area is editable.
void	setEditable(boolean editable)	Specify whether the text area is editable.
void	setEnabled(boolean enabled)	Enable or disable this option.
void	setTimestampFormat(String timestampFormat)	Set the format of an optional timestamp displayed before the message.
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, toString

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

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

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

createScrollPane, getComponentConstraints, getFinalizer, getIconPath, getInitializer, getLabel, getLayoutConstraints, getMouseListener, getName, getScripts, getToolTipText, getUIComponent, isBordered, isDetachable, isEventsEnabled, isHorizontalScrollbar, isScrollable, isVerticalScrollbar, setBordered, setComponentConstraints, setDetachable, setEventsEnabled, setFinalizer, setHorizontalScrollbar, setIconPath, setInitializer, setLabel, setLayoutConstraints, setMouseListener, setName, setScrollable, setToolTipText, setUIComponent, setVerticalScrollbar

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, getMouseListener, getName, getScripts, getToolTipText, getUIComponent, isBordered, isDetachable, isEventsEnabled, isScrollable, setComponentConstraints, setEventsEnabled, setLayoutConstraints, setMouseListener

Constructor Details

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 Details

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.

setValue

public void setValue(Object value)

Set the current value for this option.

Overrides:

setValue in class AbstractOption

Parameters:

value - a String instance.

append

public void append(String value)

Set the current value for this option.

Parameters:

value - a String instance.

setupValueChangeNotifications

protected void setupValueChangeNotifications()

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

Specified by:

setupValueChangeNotifications in class AbstractOption

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)

Specify 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)

Description copied from interface: OptionProperties

Enable or disable this option.

Parameters:

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

getTextArea

public JTextArea getTextArea()

Get the underlying JTextArea.

Returns:

an instance of JTextArea.

getTimestampFormat

public String getTimestampFormat()

Get the format of an optional timestamp displayed before the message.

Returns:

the format as a string.

setTimestampFormat

public void setTimestampFormat(String timestampFormat)

Set the format of an optional timestamp displayed before the message.

Parameters:

timestampFormat - the format as a string.