org.karora.cooee.app
Class ActiveTextArea

java.lang.Object
  org.karora.cooee.app.Component
      org.karora.cooee.app.text.TextComponent
          org.karora.cooee.app.TextArea
              org.karora.cooee.app.ActiveTextArea

All Implemented Interfaces:

java.io.Serializable, RenderIdSupport

public class ActiveTextArea
extends TextArea

A single-line text input field with pre keystroke regular expression testing

See Also:

Serialized Form

Field Summary

static java.lang.String	ACTION_VALIDATION_TRANSACTION
static java.lang.String	INPUT_INVALID
static java.lang.String	INPUT_VALID
static java.lang.String	PROPERTY_BOTTOM_FOCUS_BORDER
static java.lang.String	PROPERTY_FOCUS_BACKGROUND
static java.lang.String	PROPERTY_FOCUS_BORDER
static java.lang.String	PROPERTY_FOCUS_FOREGROUND
static java.lang.String	PROPERTY_LEFT_FOCUS_BORDER
static java.lang.String	PROPERTY_MAXIMUM_LENGTH
static java.lang.String	PROPERTY_MSG_VISIBLE
static java.lang.String	PROPERTY_RIGHT_FOCUS_BORDER
static java.lang.String	PROPERTY_TOP_FOCUS_BORDER

Fields inherited from class org.karora.cooee.app.text.TextComponent

ACTION_LISTENERS_CHANGED_PROPERTY, DOCUMENT_CHANGED_PROPERTY, INPUT_ACTION, PROPERTY_ACTION_COMMAND, PROPERTY_ALIGNMENT, PROPERTY_BACKGROUND_IMAGE, PROPERTY_BORDER, PROPERTY_DISABLED_BACKGROUND, PROPERTY_DISABLED_BACKGROUND_IMAGE, PROPERTY_DISABLED_BORDER, PROPERTY_DISABLED_FONT, PROPERTY_DISABLED_FOREGROUND, PROPERTY_HEIGHT, PROPERTY_HORIZONTAL_SCROLL, PROPERTY_INSETS, PROPERTY_TOOL_TIP_TEXT, PROPERTY_VERTICAL_SCROLL, PROPERTY_WIDTH, TEXT_CHANGED_PROPERTY

Fields inherited from class org.karora.cooee.app.Component

CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FOCUS_TRAVERSAL_INDEX_CHANGED_PROPERTY, FOCUS_TRAVERSAL_PARTICIPANT_CHANGED_PROPERTY, LAYOUT_DIRECTION_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, PROPERTY_BACKGROUND, PROPERTY_FONT, PROPERTY_FOREGROUND, PROPERTY_LAYOUT_DATA, STYLE_CHANGED_PROPERTY, STYLE_NAME_CHANGED_PROPERTY, VISIBLE_CHANGED_PROPERTY

Constructor Summary

ActiveTextArea()
Creates a new ActiveTextArea with an empty StringDocument as its model, and default width setting.

ActiveTextArea(Document document)
Creates a new ActiveTextArea with the specified Document model.

ActiveTextArea(Document document, java.lang.String text, int columns, int rows)
Creates a new ActiveTextArea with the specified Document model, initial text, and column width.

Method Summary

Border	getBottomFocusBorder()
Color	getFocusBackground() Returns the current focus background color
Border	getFocusBorder() Returns the current focus border
Color	getFocusForeground() Returns the current focus background color
Border	getLeftFocusBorder()
int	getMaxLength() Gets maximum length for this text area.
Border	getRightFocusBorder()
Border	getTopFocusBorder()
boolean	isMessageVisible() Returns whether the message is visible or not.
void	processInput(java.lang.String inputName, java.lang.Object inputValue) Processes client input specific to the Component received from the UpdateManager.
void	setBottomFocusBorder(Border border)
void	setFocusBackground(Color color)
void	setFocusBorder(Border border)
void	setFocusBorder(Border topBorder, Border rightBorder, Border bottomBorder, Border leftBorder)
void	setFocusForeground(Color color)
void	setLeftFocusBorder(Border border)
void	setMaxLength(int maxLength) Sets the maximum length for this text area.
void	setMessageVisible(boolean isVisible) Sets the status message to be always visible
void	setRightBottomFocusBorder(Border border)
void	setRightFocusBorder(Border border)
void	setTopFocusBorder(Border border)
void	setTopLeftFocusBorder(Border border)

Methods inherited from class org.karora.cooee.app.text.TextComponent

addActionListener, getActionCommand, getAlignment, getBackgroundImage, getBorder, getDisabledBackground, getDisabledBackgroundImage, getDisabledBorder, getDisabledFont, getDisabledForeground, getDocument, getHeight, getHorizontalScroll, getInsets, getMaximumLength, getText, getToolTipText, getVerticalScroll, getWidth, hasActionListeners, isValidChild, removeActionListener, setActionCommand, setAlignment, setBackgroundImage, setBorder, setDisabledBackground, setDisabledBackgroundImage, setDisabledBorder, setDisabledFont, setDisabledForeground, setDocument, setHeight, setHorizontalScroll, setInsets, setMaximumLength, setText, setToolTipText, setVerticalScroll, setWidth

Methods inherited from class org.karora.cooee.app.Component

