Package com.portal.pfc.ui
Class BigIntegerTextField
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.text.JTextComponent
javax.swing.JTextField
com.portal.pfc.ui.ValidatedTextField
com.portal.pfc.ui.BigIntegerTextField
- All Implemented Interfaces:
CyclerListener,ImageObserver,MenuContainer,Serializable,EventListener,Accessible,Scrollable,SwingConstants
- Direct Known Subclasses:
PIABigIntegerField
A textfield that accepts numeric data only. Decimal/fractional input is
rejected - the number represented by this textfield must be an integer.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class javax.swing.JTextField
JTextField.AccessibleJTextFieldNested classes/interfaces inherited from class javax.swing.text.JTextComponent
JTextComponent.AccessibleJTextComponent, JTextComponent.DropLocation, JTextComponent.KeyBindingNested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponentNested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainerNested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy -
Field Summary
Fields inherited from class javax.swing.JTextField
notifyActionFields inherited from class javax.swing.text.JTextComponent
DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEYFields inherited from class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWFields inherited from class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTHFields 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
ConstructorsConstructorDescriptionConstructs a new BigIntegerTextField.BigIntegerTextField(int cols) Constructs a new BigIntegerTextField containing the specified number of columns. -
Method Summary
Modifier and TypeMethodDescriptionvoidbooleanlongGets the maximum value allowedlongGets the minimum value allowed when spinning up.intgetValue()Used to retrieve the value of component as an Integer instead of a String (using getText()).booleanReports whether the textfield can have an empty value.voidreplaceSelection(String str) Replaces the currently selected content with the specified text, granted the specified text contains numeric data only.voidsetAllowEmptyValue(boolean b) If true, the textfield appears initially empty and getText() will return an empty string.voidsetMaximumValue(int max) Sets the minimum value allowedvoidsetMaximumValue(long max) voidsetMaximumValue(String max) voidsetMinimumValue(int min) Sets the minimum value allowedvoidsetMinimumValue(long min) voidsetMinimumValue(String min) voidsetNumDigitsAllowed(int len) Establishes the maximum number of digits allowed in this textfield Note that if the resulting number exceeds the maximum value of an Integer you will not be able to retrieve the value as an Integer.
The default is 10.voidSets the text of this textfield to the specified text, granted the specified text contains numeric data only.voidCalled when this component is embedded in a SpinnerField and the associated Cycler is selected.Methods inherited from class com.portal.pfc.ui.ValidatedTextField
getSpecialChars, isValidInput, setSpecialCharsMethods 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, setDocument, setFont, setHorizontalAlignment, setScrollOffsetMethods 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, 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, writeMethods inherited from class javax.swing.JComponent
addAncestorListener, 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, updateMethods 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, validateTreeMethods 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
-
Constructor Details
-
BigIntegerTextField
public BigIntegerTextField()Constructs a new BigIntegerTextField. The number of columns is set to 10. The default minimum value allowed (when in a SpinnerField) is 0, and the maximum value is 100. -
BigIntegerTextField
public BigIntegerTextField(int cols) Constructs a new BigIntegerTextField containing the specified number of columns. The default minimum value allowed (when in a SpinnerField) is 0, and the maximum value is 100.- Parameters:
columns- the number of columns to use to calculate the preferred width.
-
-
Method Details
-
setText
Sets the text of this textfield to the specified text, granted the specified text contains numeric data only. If the specified text contains alphabetic characters (including the currency symbol and/or the grouping separator) the text is rejected.- Overrides:
setTextin classJTextComponent- Parameters:
str- the new text to display
-
coalesceEvents
public boolean coalesceEvents() -
replaceSelection
Replaces the currently selected content with the specified text, granted the specified text contains numeric data only. If the specified text contains alphabetic characters the text is rejected. If there is no selection this amounts to an insert of the specified text.- Overrides:
replaceSelectionin classJTextComponent- Parameters:
str- the text to use when replacing the selected text
-
getValue
Used to retrieve the value of component as an Integer instead of a String (using getText()). Note that you may get a NumberFormatException if the number represented in the textfield exceeds the maximum Integer value. If that is the case, you may choose to retrieve the number as a String instead.- Specified by:
getValuein classValidatedTextField- Returns:
- the numeric value of the component
-
valueChange
Called when this component is embedded in a SpinnerField and the associated Cycler is selected.- Specified by:
valueChangein interfaceCyclerListener- Specified by:
valueChangein classValidatedTextField- Parameters:
e- the CyclerEvent
-
setMaximumValue
public void setMaximumValue(int max) Sets the minimum value allowed- Parameters:
max- the max value
-
setMaximumValue
public void setMaximumValue(long max) -
setMaximumValue
-
getMaximumValue
public long getMaximumValue()Gets the maximum value allowed- Returns:
- the max value
-
setMinimumValue
public void setMinimumValue(int min) Sets the minimum value allowed- Parameters:
the- minimum value
-
setMinimumValue
public void setMinimumValue(long min) -
setMinimumValue
-
getMinimumValue
public long getMinimumValue()Gets the minimum value allowed when spinning up.- Returns:
- the min value
-
setAllowEmptyValue
public void setAllowEmptyValue(boolean b) If true, the textfield appears initially empty and getText() will return an empty string. Otherwise, the textfield will have an initial value of the minimum value.
This is initially false;- Parameters:
b- Determines the state
-
isAllowEmptyValue
public boolean isAllowEmptyValue()Reports whether the textfield can have an empty value.- Returns:
- true if the textfield can have an empty value; false otherwise.
-
setNumDigitsAllowed
public void setNumDigitsAllowed(int len) Establishes the maximum number of digits allowed in this textfield Note that if the resulting number exceeds the maximum value of an Integer you will not be able to retrieve the value as an Integer.
The default is 10.- Parameters:
len-
-
getNumDigitsAllowed
public int getNumDigitsAllowed() -
addNotify
public void addNotify()- Overrides:
addNotifyin classJComponent
-