com.sssw.rt.jform
Class AgcJIntegerSpinnerField

java.lang.Object
 |
 +--java.awt.Component
       |
       +--java.awt.Container
             |
             +--javax.swing.JComponent
                   |
                   +--javax.swing.JPanel
                         |
                         +--com.sssw.rt.atlas.AtPanel
                               |
                               +--com.sssw.rt.form.PvBasePanel
                                     |
                                     +--com.sssw.rt.jform.AgcJIntegerSpinnerField

All Implemented Interfaces:

Accessible, ActionListener, AgiControl, AgiHelpInfo, EventListener, FocusListener, ImageObserver, KeyListener, MenuContainer, MouseListener, MouseMotionListener, PropertyChangeListener, Serializable

public class AgcJIntegerSpinnerField

extends PvBasePanel

implements PropertyChangeListener, ActionListener, KeyListener, MouseListener, MouseMotionListener, FocusListener

A lightweight component that displays an integer in an input field. The field also has spinner buttons. The user can click the buttons to increment or decrement the value by the specified increment amount. You can allow the user to edit the value directly. AgcJIntegerSpinnerField can be bound to a database column.

There are methods for selecting or getting the integer value or individual characters from the input field. These include:

• AgcJIntegerSpinnerField.getText()
• AgcJIntegerSpinnerField.getSelectedText()
• AgcJIntegerSpinnerField.getIntegerValue()
• AgcJIntegerSpinnerField.getValue()

Other methods let you change the spinner increment value and the maximum and minimum values for the field. These include:

