IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.gui
Class SpTextField

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.text.JTextComponent
                  extended byjavax.swing.JTextField
                      extended bycom.ibm.dse.gui.SpTextField
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, DataExchanger, ErrorMessageGenerator, EuroConvertible, java.util.EventListener, java.awt.event.FocusListener, GUIComponent, java.awt.image.ImageObserver, java.awt.MenuContainer, PanelActions, javax.swing.Scrollable, java.io.Serializable, javax.swing.SwingConstants, java.beans.VetoableChangeListener
Direct Known Subclasses:
SpComboBoxEditor, TextField

public class SpTextField
extends javax.swing.JTextField
implements DataExchanger, ErrorMessageGenerator, EuroConvertible, GUIComponent, java.awt.event.ActionListener, java.awt.event.FocusListener, java.beans.VetoableChangeListener

The SpTextField class is a Bean that provides a text entry on a single line. It can have a formatter to validate and format its input. It can be mandatory or optional. It has a maximum number of characters. It can have autotab and autoclear. It manages its color depending on its state.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JTextField
javax.swing.JTextField.AccessibleJTextField
 
Nested classes inherited from class javax.swing.text.JTextComponent
javax.swing.text.JTextComponent.AccessibleJTextComponent, javax.swing.text.JTextComponent.KeyBinding
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class javax.swing.JTextField
notifyAction
 
Fields inherited from class javax.swing.text.JTextComponent
DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY
 
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.Container
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields 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
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
SpTextField()
          This constructor creates a SpTextField object.
 
Method Summary
 void actionPerformed()
          Handles events for the ActionListener interface.
 void actionPerformed(java.awt.event.ActionEvent e)
          Handles events for the ActionListener interface.
 void addCoordinatedEventListener(CoordinatedEventListener newListener)
          Adds an CoordinatedEventListener.
 void addDataChangedListener(DataChangedListener newListener)
          Deprecated. (use addCoordinatedEventListener(CoordinatedEventListener newListener))
 void addErrorMessageListener(ErrorMessageListener newListener)
          Adds an ErrorMessageListener.
protected  java.lang.String calculateValueInTargetCurrency(java.lang.String source, boolean toEuro)
          Converts to/from euro the amount.
 void checkMaxCharIfNecessary(java.awt.event.KeyEvent e)
          Checks the text field length is not greater than maxChar.
protected  java.lang.String convertCurrency(java.lang.String amount, boolean toEuro)
          Converts to/from euro the amount specified as parameter.
 void convertFromEuros()
          Converts to EMU currency the value in euros and updates appropriately the valueInEuros and valueInEMUCurrency fields.
 void convertToEuros()
          Converts to euros the value in EMU currency and updates appropriately the valueInEuros and valueInEMUCurrency fields.
protected  java.lang.String evaluateText()
           
protected  void executeBeanReactions()
          When a Bean changes states and the end state is a non-error state, the Bean will call the beanReaction(java.awt.Component) public static method of the specified class.
 void fireCoordinationEvent()
          Fires a DSECoordinationEvent when data has changed.
 void fireCoordinationEvent(DSECoordinationEvent event)
          Fires a DSECoordinationEvent when data has changed.
 void fireHandleDataChanged()
          Deprecated. (use fireCoordinationEvent())
 void fireHandleDataChanged(DataChangedEvent event)
          Deprecated. (use fireCoordinationEvent(DSECoordinationEvent))
 void fireHandleErrorMessage(ErrorMessageEvent event)
          Informs that and error in the text field has happened.
 void focusGained(java.awt.event.FocusEvent e)
          Handles events for the FocusListener interface.
 void focusGainedActions()
          Fires an ErrorMessageEvent if necessary.
 void focusLost(java.awt.event.FocusEvent e)
          Handles events for the FocusListener interface.
 void focusLostActions()
          Sets dataValue as follows: if the field has a converter dataValue as an instance of the conversion type (null if empty) else the field is a String with value=text ("" if empty).
 boolean getActivatedOkKey()
          Gets the activatedOkKey property (boolean) value.
 ColorSettings getAllColors()
          Gets the allColors property (com.ibm.dse.gui.ColorSettings) value.
 java.lang.String getAlternativeDataName()
          Gets the alternativeDataName property (java.lang.String) value.
 boolean getAutoClear()
          Gets the autoClear property (boolean) value.
 boolean getAutoTab()
          Gets the autoTab property (boolean) value.
 java.lang.String getBeansReactions()
          Gets the beansReactions property (java.lang.String) value.
 Converter getConverter()
          Gets the converter associated to the text field.
 boolean getConvertible()
          Gets the convertible property (boolean) value.
 java.lang.String getDataDirection()
          Gets the dataDirection property (java.lang.String) value.
 java.lang.String getDataName()
          Gets the dataName property (java.lang.String) value.
 java.lang.String getDataToClear()
          Gets the dataToClear property (java.lang.String) value.
 java.lang.Object getDataValue()
          Gets the dataValue property (Object) value.
 DSECoordinatedPanel getDSECoordinatedPanel()
          Gets the DSECoordinatedPanel where the component is placed
 java.lang.String getErrorMessage()
          Gets the ErrorMessage property value from its formatters (if exists).
