com.ibm.etools.iseries.ui
Class DefaultFieldModel

java.lang.Object
  com.ibm.etools.iseries.ui.AbstractFieldModel
      com.ibm.etools.iseries.ui.DefaultFieldModel

All Implemented Interfaces:

DataAttributesChangeListener, FieldModel, PropertyChangeListener, VetoableChangeListener, Serializable, EventListener

public class DefaultFieldModel
extends AbstractFieldModel
implements PropertyChangeListener, VetoableChangeListener, DataAttributesChangeListener, Serializable

DefaultFieldModel sets the default field model properties without setting any AS/400 specific default properties, which would be set if you were using the AS400FieldModel.This field model sets the following default properties:

dataAttributes

Instance of DataAttributes with:

• autoAdvance: false
• dataLength: 10
• dataType: character
• decimalPlaces: 0
• decimalSymbol: .
• reverseImageColor: java.awt.Color.red

formatter

Instance of DefaultFormatter, which always returns the input string without any formatting.

keystroke verifier

Instance of javax.swing.text.PlainDocument with:

• documentProperties: {tabSize=8}

validator

Instance of DefaultValidator, which always returns true for validation. Since a JFormattedComponent verifies the data type, data length, and decimal places, the field may still be invalid.

Note:

Although the dataAttributes default to a length of 10 with a character data type, since the keystrokeVerifier is set to javax.swing.text.PlainDocument, which is the default document model set in JTextField, there is no keystroke validation. However a JFormattedComponent itself, such as a JFormattedTextField, JFormattedComboBox and JFormattedLabel, will verify the data type, the length, and decimal places of the field even when DefaultFieldModel is used.

See Also:

FieldModel, AbstractFieldModel, AS400FieldModel, Serialized Form

Field Summary

static String	Copyright
protected PropertyChangeSupport	propertyChange
protected VetoableChangeSupport	vetoPropertyChange

Fields inherited from interface com.ibm.etools.iseries.ui.DataAttributesChangeListener

copyright

Fields inherited from interface com.ibm.etools.iseries.ui.FieldModel

copyright

Constructor Summary

DefaultFieldModel()
Constructs a new AS400FieldModel.

DefaultFieldModel(Attributes dataAttributes)
Constructs a new AS400FieldModel with the specified DataAttributes.

DefaultFieldModel(Attributes dataAttributes, Formatter f)
Constructs a new AS400FieldModel with the specified DataAttributes and Formatter.

DefaultFieldModel(Attributes dataAttributes, Formatter f, Validator v)
Constructs a new AS400FieldModel with the specified DataAttributes, Formatter and Validator.

DefaultFieldModel(Attributes dataAttributes, Formatter f, Validator v, Document d)
Constructs a new AS400FieldModel with the specified DataAttributes, Formatter, Validator and Document.

Method Summary

void	addPropertyChangeListener(PropertyChangeListener l)
void	addVetoableChangeListener(VetoableChangeListener l) Add a vetoableChangeListener.
static String	Copyright() This method returns the copyright notice for this class.
void	dataAttributesChanged(DataAttributesChangeEvent evt) Whenever a bound property of DataAttributes changes, a DataAttributesChangeEvent is fired and this method will be called by the DataAttributesChangeListener.
Attributes	getDataAttributes() Gets the dataAttributes property (com.ibm.etools.iseries.ui.Attributes) value.
Formatter	getFormatter() Gets the formatter property (com.ibm.etools.iseries.ui.Formatter) value.
Document	getKeystrokeVerifier() Gets the keystrokeVerifier property (javax.swing.text.Document) value.
Validator	getValidator() Gets the validator property (com.ibm.etools.iseries.ui.Validator) value.
void	propertyChange(PropertyChangeEvent e) Examine the PropertyChangeEvent and decides what to do on a particular event.
void	removePropertyChangeListener(PropertyChangeListener l) Removes a propertyChangeListener.
void	removeVetoableChangeListener(VetoableChangeListener l) Removes a vetoableChangeListener.
void	setDataAttributes(Attributes a) Sets the dataAttributes property (com.ibm.etools.iseries.ui.Attributes) value.
void	setFormatter(Formatter f) Sets the formatter property (com.ibm.etools.iseries.ui.Formatter) value.
void	setKeystrokeVerifier(Document d) Sets the keystrokeVerifier property (javax.swing.text.Document) value.
void	setValidator(Validator v) Sets the validator property (com.ibm.etools.iseries.ui.Validator) value.
void	vetoableChange(PropertyChangeEvent e) This method gets called when a constrained property is changed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Copyright

