Package org.jdesktop.swingx

Class JXFormattedTextField

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JTextField

javax.swing.JFormattedTextField

org.jdesktop.swingx.JXFormattedTextField

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, Scrollable, SwingConstants

public class JXFormattedTextField
extends JFormattedTextField

JFormattedTextField, with integrated support for prompts and buddies.

Author:

Peter Weishapl petw@gmx.net, EUG https://github.com/homebeaver

See Also:

• PromptSupport
• BuddySupport
• Serialized Form

Nested Class Summary

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

JFormattedTextField.AbstractFormatter, JFormattedTextField.AbstractFormatterFactory

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 inherited from class javax.swing.JFormattedTextField

COMMIT, COMMIT_OR_REVERT, PERSIST, REVERT

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
JXFormattedTextField()
JXFormattedTextField(Object value)
JXFormattedTextField(String promptText)
JXFormattedTextField(String promptText, Color promptForeground)
JXFormattedTextField(String promptText, Color promptForeground, Color promptBackground)	ctor
JXFormattedTextField(Format format)
JXFormattedTextField(JFormattedTextField.AbstractFormatter formatter)

Method Summary

Modifier and Type	Method	Description
void	addBuddy(Component buddy, BuddySupport.Position pos)
void	addGap(int width, BuddySupport.Position pos)
List<Component>	getBuddies(BuddySupport.Position pos)
PromptSupport.FocusBehavior	getFocusBehavior()
Insets	getOuterMargin()
String	getPrompt()
Color	getPromptBackground()
Integer	getPromptFontStyle()
Color	getPromptForeground()
void	removeAllBuddies()
void	setFocusBehavior(PromptSupport.FocusBehavior focusBehavior)
void	setOuterMargin(Insets margin)
void	setPrompt(String labelText)
void	setPromptBackground(Color promptTextColor)
void	setPromptFontStyle(Integer fontStyle)
void	setPromptForeground(Color promptTextColor)

Methods inherited from class javax.swing.JFormattedTextField

commitEdit, getActions, getFocusLostBehavior, getFormatter, getFormatterFactory, getUIClassID, getValue, invalidEdit, isEditValid, processFocusEvent, processInputMethodEvent, setDocument, setFocusLostBehavior, setFormatter, setFormatterFactory, setValue

Methods inherited from class javax.swing.JTextField

actionPropertyChanged, addActionListener, configurePropertiesFromAction, createActionPropertyChangeListener, createDefaultModel, fireActionPerformed, getAccessibleContext, getAction, getActionListeners, getColumns, getColumnWidth, getHorizontalAlignment, getHorizontalVisibility, getPreferredSize, getScrollOffset, 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, 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, setText, 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, getToolTipText, 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, setBorder, 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, 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

Constructor Details

JXFormattedTextField

public JXFormattedTextField(Object value)

JXFormattedTextField

public JXFormattedTextField(Format format)

JXFormattedTextField

public JXFormattedTextField(JFormattedTextField.AbstractFormatter formatter)

JXFormattedTextField

public JXFormattedTextField()

JXFormattedTextField

public JXFormattedTextField(String promptText)

JXFormattedTextField

public JXFormattedTextField(String promptText,
 Color promptForeground)

JXFormattedTextField

public JXFormattedTextField(String promptText,
 Color promptForeground,
 Color promptBackground)

ctor

Parameters:

promptText - String

promptForeground - Color

promptBackground - Color

Method Details

getFocusBehavior

public PromptSupport.FocusBehavior getFocusBehavior()

Returns:

FocusBehavior

See Also:

• PromptSupport.getFocusBehavior(javax.swing.text.JTextComponent)

getPrompt

public String getPrompt()

Returns:

Prompt

See Also:

• PromptSupport.getPrompt(javax.swing.text.JTextComponent)

getPromptForeground

public Color getPromptForeground()

Returns:

Color

See Also:

• PromptSupport.getForeground(javax.swing.text.JTextComponent)

getPromptBackground

public Color getPromptBackground()

Returns:

Color

See Also:

• PromptSupport.getForeground(javax.swing.text.JTextComponent)

getPromptFontStyle

public Integer getPromptFontStyle()

Returns:

FontStyle

See Also:

• PromptSupport.getFontStyle(javax.swing.text.JTextComponent)

setFocusBehavior

public void setFocusBehavior(PromptSupport.FocusBehavior focusBehavior)

Parameters:

focusBehavior - FocusBehavior

See Also:

• PromptSupport.getFocusBehavior(javax.swing.text.JTextComponent)

setPrompt

public void setPrompt(String labelText)

Parameters:

labelText - String

See Also:

• PromptSupport.setPrompt(String, javax.swing.text.JTextComponent)

setPromptForeground

public void setPromptForeground(Color promptTextColor)

Parameters:

promptTextColor - Color

See Also:

• PromptSupport.setForeground(Color, javax.swing.text.JTextComponent)

setPromptBackground

public void setPromptBackground(Color promptTextColor)

Parameters:

promptTextColor - Color

See Also:

• PromptSupport.setBackground(Color, javax.swing.text.JTextComponent)

setPromptFontStyle

public void setPromptFontStyle(Integer fontStyle)

Parameters:

fontStyle - Integer

See Also:

• PromptSupport.setFontStyle(Integer, javax.swing.text.JTextComponent)

setOuterMargin

public void setOuterMargin(Insets margin)

Parameters:

margin - Insets

See Also:

• BuddySupport.setOuterMargin(JTextField, Insets)

getOuterMargin

public Insets getOuterMargin()

Returns:

Insets

See Also:

• BuddySupport.getOuterMargin(JTextField)

addBuddy

public void addBuddy(Component buddy,
 BuddySupport.Position pos)

Parameters:

buddy - Component

pos - Position

See Also:

• BuddySupport.add(Component, Position, JTextField)

addGap

public void addGap(int width,
 BuddySupport.Position pos)

Parameters:

width - int

pos - Position

See Also:

• BuddySupport.addGap(int, Position, JTextField)

getBuddies

public List<Component> getBuddies(BuddySupport.Position pos)

Parameters:

pos - Position

Returns:

list of Components

See Also:

• BuddySupport.getBuddies(Position, JTextField)

removeAllBuddies

public void removeAllBuddies()

See Also:

• BuddySupport.removeAll(JTextField)