nextapp.echo.app.text

Class TextComponent

java.lang.Object

nextapp.echo.app.Component

nextapp.echo.app.text.TextComponent

All Implemented Interfaces:

java.io.Serializable, RenderIdSupport

Direct Known Subclasses:

TextArea, TextField

public abstract class TextComponent
extends Component

Abstract base class for text-entry components.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_LISTENERS_CHANGED_PROPERTY
static java.lang.String	DOCUMENT_CHANGED_PROPERTY
static java.lang.String	INPUT_ACTION
static java.lang.String	PROPERTY_ACTION_COMMAND
static java.lang.String	PROPERTY_ALIGNMENT
static java.lang.String	PROPERTY_BACKGROUND_IMAGE
static java.lang.String	PROPERTY_BORDER
static java.lang.String	PROPERTY_DISABLED_BACKGROUND
static java.lang.String	PROPERTY_DISABLED_BACKGROUND_IMAGE
static java.lang.String	PROPERTY_DISABLED_BORDER
static java.lang.String	PROPERTY_DISABLED_FONT
static java.lang.String	PROPERTY_DISABLED_FOREGROUND
static java.lang.String	PROPERTY_EDITABLE
static java.lang.String	PROPERTY_HEIGHT
static java.lang.String	PROPERTY_HORIZONTAL_SCROLL
static java.lang.String	PROPERTY_INSETS
static java.lang.String	PROPERTY_MAXIMUM_LENGTH
static java.lang.String	PROPERTY_READONLY_BACKGROUND
static java.lang.String	PROPERTY_READONLY_BACKGROUND_IMAGE
static java.lang.String	PROPERTY_READONLY_BORDER
static java.lang.String	PROPERTY_READONLY_FONT
static java.lang.String	PROPERTY_READONLY_FOREGROUND
static java.lang.String	PROPERTY_TOOL_TIP_TEXT
static java.lang.String	PROPERTY_VERTICAL_SCROLL
static java.lang.String	PROPERTY_WIDTH
static java.lang.String	TEXT_CHANGED_PROPERTY

Fields inherited from class nextapp.echo.app.Component

CHILD_VISIBLE_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FOCUS_NEXT_ID_CHANGED_PROPERTY, FOCUS_PREVIOUS_ID_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

Constructors

Constructor and Description
TextComponent(Document document) Creates a new TextComponent with the specified Document as its model.

Method Summary