protected  java.lang.String[] getErrorMessageFocusGained()
          Gets the errorMessageFocusGained property (java.lang.String) value.
 Formatter getFormatter()
          Gets the formatter property (com.ibm.dse.gui.Formatter) value.
 java.lang.String getHelpID()
          Gets the helpID property (java.lang.String) value.
 boolean getInError()
          Gets the inError property (boolean) value.
 boolean getKeystroke()
          Gets the keystroke property (boolean) value.
 int getMaxChars()
          Gets the maxChars property (int) value.
 TextFieldMinLengthProperty getMinChars()
          Gets the minChars property (com.ibm.dse.gui.TextFieldMinLengthProperty) value.
 NavigationParameters getNavigationParameters()
          Gets the navigationParameters property (com.ibm.dse.gui.NavigationParameters) value.
 boolean getRequired()
          Gets the required property (boolean) value.
protected  java.lang.String getSourceValueForConversion()
          Returns the text field value formatted with the formatter text field.
protected  java.lang.String getSourceValueForConversion2(java.lang.String text)
          Receives a String formatted with the formatter text field.
 SpPanel getSpPanel()
          Gets the SpPanel where the component is placed
 java.lang.String getType()
          Gets the type property (java.lang.String) value.
 java.lang.String getUserInput()
          Gets the userInput property (java.lang.String) value.
 java.lang.Object getValueInEMUCurrency()
          Gets the valueInEMUCurrency property (Object) value.
 java.lang.Object getValueInEuros()
          Gets the valueInEuros property (Object) value.
 boolean hasAlternativeDataName()
          Returns if the SpTextField has alternative data name attribute.
protected  boolean isCursorKeyCode(int code)
          Returns true if the key is UP / DOWN / RIGHT / LEFT / END or HOME.
 boolean isInError()
          Returns if the text field is in error or not.
 boolean isKeyedValue()
          if true this bean returns a composed data value.
 boolean isRequired()
          Returns if the text field is required or not.
 void key(java.awt.event.KeyEvent keyEvent)
          Sets the text with the appropriate length according to maxChars.
 void keyPressed(java.awt.event.KeyEvent e)
          Handles events for the KeyListener interface.
static void main(java.lang.String[] args)
          Provides a main entry point.
 void paint(java.awt.Graphics g)
          Causes a non-visible and visible caret sequence the first time the text field is painted and caret is visible.
protected  void processComponentKeyEvent(java.awt.event.KeyEvent e)
          It is called after interested listeners have managed the event.
