JClass 4.5.0 API
Documentation

com.klg.jclass.field
Class JCTextField

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.text.JTextComponent
                          |
                          +--javax.swing.JTextField
                                |
                                +--com.klg.jclass.field.JCTextField
Direct Known Subclasses:
DSdbTextField, JBdbTextField, JCTextFieldCellEditor, JCTextFieldCellEditorRenderer, JCTextFieldCellRenderer, VCdbTextField

public class JCTextField
extends JTextField
implements JCFieldComponent

JCTextField has all the capability of JTextField as well as the ability to validate its contents.

See Also:
JTextField, Serialized Form

Inner classes inherited from class javax.swing.JTextField
JTextField.AccessibleJTextField
 
Inner classes inherited from class javax.swing.text.JTextComponent
JTextComponent.AccessibleJTextComponent, JTextComponent.KeyBinding
 
Inner classes inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
 
Field Summary
protected  Field field
           
protected  boolean required
           
static String version
          Contains the version number of the JClass product.
 
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 com.klg.jclass.field.JCFieldComponent
INVALID, UNDEREDIT, VALID
 
Constructor Summary
JCTextField()
          Constructs an empty JCTextField.
JCTextField(Class c)
          Constructs an empty JCTextField which expects an object of the specified class.
JCTextField(Class c, JCValidator v)
          Constructs an empty JCTextField which expects an object of the specified class and uses the specified validator.
JCTextField(int columns)
          Constructs a JCTextField with the specified number of columns.
JCTextField(com.klg.jclass.util.value.JCValueModel m)
          Constructs an empty JCTextField which uses the specified value model to contain its value.
JCTextField(com.klg.jclass.util.value.JCValueModel m, JCValidator v)
          Constructs an empty JCTextField which uses the specified value model to contain its value and which uses the specified validator.
JCTextField(String text)
          Constructs a JCTextField initialized with the specified text.
JCTextField(String text, int columns)
          Constructs an empty JCTextField with the specified number of columns and initialized with the specified text.
 
Method Summary
 void addNotify()
          Initializes the field object.
 void addPropertyChangeListener(PropertyChangeListener listener)
          Adds a PropertyChangeListener to the listener list.
 void addValueListener(com.klg.jclass.util.value.JCValueListener listener)
          Adds a listener to listen for changes to the value.
 void commitEdit()
          Commits the current field under edit.
protected  void createField(JCValidator validator)
          Creates the field object which controls the validation.
 String getAbout()
          Gets the value of the About property.
 DataProperties getDataProperties()
          Gets the Bean property which wraps the validator, data model, and Field objects properties into one property.
 JCInvalidInfo getInvalidInfo()
          Returns the Invalid properties.
 boolean getSelectOnEnter()
          Returns a flag indicating the selection status on entering the field.
 int getState()
          Returns the state of the component: VALID, INVALID, or UNDER_EDIT.
 JCValidator getValidator()
          Returns the validator currently in use.
 Object getValue()
          Returns the value for the text field.
 com.klg.jclass.util.value.JCValueModel getValueModel()
          Returns the data model being used by the field.
 boolean isRequired()
          Returns true if the field is required.
 void removePropertyChangeListener(PropertyChangeListener listener)
          Removes a PropertyChangeListener from the listener list.
 void removeValueListener(com.klg.jclass.util.value.JCValueListener listener)
          Removes a listener which listens for changes to the value.
 void setAbout(String s)
          Sets the value of the About property.
 void setBackground(Color background)
          Sets the background of the text field.
 void setDataProperties(DataProperties dp)
          Sets the Bean property which wraps the validator, data model, and Field objects properties into one property.
 void setForeground(Color foreground)
          Sets the foreground of the text field.
 void setInvalidInfo(JCInvalidInfo info)
          Sets the Invalid properties.
 void setRequired(boolean required)
          Sets the required property for the current field.
 void setSelectOnEnter(boolean select)
          Sets a flag to determines whether or the value in the field is selected when the component gains focus.
 void setValidator(JCValidator validator)
          Sets the validator to use.
 void setValue(Object value)
          Sets the value for the text field.
 void setValueModel(com.klg.jclass.util.value.JCValueModel model)
          Sets the data model being used by the field.
 
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, 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, getVisibleRect, getWidth, 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, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setDebugGraphicsOptions, setDoubleBuffered, 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
 

Field Detail

field

protected Field field

required

protected boolean required

version

public static final String version
Contains the version number of the JClass product.
Constructor Detail

JCTextField

public JCTextField()
Constructs an empty JCTextField.

JCTextField

public JCTextField(Class c)
Constructs an empty JCTextField which expects an object of the specified class.

JCTextField

public JCTextField(Class c,
                   JCValidator v)
Constructs an empty JCTextField which expects an object of the specified class and uses the specified validator.

JCTextField

public JCTextField(com.klg.jclass.util.value.JCValueModel m)
Constructs an empty JCTextField which uses the specified value model to contain its value.

JCTextField

public JCTextField(com.klg.jclass.util.value.JCValueModel m,
                   JCValidator v)
