com.partnersoft.gui.forms

Class FormSearchField

java.lang.Object

com.partnersoft.gui.forms.AbstractFormField<T>

com.partnersoft.gui.forms.AbstractFormTextField<java.lang.String>

com.partnersoft.gui.forms.FormSearchField

All Implemented Interfaces:

FormField<java.lang.String>, java.awt.event.KeyListener, java.util.EventListener

public class FormSearchField
extends AbstractFormTextField<java.lang.String>

A text field for search/filter interfaces. The extra functionality includes a placeholder string (when the user hasn't yet typed anything), and a button to clear the currently-entered text.

Adapted from some example code by Elliott Hughes.

Copyright 2012 Partner Software, Inc.

Author:

Paul Reavis, Elliott Hughes

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	armed True if the cancel button is currently armed.
protected static java.awt.Color	GRAY Color used when cancel button is not armed.
protected boolean	sendsNotificationForEachKeystroke True if search is set up to provide incremental behavior by notifying on each keystroke.
protected boolean	showingPlaceholderText True if the placeholder text is currently shown.

Fields inherited from class com.partnersoft.gui.forms.AbstractFormField

gui

Constructor Summary

Constructors

Constructor and Description
FormSearchField() Create a new FormSearchField with the placeholder text "Search".
FormSearchField(java.lang.String placeholderText) Create a new FormSearchField with the given placeholder text.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Cancels the search and clears the field.
protected void	maybeNotify() Notify if field is not blank.
void	setSendsNotificationForEachKeystroke(boolean eachKeystroke) True if search is set up to provide incremental behavior by notifying on each keystroke.

Methods inherited from class com.partnersoft.gui.forms.AbstractFormTextField

down, getJTextField, getValue, grabFocus, keyPressed, keyReleased, keyTyped, left, right, selectAll, selectNone, setDisabled, setValue, setValueSafely, up

Methods inherited from class com.partnersoft.gui.forms.AbstractFormField

addFieldListener, createPopup, doAction, fireActionRequested, fireValueChanged, getGui, getToolTipText, isDisabled, removeFieldListener, setToolTipText, toString, valueChanged

Methods inherited from class java.lang.Object

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

Field Detail

GRAY

protected static final java.awt.Color GRAY

Color used when cancel button is not armed.

sendsNotificationForEachKeystroke

protected boolean sendsNotificationForEachKeystroke

True if search is set up to provide incremental behavior by notifying on each keystroke.

showingPlaceholderText

protected boolean showingPlaceholderText

True if the placeholder text is currently shown.

armed

protected boolean armed

True if the cancel button is currently armed.

Constructor Detail

FormSearchField

public FormSearchField(java.lang.String placeholderText)

Create a new FormSearchField with the given placeholder text.

Parameters:

placeholderText - text shown when field value is blank

FormSearchField

public FormSearchField()

Create a new FormSearchField with the placeholder text "Search".

Method Detail

cancel

public void cancel()

Cancels the search and clears the field.

maybeNotify

protected void maybeNotify()

Notify if field is not blank.

setSendsNotificationForEachKeystroke

public void setSendsNotificationForEachKeystroke(boolean eachKeystroke)

True if search is set up to provide incremental behavior by notifying on each keystroke.

Parameters:

eachKeystroke - true if incremental