protected  void processKeyEvent(java.awt.event.KeyEvent e)
          Processes key events occurring on this component.
 void removeCoordinatedEventListener(CoordinatedEventListener newListener)
          Removes a CoordinatedEventListener.
 void removeDataChangedListener(DataChangedListener newListener)
          Deprecated. (use removeCoordinatedEventListener(CoordinatedEventListener newListener))
 void removeErrorMessageListener(ErrorMessageListener newListener)
          Removes an ErrorMessageListener.
 void setActivatedOkKey(boolean activatedOkKey)
          Sets the activatedOkKey property (boolean) value.
 void setAllColors(ColorSettings allColors)
          Sets the allColors property (com.ibm.dse.gui.ColorSettings) value.
 void setAlternativeDataName(java.lang.String alternativeDataName)
          Sets the alternativeDataName property (java.lang.String) value.
 void setAutoClear(boolean autoClear)
          Sets the autoClear property (boolean) value.
 void setAutoTab(boolean autoTab)
          Sets the autoTab property (boolean) value.
 void setBeansReactions(java.lang.String beansReactions)
          Sets the beansReactions property (java.lang.String) value.
 void setColors()
          Decides the background and foreground colors.
 void setConvertible(boolean convertible)
          Sets the convertible property (boolean) value.
 void setDataDirection(java.lang.String dataDirection)
          Sets the dataDirection property (java.lang.String) value.
 void setDataName(java.lang.String dataName)
          Sets the dataName property (java.lang.String) value.
 void setDataToClear(java.lang.String dataToClear)
          Sets the dataToClear property (java.lang.String) value.
 void setDataValue(java.lang.Object dataValue)
          Sets the dataValue property (Object) value.
(package private)  void setDataValueAsObject(java.lang.String value)
          Sets the dataValue property value.
 void setEditable(boolean b)
          Makes the text field editable or not depending on the parameter.
 void setEnabled(boolean b)
          Enables or disables the text field depending on the parameter.
protected  void setErrorMessageFocusGained(java.lang.String newValue)
          Sets the errorMessageFocusGained property (java.lang.String) value.
protected  void setErrorMessageFocusGained(java.lang.String[] newValue)
          Sets the errorMessageFocusGained property (java.lang.String[]) value.
 void setFormatter(Formatter formatter)
          Sets the formatter property (com.ibm.dse.gui.Formatter) value.
 void setHelpID(java.lang.String helpID)
          Sets the helpID property (java.lang.String) value.
 void setInError(boolean inError)
          Sets the inError property (boolean) value.
 void setKeystroke(boolean keystroke)
          Sets the keystroke property (boolean) value.
 void setMaxChars(int maxChars)
          Sets the maxChars property (int) value.
 void setMinChars(TextFieldMinLengthProperty minChars)
          Sets the minChars property (com.ibm.dse.gui.TextFieldMinLengthProperty) value.
 void setNavigationParameters(NavigationParameters navigationParameters)
          Sets the navigationParameters property (com.ibm.dse.gui.NavigationParameters) value.
 void setRequired(boolean required)
          Sets the required property (boolean) value.
 void setType(java.lang.String type)
          Sets the type property (java.lang.String) value.
 void setUserInput(java.lang.String userInput)
          Sets the userInput property (java.lang.String) value.
 void setValueInEMUCurrency(java.lang.Object valueInEMUCurrency)
          Sets the valueInEMUCurrency property (java.lang.Object) value.
 void setValueInEuros(java.lang.Object valueInEuros)
          Sets the valueInEuros property (Object) value.
 void setVisible(boolean b)
          Makes visible or not the text field depending on the parameter.
protected  void transferFocusIfNecessary(java.awt.event.KeyEvent e)
          Evaluates if it is necessary to transfer focus.
protected  void updateValues(java.lang.String ve, java.lang.String vp)
          Sets the valueInEuros and valueInEMUCurrency properties.
 void vetoableChange(java.beans.PropertyChangeEvent evt)
          Handles events for the VetoableChangeListener interface.
 
Methods inherited from class javax.swing.JTextField
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, setScrollOffset
 
Methods inherited from class javax.swing.text.JTextComponent
addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, updateUI, viewToModel, write
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processKeyBinding, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.dse.gui.DataExchanger
addActionListener, removeActionListener
 

Constructor Detail

SpTextField

public SpTextField()
This constructor creates a SpTextField object.

Method Detail

actionPerformed

public void actionPerformed()
Handles events for the ActionListener interface.


actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)
Handles events for the ActionListener interface.

Specified by:
actionPerformed in interface java.awt.event.ActionListener
Parameters:
e - java.awt.event.ActionEvent

addCoordinatedEventListener

