IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.gui
Class IntegerConverter

java.lang.Object
  extended bycom.ibm.dse.gui.Formatter
      extended bycom.ibm.dse.gui.Converter
          extended bycom.ibm.dse.gui.IntegerConverter
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class IntegerConverter
extends Converter

The IntegerConverter class is responsible for Integer validation and conversion.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.ibm.dse.gui.Converter
propertyChange
 
Constructor Summary
IntegerConverter()
          This constructor creates an IntegerConverter object.
IntegerConverter(java.lang.String sep)
          This constructor creates an IntegerConverter object.
IntegerConverter(java.lang.String text, java.lang.String sep)
          This constructor creates an IntegerConverter object.
 
Method Summary
 java.lang.Object formatAsConversionType(java.lang.String text)
          Converts a String into an Integer.
 java.lang.String formatFromConversionType(java.lang.Object input)
          Converts an Integer into a String.
 NumericStringFormat getFormat()
          Gets the format property (NumericStringFormat) value.
 java.lang.String getSeparator()
          Gets the separator property (java.lang.String) value.
 void setFormat(NumericStringFormat value)
          Sets the format property (NumericStringFormat) value.
 void setSeparator(java.lang.String separator)
          Sets the separator property (java.lang.String) value.
 boolean validate(java.lang.String userInput)
          Returns a boolean that indicates if the validation has been achieved successfully or not.
 boolean validateKey(java.lang.String userInput, java.awt.event.KeyEvent keyEvent)
          Returns a boolean that indicates if the validation has been achieved successfully or not for this new key.
 
Methods inherited from class com.ibm.dse.gui.Converter
addPropertyChangeListener, firePropertyChange, getErrorMessage, getIsConvertible, getIsNull, getPropertyChange, removePropertyChangeListener, setErrorMessage, setIsConvertible, setIsNull, validateWithError
 
Methods inherited from class com.ibm.dse.gui.Formatter
format
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IntegerConverter

public IntegerConverter()
This constructor creates an IntegerConverter object.


IntegerConverter

public IntegerConverter(java.lang.String sep)
This constructor creates an IntegerConverter object.

Parameters:
sep - java.lang.String, the thousands separator

IntegerConverter

public IntegerConverter(java.lang.String text,
                        java.lang.String sep)
This constructor creates an IntegerConverter object.

Parameters:
text - java.lang.String, the error message
sep - java.lang.String, the thousands separator
Method Detail

formatAsConversionType

public java.lang.Object formatAsConversionType(java.lang.String text)
Converts a String into an Integer.

Specified by:
formatAsConversionType in class Formatter
Parameters:
text - java.lang.String, the String to be converted
Returns:
Object - the result of converting the aString parameter into an Integer

formatFromConversionType

public java.lang.String formatFromConversionType(java.lang.Object input)
Converts an Integer into a String.

Specified by:
formatFromConversionType in class Formatter
Parameters:
input - Object, the integer to be converted
Returns:
String - the result of converting the input parameter into a String

getFormat

public NumericStringFormat getFormat()
Gets the format property (NumericStringFormat) value.

Returns:
NumericStringFormat - the format property value.
See Also:
setFormat(com.ibm.dse.base.NumericStringFormat)

getSeparator

public java.lang.String getSeparator()
Gets the separator property (java.lang.String) value.

Returns:
String - the separator property value.
See Also:
setSeparator(java.lang.String)

setFormat

public void setFormat(NumericStringFormat value)
Sets the format property (NumericStringFormat) value.

See Also:
getSeparator()

setSeparator

public void setSeparator(java.lang.String separator)
Sets the separator property (java.lang.String) value.

Parameters:
separator - String, the new value for the separator property.
See Also:
getSeparator()

validate

public boolean validate(java.lang.String userInput)
Returns a boolean that indicates if the validation has been achieved successfully or not.

Overrides:
validate in class Converter
Parameters:
userInput - java.lang.String - the string to be validated
Returns:
boolean - the result of the validation

validateKey

public boolean validateKey(java.lang.String userInput,
                           java.awt.event.KeyEvent keyEvent)
Returns a boolean that indicates if the validation has been achieved successfully or not for this new key.

Overrides:
validateKey in class Converter
Parameters:
userInput - java.lang.String - the string writed.
keyEvent - java.awt.event.KeyEvent - new key.
Returns:
boolean - the result of the validation.

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005