Package org.eclipse.jface.databinding.viewers

Class ViewerValueProperty

java.lang.Object

org.eclipse.core.databinding.property.value.ValueProperty<S,T>

org.eclipse.core.databinding.property.value.SimpleValueProperty

org.eclipse.jface.databinding.viewers.ViewerValueProperty

All Implemented Interfaces:

IProperty, IValueProperty, IViewerValueProperty

public abstract class ViewerValueProperty
extends SimpleValueProperty
implements IViewerValueProperty

Abstract value property implementation for Viewer properties. This class implements some basic behavior that viewer properties are generally expected to have, namely:

• Calling observe(Object) should create the observable on the display realm of the viewer's control, rather than the current default realm
• All observe() methods should return an IViewerObservableValue

Since:

1.3

Constructor Summary

Constructors

Constructor	Description
ViewerValueProperty()

Method Summary

Modifier and Type	Method	Description
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
IViewerObservableValue	observe(Viewer viewer)	Returns an IViewerObservableValue observing this value property on the given viewer
IViewerObservableValue	observeDelayed(int delay, Viewer viewer)	Returns an IViewerObservableValue observing this value property on the given viewer, which delays notification of value changes until at least delay milliseconds have elapsed since that last change event, or until a FocusOut event is received from the viewer's control (whichever happens first).

Methods inherited from class org.eclipse.core.databinding.property.value.SimpleValueProperty

adaptListener, doGetValue, doSetValue, observeDetail, observeDetail, observeDetail

Methods inherited from class org.eclipse.core.databinding.property.value.ValueProperty

getValue, list, map, observeDetail, set, setValue, value, valueFactory, valueFactory

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.value.IValueProperty

getValue, getValueType, list, map, observeDetail, observeDetail, observeDetail, observeDetail, set, setValue, value, valueFactory, valueFactory

Constructor Detail

ViewerValueProperty

public ViewerValueProperty()

Method Detail

observe

public IObservableValue observe(Object source)

Description copied from interface: IValueProperty

Returns an observable value observing this value property on the given property source.

Specified by:

observe in interface IValueProperty

Overrides:

observe in class ValueProperty

Parameters:

source - the property source

Returns:

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

observe

public IObservableValue observe(Realm realm,
                                Object source)

Description copied from interface: IValueProperty

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

Specified by:

observe in interface IValueProperty

Overrides:

observe in class SimpleValueProperty

Parameters:

realm - the observable's realm

source - the property source

Returns:

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

observe

public IViewerObservableValue observe(Viewer viewer)

Description copied from interface: IViewerValueProperty

Returns an IViewerObservableValue observing this value property on the given viewer

Specified by:

observe in interface IViewerValueProperty

Parameters:

viewer - the source viewer

Returns:

an observable value observing this value property on the given viewer

observeDelayed

public IViewerObservableValue observeDelayed(int delay,
                                             Viewer viewer)

Description copied from interface: IViewerValueProperty

Returns an IViewerObservableValue observing this value property on the given viewer, which delays notification of value changes until at least delay milliseconds have elapsed since that last change event, or until a FocusOut event is received from the viewer's control (whichever happens first).

This method is equivalent to ViewersObservables.observeDelayedValue(delay, observe(viewer)).

Specified by:

observeDelayed in interface IViewerValueProperty

Parameters:

delay - the delay in milliseconds.

viewer - the source viewer

Returns:

an observable value observing this value property on the given viewer, and which delays change notifications for delay milliseconds.