public void addCoordinatedEventListener(CoordinatedEventListener newListener)
Adds an CoordinatedEventListener.

Specified by:
addCoordinatedEventListener in interface DataExchanger
Parameters:
newListener - CoordinatedEventListener

addDataChangedListener

public void addDataChangedListener(DataChangedListener newListener)
Deprecated. (use addCoordinatedEventListener(CoordinatedEventListener newListener))

Adds a DataChangedListener.

Specified by:
addDataChangedListener in interface DataExchanger
Parameters:
newListener - DataChangedListener

addErrorMessageListener

public void addErrorMessageListener(ErrorMessageListener newListener)
Adds an ErrorMessageListener.

Specified by:
addErrorMessageListener in interface ErrorMessageGenerator
Parameters:
newListener - ErrorMessageListener

calculateValueInTargetCurrency

protected java.lang.String calculateValueInTargetCurrency(java.lang.String source,
                                                          boolean toEuro)
Converts to/from euro the amount.

Parameters:
source - String, the amount formatted with the label formatter
toEuro - boolean, indicates if the conversion is to or from euro
Returns:
String - the converted amount formatted with the label formatter

checkMaxCharIfNecessary

public void checkMaxCharIfNecessary(java.awt.event.KeyEvent e)
Checks the text field length is not greater than maxChar.

Parameters:
e - java.awt.event.KeyEvent

convertCurrency

protected java.lang.String convertCurrency(java.lang.String amount,
                                           boolean toEuro)
Converts to/from euro the amount specified as parameter.

Parameters:
amount - String, the amount to be converted (formatted as "standard" float)
toEuro - boolean, indicates if the conversion is to or from euro
Returns:
String - the converted amount

convertFromEuros

public void convertFromEuros()
Converts to EMU currency the value in euros and updates appropriately the valueInEuros and valueInEMUCurrency fields.

Specified by:
convertFromEuros in interface EuroConvertible

convertToEuros

public void convertToEuros()
Converts to euros the value in EMU currency and updates appropriately the valueInEuros and valueInEMUCurrency fields.

Specified by:
convertToEuros in interface EuroConvertible

evaluateText

protected java.lang.String evaluateText()

executeBeanReactions

protected void executeBeanReactions()
When a Bean changes states and the end state is a non-error state, the Bean will call the beanReaction(java.awt.Component) public static method of the specified class.


fireCoordinationEvent

public void fireCoordinationEvent()
Fires a DSECoordinationEvent when data has changed.


fireCoordinationEvent

public void fireCoordinationEvent(DSECoordinationEvent event)
Fires a DSECoordinationEvent when data has changed.

Parameters:
event - DSECoordinationEvent

fireHandleDataChanged

public void fireHandleDataChanged()
Deprecated. (use fireCoordinationEvent())

Fires a DataChangedEvent when data has changed.


fireHandleDataChanged

public void fireHandleDataChanged(DataChangedEvent event)
Deprecated. (use fireCoordinationEvent(DSECoordinationEvent))

Supports listener events.


fireHandleErrorMessage

public void fireHandleErrorMessage(ErrorMessageEvent event)
Informs that and error in the text field has happened.

Specified by:
fireHandleErrorMessage in interface ErrorMessageGenerator
Parameters:
event - ErrorMessageEvent

focusGained

public void focusGained(java.awt.event.FocusEvent e)
Handles events for the FocusListener interface.

Specified by:
focusGained in interface java.awt.event.FocusListener
Parameters:
e - java.awt.event.FocusEvent

focusGainedActions

public void focusGainedActions()
Fires an ErrorMessageEvent if necessary. Selects all the text if autoclear is true.


focusLost

public void focusLost(java.awt.event.FocusEvent e)
Handles events for the FocusListener interface.

Specified by:
focusLost in interface java.awt.event.FocusListener
Parameters:
e - java.awt.event.FocusEvent

focusLostActions

public void focusLostActions()
Sets dataValue as follows: if the field has a converter dataValue as an instance of the conversion type (null if empty) else the field is a String with value=text ("" if empty). If the field has a converter, the entry field is also formatted (text is updated as appropriate).


getActivatedOkKey