public static final String Copyright

See Also:

Constant Field Values

propertyChange

protected transient PropertyChangeSupport propertyChange

vetoPropertyChange

protected transient VetoableChangeSupport vetoPropertyChange

Constructor Detail

DefaultFieldModel

public DefaultFieldModel()

Constructs a new AS400FieldModel.

DefaultFieldModel

public DefaultFieldModel(Attributes dataAttributes)

Constructs a new AS400FieldModel with the specified DataAttributes. Please note that the parameter must be an instance of com.ibm.etools.iseries.ui.DataAttributes; otherwise java.beans.PropertyVetoException will be thrown at run time.

Parameters:

dataAttributes - com.ibm.etools.iseries.ui.Attributes

DefaultFieldModel

public DefaultFieldModel(Attributes dataAttributes,
                         Formatter f)

Constructs a new AS400FieldModel with the specified DataAttributes and Formatter. Please note that the first parameter must be an instance of com.ibm.etools.iseries.ui.DataAttributes; otherwise java.beans.PropertyVetoException will be thrown at run time.

Parameters:

dataAttributes - com.ibm.etools.iseries.ui.Attributes

f - com.ibm.etools.iseries.ui.Formatter

DefaultFieldModel

public DefaultFieldModel(Attributes dataAttributes,
                         Formatter f,
                         Validator v)

Constructs a new AS400FieldModel with the specified DataAttributes, Formatter and Validator. Please note that the first parameter must be an instance of com.ibm.etools.iseries.ui.DataAttributes; otherwise java.beans.PropertyVetoException will be thrown at run time.

Parameters:

dataAttributes - com.ibm.etools.iseries.ui.Attributes

f - com.ibm.etools.iseries.ui.Formatter

v - com.ibm.etools.iseries.ui.Validator

DefaultFieldModel

public DefaultFieldModel(Attributes dataAttributes,
                         Formatter f,
                         Validator v,
                         Document d)

Constructs a new AS400FieldModel with the specified DataAttributes, Formatter, Validator and Document. Please note that the first parameter must be an instance of com.ibm.etools.iseries.ui.DataAttributes; otherwise java.beans.PropertyVetoException will be thrown at run time.

Parameters:

dataAttributes - com.ibm.etools.iseries.ui.Attributes

f - com.ibm.etools.iseries.ui.Formatter

v - com.ibm.etools.iseries.ui.Validator

d - javax.swing.text.Document

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

addVetoableChangeListener

public void addVetoableChangeListener(VetoableChangeListener l)

Add a vetoableChangeListener.

Parameters:

l - java.beans.VetoableChangeListener

Copyright

public static String Copyright()

This method returns the copyright notice for this class.

Returns:

java.lang.String

dataAttributesChanged

public void dataAttributesChanged(DataAttributesChangeEvent evt)

Whenever a bound property of DataAttributes changes, a DataAttributesChangeEvent is fired and this method will be called by the DataAttributesChangeListener.

Specified by:

dataAttributesChanged in interface DataAttributesChangeListener

Parameters:

evt - com.ibm.etools.iseries.ui.DataAttributesChangeEvent

getDataAttributes

public Attributes getDataAttributes()

Gets the dataAttributes property (com.ibm.etools.iseries.ui.Attributes) value.

