Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.jgoodies.binding.value
Interface ValueModel

All Known Subinterfaces:
  ComponentValueModel

All Known Implementing Classes:
  AbstractValueModel, AbstractVetoableValueModel, AbstractWrappedValueModel, BeanAdapter.SimplePropertyAdapter, BufferedValueModel, ConverterValueModel, DefaultComponentValueModel, DelayedReadValueModel, DelayedWriteValueModel, NonNullValueModel, PreferencesAdapter, PropertyAdapter, SelectionInList, Trigger, ValueHolder

    public interface ValueModel

Describes models with a generic access to a single value that allow to observe value changes. The value can be accessed using the `#getValue()`/`#setValue(Object)` methods. Observers can register instances of `PropertyChangeListener` to be notified if the value changes.

If the value is read-only or write-only, an implementor may choose to reject an operation using an `UnsupportedOperationException` or may do nothing or perform an appropriate action, or may return an appropriate value.

The listeners registered with this ValueModel using #addValueChangeListener will be invoked only with PropertyChangeEvents that have the name set to "value". In other words, the listeners won't get notified when a PropertyChangeEvent is fired that has a null object as the name to indicate an arbitrary set of the event source's properties have changed. This is the case if you use the PropertyChangeSupport, either directly or indirectly, to fire property changes with the property name "value" specified. This constraint ensures that all ValueModel implementors behave like the AbstractValueModel subclasses. In the rare case, where you want to notify a PropertyChangeListener even with PropertyChangeEvents that have no property name set, you can register the listener with #addPropertyChangeListener, not #addValueChangeListener.

AbstractValueModel minimizes the effort required to implement this interface. It uses the PropertyChangeSupport to fire PropertyChangeEvents, and it adds PropertyChangeListeners for the specific property name "value". This ensures that the constraint mentioned above is met.

Implementors are encouraged to provide non-null values for the PropertyChangeEvent's old and new values. However, both may be null.

Version:
  $Revision: 1.9 $
Author:
  Karsten Lentzsch
See Also:
  `AbstractValueModel`, `ValueHolder`, `PropertyAdapter`

Field Summary
`static String` | `PROPERTY_VALUE` The name of the bound property value.

Method Summary
`void` | `addValueChangeListener(PropertyChangeListener listener)` Registers the given PropertyChangeListener with this ValueModel.
`Object` | `getValue()` Returns this model's value.
`void` | `removeValueChangeListener(PropertyChangeListener listener)` Deregisters the given PropertyChangeListener from this ValueModel.
`void` | `setValue(Object newValue)` Sets a new value and notifies any registered value listeners if the value has changed.

Field Detail

### PROPERTY_VALUE

    static final String PROPERTY_VALUE

  The name of the bound property value.

  See Also:
    Constant Field Values

Method Detail

### getValue

    Object getValue()

  Returns this model's value. In case of a write-only value, implementors may choose to either reject this operation or or return `null` or any other appropriate value.

  Returns:
    this model's value

### setValue

    void setValue(Object newValue)

  Sets a new value and notifies any registered value listeners if the value has changed. In case of a read-only value implementors may choose to either reject this operation or to do nothing.

  Parameters:
    `newValue` - the value to be set

### addValueChangeListener

    void addValueChangeListener(PropertyChangeListener listener)

  Registers the given PropertyChangeListener with this ValueModel. The listener will be notified if the value has changed. The PropertyChangeEvents delivered to the listener must have the name set to "value". The latter ensures that all ValueModel implementors behave like the AbstractValueModel subclasses.

  To comply with the above specification implementors can use the PropertyChangeSupport's #addPropertyChangeListener method that accepts a property name, so that listeners will be invoked only if that specific property has changed.

  Parameters:
    `listener` - the listener to be added
  See Also:
    `AbstractValueModel.addValueChangeListener(PropertyChangeListener)`

### removeValueChangeListener

    void removeValueChangeListener(PropertyChangeListener listener)

  Deregisters the given PropertyChangeListener from this ValueModel.

  Parameters:
    `listener` - the listener to be removed

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2002-2013 JGoodies Software GmbH. All Rights Reserved.