public boolean getActivatedOkKey()
Gets the activatedOkKey property (boolean) value.

Specified by:
getActivatedOkKey in interface GUIComponent
Returns:
boolean - the activatedOkKey property value
See Also:
setActivatedOkKey(boolean)

getAllColors

public ColorSettings getAllColors()
Gets the allColors property (com.ibm.dse.gui.ColorSettings) value.

Returns:
ColorSettings - the allColors property value
See Also:
setAllColors(com.ibm.dse.gui.ColorSettings)

getAlternativeDataName

public java.lang.String getAlternativeDataName()
Gets the alternativeDataName property (java.lang.String) value.

Specified by:
getAlternativeDataName in interface DataExchanger
Returns:
The alternativeDataName property value.
See Also:
setAlternativeDataName(java.lang.String)

getAutoClear

public boolean getAutoClear()
Gets the autoClear property (boolean) value.

Returns:
boolean - the autoClear property value
See Also:
setAutoClear(boolean)

getAutoTab

public boolean getAutoTab()
Gets the autoTab property (boolean) value.

Returns:
boolean - the autoTab property value
See Also:
setAutoTab(boolean)

getBeansReactions

public java.lang.String getBeansReactions()
Gets the beansReactions property (java.lang.String) value.

Returns:
The beansReactions property value.
See Also:
setBeansReactions(java.lang.String)

getConverter

public Converter getConverter()
Gets the converter associated to the text field.

Returns:
com.ibm.dse.gui.Converter - the converter associated to the text field

getConvertible

public boolean getConvertible()
Gets the convertible property (boolean) value.

Returns:
boolean - the convertible property value
See Also:
setConvertible(boolean)

getDataDirection

public java.lang.String getDataDirection()
Gets the dataDirection property (java.lang.String) value.

Specified by:
getDataDirection in interface DataExchanger
Returns:
String - the dataDirection property value
See Also:
setDataDirection(java.lang.String)

getDataName

public java.lang.String getDataName()
Gets the dataName property (java.lang.String) value.

Specified by:
getDataName in interface DataExchanger
Returns:
String - the dataName property value
See Also:
setDataName(java.lang.String)

getDataToClear

public java.lang.String getDataToClear()
Gets the dataToClear property (java.lang.String) value.

Specified by:
getDataToClear in interface PanelActions
Returns:
The dataToClear property value.
See Also:
setDataToClear(java.lang.String)

getDataValue

public java.lang.Object getDataValue()
Gets the dataValue property (Object) value.

Specified by:
getDataValue in interface DataExchanger
Returns:
Object - the dataValue property value
See Also:
setDataValue(java.lang.Object)

getDSECoordinatedPanel

public DSECoordinatedPanel getDSECoordinatedPanel()
Gets the DSECoordinatedPanel where the component is placed

Specified by:
getDSECoordinatedPanel in interface PanelActions
Returns:
com.ibm.dse.gui.DSECoordinatedPanel

getErrorMessage

public java.lang.String getErrorMessage()
Gets the ErrorMessage property value from its formatters (if exists).

Specified by:
getErrorMessage in interface DataExchanger
Returns:
java.lang.String - the error message

getErrorMessageFocusGained

protected java.lang.String[] getErrorMessageFocusGained()
Gets the errorMessageFocusGained property (java.lang.String) value.

Returns:
String[] - the errorMessageFocusGained property value

getFormatter

public Formatter getFormatter()
Gets the formatter property (com.ibm.dse.gui.Formatter) value.

Returns:
Formatter - the formatter property value
See Also:
setFormatter(com.ibm.dse.gui.Formatter)

getHelpID

public java.lang.String getHelpID()
Gets the helpID property (java.lang.String) value.

Returns:
String - the helpID property value
See Also:
setHelpID(java.lang.String)

getInError

public boolean getInError()
Gets the inError property (boolean) value.

Returns:
boolean - the inError property value
See Also:
setInError(boolean)

getKeystroke

public boolean getKeystroke()
Gets the keystroke property (boolean) value.

Returns:
The keystroke property value.
See Also:
setKeystroke(boolean)

getMaxChars

