Eclipse Platform
Release 3.6

org.eclipse.core.databinding.property.value
Interface IValueProperty

All Superinterfaces:
IProperty
All Known Subinterfaces:
IBeanValueProperty, IViewerValueProperty, IWidgetValueProperty
All Known Implementing Classes:
DelegatingValueProperty, SimpleValueProperty, ValueProperty, ViewerValueProperty, WidgetValueProperty

public interface IValueProperty
extends IProperty

Interface for value-typed properties

Since:
1.2
See Also:
ValueProperty, SimpleValueProperty
Restriction:
This interface is not intended to be implemented by clients. Clients should instead subclass one of the classes that implement this interface. Note that direct implementers of this interface outside of the framework will be broken in future releases when methods are added to this interface.

Method Summary
 Object getValue(Object source)
          Returns the current value of this property on the specified property source.
 Object getValueType()
          Returns the value type of the property, or null if untyped.
 IListProperty list(IListProperty detailList)
          Returns the nested combination of this property and the specified detail list property.
 IMapProperty map(IMapProperty detailMap)
          Returns the nested combination of this property and the specified detail map property.
 IObservableValue observe(Object source)
          Returns an observable value observing this value property on the given property source.
 IObservableValue observe(Realm realm, Object source)
          Returns an observable value observing this value property on the given property source
 IObservableList observeDetail(IObservableList master)
          Returns an observable list on the master observable's realm which tracks this property on each element of master.
 IObservableMap observeDetail(IObservableMap master)
          Returns an observable map on the master observable's realm where the map's key set is the same as the master observable map, and where each value is the property value of the corresponding value in the master observable map.
 IObservableMap observeDetail(IObservableSet master)
          Returns an observable map on the master observable's realm where the map's key set is the specified master set, and where each key maps to the current property value for each element.
 IObservableValue observeDetail(IObservableValue master)
          Returns an observable value on the master observable's realm which tracks this property on the current value of master.
 ISetProperty set(ISetProperty detailSet)
          Returns the nested combination of this property and the specified detail set property.
 void setValue(Object source, Object value)
          Sets this property on the specified property source to the specified value.
 IValueProperty value(IValueProperty detailValue)
          Returns the nested combination of this property and the specified detail value property.
 IObservableFactory valueFactory()
          Returns a factory for creating observable values tracking this property of a particular property source.
 IObservableFactory valueFactory(Realm realm)
          Returns a factory for creating observable values in the given realm, tracking this property of a particular property source.
 

Method Detail

getValueType

Object getValueType()
Returns the value type of the property, or null if untyped.

Returns:
the value type of the property, or null if untyped.

getValue

Object getValue(Object source)
Returns the current value of this property on the specified property source.

Parameters:
source - the property source (may be null)
Returns:
the current value of this property on the specified property source.
Since:
1.3

setValue

void setValue(Object source,
              Object value)
Sets this property on the specified property source to the specified value.

Note: This method is made available to facilitate basic property access. However if the property source lacks property change notification, then observables on the source object may not be notified of the change. In most cases it is preferable to call IObservableValue.setValue(Object) on the observable instead.

Parameters:
source - the property source (may be null)
value - the new property value
Since:
1.3

observe

IObservableValue observe(Object source)
Returns an observable value observing this value property on the given property source.

Parameters:
source - the property source
Returns:
an observable value observing this value property on the given property source

observe

IObservableValue observe(Realm realm,
                         Object source)
Returns an observable value observing this value property on the given property source

Parameters:
realm - the observable's realm
source - the property source
Returns:
an observable value observing this value property on the given property source

valueFactory

IObservableFactory valueFactory()
Returns a factory for creating observable values tracking this property of a particular property source.

Returns:
a factory for creating observable values tracking this property of a particular property source.

valueFactory

IObservableFactory valueFactory(Realm realm)
Returns a factory for creating observable values in the given realm, tracking this property of a particular property source.

Parameters:
realm - the realm
Returns:
a factory for creating observable values in the given realm, tracking this property of a particular property source.

observeDetail

IObservableValue observeDetail(IObservableValue master)
Returns an observable value on the master observable's realm which tracks this property on the current value of master.

Parameters:
master - the master observable
Returns:
an observable value which tracks this property of the current value of master.

observeDetail

IObservableList observeDetail(IObservableList master)
Returns an observable list on the master observable's realm which tracks this property on each element of master.

Parameters:
master - the master observable
Returns:
an observable list which tracks this property on each element of the master observable.

observeDetail

IObservableMap observeDetail(IObservableSet master)
Returns an observable map on the master observable's realm where the map's key set is the specified master set, and where each key maps to the current property value for each element.

Parameters:
master - the master observable
Returns:
an observable map that tracks the current value of this property for the elements in the given set.

observeDetail

IObservableMap observeDetail(IObservableMap master)
Returns an observable map on the master observable's realm where the map's key set is the same as the master observable map, and where each value is the property value of the corresponding value in the master observable map.

Parameters:
master - the master observable
Returns:
an observable map on the master observable's realm which tracks the current value of this property for the elements in the given map's values collection

value

IValueProperty value(IValueProperty detailValue)
Returns the nested combination of this property and the specified detail value property. Value modifications made through the returned property are delegated to the detail property, using the value of this property as the source.

Parameters:
detailValue - the detail property
Returns:
the nested combination of the master and detail properties

list

IListProperty list(IListProperty detailList)
Returns the nested combination of this property and the specified detail list property. List modifications made through the returned property are delegated to the detail property, using the value of the master property as the source.

Parameters:
detailList - the detail property
Returns:
the nested combination of the master value and detail list properties

set

ISetProperty set(ISetProperty detailSet)
Returns the nested combination of this property and the specified detail set property. Set modifications made through the returned property are delegated to the detail property, using the value of the master property as the source.

Parameters:
detailSet - the detail property
Returns:
the nested combination of the master value and detail set properties

map

IMapProperty map(IMapProperty detailMap)
Returns the nested combination of this property and the specified detail map property. Map modifications made through the returned property are delegated to the detail property, using the value of the master property as the source.

Parameters:
detailMap - the detail property
Returns:
the nested combination of the master value and detial map properties

Eclipse Platform
Release 3.6

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.