Package net.simplace.pipe.util.components

Class FWTextField

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JTextField

net.simplace.pipe.util.components.FWTextField

All Implemented Interfaces:

FocusListener, MouseListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, DocumentListener, Scrollable, SwingConstants

public class FWTextField
extends JTextField
implements MouseListener, FocusListener, DocumentListener

This class add the possibility to JTextField to lock the number of character in field to a max length.

Author:

Andreas Enders

See Also:

• Serialized Form

Nested Class Summary

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

JTextField.AccessibleJTextField

Nested classes/interfaces inherited from class javax.swing.text.JTextComponent

JTextComponent.AccessibleJTextComponent, JTextComponent.DropLocation, JTextComponent.KeyBinding

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

Modifier and Type	Field	Description
static final int	BIG_TEXTSIZE	This constant represents the size of a big text.
static final int	DEFAULT_TEXTSIZE	This constant represents the defaultvalue, that will be choosen when the developer has called the default constructor.
static final int	FILE_TEXTSIZE	This size for filepaths.
static final int	LITTLE_TEXTSIZE	This constant represents the size of a little text.
static final int	NORMAL_TEXTSIZE	This constant represents the size of a normal sized text.
static final int	UNLIMITED_TEXTSIZE	This constant represents the unlimited size.

Fields inherited from class javax.swing.JTextField

notifyAction

Fields inherited from class javax.swing.text.JTextComponent

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

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

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

Constructors

Constructor	Description
FWTextField(boolean aRequiredBorder)	Default constructor.
FWTextField(int aMaxSize, boolean aRequiredBorder)	This construcotr has the maxsize as parameter.
FWTextField(int aMaxSize, int aMaxInput, boolean aRequiredBorder)	This construcotr has the maxsize and the maxInput as parameter.
FWTextField(String aString, int aMaxSize, boolean aRequiredBorder)	Default constructor.
FWTextField(String aString, int aMaxSize, int aMaxInput, boolean aRequiredBorder)	This construcotr has the maxsize and the maxInput as parameter.
FWTextField(String aString, int aMaxSize, int aMaxInput, boolean aRequiredBorder, String aRegularExpression)	This construcotr has the maxsize and the maxInput as parameter.

Method Summary

Modifier and Type	Method	Description
void	changedUpdate(DocumentEvent eDocumentEvent)
static JPanel	createTextPanel(Component aComponent)	Creates a box with the given XTextField as only component.
void	focusGained(FocusEvent aFocusEvent)
void	focusLost(FocusEvent aFocusEvent)
String	getToolTipText()
void	insertUpdate(DocumentEvent eDocumentEvent)
void	mouseClicked(MouseEvent aMouseEvent)
void	mouseEntered(MouseEvent aMouseEvent)
void	mouseExited(MouseEvent aMouseEvent)
void	mousePressed(MouseEvent aMouseEvent)
void	mouseReleased(MouseEvent aMouseEvent)
void	removeUpdate(DocumentEvent eDocumentEvent)
void	setAcceptedChars(String aAcceptedChars)	Configures the FWTextFieldFilter.
void	setBorder(Border aBorder)
void	setDocument(Document aDocument)
void	setDrawBackgroundIfEmpty(boolean aB)	Sets the automatic drawing of the background.
void	setRequired(boolean aRequired)	Enables/disables the required mode.
void	setText(String aText)
void	updateColors()	updates the color after changes to the document

Methods inherited from class javax.swing.JTextField

actionPropertyChanged, addActionListener, configurePropertiesFromAction, createActionPropertyChangeListener, createDefaultModel, fireActionPerformed, getAccessibleContext, getAction, getActionListeners, getActions, getColumns, getColumnWidth, getHorizontalAlignment, getHorizontalVisibility, getPreferredSize, getScrollOffset, getUIClassID, isValidateRoot, paramString, postActionEvent, removeActionListener, scrollRectToVisible, setAction, setActionCommand, setColumns, setFont, setHorizontalAlignment, setScrollOffset

Methods inherited from class javax.swing.text.JTextComponent

addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getPrintable, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, modelToView2D, moveCaretPosition, paste, print, print, print, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, restoreComposedText, saveComposedText, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setUI, updateUI, viewToModel, viewToModel2D, write

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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, 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, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addKeyListener, 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, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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

Field Details

LITTLE_TEXTSIZE