Constructs an empty JCTextField which uses the specified value model to contain its value and which uses the specified validator.

JCTextField

public JCTextField(String text)
Constructs a JCTextField initialized with the specified text.

JCTextField

public JCTextField(int columns)
Constructs a JCTextField with the specified number of columns.

JCTextField

public JCTextField(String text,
                   int columns)
Constructs an empty JCTextField with the specified number of columns and initialized with the specified text.
Method Detail

getDataProperties

public DataProperties getDataProperties()
Gets the Bean property which wraps the validator, data model, and Field objects properties into one property.
Specified by:
getDataProperties in interface JCFieldComponent
Tags copied from interface: JCFieldComponent
See Also:
JCValidator, JCValueModel, JCInvalidInfo

setDataProperties

public void setDataProperties(DataProperties dp)
Sets the Bean property which wraps the validator, data model, and Field objects properties into one property.
Specified by:
setDataProperties in interface JCFieldComponent
Tags copied from interface: JCFieldComponent
See Also:
JCValidator, JCValueModel, JCInvalidInfo

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)
Adds a PropertyChangeListener to the listener list.
Overrides:
addPropertyChangeListener in class JComponent
Parameters:
listener - The PropertyChangeListener to be added

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)
Removes a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties.
Overrides:
removePropertyChangeListener in class JComponent
Parameters:
listener - The PropertyChangeListener to be removed

addValueListener

public void addValueListener(com.klg.jclass.util.value.JCValueListener listener)
Adds a listener to listen for changes to the value.
Specified by:
addValueListener in interface JCFieldComponent

removeValueListener

public void removeValueListener(com.klg.jclass.util.value.JCValueListener listener)
Removes a listener which listens for changes to the value.
Specified by:
removeValueListener in interface JCFieldComponent

addNotify

public void addNotify()
Initializes the field object. This method should not need to be called.
Overrides:
addNotify in class JComponent

createField

protected void createField(JCValidator validator)
Creates the field object which controls the validation.

getAbout

public String getAbout()
Gets the value of the About property. The About property displays contact information for KL Group in the bean box.

setAbout

public void setAbout(String s)
Sets the value of the About property. The About property displays contact information for KL Group in the bean box.

setBackground

public void setBackground(Color background)
Sets the background of the text field.
Overrides:
setBackground in class JComponent

setForeground

public void setForeground(Color foreground)
Sets the foreground of the text field.
Overrides:
setForeground in class JComponent

getValue

public Object getValue()
Returns the value for the text field.
Specified by:
getValue in interface JCFieldComponent

setValue

public void setValue(Object value)
Sets the value for the text field.
Specified by:
setValue in interface JCFieldComponent

getValueModel

public com.klg.jclass.util.value.JCValueModel getValueModel()
Returns the data model being used by the field.
Specified by:
getValueModel in interface JCFieldComponent
See Also:
JCValueModel

setValueModel

public void setValueModel(com.klg.jclass.util.value.JCValueModel model)
Sets the data model being used by the field.
Specified by:
setValueModel in interface JCFieldComponent
See Also:
JCValueModel

getValidator

public JCValidator getValidator()
Returns the validator currently in use.
Specified by:
getValidator in interface JCFieldComponent
See Also:
JCValidator

setValidator

public void setValidator(JCValidator validator)
Sets the validator to use.
Specified by:
setValidator in interface JCFieldComponent
See Also:
JCValidator

getInvalidInfo

public JCInvalidInfo getInvalidInfo()
Returns the Invalid properties. The Invalid properties are beepOnInvalid, invalidForeground, invalidBackground, defaultValue, and invalidPolicy.
Specified by:
getInvalidInfo in interface JCFieldComponent

setInvalidInfo

public void setInvalidInfo(JCInvalidInfo info)
Sets the Invalid properties. The Invalid properties are beepOnInvalid, invalidForeground, invalidBackground, defaultValue, and invalidPolicy.
Specified by:
setInvalidInfo in interface JCFieldComponent

getState

public int getState()
Returns the state of the component: VALID, INVALID, or UNDER_EDIT.
Specified by:
getState in interface JCFieldComponent

getSelectOnEnter

public boolean getSelectOnEnter()
Returns a flag indicating the selection status on entering the field.
Specified by:
getSelectOnEnter in interface JCFieldComponent
See Also:
setSelectOnEnter(boolean)

setSelectOnEnter

public void setSelectOnEnter(boolean select)
Sets a flag to determines whether or the value in the field is selected when the component gains focus. The default value is false.
Specified by:
setSelectOnEnter in interface JCFieldComponent

commitEdit

public void commitEdit()
Commits the current field under edit.
Specified by:
commitEdit in interface JCFieldComponent

isRequired

public boolean isRequired()
Returns true if the field is required.
Specified by:
isRequired in interface JCFieldComponent

setRequired

public void setRequired(boolean required)
Sets the required property for the current field.
Specified by:
setRequired in interface JCFieldComponent

Copyright© 1999-2000 KL Group Inc.
All rights reserved.