org.eclipse.core.databinding.property.list

Class SimpleListProperty

java.lang.Object

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

org.eclipse.core.databinding.property.list.SimpleListProperty

All Implemented Interfaces:

IProperty, IListProperty

Direct Known Subclasses:

ViewerListProperty, WidgetListProperty

public abstract class SimpleListProperty
extends ListProperty

Simplified abstract implementation of IListProperty. This class takes care of most of the functional requirements for an IListProperty implementation, leaving only the property-specific details to subclasses.

Subclasses must implement these methods:

• IListProperty.getElementType()
• doGetList(Object)
• doSetList(Object, List, ListDiff)
• adaptListener(ISimplePropertyListener)

In addition, we recommended overriding Object.toString() to return a description suitable for debugging purposes.

Since:

1.2

Constructor Summary

Constructors

Constructor and Description
SimpleListProperty()

Method Summary

Modifier and Type	Method and Description
abstract INativePropertyListener	adaptListener(ISimplePropertyListener listener) Returns a listener capable of adding or removing itself as a listener on a source object using the the source's "native" listener API.
protected abstract 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 abstract void	doSetList(Object source, List list, ListDiff diff) 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
IObservableList	observe(Realm realm, Object source) Returns an observable list observing this list property on the given property source
void	setList(Object source, List list, ListDiff diff) Updates the property on the source with the specified change.

Methods inherited from class org.eclipse.core.databinding.property.list.ListProperty

getList, listFactory, listFactory, observe, observeDetail, setList, updateList, values

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

Constructor Detail

SimpleListProperty

public SimpleListProperty()

Method Detail

observe

public IObservableList observe(Realm realm,
                               Object source)

Description copied from interface: IListProperty

Returns an observable list observing this list property on the given property source

Parameters:

realm - the observable's realm

source - the property source

Returns:

an observable list observing this list property on the given property source

doGetList

protected abstract List doGetList(Object source)

Description copied from class: ListProperty

Returns a List with the current contents of the source's list property

Overrides:

doGetList in class ListProperty

Parameters:

source - the property source

Returns:

a List with the current contents of the source's list property

setList

public final void setList(Object source,
                          List list,
                          ListDiff diff)

Updates the property on the source with the specified change.

Parameters:

source - the property source

list - the new list

diff - a diff describing the change

Restriction:

This method is not intended to be referenced by clients.

doSetList

protected abstract void doSetList(Object source,
                                  List list,
                                  ListDiff diff)

Updates the property on the source with the specified change.

Parameters:

source - the property source

list - the new list

diff - a diff describing the change

Restriction:

This method is not intended to be referenced by clients.

doSetList

protected void doSetList(Object source,
                         List list)

Description copied from class: ListProperty

Updates the property on the source with the specified change.

Overrides:

doSetList in class ListProperty

Parameters:

source - the property source

list - the new list

doUpdateList

protected void doUpdateList(Object source,
                            ListDiff diff)

Description copied from class: ListProperty

Updates the property on the source with the specified change

Overrides:

doUpdateList in class ListProperty

Parameters:

source - the property source

diff - a diff describing the change

adaptListener

public abstract INativePropertyListener adaptListener(ISimplePropertyListener listener)

Returns a listener capable of adding or removing itself as a listener on a source object using the the source's "native" listener API. Events received from the source objects are parlayed to the specified listener argument.

This method returns null if the source object has no listener APIs for this property.

Parameters:

listener - the property listener to receive events

Returns:

a native listener which parlays property change events to the specified listener, or null if the source object has no listener APIs for this property.

Restriction:

This method is not intended to be referenced by clients.