JClass 4.5.0 API
Documentation

com.klg.jclass.field
Class JCLabelField

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JLabel
                          |
                          +--com.klg.jclass.field.JCLabelField
Direct Known Subclasses:
DSdbLabelField, JBdbLabelField, JCLabelFieldCellRenderer, VCdbLabelField

public class JCLabelField
extends JLabel
implements JCFieldComponent

JCLabelField has all the capability of JLabelField as well as the ability to validate its contents.

See Also:
Serialized Form

Inner classes inherited from class javax.swing.JLabel
JLabel.AccessibleJLabel
 
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.JLabel
labelFor
 
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
JCLabelField()
          Constructs an empty JCLabelField.
JCLabelField(Class c)
          Constructs an empty JCLabelField which expects an object of the specified class.
JCLabelField(Class c, JCValidator v)
          Constructs an empty JCLabelField which expects an object of the specified class and which uses the specified validator.
JCLabelField(com.klg.jclass.util.value.JCValueModel m)
          Constructs an empty JCLabelField which uses the specified value model to contain its value.
JCLabelField(com.klg.jclass.util.value.JCValueModel m, JCValidator v)
          Constructs an empty JCLabelField which uses the specified value model to contain its value and which uses the specified validator.
 
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()
          Not used for this component.
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 OR INVALID.
 JCValidator getValidator()
          Returns the validator currently in use.
 Object getValue()
          Returns the value for the label 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 label 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 label 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)
          Not used for this component.
 void setText(String text)
          Overriden: This method should never be called since it will bypass the validation and formatting.
 void setValidator(JCValidator validator)
          Sets the validator to use.
 void setValue(Object value)
          Sets the value for the label 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.JLabel
checkHorizontalKey, checkVerticalKey, getAccessibleContext, getDisabledIcon, getDisplayedMnemonic, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getLabelFor, getText, getUI, getUIClassID, getVerticalAlignment, getVerticalTextPosition, paramString, setDisabledIcon, setDisplayedMnemonic, setDisplayedMnemonic, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabelFor, setUI, setVerticalAlignment, setVerticalTextPosition, updateUI
 
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, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, processComponentKeyEvent, processFocusEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, 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, addInputMethodListener, 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, getInputMethodRequests, 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, processInputMethodEvent, 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

JCLabelField

public JCLabelField()
Constructs an empty JCLabelField.

JCLabelField

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

JCLabelField

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

JCLabelField

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

JCLabelField

public JCLabelField(com.klg.jclass.util.value.JCValueModel m,
                    JCValidator v)
Constructs an empty JCLabelField which uses the specified value model to contain its value and which uses the specified validator.
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 label field.
Overrides:
setBackground in class JComponent

setForeground

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

getValue

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

setValue

public void setValue(Object value)
Sets the value for the label 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 OR INVALID.
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)
Not used for this component.
Specified by:
setSelectOnEnter in interface JCFieldComponent

commitEdit

public void commitEdit()
Not used for this component.
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

setText

public void setText(String text)
Overriden: This method should never be called since it will bypass the validation and formatting. Use the setValue method instead.
Overrides:
setText in class JLabel
See Also:
setValue(java.lang.Object)

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