public int getMaxChars()
Gets the maxChars property (int) value.

Returns:
int - the maxChars property value
See Also:
setMaxChars(int)

getMinChars

public TextFieldMinLengthProperty getMinChars()
Gets the minChars property (com.ibm.dse.gui.TextFieldMinLengthProperty) value.

Returns:
The minChars property value.
See Also:
setMinChars(com.ibm.dse.gui.TextFieldMinLengthProperty)

getNavigationParameters

public NavigationParameters getNavigationParameters()
Gets the navigationParameters property (com.ibm.dse.gui.NavigationParameters) value.

Specified by:
getNavigationParameters in interface DataExchanger
Returns:
The navigationParameters property value.
See Also:
setNavigationParameters(com.ibm.dse.gui.NavigationParameters)

getRequired

public boolean getRequired()
Gets the required property (boolean) value.

Returns:
boolean - the required property value
See Also:
setRequired(boolean)

getSourceValueForConversion

protected java.lang.String getSourceValueForConversion()
Returns the text field value formatted with the formatter text field.


getSourceValueForConversion2

protected java.lang.String getSourceValueForConversion2(java.lang.String text)
Receives a String formatted with the formatter text field. Returns the same value formatted as standard float.


getSpPanel

public SpPanel getSpPanel()
Gets the SpPanel where the component is placed

Specified by:
getSpPanel in interface PanelActions
Returns:
com.ibm.dse.gui.SpPanel

getType

public java.lang.String getType()
Gets the type property (java.lang.String) value.

Specified by:
getType in interface DataExchanger
Returns:
The type property value.
See Also:
setType(java.lang.String)

getUserInput

public java.lang.String getUserInput()
Gets the userInput property (java.lang.String) value.

Returns:
String - the userInput property value
See Also:
setUserInput(java.lang.String)

getValueInEMUCurrency

public java.lang.Object getValueInEMUCurrency()
Gets the valueInEMUCurrency property (Object) value.

Specified by:
getValueInEMUCurrency in interface EuroConvertible
Returns:
Object - the valueInEMUCurrency property value
See Also:
setValueInEMUCurrency(java.lang.Object)

getValueInEuros

public java.lang.Object getValueInEuros()
Gets the valueInEuros property (Object) value.

Specified by:
getValueInEuros in interface EuroConvertible
Returns:
Object - the valueInEuros property value
See Also:
setValueInEuros(java.lang.Object)

hasAlternativeDataName

public boolean hasAlternativeDataName()
Returns if the SpTextField has alternative data name attribute.

Specified by:
hasAlternativeDataName in interface DataExchanger
Returns:
boolean - if it has alternative data name atribute

isCursorKeyCode

protected boolean isCursorKeyCode(int code)
Returns true if the key is UP / DOWN / RIGHT / LEFT / END or HOME. False otherwise.

Parameters:
code - int
Returns:
boolean

isInError

public boolean isInError()
Returns if the text field is in error or not.

Specified by:
isInError in interface DataExchanger
Returns:
boolean - if it is in error or not

isKeyedValue

public boolean isKeyedValue()
if true this bean returns a composed data value.

Specified by:
isKeyedValue in interface DataExchanger
Returns:
boolean

isRequired

public boolean isRequired()
Returns if the text field is required or not.

Specified by:
isRequired in interface DataExchanger
Returns:
boolean - if it is required or not

key

public void key(java.awt.event.KeyEvent keyEvent)
Sets the text with the appropriate length according to maxChars.

Parameters:
keyEvent - java.awt.event.KeyEvent

keyPressed

public void keyPressed(java.awt.event.KeyEvent e)
Handles events for the KeyListener interface.

Specified by:
keyPressed in interface GUIComponent
Parameters:
e - java.awt.event.KeyEvent

main

public static void main(java.lang.String[] args)
Provides a main entry point. It starts the part when it is run as an application.

Parameters:
args - java.lang.String[]

paint

public void paint(java.awt.Graphics g)
Causes a non-visible and visible caret sequence the first time the text field is painted and caret is visible.

Parameters:
g - java.awt.Graphics

processComponentKeyEvent