Specified by:

getDataAttributes in interface FieldModel

Specified by:

getDataAttributes in class AbstractFieldModel

Returns:

The dataAttributes property value.

See Also:

setDataAttributes(com.ibm.etools.iseries.ui.Attributes)

getFormatter

public Formatter getFormatter()

Gets the formatter property (com.ibm.etools.iseries.ui.Formatter) value.

Specified by:

getFormatter in interface FieldModel

Specified by:

getFormatter in class AbstractFieldModel

Returns:

The formatter property value.

See Also:

setFormatter(com.ibm.etools.iseries.ui.Formatter)

getKeystrokeVerifier

public Document getKeystrokeVerifier()

Gets the keystrokeVerifier property (javax.swing.text.Document) value.

Specified by:

getKeystrokeVerifier in interface FieldModel

Specified by:

getKeystrokeVerifier in class AbstractFieldModel

Returns:

The keystrokeVerifier property value.

See Also:

setKeystrokeVerifier(javax.swing.text.Document)

getValidator

public Validator getValidator()

Gets the validator property (com.ibm.etools.iseries.ui.Validator) value.

Specified by:

getValidator in interface FieldModel

Specified by:

getValidator in class AbstractFieldModel

Returns:

The validator property value.

See Also:

setValidator(com.ibm.etools.iseries.ui.Validator)

propertyChange

public void propertyChange(PropertyChangeEvent e)

Examine the PropertyChangeEvent and decides what to do on a particular event.

Specified by:

propertyChange in interface PropertyChangeListener

Parameters:

e - java.beans.PropertyChangeEvent

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

Removes a propertyChangeListener.

Parameters:

l - PropertyChangeListener

removeVetoableChangeListener

public void removeVetoableChangeListener(VetoableChangeListener l)

Removes a vetoableChangeListener.

Parameters:

l - java.beans.VetoableChangeListener

setDataAttributes

public void setDataAttributes(Attributes a)
                       throws PropertyVetoException

Sets the dataAttributes property (com.ibm.etools.iseries.ui.Attributes) value. Please note that the parameter must be an instance of com.ibm.etools.iseries.ui.DataAttributes; otherwise java.beans.PropertyVetoException will be thrown at run time.

Specified by:

setDataAttributes in interface FieldModel

Specified by:

setDataAttributes in class AbstractFieldModel

Parameters:

dataAttributes - The new value for the property.

Throws:

PropertyVetoException

See Also:

getDataAttributes()

setFormatter

public void setFormatter(Formatter f)

Sets the formatter property (com.ibm.etools.iseries.ui.Formatter) value.

Specified by:

setFormatter in interface FieldModel

Specified by:

setFormatter in class AbstractFieldModel

Parameters:

f - The new value for the property.

See Also:

getFormatter()

setKeystrokeVerifier

public void setKeystrokeVerifier(Document d)

Sets the keystrokeVerifier property (javax.swing.text.Document) value.

Specified by:

setKeystrokeVerifier in interface FieldModel

Specified by:

setKeystrokeVerifier in class AbstractFieldModel

Parameters:

d - The new value for the property.

See Also:

getKeystrokeVerifier()

setValidator

public void setValidator(Validator v)

Sets the validator property (com.ibm.etools.iseries.ui.Validator) value.

Specified by:

setValidator in interface FieldModel

Specified by:

setValidator in class AbstractFieldModel

Parameters:

v - The new value for the property.

See Also:

getValidator()

vetoableChange

public void vetoableChange(PropertyChangeEvent e)
                    throws PropertyVetoException

This method gets called when a constrained property is changed.

Specified by:

vetoableChange in interface VetoableChangeListener

Parameters:

e - java.beans.PropertyChangeEvent a PropertyChangeEvent object describing the event source and the property that has changed.

Throws:

PropertyVetoException - if the recipient wishes the property change to be rolled back.