Modifier and Type	Method and Description
void	addActionListener(ActionListener l) Adds an ActionListener to the TextComponent.
java.lang.String	getActionCommand() Returns the action command which will be provided in ActionEvents fired by this TextComponent.
Alignment	getAlignment() Returns the alignment of the text component.
FillImage	getBackgroundImage() Returns the default background image of the text component.
Border	getBorder() Returns the border of the text component.
Color	getDisabledBackground() Returns the background color displayed when the text component is disabled.
FillImage	getDisabledBackgroundImage() Returns the background image displayed when the text component is disabled.
Border	getDisabledBorder() Returns the border displayed when the text component is disabled.
Font	getDisabledFont() Returns the font displayed when the text component is disabled.
Color	getDisabledForeground() Returns the foreground color displayed when the text component is disabled.
Document	getDocument() Returns the model associated with this TextComponent.
Extent	getHeight() Returns the height of the text component.
Extent	getHorizontalScroll() Returns the horizontal scroll bar position.
Insets	getInsets() Returns the insets of the text component.
int	getMaximumLength() Returns the maximum length (in characters) of the text which may be entered into the component.
Color	getReadOnlyBackground() Returns the background color displayed when the text component is read only.
FillImage	getReadOnlyBackgroundImage() Returns the background image displayed when the text component is read only.
Border	getReadOnlyBorder() Returns the border displayed when the text component is read only.
Font	getReadOnlyFont() Returns the font displayed when the text component is read only.
Color	getReadOnlyForeground() Returns the foreground color displayed when the text component is read only.
java.lang.String	getText() Returns the text contained in the Document model of this text component.
java.lang.String	getToolTipText() Returns the tool tip text (displayed when the mouse cursor is hovered over the component).
Extent	getVerticalScroll() Returns the vertical scroll bar position.
Extent	getWidth() Returns the width of the text component.
boolean	hasActionListeners() Determines if any ActionListeners are registered.
boolean	isEditable() Determines the editable state of this component.
boolean	isValidChild(Component component) This component does not support children.
void	processInput(java.lang.String inputName, java.lang.Object inputValue) Processes client input specific to the Component received from the UpdateManager.
void	removeActionListener(ActionListener l) Removes an ActionListener from the TextComponent.
void	setActionCommand(java.lang.String newValue) Sets the action command which will be provided in ActionEvents fired by this TextComponent.
void	setAlignment(Alignment newValue) Sets the alignment of the text component.
void	setBackgroundImage(FillImage newValue) Sets the default background image of the text component.
void	setBorder(Border newValue) Sets the border of the text component.
void	setDisabledBackground(Color newValue) Sets the background color displayed when the component is disabled.
void	setDisabledBackgroundImage(FillImage newValue) Sets the background image displayed when the component is disabled.
void	setDisabledBorder(Border newValue) Sets the border displayed when the component is disabled.
void	setDisabledFont(Font newValue) Sets the font displayed when the component is disabled.
void	setDisabledForeground(Color newValue) Sets the foreground color displayed when the component is disabled.
void	setDocument(Document newValue) Sets the model associated with this TextComponent.
void	setEditable(boolean newValue) Sets the editable state of this component.
void	setHeight(Extent newValue) Sets the height of the text component.
void	setHorizontalScroll(Extent newValue) Sets the horizontal scroll bar position.
void	setInsets(Insets newValue) Sets the insets of the text component.
void	setMaximumLength(int newValue) Sets the maximum length (in characters) of the text which may be entered into the component.
void	setReadOnlyBackground(Color newValue) Sets the background color displayed when the component is read only.
void	setReadOnlyBackgroundImage(FillImage newValue) Sets the background image displayed when the component is read only.
void	setReadOnlyBorder(Border newValue) Sets the border displayed when the component is read only.
void	setReadOnlyFont(Font newValue) Sets the font displayed when the component is read only.
void	setReadOnlyForeground(Color newValue) Sets the foreground color displayed when the component is read only.
void	setText(java.lang.String newValue) Sets the text of document model of this text component.
void	setToolTipText(java.lang.String newValue) Sets the tool tip text (displayed when the mouse cursor is hovered over the component).
void	setVerticalScroll(Extent newValue) Sets the vertical scroll bar position.
void	setWidth(Extent newValue) Sets the width of the text component.

Methods inherited from class nextapp.echo.app.Component

add, add, addPropertyChangeListener, addPropertyChangeListener, dispose, firePropertyChange, get, getApplicationInstance, getBackground, getComponent, getComponent, getComponentCount, getComponents, getEventListenerList, getFocusNextId, getFocusPreviousId, getFont, getForeground, getId, getIndex, getLastRenderId, getLayoutData, getLayoutDirection, getLocale, getLocalStyle, getParent, getRenderId, getRenderIndexedProperty, getRenderIndexedProperty, getRenderLocale, getRenderProperty, getRenderProperty, getStyle, getStyleName, getVisibleComponent, getVisibleComponentCount, getVisibleComponents, hasEventListenerList, indexOf, init, isAncestorOf, isEnabled, isFocusTraversalParticipant, isRegistered, isRenderEnabled, isRenderVisible, isValidParent, isVisible, remove, remove, removeAll, removePropertyChangeListener, removePropertyChangeListener, set, setBackground, setComponents, setEnabled, setFocusNextId, setFocusPreviousId, setFocusTraversalParticipant, setFont, setForeground, setId, setIndex, setLayoutData, setLayoutDirection, setLocale, 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

INPUT_ACTION

public static final java.lang.String INPUT_ACTION

See Also:

Constant Field Values

PROPERTY_ACTION_COMMAND