protected void processComponentKeyEvent(java.awt.event.KeyEvent e)
It is called after interested listeners have managed the event. In case the event is due to an special key, the event is consumed.


processKeyEvent

protected void processKeyEvent(java.awt.event.KeyEvent e)
Processes key events occurring on this component.

Parameters:
e - KeyEvent

removeCoordinatedEventListener

public void removeCoordinatedEventListener(CoordinatedEventListener newListener)
Removes a CoordinatedEventListener.

Specified by:
removeCoordinatedEventListener in interface DataExchanger
Parameters:
newListener - DataChangedListener

removeDataChangedListener

public void removeDataChangedListener(DataChangedListener newListener)
Deprecated. (use removeCoordinatedEventListener(CoordinatedEventListener newListener))

Removes a DataChangedListener.

Specified by:
removeDataChangedListener in interface DataExchanger
Parameters:
newListener - DataChangedListener

removeErrorMessageListener

public void removeErrorMessageListener(ErrorMessageListener newListener)
Removes an ErrorMessageListener.

Specified by:
removeErrorMessageListener in interface ErrorMessageGenerator
Parameters:
newListener - ErrorMessageListener

setActivatedOkKey

public void setActivatedOkKey(boolean activatedOkKey)
Sets the activatedOkKey property (boolean) value.

Specified by:
setActivatedOkKey in interface GUIComponent
Parameters:
activatedOkKey - boolean, the new value for the property
See Also:
getActivatedOkKey()

setAllColors

public void setAllColors(ColorSettings allColors)
Sets the allColors property (com.ibm.dse.gui.ColorSettings) value.

Parameters:
allColors - ColorSettings, the new value for the property
See Also:
getAllColors()

setAlternativeDataName

public void setAlternativeDataName(java.lang.String alternativeDataName)
Sets the alternativeDataName property (java.lang.String) value.

Specified by:
setAlternativeDataName in interface DataExchanger
Parameters:
alternativeDataName - The new value for the property.
See Also:
getAlternativeDataName()

setAutoClear

public void setAutoClear(boolean autoClear)
Sets the autoClear property (boolean) value.

Parameters:
autoClear - boolean, the new value for the property
See Also:
getAutoClear()

setAutoTab

public void setAutoTab(boolean autoTab)
Sets the autoTab property (boolean) value.

Parameters:
autoTab - boolean, the new value for the property
See Also:
getAutoTab()

setBeansReactions

public void setBeansReactions(java.lang.String beansReactions)
Sets the beansReactions property (java.lang.String) value.

Parameters:
beansReactions - The new value for the property.
See Also:
getBeansReactions()

setColors

public void setColors()
Decides the background and foreground colors.


setConvertible

public void setConvertible(boolean convertible)
Sets the convertible property (boolean) value.

Parameters:
convertible - boolean, the new value for the property
See Also:
getConvertible()

setDataDirection

public void setDataDirection(java.lang.String dataDirection)
Sets the dataDirection property (java.lang.String) value.

Specified by:
setDataDirection in interface DataExchanger
Parameters:
dataDirection - String, the new value for the property
See Also:
getDataDirection()

setDataName

public void setDataName(java.lang.String dataName)
Sets the dataName property (java.lang.String) value.

Specified by:
setDataName in interface DataExchanger
Parameters:
dataName - String, the new value for the property
See Also:
getDataName()

setDataToClear

public void setDataToClear(java.lang.String dataToClear)
Sets the dataToClear property (java.lang.String) value.

Parameters:
dataToClear - The new value for the property.
See Also:
getDataToClear()

setDataValue

public void setDataValue(java.lang.Object dataValue)
Sets the dataValue property (Object) value.

Specified by:
setDataValue in interface DataExchanger
Parameters:
dataValue - Object, the new value for the property
See Also:
getDataValue()

setDataValueAsObject

void setDataValueAsObject(java.lang.String value)
Sets the dataValue property value.

Parameters:
value - String, the new value String for the dataValue property

setEditable

public void setEditable(boolean b)
Makes the text field editable or not depending on the parameter.

Parameters:
b - boolean, the new value for enabling or disabling the text field

setEnabled

public void setEnabled(boolean b)
Enables or disables the text field depending on the parameter.

