Class WidgetValueProperty
- java.lang.Object
-
- org.eclipse.core.databinding.property.value.ValueProperty<S,T>
-
- org.eclipse.core.databinding.property.value.SimpleValueProperty
-
- org.eclipse.jface.databinding.swt.WidgetValueProperty
-
- All Implemented Interfaces:
IProperty
,IValueProperty
,IWidgetValueProperty
public abstract class WidgetValueProperty extends SimpleValueProperty implements IWidgetValueProperty
Abstract value property implementation forWidget
properties. This class implements some basic behavior that widget properties are generally expected to have, namely:- Calling
observe(Object)
should create the observable on the display realm of the widget, rather than the current default realm - All
observe()
methods should return anISWTObservableValue
untyped listener API
. Subclasses may pass one or more SWT event type constants to the super constructor to indicate which events signal a property change.- Since:
- 1.3
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
WidgetValueProperty()
Constructs a WidgetValueProperty which does not listen for any SWT events.protected
WidgetValueProperty(int changeEvent)
Constructs a WidgetValueProperty with the specified SWT event typeprotected
WidgetValueProperty(int[] changeEvents)
Constructs a WidgetValueProperty with the specified SWT event type(s).WidgetValueProperty(int[] changeEvents, int[] staleEvents)
Constructs a WidgetValueProperty with the specified SWT event types.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.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 sourceISWTObservableValue
observe(Widget widget)
Returns anISWTObservableValue
observing this value property on the given widgetISWTObservableValue
observeDelayed(int delay, Widget widget)
Returns anISWTObservableValue
observing this value property on the given widget, which delays notification of value changes until at leastdelay
milliseconds have elapsed since that last change event, or until a FocusOut event is received from the widget (whichever happens first).protected ISWTObservableValue
wrapObservable(IObservableValue observable, Widget widget)
-
Methods inherited from class org.eclipse.core.databinding.property.value.SimpleValueProperty
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
-
WidgetValueProperty
protected WidgetValueProperty()
Constructs a WidgetValueProperty which does not listen for any SWT events.
-
WidgetValueProperty
protected WidgetValueProperty(int changeEvent)
Constructs a WidgetValueProperty with the specified SWT event type- Parameters:
changeEvent
- SWT event type constant of the event that signifies a property change.
-
WidgetValueProperty
protected WidgetValueProperty(int[] changeEvents)
Constructs a WidgetValueProperty with the specified SWT event type(s).- Parameters:
changeEvents
- array of SWT event type constants of the events that signify a property change.
-
WidgetValueProperty
public WidgetValueProperty(int[] changeEvents, int[] staleEvents)
Constructs a WidgetValueProperty with the specified SWT event types.- Parameters:
changeEvents
- array of SWT event type constants of the events that signify a property change.staleEvents
- array of SWT event type constants of the events that signify a property became stale.
-
-
Method Detail
-
adaptListener
public INativePropertyListener adaptListener(ISimplePropertyListener listener)
Description copied from class:SimpleValueProperty
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.
- Specified by:
adaptListener
in classSimpleValueProperty
- 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.
-
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 interfaceIValueProperty
- Overrides:
observe
in classValueProperty
- 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 interfaceIValueProperty
- Overrides:
observe
in classSimpleValueProperty
- Parameters:
realm
- the observable's realmsource
- the property source- Returns:
- an observable value observing this value property on the given property source
-
wrapObservable
protected ISWTObservableValue wrapObservable(IObservableValue observable, Widget widget)
-
observe
public ISWTObservableValue observe(Widget widget)
Description copied from interface:IWidgetValueProperty
Returns anISWTObservableValue
observing this value property on the given widget- Specified by:
observe
in interfaceIWidgetValueProperty
- Parameters:
widget
- the source widget- Returns:
- an observable value observing this value property on the given widget
-
observeDelayed
public ISWTObservableValue observeDelayed(int delay, Widget widget)
Description copied from interface:IWidgetValueProperty
Returns anISWTObservableValue
observing this value property on the given widget, which delays notification of value changes until at leastdelay
milliseconds have elapsed since that last change event, or until a FocusOut event is received from the widget (whichever happens first).This method is equivalent to
SWTObservables.observeDelayedValue(delay, observe(widget))
.- Specified by:
observeDelayed
in interfaceIWidgetValueProperty
- Parameters:
delay
- the delay in milliseconds.widget
- the source widget- Returns:
- an observable value observing this value property on the given
widget, and which delays change notifications for
delay
milliseconds.
-
-