public static final java.lang.String PROPERTY_ACTION_COMMAND

See Also:

Constant Field Values

PROPERTY_ALIGNMENT

public static final java.lang.String PROPERTY_ALIGNMENT

See Also:

Constant Field Values

PROPERTY_BACKGROUND_IMAGE

public static final java.lang.String PROPERTY_BACKGROUND_IMAGE

See Also:

Constant Field Values

PROPERTY_BORDER

public static final java.lang.String PROPERTY_BORDER

See Also:

Constant Field Values

PROPERTY_DISABLED_BACKGROUND

public static final java.lang.String PROPERTY_DISABLED_BACKGROUND

See Also:

Constant Field Values

PROPERTY_DISABLED_BACKGROUND_IMAGE

public static final java.lang.String PROPERTY_DISABLED_BACKGROUND_IMAGE

See Also:

Constant Field Values

PROPERTY_DISABLED_BORDER

public static final java.lang.String PROPERTY_DISABLED_BORDER

See Also:

Constant Field Values

PROPERTY_DISABLED_FONT

public static final java.lang.String PROPERTY_DISABLED_FONT

See Also:

Constant Field Values

PROPERTY_DISABLED_FOREGROUND

public static final java.lang.String PROPERTY_DISABLED_FOREGROUND

See Also:

Constant Field Values

PROPERTY_EDITABLE

public static final java.lang.String PROPERTY_EDITABLE

See Also:

Constant Field Values

PROPERTY_HEIGHT

public static final java.lang.String PROPERTY_HEIGHT

See Also:

Constant Field Values

PROPERTY_HORIZONTAL_SCROLL

public static final java.lang.String PROPERTY_HORIZONTAL_SCROLL

See Also:

Constant Field Values

PROPERTY_INSETS

public static final java.lang.String PROPERTY_INSETS

See Also:

Constant Field Values

PROPERTY_MAXIMUM_LENGTH

public static final java.lang.String PROPERTY_MAXIMUM_LENGTH

See Also:

Constant Field Values

PROPERTY_READONLY_BACKGROUND

public static final java.lang.String PROPERTY_READONLY_BACKGROUND

See Also:

Constant Field Values

PROPERTY_READONLY_BACKGROUND_IMAGE

public static final java.lang.String PROPERTY_READONLY_BACKGROUND_IMAGE

See Also:

Constant Field Values

PROPERTY_READONLY_BORDER

public static final java.lang.String PROPERTY_READONLY_BORDER

See Also:

Constant Field Values

PROPERTY_READONLY_FONT

public static final java.lang.String PROPERTY_READONLY_FONT

See Also:

Constant Field Values

PROPERTY_READONLY_FOREGROUND

public static final java.lang.String PROPERTY_READONLY_FOREGROUND

See Also:

Constant Field Values

PROPERTY_TOOL_TIP_TEXT

public static final java.lang.String PROPERTY_TOOL_TIP_TEXT

See Also:

Constant Field Values

PROPERTY_VERTICAL_SCROLL

public static final java.lang.String PROPERTY_VERTICAL_SCROLL

See Also:

Constant Field Values

PROPERTY_WIDTH

public static final java.lang.String PROPERTY_WIDTH

See Also:

Constant Field Values

ACTION_LISTENERS_CHANGED_PROPERTY

public static final java.lang.String ACTION_LISTENERS_CHANGED_PROPERTY

See Also:

Constant Field Values

DOCUMENT_CHANGED_PROPERTY

public static final java.lang.String DOCUMENT_CHANGED_PROPERTY

See Also:

Constant Field Values

TEXT_CHANGED_PROPERTY

public static final java.lang.String TEXT_CHANGED_PROPERTY

See Also:

Constant Field Values

Constructor Detail

TextComponent

public TextComponent(Document document)

Creates a new TextComponent with the specified Document as its model.

Parameters:

document - the desired model

Method Detail

addActionListener

public void addActionListener(ActionListener l)

Adds an ActionListener to the TextComponent. The ActionListener will be invoked when the user presses the ENTER key in the field.