• AgcJIntegerSpinnerField.setIncrement(int)
• AgcJIntegerSpinnerField.setMinValue(int)
• AgcJIntegerSpinnerField.setMaxValue(int)

  AgcJIntegerSpinnerField is not associated with a data model.

  Properties:

  Background Color, Control Type, Data Column, Display Format, Editable, Enabled, Font Name, Font Size, Font Style, Height, Help Page, Increment, Left, Max Value, Min Value, Name, Text Color, Tool Tip, Top, Validation Rules, Visible, Width

  Events:

  focusGained, focusLost, keyPressed, keyReleased, keyTyped, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, validationFailed, validationTest, valueChanged

  See Also:

  Serialized Form

  Inner classes inherited from class javax.swing.JPanel

  JPanel.AccessibleJPanel

  Inner classes inherited from class javax.swing.JComponent

  JComponent.AccessibleJComponent

  Field Summary

  static int

  NO_LIMIT Used to remove a limit on the allowed values.

  Fields inherited from class com.sssw.rt.atlas.AtPanel

  BGIMAGE_DRAW_CENTERED, BGIMAGE_DRAW_NORMAL, BGIMAGE_DRAW_STRETCH, BGIMAGE_DRAW_TILED

  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

  Constructor Summary

  AgcJIntegerSpinnerField()
  Creates an integer spinner field.

  Method Summary

  String	getDisplayPattern() Gets the pattern that the control uses to parse input and format the numeric value.
  int	getDisplayStyle() Gets the display style that the control uses to parse input and format the numeric value.
  int	getIncrement() Gets the value that is added or subtracted from the field value when the user clicks a spinner button.
  Integer	getIntegerValue() Gets the field value as an Integer object.
  int	getMaxValue() Gets the maximum value that the user is allowed to enter.
  int	getMinValue() Gets the minimum value that the user is allowed to enter.
  String	getSelectedText() Gets the text that is selected in the input field.
  int	getSelectionEnd() Gets the caret position of the end of selected text.
  int	getSelectionStart() Gets the caret position of the start of selected text, where 0 is the position before the first character.
  String	getText() Gets the text displayed in the input field.
  int	getValue() Gets the field value as a primitive int.
  boolean	isEditable() Finds out whether the user can type a value in the input field.
  void	select(int start, int end) Selects a range of characters in the input field.
  void	selectAll() Selects all the characters in the input field.
  void	setDisplayPattern(String pattern) Sets the pattern that the control uses to parse input and format the numeric value.
  void	setDisplayStyle(int style) Sets the display style assigned to the control.
  void	setEditable(boolean b) Specifies whether the user can type a value in the input field.
  void	setIncrement(int increment) Sets the value that is added or subtracted from the field value when the user clicks a spinner button.
  void	setIntegerValue(Integer value) Sets the field value with an Integer object.
  void	setMaxValue(int value) Sets the maximum value that the user is allowed to enter.
  void	setMinValue(int value) Sets the minimum value that the user is allowed to enter.
  void	setText(String value) Sets the text displayed in the input field.
  void	setValue(int value) Sets the field value.

  Methods inherited from class com.sssw.rt.form.PvBasePanel

  getBackgroundColor, getFontIdentifier, setBackgroundColor, setFontIdentifier

  Methods inherited from class com.sssw.rt.atlas.AtPanel

  addImpl, addNotify, clientPaint, clientPaint, deliverMouseEvent, deliverMouseMoveEvent, doAtCommand, drawTiledImage, enableAtCommands, getBackgroundImage, getBackgroundImageMode, getHelper, getTransparent, hide, hideToolTip, imageUpdate, isFocusTraversable, isOptimizedDrawingEnabled, ownedImage, paintBorder, paintComponent, paintImmediately, paintImmediately, paintNow, preprocessKeyEvent, processEvent, reshape, setBackgroundImage, setBackgroundImageMode, setTransparent, show, showToolTip

  Methods inherited from class javax.swing.JPanel

  getAccessibleContext, getUIClassID, paramString, updateUI

  Methods inherited from class javax.swing.JComponent

  addAncestorListener, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isLightweightComponent, isManagingFocus, isOpaque, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, print, printAll, processComponentKeyEvent, processFocusEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVisible, unregisterKeyboardAction, update

  Methods inherited from class java.awt.Container

  add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, remove, remove, removeAll, removeContainerListener, setCursor, setLayout, validate, validateTree

  Methods inherited from class java.awt.Component

  action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, size, toString, transferFocus

  Methods inherited from class java.lang.Object

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

  Methods implemented from interface java.awt.event.ActionListener

  actionPerformed

  Methods implemented from interface com.sssw.rt.form.AgiControl

  getComponent, getHelpInfo, setHelpInfo

  Methods implemented from interface java.awt.event.FocusListener

  focusGained, focusLost

  Methods implemented from interface java.awt.event.KeyListener

  keyPressed, keyReleased, keyTyped

  Methods implemented from interface java.awt.event.MouseListener

  mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased

  Methods implemented from interface java.awt.event.MouseMotionListener

  mouseDragged, mouseMoved

  Methods implemented from interface java.beans.PropertyChangeListener

  propertyChange

  Field Detail

  NO_LIMIT

  public static final int NO_LIMIT

  Used to remove a limit on the allowed values.

  Constructor Detail

  AgcJIntegerSpinnerField

  public AgcJIntegerSpinnerField()

  Creates an integer spinner field.

  Method Detail

  setIncrement

  public void setIncrement(int increment)

  Sets the value that is added or subtracted from the field value when the user clicks a spinner button. The spinner buttons have no effect when incrementing or decrementing the value would take it beyond the maximum or minimum for the field.

  Parameters:

  increment - the int to be used to increment or decrement the field value

  See Also:

  AgcJIntegerSpinnerField.getIncrement()

  getIncrement

  public int getIncrement()

  Gets the value that is added or subtracted from the field value when the user clicks a spinner button.

  Returns:

  an int specifying the increment value for the spinner buttons

  See Also:

  AgcJIntegerSpinnerField.setIncrement(int)

  isEditable

  public boolean isEditable()

  Finds out whether the user can type a value in the input field.

  Returns:

  a boolean where:

  • true indicates the user can change field value by typing, as well as via the spinner buttons.
  • false indicates the user cannot change the field value by typing. The user must use the spinner buttons.

  See Also:

  AgcJIntegerSpinnerField.setEditable(boolean)

  setEditable

  public void setEditable(boolean b)

  Specifies whether the user can type a value in the input field.

  Parameters:

  b - a boolean value where:

  • true enables editing
  • false disables editing

  See Also:

  AgcJIntegerSpinnerField.isEditable()

  select

  public void select(int start,
                     int end)

  Selects a range of characters in the input field. The selected text is highlighted.

  Parameters:

  start - an int specifying caret position of the start of the selection, where 0 is the position before the first character in the field

  end - an int specifying the caret position of the end of the selection

  Usage:

  If the start position is beyond the end of the text, nothing is selected and the current selection, if any, does not change. If the end value is greater than the number of characters, the selection end position is at the end of the text.

  If the display format adds characters to the displayed number, such as commas, they are counted in determining how many characters to select.

  Example:

  If the displayed value is 345,678, this code selects the substring "45,6". If the field has no display format and displays 345678, the code selects the substring "4567".

   fldSpinner.select(1, 5);  
   

  See Also:

  AgcJIntegerSpinnerField.selectAll()

  selectAll

  public void selectAll()

  Selects all the characters in the input field.

  See Also:

  AgcJIntegerSpinnerField.select(int, int)

  getSelectionStart

  public int getSelectionStart()

  Gets the caret position of the start of selected text, where 0 is the position before the first character.

  Returns:

  an int value that is the start of the selection

  Usage:

  If the user sets the selection, the selection is lost when the field loses focus and getSelectionStart() and getSelectionEnd() both return the same value.

  See Also:

  AgcJIntegerSpinnerField.getSelectionEnd(), AgcJIntegerSpinnerField.getSelectedText(), AgcJIntegerSpinnerField.getText()

  getSelectionEnd

  public int getSelectionEnd()

  Gets the caret position of the end of selected text. 0 is the position before the first character. If there is no selection, the start and end positions are the same.

  Returns:

  an int value that is the caret position after the last selected character

  See Also:

  AgcJIntegerSpinnerField.getSelectionStart(), AgcJIntegerSpinnerField.getSelectedText(), AgcJIntegerSpinnerField.getText()

  getSelectedText

  public String getSelectedText()

  Gets the text that is selected in the input field.

  Returns:

  a String containing the current selection

  Example:

  If the field displays 123,456 and "45" is selected, this code displays:
  Start, end, and selected text: 4 6 45

      String s = "Start, end, and selected text: " +
     fldSpinner.getSelectionStart() + " "  + 
     fldSpinner.getSelectionEnd() + " "  + 
   	  fldSpinner.getSelectedText();
   

  See Also:

  AgcJIntegerSpinnerField.getSelectionStart(), AgcJIntegerSpinnerField.getSelectionEnd()

  getText

  public String getText()

  Gets the text displayed in the input field.

  Returns:

  a String that is the displayed text

  See Also:

  AgcJIntegerSpinnerField.setText(String), AgcJIntegerSpinnerField.getSelectedText()

  setText

  public void setText(String value)

  Sets the text displayed in the input field.

  Parameters:

  value - a String whose value is the integer to be displayed

  Usage:

  The text is not restricted to digits but if the string can be parsed as an integer, other characters are discarded.

  See Also:

  AgcJIntegerSpinnerField.getText()

  getDisplayPattern

  public String getDisplayPattern()

  Gets the pattern that the control uses to parse input and format the numeric value.

  Returns:

  a String that is the current display pattern

  Usage:

  A display pattern overrides a display style. If the display pattern is null, then the display style is used.

  For information on display patterns and styles, see Formatting Patterns and Styles in the online General Reference.

  See Also:

  AgcJIntegerSpinnerField.setDisplayPattern(String), AgcJIntegerSpinnerField.getDisplayStyle(), AgcJIntegerSpinnerField.setDisplayStyle(int)

  setDisplayPattern

  public void setDisplayPattern(String pattern)

  Sets the pattern that the control uses to parse input and format the numeric value.

  Parameters:

  pattern - a String specifying a format for the numeric data

  Usage:

  A display pattern or style allows numbers to be displayed correctly according to the usage in different countries.

  If the control has both a display pattern and a display style, the display pattern is used. If neither are specified, a default pattern is used. When you change the display pattern, it doesn't take effect until the value in the control changes.

  For information on display patterns and styles, see Formatting Patterns and Styles in the online General Reference.

  Example:

    String pattern = "###,###";
    fldSpinner.setDisplayPattern(pattern);
   

  See Also:

  AgcJIntegerSpinnerField.getDisplayPattern(), AgcJIntegerSpinnerField.getDisplayStyle(), AgcJIntegerSpinnerField.setDisplayStyle(int)

  getDisplayStyle

  public int getDisplayStyle()

  Gets the display style that the control uses to parse input and format the numeric value.

  Returns:

  an int value corresponding to a predefined display style

  Usage:

  For information on display patterns and styles, see Formatting Patterns and Styles in the online General Reference.

  Example:

    if (fldSpinner.getDisplayStyle() == AgFormat.PERCENTSTYLE) {...}
   

  See Also:

  AgcJIntegerSpinnerField.getDisplayPattern(), AgcJIntegerSpinnerField.setDisplayPattern(String), AgcJIntegerSpinnerField.setDisplayStyle(int)

  setDisplayStyle

  public void setDisplayStyle(int style)

  Sets the display style assigned to the control. A display style is a predefined display pattern, and like a display pattern, is used to parse input and format the numeric value.

  Parameters:

  style - an int identifying a predefined display style. Specify null to use the default pattern.

  Usage:

  If the control has both a display pattern and a display style, the display style is ignored and the display pattern is used. If neither are specified, a default pattern is used.

  Typical numeric display styles are percent, number, and currency. For information on display patterns and styles, see Formatting Patterns and Styles in the online General Reference.

  A note about the numeric style PERCENTSTYLE: "63%" represents a value of .63, not 63. So this style makes little sense for integer fields (it could only display 100%, 200%, etc).

  Example:

   fldSpinner.setDisplayPattern( null );
   fldSpinner.setDisplayStyle( AgFormat.PERCENTSTYLE );
   

  See Also:

  AgcJIntegerSpinnerField.getDisplayPattern(), AgcJIntegerSpinnerField.setDisplayPattern(String), AgcJIntegerSpinnerField.getDisplayStyle()

  getValue

  public int getValue()

  Gets the field value as a primitive int.

  Returns:

  an int. If the field value can't be interpreted as a number, returns 0.

  See Also:

  AgcJIntegerSpinnerField.setValue(int)

  setValue

  public void setValue(int value)

  Sets the field value.

  Parameters:

  value - an int specifying the value to be displayed in the field

  Example:

   	fldSpinner.setValue( 55 );
   

  See Also:

  AgcJIntegerSpinnerField.getValue(), AgcJIntegerSpinnerField.setIntegerValue(Integer), AgcJIntegerSpinnerField.setText(String)

  getIntegerValue

  public Integer getIntegerValue()

  Gets the field value as an Integer object.

  Returns:

  an Integer object. If the field value can't be interpreted as a number, returns null.

  Example:

  This code tests whether the field contains a number.

      if (fldSpinner.getIntegerValue() == null) { ... }
   

  See Also:

  AgcJIntegerSpinnerField.setIntegerValue(Integer)

  setIntegerValue

  public void setIntegerValue(Integer value)

  Sets the field value with an Integer object.

  Parameters:

  value - an Integer object specifying the value to be displayed in the field

  See Also:

  AgcJIntegerSpinnerField.getIntegerValue(), AgcJIntegerSpinnerField.setValue(int), AgcJIntegerSpinnerField.setText(String)

  getMaxValue

  public int getMaxValue()

  Gets the maximum value that the user is allowed to enter.

  Returns:

  an int specifying the maximum value allowed. If there is no maximum limit, returns the value defined by the NO_LIMIT constant.

  See Also:

  AgcJIntegerSpinnerField.setMaxValue(int)

  getMinValue

  public int getMinValue()

  Gets the minimum value that the user is allowed to enter.

  Returns:

  an int specifying the minimum value allowed. If there is no minimum limit, returns the value defined by the NO_LIMIT constant.

  See Also:

  AgcJIntegerSpinnerField.setMinValue(int)

  setMaxValue

  public void setMaxValue(int value)

  Sets the maximum value that the user is allowed to enter.

  Parameters:

  value - an int specifying the maximum input value. Use the constant NO_LIMIT to disable the limit.

  Usage:

  If the user tries to enter a larger value, a validationFailed event is fired.

  See Also:

  AgcJIntegerSpinnerField.getMaxValue(), AgcJIntegerSpinnerField.setMinValue(int)

  setMinValue

  public void setMinValue(int value)

  Sets the minimum value that the user is allowed to enter.

  Parameters:

  value - an int specifying the minimum input value. Use the constant NO_LIMIT to disable the limit.

  Usage:

  If the user tries to enter a smaller value, a validationFailed event is fired.

  See Also:

  AgcJIntegerSpinnerField.getMinValue(), AgcJIntegerSpinnerField.setMaxValue(int)