JFace Data Bindings

Supported for Eclipse 3.3 and above only

The Edit Data Bindings dialog can be opened by clicking the Edit Data Bindings button on the main Designer toolbar.

JFace Viewers can bind to a content provider, label provider and input object. The content provider (an ObservableListContentProvider or ObservableSetContentProvider) is calculated automatically based on the input. The label provider (and ObservableMapLabelProvider) is created based on the observed bean and its selected properties.

Viewers

The list of viewers defined in the current compilation unit is shown in the Viewers field.

Input Types

Three types of inputs are supported:

  • Collections: any field of the current compilation unit that is a java.lang.List or java.lang.Set may be selected. The filter field above the list can be used to filter the list of collections. The clear button can be used to clear the filter and restore the full list.


     

  • Beans: any field of the current compilation unit may be selected. The filter field above the list can be used to filter the list of beans. The clear button can be used to clear the filter and restore the full list. Beans are the primary data source for bindings (usually the model). Any property of the Bean may be observed.


     

  • Selection: any object (usually a JFace viewer) with a selection property of type org.eclipse.jface.viewers.IStructuredSelection may be selected. The filter field above the list can be used to filter the list of selections. The clear button can be used to clear the filter and restore the full list. Typically, the selection of one viewer is bound to the input of another viewer in a master-detail relationship. New with Eclipse 3.4: If the selection target provide multiple selection or checked elements, those are available as inputs as well.

New JFace Bindings

New bindings are created by selecting a Viewer, an Input and clicking the Bind button. When creating a binding, the Content Provider and Label Provider may be specified.

    

New for Eclipse 3.4:

For TreeViewer inputs, the Input Bean Class, IObservableFactory, Tree Structure Advisor, Content Provider and Label Provider may be specified.

In order to simplify this, Designer can generate a number of pre-defined helper classes that implement most of the needed tree behavior.

Existing JFace Bindings

At the top of the page, existing Bound Viewers are listed. The Content Provider, Label Provider and Input are listed for each viewer.

Clicking the Edit button or Edit menu opens the Edit Binding dialog where the providers may be modified.

    

The Delete button or Delete menu is used to delete the selected bound viewer while the Delete All button or Delete All menu is used to delete all of the bound viewers.

Source

Clicking the OK button in the Edit Data Bindings dialog will generate or update any necessary data binding code which may then be seen in the Source view. An initDataBindings() method is created, if it does not already exist and a call to that method is added to the end of the widget creation process.

Within the initDataBindings() method, any needed observables are created first followed by the creation of the Data Binding Context. Simple SWT data bindings are then created using the new context followed by any JFace content providers, list providers and inputs that are needed.

Warning: do not edit the initDataBinding() method by hand (without carefully matching the code generation pattern used by Designer) as it will be regenerated in its entirety any time Designer needs to add, remove or update a data binding.