Eclipse Plug-in Developer Guide (Galileo) - ObservablesManager (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 ObservablesManager


java.lang.Object
  
org.eclipse.core.databinding.ObservablesManager

public class ObservablesManager
extends Object
extends Object

An observables manager can be used for lifecycle management of IObservable objects.

Since:: 1.0
Restriction:: This class is not intended to be subclassed by clients.

Constructor Summary

ObservablesManager ()
          Create a new observables manager.

Method Summary

void addObservable ( IObservable observable)
          Adds the given observable to this manager.

void addObservablesFromContext ( DataBindingContext context, boolean trackTargets, boolean trackModels)
          Adds the given data binding context's target and/or model observables to this manager.

void dispose ()
          Disposes of this manager and all observables that it manages.

void excludeObservable ( IObservable observable)
          Adds the given observable to this manager's exclusion list.

void runAndCollect ( Runnable runnable)
          Executes the specified runnable and adds to this manager all observables created while executing the runnable.

Methods inherited from class java.lang. Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ObservablesManager

public ObservablesManager()

Create a new observables manager.

Method Detail

addObservable

public void addObservable(
IObservable observable)

Adds the given observable to this manager.

Parameters:: observable - the observable

excludeObservable

public void excludeObservable(
IObservable observable)

Adds the given observable to this manager's exclusion list. The given observable will not be disposed of by this manager.

Parameters:: observable - the observable

addObservablesFromContext

public void addObservablesFromContext(
DataBindingContext context,
                                      boolean trackTargets,
                                      boolean trackModels)

Adds the given data binding context's target and/or model observables to this manager.

Parameters:: context - the data binding context; trackTargets - true if the target observables of the context should be managed; trackModels - true if the model observables of the context should be managed

runAndCollect

public void runAndCollect(
Runnable runnable)

Executes the specified runnable and adds to this manager all observables created while executing the runnable.

NOTE: As of 1.2 (Eclipse 3.5), there are unresolved problems with this API, see bug 278550. If we cannot find a way to make this API work, it will be deprecated as of 3.6.

Parameters:: runnable - the runnable to execute
Since:: 1.2

dispose

public void dispose()

Disposes of this manager and all observables that it manages.