Parameters:
b - boolean, that indicates if the combo box must be enabled or not

setErrorMessageFocusGained

protected void setErrorMessageFocusGained(java.lang.String[] newValue)
Sets the errorMessageFocusGained property (java.lang.String[]) value.


setErrorMessageFocusGained

protected void setErrorMessageFocusGained(java.lang.String newValue)
Sets the errorMessageFocusGained property (java.lang.String) value.


setFormatter

public void setFormatter(Formatter formatter)
Sets the formatter property (com.ibm.dse.gui.Formatter) value.

Parameters:
formatter - Formatter, the new value for the property
See Also:
getFormatter()

setHelpID

public void setHelpID(java.lang.String helpID)
Sets the helpID property (java.lang.String) value.

Specified by:
setHelpID in interface DataExchanger
Parameters:
helpID - String, the new value for the property
See Also:
getHelpID()

setInError

public void setInError(boolean inError)
Sets the inError property (boolean) value.

Parameters:
inError - boolean, the new value for the property
See Also:
getInError()

setKeystroke

public void setKeystroke(boolean keystroke)
Sets the keystroke property (boolean) value.

Parameters:
keystroke - The new value for the property.
See Also:
getKeystroke()

setMaxChars

public void setMaxChars(int maxChars)
Sets the maxChars property (int) value.

Parameters:
maxChars - int, the new value for the property
See Also:
getMaxChars()

setMinChars

public void setMinChars(TextFieldMinLengthProperty minChars)
Sets the minChars property (com.ibm.dse.gui.TextFieldMinLengthProperty) value.

Parameters:
minChars - The new value for the property.
See Also:
getMinChars()

setNavigationParameters

public void setNavigationParameters(NavigationParameters navigationParameters)
Sets the navigationParameters property (com.ibm.dse.gui.NavigationParameters) value.

Specified by:
setNavigationParameters in interface DataExchanger
Parameters:
navigationParameters - The new value for the property.
See Also:
getNavigationParameters()

setRequired

public void setRequired(boolean required)
Sets the required property (boolean) value.

Specified by:
setRequired in interface DataExchanger
Parameters:
required - boolean, the new value for the property
See Also:
getRequired()

setType

public void setType(java.lang.String type)
Sets the type property (java.lang.String) value.

Specified by:
setType in interface DataExchanger
Parameters:
type - The new value for the property.
See Also:
getType()

setUserInput

public void setUserInput(java.lang.String userInput)
Sets the userInput property (java.lang.String) value.

Parameters:
userInput - String, the new value for the property
See Also:
getUserInput()

setValueInEMUCurrency

public void setValueInEMUCurrency(java.lang.Object valueInEMUCurrency)
Sets the valueInEMUCurrency property (java.lang.Object) value.

Specified by:
setValueInEMUCurrency in interface EuroConvertible
Parameters:
valueInEMUCurrency - Object, the new value for the property
See Also:
getValueInEMUCurrency()

setValueInEuros

public void setValueInEuros(java.lang.Object valueInEuros)
Sets the valueInEuros property (Object) value.

Specified by:
setValueInEuros in interface EuroConvertible
Parameters:
valueInEuros - Object, the new value for the property
See Also:
getValueInEuros()

setVisible

public void setVisible(boolean b)
Makes visible or not the text field depending on the parameter.

Parameters:
b - boolean, that indicates if the text field must be visible or not

transferFocusIfNecessary

protected void transferFocusIfNecessary(java.awt.event.KeyEvent e)
Evaluates if it is necessary to transfer focus.

Parameters:
e - java.awt.event.KeyEvent

updateValues

protected void updateValues(java.lang.String ve,
                            java.lang.String vp)
Sets the valueInEuros and valueInEMUCurrency properties.


vetoableChange

public void vetoableChange(java.beans.PropertyChangeEvent evt)
                    throws java.beans.PropertyVetoException
Handles events for the VetoableChangeListener interface.

Specified by:
vetoableChange in interface java.beans.VetoableChangeListener
Parameters:
evt - java.beans.PropertyChangeEvent
Throws:
java.beans.PropertyVetoException

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005