public static final int LITTLE_TEXTSIZE

This constant represents the size of a little text.

See Also:

• Constant Field Values

NORMAL_TEXTSIZE

public static final int NORMAL_TEXTSIZE

This constant represents the size of a normal sized text.

See Also:

• Constant Field Values

BIG_TEXTSIZE

public static final int BIG_TEXTSIZE

This constant represents the size of a big text.

See Also:

• Constant Field Values

UNLIMITED_TEXTSIZE

public static final int UNLIMITED_TEXTSIZE

This constant represents the unlimited size.

See Also:

• Constant Field Values

FILE_TEXTSIZE

public static final int FILE_TEXTSIZE

This size for filepaths.

See Also:

• Constant Field Values

DEFAULT_TEXTSIZE

public static final int DEFAULT_TEXTSIZE

This constant represents the defaultvalue, that will be choosen when the developer has called the default constructor.

See Also:

• Constant Field Values

Constructor Details

FWTextField

public FWTextField(boolean aRequiredBorder)

Default constructor. Sets the default-textsize to this field.

FWTextField

public FWTextField(String aString,
 int aMaxSize,
 boolean aRequiredBorder)

Default constructor. Sets the default-textsize to this field.

FWTextField

public FWTextField(int aMaxSize,
 boolean aRequiredBorder)

This construcotr has the maxsize as parameter. This allows the developer to choose a size different from the default.

FWTextField

public FWTextField(int aMaxSize,
 int aMaxInput,
 boolean aRequiredBorder)

This construcotr has the maxsize and the maxInput as parameter. This allows the developer separate the MaxSize and the max. input of letters

FWTextField

public FWTextField(String aString,
 int aMaxSize,
 int aMaxInput,
 boolean aRequiredBorder)

This construcotr has the maxsize and the maxInput as parameter. This allows the developer separate the MaxSize and the max. input of letters

FWTextField

public FWTextField(String aString,
 int aMaxSize,
 int aMaxInput,
 boolean aRequiredBorder,
 String aRegularExpression)

This construcotr has the maxsize and the maxInput as parameter. This allows the developer separate the MaxSize and the max. input of letters

Method Details

createTextPanel

public static JPanel createTextPanel(Component aComponent)

Creates a box with the given XTextField as only component.

setRequired

public void setRequired(boolean aRequired)

Enables/disables the required mode.

mouseReleased

public void mouseReleased(MouseEvent aMouseEvent)

Specified by:

mouseReleased in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent aMouseEvent)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent aMouseEvent)

Specified by:

mouseExited in interface MouseListener

mousePressed

public void mousePressed(MouseEvent aMouseEvent)

Specified by:

mousePressed in interface MouseListener

mouseClicked

public void mouseClicked(MouseEvent aMouseEvent)

Specified by:

mouseClicked in interface MouseListener

updateColors

public void updateColors()

updates the color after changes to the document

setText

public void setText(String aText)

Overrides:

setText in class JTextComponent

See Also:

• JTextComponent.setText(java.lang.String)

setDocument

public void setDocument(Document aDocument)

Overrides:

setDocument in class JTextField

setAcceptedChars

public void setAcceptedChars(String aAcceptedChars)

Configures the FWTextFieldFilter.

focusGained

public void focusGained(FocusEvent aFocusEvent)

Specified by:

focusGained in interface FocusListener

focusLost

public void focusLost(FocusEvent aFocusEvent)

Specified by:

focusLost in interface FocusListener

setDrawBackgroundIfEmpty

public void setDrawBackgroundIfEmpty(boolean aB)

Sets the automatic drawing of the background.

insertUpdate

public void insertUpdate(DocumentEvent eDocumentEvent)

Specified by:

insertUpdate in interface DocumentListener

removeUpdate

public void removeUpdate(DocumentEvent eDocumentEvent)

Specified by:

removeUpdate in interface DocumentListener

changedUpdate

public void changedUpdate(DocumentEvent eDocumentEvent)

Specified by:

changedUpdate in interface DocumentListener

getToolTipText

public String getToolTipText()

Overrides:

getToolTipText in class JComponent

See Also:

• JComponent.getToolTipText()

setBorder

public void setBorder(Border aBorder)

Overrides:

setBorder in class JComponent

See Also:

• JComponent.setBorder(javax.swing.border.Border)