Parameters:

l - the ActionListener to add

getActionCommand

public java.lang.String getActionCommand()

Returns the action command which will be provided in ActionEvents fired by this TextComponent.

Returns:

the action command

getAlignment

public Alignment getAlignment()

Returns the alignment of the text component.

Returns:

the alignment

getBackgroundImage

public FillImage getBackgroundImage()

Returns the default background image of the text component.

Returns:

the background image

getBorder

public Border getBorder()

Returns the border of the text component.

Returns:

the border

getDisabledBackground

public Color getDisabledBackground()

Returns the background color displayed when the text component is disabled.

Returns:

the color

getDisabledBackgroundImage

public FillImage getDisabledBackgroundImage()

Returns the background image displayed when the text component is disabled.

Returns:

the background image

getDisabledBorder

public Border getDisabledBorder()

Returns the border displayed when the text component is disabled.

Returns:

the border

getDisabledFont

public Font getDisabledFont()

Returns the font displayed when the text component is disabled.

Returns:

the font

getDisabledForeground

public Color getDisabledForeground()

Returns the foreground color displayed when the text component is disabled.

Returns:

the color

getDocument

public Document getDocument()

Returns the model associated with this TextComponent.

Returns:

the model

getHeight

public Extent getHeight()

Returns the height of the text component. This property only supports Extents with fixed (i.e., not percent) units.

Returns:

the height

getHorizontalScroll

public Extent getHorizontalScroll()

Returns the horizontal scroll bar position.

Returns:

the scroll bar position

getInsets

public Insets getInsets()

Returns the insets of the text component.

Returns:

the insets

getMaximumLength

public int getMaximumLength()

Returns the maximum length (in characters) of the text which may be entered into the component.

Returns:

the maximum length, or -1 if no value is specified

getReadOnlyBackground

public Color getReadOnlyBackground()

Returns the background color displayed when the text component is read only.

Returns:

the color

getReadOnlyBackgroundImage

public FillImage getReadOnlyBackgroundImage()

Returns the background image displayed when the text component is read only.

Returns:

the background image

getReadOnlyBorder

public Border getReadOnlyBorder()

Returns the border displayed when the text component is read only.

Returns:

the border

getReadOnlyFont

public Font getReadOnlyFont()

Returns the font displayed when the text component is read only.

Returns:

the font

getReadOnlyForeground

public Color getReadOnlyForeground()

Returns the foreground color displayed when the text component is read only.

Returns:

the color

getText

public java.lang.String getText()

Returns the text contained in the Document model of this text component.

Returns:

the text contained in the document

getToolTipText

public java.lang.String getToolTipText()

Returns the tool tip text (displayed when the mouse cursor is hovered over the component).

Returns:

the tool tip text

getVerticalScroll

public Extent getVerticalScroll()

Returns the vertical scroll bar position.

Returns:

the scroll bar position

getWidth

public Extent getWidth()

Returns the width of the text component. This property supports Extents with either fixed or percentage-based units.

Returns:

the width

hasActionListeners

public boolean hasActionListeners()

Determines if any ActionListeners are registered.

Returns:

true if any action listeners are registered

isEditable

public boolean isEditable()

Determines the editable state of this component. Components that are not editable do not receive user input, but they do gain focus, so it is possible to, say, copy the component's text using keyboard shortcuts.

Returns:

true if this component is editable

isValidChild

public boolean isValidChild(Component component)

This component does not support children.

Overrides:

isValidChild in class Component

Parameters:

component - the Component to evaluate as a child

Returns:

true if the Component is a valid child

See Also:

Component.isValidChild(nextapp.echo.app.Component)

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(). Security note: Because input to this method is likely from a remote client, it should be treated as potentially hostile. All input to this method should be carefully verified. For example, directly invoking set() method with the provided input would constitute a security hole.

Overrides:

processInput in class Component

Parameters:

inputName - the name of the input

inputValue - the value of the input

See Also:

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

removeActionListener