add, add, addPropertyChangeListener, dispose, firePropertyChange, getApplicationInstance, getBackground, getComponent, getComponent, getComponentCount, getComponents, getEventListenerList, getFocusTraversalIndex, getFont, getForeground, getId, getIndexedProperty, getLayoutData, getLayoutDirection, getLocale, getParent, getProperty, getRenderId, getRenderIndexedProperty, getRenderIndexedProperty, getRenderLayoutDirection, getRenderLocale, getRenderProperty, getRenderProperty, getStyle, getStyleName, getVisibleComponent, getVisibleComponentCount, getVisibleComponents, hasEventListenerList, indexOf, init, isAncestorOf, isEnabled, isFocusTraversalParticipant, isRegistered, isRenderEnabled, isRenderVisible, isValidParent, isVisible, remove, remove, removeAll, removePropertyChangeListener, setBackground, setEnabled, setFocusTraversalIndex, setFocusTraversalParticipant, setFont, setForeground, setId, setIndexedProperty, setLayoutData, setLayoutDirection, setLocale, setProperty, setRenderId, setStyle, setStyleName, setVisible, validate, verifyInput, visibleIndexOf

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_FOCUS_BORDER

public static final java.lang.String PROPERTY_FOCUS_BORDER

See Also:

Constant Field Values

PROPERTY_TOP_FOCUS_BORDER

public static final java.lang.String PROPERTY_TOP_FOCUS_BORDER

See Also:

Constant Field Values

PROPERTY_RIGHT_FOCUS_BORDER

public static final java.lang.String PROPERTY_RIGHT_FOCUS_BORDER

See Also:

Constant Field Values

PROPERTY_BOTTOM_FOCUS_BORDER

public static final java.lang.String PROPERTY_BOTTOM_FOCUS_BORDER

See Also:

Constant Field Values

PROPERTY_LEFT_FOCUS_BORDER

public static final java.lang.String PROPERTY_LEFT_FOCUS_BORDER

See Also:

Constant Field Values

PROPERTY_FOCUS_FOREGROUND

public static final java.lang.String PROPERTY_FOCUS_FOREGROUND

See Also:

Constant Field Values

PROPERTY_FOCUS_BACKGROUND

public static final java.lang.String PROPERTY_FOCUS_BACKGROUND

See Also:

Constant Field Values

ACTION_VALIDATION_TRANSACTION

public static final java.lang.String ACTION_VALIDATION_TRANSACTION

See Also:

Constant Field Values

INPUT_VALID

public static final java.lang.String INPUT_VALID

See Also:

Constant Field Values

INPUT_INVALID

public static final java.lang.String INPUT_INVALID

See Also:

Constant Field Values

PROPERTY_MAXIMUM_LENGTH

public static final java.lang.String PROPERTY_MAXIMUM_LENGTH

See Also:

Constant Field Values

PROPERTY_MSG_VISIBLE

public static final java.lang.String PROPERTY_MSG_VISIBLE

See Also:

Constant Field Values

Constructor Detail

ActiveTextArea

public ActiveTextArea()

Creates a new ActiveTextArea with an empty StringDocument as its model, and default width setting.

ActiveTextArea

public ActiveTextArea(Document document)

Creates a new ActiveTextArea with the specified Document model.

Parameters:

document - the document

ActiveTextArea

public ActiveTextArea(Document document,
                      java.lang.String text,
                      int columns,
                      int rows)

Creates a new ActiveTextArea with the specified Document model, initial text, and column width.

Parameters:

document - the document

text - the initial text (may be null)

columns - the number of columns to display

Method Detail

processInput

public void processInput(java.lang.String inputName,
                         java.lang.Object inputValue)

Description copied from class: Component

Processes client input specific to the Component received from the UpdateManager. Derivative implementations should take care to invoke super.processInput().

Overrides:

processInput in class TextComponent

Parameters:

inputName - the name of the input

inputValue - the value of the input

See Also:

Component.processInput(java.lang.String, java.lang.Object)

setMaxLength

public void setMaxLength(int maxLength)

Sets the maximum length for this text area.

Parameters:

maxLength - the maximum length set to this text area.

getMaxLength

public int getMaxLength()

Gets maximum length for this text area.

Returns:

the maximum length as an int

setMessageVisible

public void setMessageVisible(boolean isVisible)

Sets the status message to be always visible

Parameters:

isVisible - boolean value set to determine

isMessageVisible

public boolean isMessageVisible()

Returns whether the message is visible or not.

setFocusBorder

public void setFocusBorder(Border border)

getFocusBorder

public Border getFocusBorder()

Returns the current focus border

setFocusBorder

public void setFocusBorder(Border topBorder,
                           Border rightBorder,
                           Border bottomBorder,
                           Border leftBorder)

setTopLeftFocusBorder

public void setTopLeftFocusBorder(Border border)

setRightBottomFocusBorder

public void setRightBottomFocusBorder(Border border)

setTopFocusBorder

public void setTopFocusBorder(Border border)

getTopFocusBorder

public Border getTopFocusBorder()

setRightFocusBorder

public void setRightFocusBorder(Border border)

getRightFocusBorder

public Border getRightFocusBorder()

setBottomFocusBorder

public void setBottomFocusBorder(Border border)

getBottomFocusBorder

public Border getBottomFocusBorder()

setLeftFocusBorder

public void setLeftFocusBorder(Border border)

getLeftFocusBorder

public Border getLeftFocusBorder()

setFocusBackground

public void setFocusBackground(Color color)

getFocusBackground

public Color getFocusBackground()

Returns the current focus background color

setFocusForeground

public void setFocusForeground(Color color)

getFocusForeground

public Color getFocusForeground()

Returns the current focus background color