acm.gui
Class IntField

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.text.JTextComponent
                  extended by javax.swing.JTextField
                      extended by acm.gui.IntField

public class IntField
extends JTextField

This class implements a simple interactor that accepts an integer value.


   

Field Summary
 
Constructor Summary
IntField()
Creates a new field object for entering a int value.
IntField(int value)
Creates a new field object for entering a int value.
IntField(int low, int high)
Creates a new field object for entering a int value, which is constrained to be within the specified range.
IntField(int value, int low, int high)
Creates a new field object for entering a int value, which is constrained to be within the specified range.
 
Method Summary
 boolean getExceptionOnError()
Returns the state of the error-handling flag.
 String getFormat()
Returns the format currently in use for this field, or null if no format has been set.
 int getValue()
Returns the value of this field as a int.
 void setExceptionOnError(boolean flag)
Sets the error-handling mode of this interactor as specified by the flag parameter.
 void setFormat(String format)
Sets the format used for the field.
 void setValue(int n)
Sets the value of a field.
 

Constructor Detail

public IntField()

Creates a new field object for entering a int value. The contents of the field are initially blank.

 
Usage: IntField field = new IntField(); 
 


public IntField(int value)

Creates a new field object for entering a int value. The contents of the field initially contain the specified value.

 
Usage: IntField field = new IntField(value); 
Parameter: 
value  The value to store in the field
 


public IntField(int low, int high)

Creates a new field object for entering a int value, which is constrained to be within the specified range. The contents of the field are initially blank.

 
Usage: IntField field = new IntField(low, high); 
Parameters: 
low  The lowest value in the permitted range
high  The highest value in the permitted range
 


public IntField(int value, int low, int high)

Creates a new field object for entering a int value, which is constrained to be within the specified range. The contents of the field initially contain the specified value.

 
Usage: IntField field = new IntField(value, low, high); 
Parameters: 
value  The value to store in the field
low  The lowest value in the permitted range
high  The highest value in the permitted range
 

Method Detail

public boolean getExceptionOnError()

Returns the state of the error-handling flag.

 
Usage: boolean flag = console.getExceptionOnError(); 
Returns: The current setting of the error-handling mode (false to retry on errors; true to raise an exception)
 


public String getFormat()

Returns the format currently in use for this field, or null if no format has been set.

 
Usage: String format = field.getFormat(); 
Returns: The format for this field
 


public int getValue()

Returns the value of this field as a int. If this value is either not a legal numeric value or is outside the specified range, this method will either pop up a dialog allowing the user to reenter the value or throw an ErrorException depending on the state of the exceptionOnError flag.

 
Usage: int n = field.getValue(); 
Returns: The value stored in the field as a int
 


public void setExceptionOnError(boolean flag)

Sets the error-handling mode of this interactor as specified by the flag parameter. If flag is false (which is the default), calling getValue on this interactor displays a dialog that gives the user a chance to retry after erroneous input. If this value is set to true, illegal input raises an ErrorException instead.

 
Usage: field.setExceptionOnError(flag); 
Parameter: 
flag  false to retry on errors; true to raise an exception
 


public void setFormat(String format)

Sets the format used for the field. The structure of the format string is described in the comments for the DecimalFormat class.

 
Usage: field.setFormat(format); 
Parameter: 
format  The format to use for the field
 


public void setValue(int n)

Sets the value of a field.

 
Usage: field.setValue(n); 
Parameter: 
 The value to be stored in the field