Eclipse Platform
Release 3.4

org.eclipse.core.databinding
Class Binding

java.lang.Object
  extended byorg.eclipse.core.databinding.ValidationStatusProvider
      extended byorg.eclipse.core.databinding.Binding
Direct Known Subclasses:
ListBinding, SetBinding

public abstract class Binding
extends ValidationStatusProvider

This abstract class represents a binding between a model and a target. Newly created instances need to be added to a data binding context using init(DataBindingContext).

Since:
1.0

Field Summary
protected  DataBindingContext context
           
 
Fields inherited from class org.eclipse.core.databinding.ValidationStatusProvider
disposed
 
Constructor Summary
Binding(IObservable target, IObservable model)
          Creates a new binding.
 
Method Summary
 void dispose()
          Disposes of this Binding.
 IObservable getModel()
           
 IObservableList getModels()
          Returns the model observables (if any) that are being tracked by this validation status provider.
 IObservable getTarget()
           
 IObservableList getTargets()
          Returns the list of target observables (if any) that are being tracked by this validation status provider.
abstract  IObservableValue getValidationStatus()
           
 void init(DataBindingContext context)
          Initializes this binding with the given context and adds it to the list of bindings of the context.
protected abstract  void postInit()
          Called by init(DataBindingContext) after adding this binding to the context.
protected abstract  void preInit()
          Called by init(DataBindingContext) after setting context but before adding this binding to the context.
abstract  void updateModelToTarget()
          Updates the target's state from the model's state at the next reasonable opportunity.
abstract  void updateTargetToModel()
          Updates the model's state from the target's state at the next reasonable opportunity.
abstract  void validateModelToTarget()
          Validates the model's state at the next reasonable opportunity.
abstract  void validateTargetToModel()
          Validates the target's state at the next reasonable opportunity.
 
Methods inherited from class org.eclipse.core.databinding.ValidationStatusProvider
isDisposed
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

context

protected DataBindingContext context
Constructor Detail

Binding

public Binding(IObservable target,
               IObservable model)
Creates a new binding.

Parameters:
target - target observable
model - model observable
Method Detail

init

public final void init(DataBindingContext context)
Initializes this binding with the given context and adds it to the list of bindings of the context.

Subclasses may extend, but must call the super implementation.

Parameters:
context -

preInit

protected abstract void preInit()
Called by init(DataBindingContext) after setting context but before adding this binding to the context. Subclasses may use this method to perform initialization that could not be done in the constructor. Care should be taken not to cause any events while running this method.


postInit

protected abstract void postInit()
Called by init(DataBindingContext) after adding this binding to the context. Subclasses may use this method to perform initialization that may cause events to be fired, including BindingEvents that are forwarded to the data binding context.


getValidationStatus

public abstract IObservableValue getValidationStatus()
Specified by:
getValidationStatus in class ValidationStatusProvider
Returns:
an observable value containing the current validation status

updateTargetToModel

public abstract void updateTargetToModel()
Updates the model's state from the target's state at the next reasonable opportunity. There is no guarantee that the state will have been updated by the time this call returns.


updateModelToTarget

public abstract void updateModelToTarget()
Updates the target's state from the model's state at the next reasonable opportunity. There is no guarantee that the state will have been updated by the time this call returns.


validateTargetToModel

public abstract void validateTargetToModel()
Validates the target's state at the next reasonable opportunity. There is no guarantee that the validation status will have been updated by the time this call returns.


validateModelToTarget

public abstract void validateModelToTarget()
Validates the model's state at the next reasonable opportunity. There is no guarantee that the validation status will have been updated by the time this call returns.


dispose

public void dispose()
Disposes of this Binding. Subclasses may extend, but must call super.dispose().

Overrides:
dispose in class ValidationStatusProvider

getTarget

public IObservable getTarget()
Returns:
target observable

getTargets

public IObservableList getTargets()
Description copied from class: ValidationStatusProvider
Returns the list of target observables (if any) that are being tracked by this validation status provider.

Specified by:
getTargets in class ValidationStatusProvider
Returns:
an observable list of target IObservables (may be empty)
Since:
1.1

getModel

public IObservable getModel()
Returns:
model observable

getModels

public IObservableList getModels()
Description copied from class: ValidationStatusProvider
Returns the model observables (if any) that are being tracked by this validation status provider.

Specified by:
getModels in class ValidationStatusProvider
Returns:
an observable list of model IObservables (may be empty)
Since:
1.1

Eclipse Platform
Release 3.4

Guidelines for using Eclipse APIs.

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