echopoint
Class KeystrokeTextField

java.lang.Object
  nextapp.echo.app.Component
      nextapp.echo.app.text.TextComponent
          nextapp.echo.app.TextField
              echopoint.internal.TextField
                  echopoint.KeystrokeTextField

All Implemented Interfaces:

Serializable, RenderIdSupport

Direct Known Subclasses:

AutoLookupTextField

public class KeystrokeTextField
extends TextField

The KeystrokeTextField allows you to be notified about each keystroke in the text field component. This can for example be used to do a incremental filetring of a server database and then display the matching records as you type. Please use the following component with care, it creates a request for every keystroke per default. You can configure a keystrokeDelay which synchronizes only after the specified delay. So someone who is typing rapidly doesn't create lots of requests, instead the synchronization is triggered only when the user stops typing for the specified amount of time (=keystrokeDelay).

Version:

$Id: $

Author:

André Schild, 299-06-05, Based on code posted in the Echo wiki

See Also:

Serialized Form

Field Summary

static String

PROPERTY_KEYSTROKE_DELAY

Fields inherited from class echopoint.internal.TextField

PROPERTY_DEFAULT_TEXT

Fields inherited from class nextapp.echo.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_EDITABLE, PROPERTY_HEIGHT, PROPERTY_HORIZONTAL_SCROLL, PROPERTY_INSETS, PROPERTY_MAXIMUM_LENGTH, PROPERTY_TOOL_TIP_TEXT, PROPERTY_VERTICAL_SCROLL, PROPERTY_WIDTH, 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

KeystrokeTextField()
Default constructor.

KeystrokeTextField(int keystrokeDelay)
Create a new text field with the specified keystroke delay

Method Summary

void	setKeystrokeDelay(int keystrokeDelay) Set the keystroke delay

Methods inherited from class echopoint.internal.TextField

getDefaultText, setDefaultText

Methods inherited from class nextapp.echo.app.text.TextComponent

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

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, 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

PROPERTY_KEYSTROKE_DELAY

public static final String PROPERTY_KEYSTROKE_DELAY

See Also:

Constant Field Values

Constructor Detail

KeystrokeTextField

public KeystrokeTextField()

Default constructor. Uses a keystroke delay of 0ms. Not a good idea in most cases. Instead use the constructor with a keystrokeDelay of for example 250ms

KeystrokeTextField

public KeystrokeTextField(int keystrokeDelay)

Create a new text field with the specified keystroke delay

Parameters:

keystrokeDelay - The keystroke delay to be used in ms

Method Detail

setKeystrokeDelay

public void setKeystrokeDelay(int keystrokeDelay)

Set the keystroke delay

Parameters:

keystrokeDelay - The keystroke delay to be used in ms