public void removeActionListener(ActionListener l)

Removes an ActionListener from the TextComponent.

Parameters:

l - the ActionListener to remove

setActionCommand

public void setActionCommand(java.lang.String newValue)

Sets the action command which will be provided in ActionEvents fired by this TextComponent.

Parameters:

newValue - the new action command

setAlignment

public void setAlignment(Alignment newValue)

Sets the alignment of the text component.

Parameters:

newValue - the new alignment

setBackgroundImage

public void setBackgroundImage(FillImage newValue)

Sets the default background image of the text component.

Parameters:

newValue - the new background image

setBorder

public void setBorder(Border newValue)

Sets the border of the text component.

Parameters:

newValue - the new border

setDisabledBackground

public void setDisabledBackground(Color newValue)

Sets the background color displayed when the component is disabled.

Parameters:

newValue - the new Color

setDisabledBackgroundImage

public void setDisabledBackgroundImage(FillImage newValue)

Sets the background image displayed when the component is disabled.

Parameters:

newValue - the new background image

setDisabledBorder

public void setDisabledBorder(Border newValue)

Sets the border displayed when the component is disabled.

Parameters:

newValue - the new border

setDisabledFont

public void setDisabledFont(Font newValue)

Sets the font displayed when the component is disabled.

Parameters:

newValue - the new Font

setDisabledForeground

public void setDisabledForeground(Color newValue)

Sets the foreground color displayed when the component is disabled.

Parameters:

newValue - the new Color

setDocument

public void setDocument(Document newValue)

Sets the model associated with this TextComponent.

Parameters:

newValue - the new model (may not be null)

setEditable

public void setEditable(boolean newValue)

Sets the editable state of this component. Components that are not editable do not receive user input, but they do gain focus, so it is possible to, say, copy the component's text using keyboard shortcuts.

Parameters:

newValue - the new editable state

setHeight

public void setHeight(Extent newValue)

Sets the height of the text component. This property only supports Extents with fixed (i.e., not percent) units.

Parameters:

newValue - the new height

setHorizontalScroll

public void setHorizontalScroll(Extent newValue)

Sets the horizontal scroll bar position. The provided Extent value must be in pixel units.

Parameters:

newValue - the new scroll bar position

setInsets

public void setInsets(Insets newValue)

Sets the insets of the text component.

Parameters:

newValue - the new insets

setMaximumLength

public void setMaximumLength(int newValue)

Sets the maximum length (in characters) of the text which may be entered into the component.

Parameters:

newValue - the new maximum length, or -1 if to specify an unlimited length

setReadOnlyBackground

public void setReadOnlyBackground(Color newValue)

Sets the background color displayed when the component is read only.

Parameters:

newValue - the new Color

setReadOnlyBackgroundImage

public void setReadOnlyBackgroundImage(FillImage newValue)

Sets the background image displayed when the component is read only.

Parameters:

newValue - the new background image

setReadOnlyBorder

public void setReadOnlyBorder(Border newValue)

Sets the border displayed when the component is read only.

Parameters:

newValue - the new border

setReadOnlyFont

public void setReadOnlyFont(Font newValue)

Sets the font displayed when the component is read only.

Parameters:

newValue - the new Font

setReadOnlyForeground

public void setReadOnlyForeground(Color newValue)

Sets the foreground color displayed when the component is read only.

Parameters:

newValue - the new Color

setText

public void setText(java.lang.String newValue)

Sets the text of document model of this text component.

Parameters:

newValue - the new text

setToolTipText

public void setToolTipText(java.lang.String newValue)

Sets the tool tip text (displayed when the mouse cursor is hovered over the component).

Parameters:

newValue - the new tool tip text

setVerticalScroll

public void setVerticalScroll(Extent newValue)

Sets the vertical scroll bar position. The provided Extent value must be in pixel units.

Parameters:

newValue - the new scroll bar position

setWidth

public void setWidth(Extent newValue)

Sets the width of the text component. This property supports Extents with either fixed or percentage-based units.

Parameters:

newValue - the new width