ControlBeans
Class CTextField

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.text.JTextComponent
                          |
                          +--javax.swing.JTextField
                                |
                                +--ControlBeans.CTextField

public class CTextField
extends javax.swing.JTextField
implements java.awt.event.ActionListener, ComponentInterface

This class implements a textfield as a control component. Its purpose is to provide the user with a component that can send and receive strings to and from the communicator. This component also performs automatic conversion between strings and numeric values if possible before sending them.
It has been implemented as a Javabean, meaning that it is well suited to use within visual programming tools such as NetBeans or JBuilder.

See Also:
Serialized Form

Inner classes inherited from class javax.swing.JTextField
javax.swing.JTextField.AccessibleJTextField
 
Inner classes inherited from class javax.swing.text.JTextComponent
javax.swing.text.JTextComponent.AccessibleJTextComponent, javax.swing.text.JTextComponent.KeyBinding
 
Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
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.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface ControlBeans.ComponentInterface
DEFAULT_ID
 
Constructor Summary
CTextField()
          Constructs a new CTextField.
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent e)
          Invoked when a user changes the text in this component.
 void addComponentListener(ComponentListener l)
          Registers a ComponentListener.
 boolean getIsReceiver()
          Gets whether or not this component will receive values.
 boolean getIsSender()
          Gets whether or not this component will send values.
 int getTag()
          Gets the tag of this component.
 int[] getTags()
          The communicator uses this method to get all the tags used by this component.
 void putValue(double value, int aTag, double time, int ID)
          Sets the value of this component.
 void putValue(int value, int aTag, double time, int ID)
          Sets the value of this component.
 void putValue(java.lang.String value, int aTag, double time, int ID)
          Sets the value of this component.
 void registerCommunicator(AbstractCommunicator c, int ID)
          The communicator uses this method to alert this component of its presence.
 void removeComponentListener(ComponentListener l)
          Deregisters the ComponentListener.
 void requestValues()
          Called by the communicator to make this component send its value(s).
 void setIsReceiver(boolean value)
          Sets whether or not this component should receive values.
 void setIsSender(boolean value)
          Sets whether or not this component should send values.
 void setTag(int value)
          Sets the tag of this component.
 
Methods inherited from class javax.swing.JTextField
addActionListener, createDefaultModel, fireActionPerformed, getAccessibleContext, getActions, getColumns, getColumnWidth, getHorizontalAlignment, getHorizontalVisibility, getPreferredSize, getScrollOffset, getUIClassID, isValidateRoot, paramString, postActionEvent, removeActionListener, scrollRectToVisible, setActionCommand, setColumns, setFont, setHorizontalAlignment, setScrollOffset
 
Methods inherited from class javax.swing.text.JTextComponent
addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getCaret, getCaretColor, getCaretPosition, getDisabledTextColor, getDocument, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getUI, isEditable, isFocusTraversable, isOpaque, loadKeymap, modelToView, moveCaretPosition, paste, processComponentKeyEvent, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, select, selectAll, setCaret, setCaretColor, setCaretPosition, setDisabledTextColor, setDocument, setEditable, setEnabled, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setOpaque, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, updateUI, viewToModel, write
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, 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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getWidth, getVisibleRect, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isLightweightComponent, isManagingFocus, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, processFocusEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setCursor, setLayout, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, 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, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hide, imageUpdate, 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, printAll, processComponentEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CTextField

public CTextField()
Constructs a new CTextField.
Method Detail

getIsReceiver

public boolean getIsReceiver()
Gets whether or not this component will receive values.
Specified by:
getIsReceiver in interface ComponentInterface
Returns:
true if this component will receive values to the communicator; false otherwise.

setIsReceiver

public void setIsReceiver(boolean value)
Sets whether or not this component should receive values.
Specified by:
setIsReceiver in interface ComponentInterface
Parameters:
value - true if this component should receive values from the communicator; false otherwise.

getIsSender

public boolean getIsSender()
Gets whether or not this component will send values.
Specified by:
getIsSender in interface ComponentInterface
Returns:
true if this component will send values to the communicator; false otherwise.

setIsSender

public void setIsSender(boolean value)
Sets whether or not this component should send values.
Specified by:
setIsSender in interface ComponentInterface
Parameters:
value - true if this component should send values to the communicator; false otherwise.

getTag

public int getTag()
Gets the tag of this component. The tag is used to group different components within the communicator.
Returns:
the tag of this component

setTag

public void setTag(int value)
Sets the tag of this component. The tag is used to group different components within the communicator.
Parameters:
value - the tag of this component

addComponentListener

public void addComponentListener(ComponentListener l)
Registers a ComponentListener. By doing so the ComponentListener can receive component events from this component.
NOTE: This component can only hold one ComponentListener.
Specified by:
addComponentListener in interface ComponentInterface
Parameters:
l - the ComponentListener to register.

removeComponentListener

public void removeComponentListener(ComponentListener l)
Deregisters the ComponentListener.
Specified by:
removeComponentListener in interface ComponentInterface
Parameters:
l - the ComponentListener to remove.

registerCommunicator

public void registerCommunicator(AbstractCommunicator c,
                                 int ID)
The communicator uses this method to alert this component of its presence.
NOTE: This method is invoked by AbstractCommunicator and should therefore never be called directly by the user.
Specified by:
registerCommunicator in interface ComponentInterface
Parameters:
c - the communicator in question
ID - the ID number assigned to this component and is stored in myID
See Also:
putValue(int, int, double, int), putValue(double, int, double, int), putValue(java.lang.String, int, double, int)

getTags

public int[] getTags()
The communicator uses this method to get all the tags used by this component.
NOTE: This method is invoked by AbstractCommunicator and should therefore never be called directly by the user.
Specified by:
getTags in interface ComponentInterface
Returns:
all tags used by this component

putValue

public void putValue(int value,
                     int aTag,
                     double time,
                     int ID)
Sets the value of this component.
Specified by:
putValue in interface ComponentInterface
Parameters:
value - the value to be set
aTag - the tag of the component
time - a time tag for the value
ID - the ID of the component
See Also:
registerCommunicator(ControlBeans.AbstractCommunicator, int)

putValue

public void putValue(double value,
                     int aTag,
                     double time,
                     int ID)
Sets the value of this component.
Specified by:
putValue in interface ComponentInterface
Parameters:
value - the value to be set
aTag - the tag of the component
time - a time tag for the value
ID - the ID of the component
See Also:
registerCommunicator(ControlBeans.AbstractCommunicator, int)

putValue

public void putValue(java.lang.String value,
                     int aTag,
                     double time,
                     int ID)
Sets the value of this component.
Specified by:
putValue in interface ComponentInterface
Parameters:
value - the value to be set
aTag - the tag of the component
time - a time tag for the value
ID - the ID of the component
See Also:
registerCommunicator(ControlBeans.AbstractCommunicator, int)

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)
Invoked when a user changes the text in this component. It will attempt to convert the string to a double or integer value if possible before sending it to the communicator. If this isn't possible (because the string is truly a textstring and not a numerical value), the string will be sent unchanged.
NOTE: This method is invoked by the AWT event handling and should therefore never be called directly by the user.
Specified by:
actionPerformed in interface java.awt.event.ActionListener
Parameters:
e - the event describing that someone clicked this component
See Also:
AbstractCommunicator.putValue(java.lang.String, int, double, int)

requestValues

public void requestValues()
Called by the communicator to make this component send its value(s). This can be used for initialization.
Specified by:
requestValues in interface ComponentInterface