Eclipse Platform
Release 3.6

org.eclipse.core.databinding.property.list
Class ListProperty

java.lang.Object
  extended by org.eclipse.core.databinding.property.list.ListProperty
All Implemented Interfaces:
IProperty, IListProperty
Direct Known Subclasses:
DelegatingListProperty, MultiListProperty, SimpleListProperty

public abstract class ListProperty
extends Object
implements IListProperty

Abstract implementation of IListProperty.

Since:
1.2

Constructor Summary
ListProperty()
           
 
Method Summary
protected  List doGetList(Object source)
          Returns a List with the current contents of the source's list property
protected  void doSetList(Object source, List list)
          Updates the property on the source with the specified change.
protected  void doUpdateList(Object source, ListDiff diff)
          Updates the property on the source with the specified change
 List getList(Object source)
          Returns an unmodifiable List with the current contents of the source's list property
 IObservableFactory listFactory()
          Returns a factory for creating observable lists tracking this property of a particular property source.
 IObservableFactory listFactory(Realm realm)
          Returns a factory for creating observable lists in the given realm, tracking this property of a particular property source.
 IObservableList observe(Object source)
          Returns an observable list observing this list property on the given property source
 IObservableList observeDetail(IObservableValue master)
          Returns an observable list on the master observable's realm which tracks this property of the current value of master.
 void setList(Object source, List list)
          Updates the property on the source with the specified change Note: This method is made available to facilitate basic property access.
 void updateList(Object source, ListDiff diff)
          Updates the property on the source with the specified change Note: This method is made available to facilitate basic property access.
 IListProperty values(IValueProperty detailValue)
          Returns the nested combination of this property and the specified detail value property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.core.databinding.property.list.IListProperty
getElementType, observe
 

Constructor Detail

ListProperty

public ListProperty()
Method Detail

getList

public final List getList(Object source)
Description copied from interface: IListProperty
Returns an unmodifiable List with the current contents of the source's list property

Specified by:
getList in interface IListProperty
Parameters:
source - the property source (may be null)
Returns:
an unmodifiable List with the current contents of the source's list property
Since:
1.3

doGetList

protected List doGetList(Object source)
Returns a List with the current contents of the source's list property

Parameters:
source - the property source
Returns:
a List with the current contents of the source's list property
Since:
1.3
Restriction:
This method is not intended to be referenced by clients.

setList

public final void setList(Object source,
                          List list)
Description copied from interface: IListProperty
Updates the property on the source with the specified change

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 modify the source through an IObservableList than through the property directly.

Specified by:
setList in interface IListProperty
Parameters:
source - the property source (may be null)
list - the new list
Since:
1.3

doSetList

protected void doSetList(Object source,
                         List list)
Updates the property on the source with the specified change.

Parameters:
source - the property source
list - the new list
Since:
1.3
Restriction:
This method is not intended to be referenced by clients.

updateList

public final void updateList(Object source,
                             ListDiff diff)
Description copied from interface: IListProperty
Updates the property on the source with the specified change

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 modify the source through an IObservableList than through the property directly.

Specified by:
updateList in interface IListProperty
Parameters:
source - the property source (may be null)
diff - a diff describing the change
Since:
1.3

doUpdateList

protected void doUpdateList(Object source,
                            ListDiff diff)
Updates the property on the source with the specified change

Parameters:
source - the property source
diff - a diff describing the change
Since:
1.3

observe

public IObservableList observe(Object source)
Description copied from interface: IListProperty
Returns an observable list observing this list property on the given property source

Specified by:
observe in interface IListProperty
Parameters:
source - the property source
Returns:
an observable list observing this list property on the given property source

listFactory

public IObservableFactory listFactory()
Description copied from interface: IListProperty
Returns a factory for creating observable lists tracking this property of a particular property source.

Specified by:
listFactory in interface IListProperty
Returns:
a factory for creating observable lists tracking this property of a particular property source.

listFactory

public IObservableFactory listFactory(Realm realm)
Description copied from interface: IListProperty
Returns a factory for creating observable lists in the given realm, tracking this property of a particular property source.

Specified by:
listFactory in interface IListProperty
Parameters:
realm - the realm
Returns:
a factory for creating observable lists in the given realm, tracking this property of a particular property source.

observeDetail

public IObservableList observeDetail(IObservableValue master)
Description copied from interface: IListProperty
Returns an observable list on the master observable's realm which tracks this property of the current value of master.

Specified by:
observeDetail in interface IListProperty
Parameters:
master - the master observable
Returns:
an observable list on the given realm which tracks this property of the current value of master.

values

public final IListProperty values(IValueProperty detailValue)
Description copied from interface: IListProperty
Returns the nested combination of this property and the specified detail value property. Note that because this property is a projection of value properties over a list, the only modification supported is through the IObservableList.set(int, Object) method. Modifications made through the returned property are delegated to the detail property, using the corresponding list element from the master property as the source.

Specified by:
values in interface IListProperty
Parameters:
detailValue - the detail property
Returns:
the nested combination of the master list and detail value properties

Eclipse Platform
Release 3.6

Guidelines for using Eclipse APIs.

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