com.lf.commons.gui.field

Class HistoryField

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.lf.commons.gui.field.HistoryField

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

public class HistoryField
extends javax.swing.JPanel
implements java.awt.event.ActionListener

Let's the user specify a pattern e.g. for search or choose one from the history list.

Since:

1.5

Version:

$Revision: 1.11 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
HistoryField() Constructor of this form.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent event) Called whenever the one of the components was activated.
void	addDocumentListener(javax.swing.event.DocumentListener listener) Adds a document listener to react on text changes.
void	addFocusListener(java.awt.event.FocusListener listener) Adds a focus listener to react on focussing from outside the component.
void	addKeyListener(java.awt.event.KeyListener listener) Adds a key listener to react on typing from outside the component.
void	addToHistory() Adds the current text as history item.
javax.swing.JComboBox	getComboBox() Provides the combo box component.
javax.swing.text.JTextComponent	getEditor() Gets the editor component for the text.
java.lang.String[]	getHistory() Gets the items of the history list.
int	getMaxItems() Gets the maximum number of items in the history list.
java.lang.String	getText() Gets the current text entered in the pattern text field.
java.lang.String	getToolTipText() Provides the tooltip text.
void	removeFromHistory(java.lang.String item) Removes an item from the history list.
void	requestFocus() Sets the focus to type into the pattern text field.
void	selectText() Selects the text displayed by the pattern text field.
void	setEnabled(boolean enable) Activates/deactivates the component for input.
void	setHistory(java.lang.String[] items) Sets the items of the history list.
boolean	setMaxItems(int maxitems) Sets the maximum number of items in the history list.
void	setStatusBar(StatusBar statusbar) Sets the status bar to display messages (copy and paste etc.).
boolean	setText(java.lang.String text) Sets the current text shown by the pattern text field.
void	setToolTipText(java.lang.String tooltip) Sets the tooltip text.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

HistoryField

public HistoryField()

Constructor of this form.

Since:

1.5

Method Detail

setMaxItems

public boolean setMaxItems(int maxitems)

Sets the maximum number of items in the history list.

Parameters:

maxitems - The maximum number of items >= 1

Returns:

Setting succeeded?

Since:

1.5

getMaxItems

public int getMaxItems()

Gets the maximum number of items in the history list.

Returns:

The maximum number of items

Since:

1.5

setText

public boolean setText(java.lang.String text)

Sets the current text shown by the pattern text field.

Parameters:

text - The text to be shown

Returns:

Setting succeeded?

Since:

1.5

getText

public java.lang.String getText()

Gets the current text entered in the pattern text field.

Returns:

The current text or empty string if not available

Since:

1.5

selectText

public void selectText()

Selects the text displayed by the pattern text field.

Since:

1.5

requestFocus

public void requestFocus()

Sets the focus to type into the pattern text field.

Overrides:

requestFocus in class javax.swing.JComponent

Since:

1.5

getHistory

public java.lang.String[] getHistory()

Gets the items of the history list.

Returns:

The list of items

Since:

1.5

addToHistory

public void addToHistory()

Adds the current text as history item.

Normally new items are only added on ENTER.

Since:

1.6

removeFromHistory

public void removeFromHistory(java.lang.String item)

Removes an item from the history list.

Parameters:

item - To be removed

Since:

1.6

setHistory

public void setHistory(java.lang.String[] items)

Sets the items of the history list.

After setting the history items no automatic selection of the first item takes place.

Parameters:

items - The list of items

Since:

1.5

addKeyListener

public void addKeyListener(java.awt.event.KeyListener listener)

Adds a key listener to react on typing from outside the component.

Overrides:

addKeyListener in class java.awt.Component

Parameters:

listener - The new key listener to be added

Since:

1.5

addFocusListener

public void addFocusListener(java.awt.event.FocusListener listener)

Adds a focus listener to react on focussing from outside the component.

Overrides:

addFocusListener in class java.awt.Component

Parameters:

listener - The new focus listener to be added

Since:

1.5

addDocumentListener

public void addDocumentListener(javax.swing.event.DocumentListener listener)

Adds a document listener to react on text changes.

Parameters:

listener - The new document listener to be added

Since:

1.5

getEditor

public javax.swing.text.JTextComponent getEditor()

Gets the editor component for the text.

Returns:

The text component or null if not available

Since:

1.5

setToolTipText

public void setToolTipText(java.lang.String tooltip)

Sets the tooltip text.

Overrides:

setToolTipText in class javax.swing.JComponent

Parameters:

tooltip - The new tooltip text

Since:

1.5

getToolTipText

public java.lang.String getToolTipText()

Provides the tooltip text.

Overrides:

getToolTipText in class javax.swing.JComponent

Returns:

The tooltip text

Since:

1.6

setStatusBar

public void setStatusBar(StatusBar statusbar)

Sets the status bar to display messages (copy and paste etc.).

Parameters:

statusbar - The status bar for messages

Since:

1.6

getComboBox

public javax.swing.JComboBox getComboBox()

Provides the combo box component.

Returns:

The combo box

Since:

1.6

setEnabled

public void setEnabled(boolean enable)

Activates/deactivates the component for input.

Overrides:

setEnabled in class javax.swing.JComponent

Since:

1.6

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)

Called whenever the one of the components was activated.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

event - The event object

Since:

1.6