net.shredzone.jshred.swing

Class JHistoryTextField

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

net.shredzone.jshred.swing.JHistoryTextField

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable

public class JHistoryTextField
extends JComponent

This is some kind of JTextField with a JComboBox. Text can be entered freely into the text field. The class keeps a history of recently entered texts, which can be selected in the JComboBox. The history is optionally stored as Preferences if a unique name is given to the constructor.

Since:

R6

Author:

Richard "Shred" Körber

See Also:

Serialized Form

Nested Class Summary

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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
JHistoryTextField() Creates a new JHistoryTextField.
JHistoryTextField(String name) Creates a new JHistoryTextField.

Method Summary

Modifier and Type	Method and Description
void	addActionListener(ActionListener l) Adds an ActionListener.
protected void	addHistory(String text) Adds a text to the top of the history.
void	clearHistory() Clears the entire history.
protected void	fireActionEvent(ActionEvent e) Informs all registered ActionListeners about a new ActionEvent.
int	getCurrentSize() Gets the current number of history entries.
List<String>	getHistory() Gets a List of the current history.
int	getHistorySize() Gets the current history size.
String	getText() Gets the text that is currently shown in this component.
boolean	isAutoSelection() Checks if the auto selection mode is enabled.
protected void	recallHistory(String name) Recalls the history from preferences, using the given name.
void	removeActionListener(ActionListener l) Removes an ActionListener.
void	setAutoSelection(boolean as) Sets the auto selection mode.
void	setEnabled(boolean enabled)
void	setHistorySize(int size) Sets the maximum history size.
void	setText(String text) Sets the text to be shown in this component.
protected void	storeHistory(String name) Stores the current history to the preferences, using the given name.

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, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, 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, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

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, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, 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, 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

JHistoryTextField

public JHistoryTextField()

Creates a new JHistoryTextField. The history will only be stored during the lifetime of this object.

JHistoryTextField

public JHistoryTextField(String name)

Creates a new JHistoryTextField. The history will be persistently stored using Preferences. You must provide a unique name for the history to be stored. It is strongly recommended to use the Java notation for unique names, as used in package names (i.e. your domain name in reverse notation, following a unique string of your choice).

Parameters:

name - Name which is used to persist the history.

Method Detail

setHistorySize

public void setHistorySize(int size)

Sets the maximum history size. If a new entry would exceed the limit, the least recently used entry will be removed from the history.

Parameters:

size - New history size

getHistorySize

public int getHistorySize()

Gets the current history size. Default is 10.

Returns:

Current history size

setAutoSelection

public void setAutoSelection(boolean as)

Sets the auto selection mode. If enabled, the entire text field will be marked after the user pressed return, so a new text entered will automatically replace the old one. This mode is turned on by default.

Parameters:

as - Auto selection mode.

isAutoSelection

public boolean isAutoSelection()

Checks if the auto selection mode is enabled.

Returns:

Auto selection mode state.

setText

public void setText(String text)

Sets the text to be shown in this component. The text will also be added to the history.

Parameters:

text - Text to be set.

getText

public String getText()

Gets the text that is currently shown in this component.

Returns:

Current text.

addHistory

protected void addHistory(String text)

Adds a text to the top of the history. If the text was already within the history, it is moved to the top. After that the text will be shown in the component. The current history will be persisted if a name was given to the constructor.

Parameters:

text - Text to be added to the history.

getHistory

public List<String> getHistory()

Gets a List of the current history. The list is unmodifiable and sorted from the most recent to the least recent history entry.

Returns:

List of all history entries

getCurrentSize

public int getCurrentSize()

Gets the current number of history entries.

Returns:

Current number of history entries.

clearHistory

public void clearHistory()

Clears the entire history.

setEnabled

public void setEnabled(boolean enabled)

Overrides:

setEnabled in class JComponent

storeHistory

protected void storeHistory(String name)
                     throws BackingStoreException

Stores the current history to the preferences, using the given name.

Parameters:

name - Name to file the history to.

Throws:

BackingStoreException - if it was not possible to store the history.

recallHistory

protected void recallHistory(String name)
                      throws BackingStoreException

Recalls the history from preferences, using the given name. The current history will be replaced.

Parameters:

name - Name the history was filed to.

Throws:

BackingStoreException - if it was not possible to recall the history.

addActionListener

public void addActionListener(ActionListener l)

Adds an ActionListener. It will be invoked if a new text has been entered. If it was already added, nothing will happen.

Parameters:

l - ActionListener to be added.

removeActionListener

public void removeActionListener(ActionListener l)

Removes an ActionListener. If it was not added, nothing will happen.

Parameters:

l - ActionListener to be removed.

fireActionEvent

protected void fireActionEvent(ActionEvent e)

Informs all registered ActionListeners about a new ActionEvent.

Parameters:

e - The ActionEvent to be broadcasted.