Eclipse Plug-in Developer Guide (Galileo) - Binding (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.core.databinding
Class Binding


java.lang.Object
  

org.eclipse.core.databinding.ValidationStatusProvider
      
org.eclipse.core.databinding.Binding

Direct Known Subclasses:: ListBinding, SetBinding

public abstract class Binding
extends ValidationStatusProvider
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 ()
          Returns the model observable

IObservableList getModels ()
          Returns an IObservableList < IObservable > containing the model observables (if any) that are being tracked by this validation status provider.

IObservable getTarget ()
          Returns the target observable

IObservableList getTargets ()
          Returns an IObservableList < IObservable > containing the target observables (if any) that are being tracked by this validation status provider.

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

getValidationStatus, 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.

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 the target observable

Returns:: the target observable

getTargets

public 
IObservableList getTargets()

Description copied from class: ValidationStatusProvider

Returns an IObservableList < IObservable > containing the target observables (if any) that are being tracked by this validation status provider.

Specified by:: getTargets in class ValidationStatusProvider

Returns:: an IObservableList < IObservable > (may be empty)

getModel

public 
IObservable getModel()

Returns the model observable

Returns:: the model observable

getModels

public 
IObservableList getModels()