com.ibm.ulc.ui.dataTypes
Class UIStringFormatter

java.lang.Object
  |
  +--com.ibm.ulc.util.UlcObject
        |
        +--com.ibm.ulc.ui.UIProxy
              |
              +--com.ibm.ulc.ui.dataTypes.UIDataType
                    |
                    +--com.ibm.ulc.ui.dataTypes.UIStringFormatter

public class UIStringFormatter
extends UIDataType

See Also:
Serialized Form

Field Summary
protected  int fMaxLength
          The maximum length of the string allowed.
protected  int fMode
          Mode can be one of the following: IDENTITY = 0; ALL_UPPER_CASE = 1; ALL_LOWER_CASE = 2; SECRET = 3;
 
Fields inherited from class com.ibm.ulc.ui.UIProxy
fConnection, fId
 
Constructor Summary
UIStringFormatter()
           
 
Method Summary
 java.lang.Object convertToObject(int phase, java.lang.String newString, java.lang.Object previousValue)
          Convert the input string based on the configured length and converion specified.
 java.lang.String convertToString(java.lang.Object object, boolean forEditing)
          Return the String represenation of the object or the empty string if object is null.
 java.lang.String filterInput(java.lang.String newString, java.lang.String oldText)
          Hook to filter any text input into the field.
 void restoreState(ORBConnection conn, Anything args)
          This method is the first method called after this widget is instantiated.
 
Methods inherited from class com.ibm.ulc.ui.dataTypes.UIDataType
filterInput, getCols, getDefaultValue
 
Methods inherited from class com.ibm.ulc.ui.UIProxy
add, add, addInstance, addMany, convert, convert, finalize, find, free, getManaged, handleRequest, isOptionalEventEnabled, printInstances, remove, remove, removeInstance, removeMany, sendEventULC, sendEventULC, sendEventULC, sendOptionalEventULC, sendOptionalEventULC, sendOptionalEventULC, sendULC, sendULC, setOptionalEventsEnabled, trouble
 
Methods inherited from class com.ibm.ulc.util.UlcObject
trouble2, trouble2Err, troubleErr
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

fMode

protected int fMode
Mode can be one of the following:
 		IDENTITY = 0;
		ALL_UPPER_CASE = 1;
		ALL_LOWER_CASE = 2;
		SECRET = 3;
 

fMaxLength

protected int fMaxLength
The maximum length of the string allowed. (default is -1 which indicates no limit specified)
Constructor Detail

UIStringFormatter

public UIStringFormatter()
Method Detail

convertToObject

public java.lang.Object convertToObject(int phase,
                                        java.lang.String newString,
                                        java.lang.Object previousValue)
Convert the input string based on the configured length and converion specified. Throw an exception on error.
Parameters:
phase - int The current validation phase. The phase can be one of the following:
	FORM_NOTIFICATION_IMMEDIATE : Typically no validation is performed in this case the input string is returned as is.
	FORM_NOTIFICATION_ON_FOCUS_CHANGE 	 
 	FORM_NOTIFICATION_ON_REQUEST
	
newString - The String to convert.
Returns:
An object representing the converted String or null.
Overrides:
convertToObject in class UIDataType
See Also:
IDataType.convertToObject(int, String, Object)

convertToString

public java.lang.String convertToString(java.lang.Object object,
                                        boolean forEditing)
Return the String represenation of the object or the empty string if object is null. The default implementation calls the toString() to return a string representation of the object. Subclasses should override this method to return the formatted data type as a String.
Overrides:
convertToString in class UIDataType
See Also:
IDataType.convertToString(Object, boolean)

filterInput

public java.lang.String filterInput(java.lang.String newString,
                                    java.lang.String oldText)
Hook to filter any text input into the field.
Parameters:
newString - The string to filter.
oldText - The current Contents.
Returns:
the filtered result, If null input is not accepted.
Overrides:
filterInput in class UIDataType
See Also:
IDataType.filterInput(String, String)

restoreState

public void restoreState(ORBConnection conn,
                         Anything args)
This method is the first method called after this widget is instantiated. All widget specific initialization must take place in this method. All the parameters necessary to initialize this widget are specified in the arguments. Subclasses implementing this method must call the superclass implementation as well.
Parameters:
conn - the UlcConnection in which this operation is performed
args - the Anything containing the optional initialization parameters
Overrides:
restoreState in class com.ibm.ulc.ui.UIProxy