blob: 7ac98aead24449809857f20fcb0cba86e3ecab05 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2006 The Pampered Chef, Inc. and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Coconut Palm Software, Inc. - Initial API and implementation
******************************************************************************/
package org.eclipse.jface.examples.databinding.snippets;
import java.beans.PropertyChangeListener;
import java.beans.PropertyChangeSupport;
import org.eclipse.core.databinding.DataBindingContext;
import org.eclipse.core.databinding.beans.BeansObservables;
import org.eclipse.core.databinding.observable.Realm;
import org.eclipse.core.databinding.observable.list.IObservableList;
import org.eclipse.core.databinding.observable.list.WritableList;
import org.eclipse.core.databinding.observable.map.CompositeMap;
import org.eclipse.core.databinding.observable.map.IObservableMap;
import org.eclipse.core.databinding.observable.value.IObservableValue;
import org.eclipse.jface.databinding.swt.SWTObservables;
import org.eclipse.jface.databinding.viewers.ObservableListContentProvider;
import org.eclipse.jface.databinding.viewers.ObservableMapLabelProvider;
import org.eclipse.jface.databinding.viewers.ViewersObservables;
import org.eclipse.jface.layout.GridDataFactory;
import org.eclipse.jface.layout.GridLayoutFactory;
import org.eclipse.jface.viewers.ComboViewer;
import org.eclipse.jface.viewers.TableViewer;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.jface.viewers.ViewerFilter;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.TableColumn;
import org.eclipse.swt.widgets.Text;
/**
* Demonstrates binding a TableViewer to a collection.
*/
public class Snippet017TableViewerWithDerivedColumns {
public static void main(String[] args) {
final Display display = new Display();
// Set up data binding. In an RCP application, the threading Realm
// will be set for you automatically by the Workbench. In an SWT
// application, you can do this once, wrapping your binding
// method call.
Realm.runWithDefault(SWTObservables.getRealm(display), new Runnable() {
public void run() {
ViewModel viewModel = new ViewModel();
Shell shell = new View(viewModel).createShell();
// The SWT event loop
while (!shell.isDisposed()) {
if (!display.readAndDispatch()) {
display.sleep();
}
}
}
});
}
// Minimal JavaBeans support
public static abstract class AbstractModelObject {
private PropertyChangeSupport propertyChangeSupport = new PropertyChangeSupport(
this);
public void addPropertyChangeListener(PropertyChangeListener listener) {
propertyChangeSupport.addPropertyChangeListener(listener);
}
public void addPropertyChangeListener(String propertyName,
PropertyChangeListener listener) {
propertyChangeSupport.addPropertyChangeListener(propertyName,
listener);
}
public void removePropertyChangeListener(PropertyChangeListener listener) {
propertyChangeSupport.removePropertyChangeListener(listener);
}
public void removePropertyChangeListener(String propertyName,
PropertyChangeListener listener) {
propertyChangeSupport.removePropertyChangeListener(propertyName,
listener);
}
protected void firePropertyChange(String propertyName, Object oldValue,
Object newValue) {
propertyChangeSupport.firePropertyChange(propertyName, oldValue,
newValue);
}
}
private static Person UNKNOWN = new Person("unknown", null, null);
// The data model class. This is normally a persistent class of some sort.
static class Person extends AbstractModelObject {
// A property...
String name = "Donald Duck";
Person mother;
Person father;
public Person(String name, Person mother, Person father) {
this.name = name;
this.mother = mother;
this.father = father;
}
public String getName() {
return name;
}
public void setName(String name) {
String oldValue = this.name;
this.name = name;
firePropertyChange("name", oldValue, name);
}
public Person getMother() {
return mother;
}
public void setMother(Person mother) {
firePropertyChange("mother", this.mother, this.mother = mother);
}
public Person getFather() {
return father;
}
public void setFather(Person father) {
firePropertyChange("father", this.father, this.father = father);
}
public String toString() {
return name;
}
}
// The View's model--the root of our Model graph for this particular GUI.
//
// Typically each View class has a corresponding ViewModel class.
// The ViewModel is responsible for getting the objects to edit from the
// data access tier. Since this snippet doesn't have any persistent objects
// ro retrieve, this ViewModel just instantiates a model object to edit.
static class ViewModel {
// The model to bind
private IObservableList people = new WritableList();
{
Person fergus = new Person("Fergus McDuck", UNKNOWN, UNKNOWN);
Person downy = new Person("Downy O'Drake", UNKNOWN, UNKNOWN);
Person scrooge = new Person("Scrooge McDuck", downy, fergus);
Person hortense = new Person("Hortense McDuck", downy, fergus);
Person quackmore = new Person("Quackmore Duck", UNKNOWN, UNKNOWN);
Person della = new Person("Della Duck", hortense, quackmore);
Person donald = new Person("Donald Duck", hortense, quackmore);
donald.setFather(quackmore);
donald.setMother(hortense);
della.setFather(quackmore);
della.setMother(hortense);
hortense.setMother(downy);
hortense.setFather(fergus);
scrooge.setMother(downy);
scrooge.setFather(fergus);
people.add(UNKNOWN);
people.add(downy);
people.add(fergus);
people.add(scrooge);
people.add(quackmore);
people.add(hortense);
people.add(della);
people.add(donald);
}
public IObservableList getPeople() {
return people;
}
}
// The GUI view
static class View {
private ViewModel viewModel;
private Table duckFamily;
private Text nameText;
private Combo motherCombo;
private Combo fatherCombo;
public View(ViewModel viewModel) {
this.viewModel = viewModel;
}
public Shell createShell() {
// Build a UI
Display display = Display.getDefault();
Shell shell = new Shell(display);
duckFamily = new Table(shell, SWT.BORDER | SWT.FULL_SELECTION);
duckFamily.setHeaderVisible(true);
GridDataFactory.defaultsFor(duckFamily).span(2, 1).applyTo(
duckFamily);
createColumn("Name");
createColumn("Mother");
createColumn("Father");
createColumn("Grandmother");
duckFamily.setLinesVisible(true);
new Label(shell, SWT.NONE).setText("Name:");
nameText = new Text(shell, SWT.BORDER);
GridDataFactory.defaultsFor(nameText).grab(true, false).applyTo(
nameText);
new Label(shell, SWT.NONE).setText("Mother:");
motherCombo = new Combo(shell, SWT.READ_ONLY);
new Label(shell, SWT.NONE).setText("Father:");
fatherCombo = new Combo(shell, SWT.READ_ONLY);
DataBindingContext bindingContext = new DataBindingContext();
bindGUI(bindingContext);
GridLayoutFactory.swtDefaults().numColumns(2).applyTo(shell);
// Open and return the Shell
shell.setSize(500, 300);
shell.open();
return shell;
}
private void createColumn(String string) {
final TableColumn column = new TableColumn(duckFamily, SWT.NONE);
column.setWidth(100);
column.setText(string);
}
protected void bindGUI(DataBindingContext bindingContext) {
// Since we're using a JFace Viewer, we do first wrap our Table...
TableViewer peopleViewer = new TableViewer(duckFamily);
peopleViewer.addFilter(new ViewerFilter() {
public boolean select(Viewer viewer, Object parentElement,
Object element) {
return element != UNKNOWN;
}
});
// Create a standard content provider
ObservableListContentProvider peopleViewerContentProvider = new ObservableListContentProvider();
peopleViewer.setContentProvider(peopleViewerContentProvider);
// And a standard label provider that maps columns
IObservableMap nameMap = BeansObservables.observeMap(
peopleViewerContentProvider.getKnownElements(),
Person.class, "name");
IObservableMap motherMap = BeansObservables.observeMap(
peopleViewerContentProvider.getKnownElements(),
Person.class, "mother");
IObservableMap fatherMap = BeansObservables.observeMap(
peopleViewerContentProvider.getKnownElements(),
Person.class, "father");
IObservableMap grandmotherMap = new CompositeMap(motherMap,
BeansObservables.setToMapFactory(Person.class, "mother"));
IObservableMap[] columnMaps = new IObservableMap[] {
nameMap,
new CompositeMap(motherMap, BeansObservables.setToMapFactory(
Person.class, "name")),
new CompositeMap(fatherMap, BeansObservables.setToMapFactory(
Person.class, "name")),
new CompositeMap(grandmotherMap, BeansObservables.setToMapFactory(
Person.class, "name")) };
peopleViewer.setLabelProvider(new ObservableMapLabelProvider(
columnMaps));
// Now set the Viewer's input
peopleViewer.setInput(viewModel.getPeople());
IObservableValue selection = ViewersObservables
.observeSingleSelection(peopleViewer);
bindingContext
.bindValue(
SWTObservables.observeText(nameText, SWT.Modify),
BeansObservables.observeDetailValue(Realm
.getDefault(), selection, "name",
String.class), null, null);
ComboViewer mothercomboViewer = new ComboViewer(motherCombo);
ObservableListContentProvider motherComboContentProvider = new ObservableListContentProvider();
mothercomboViewer.setContentProvider(motherComboContentProvider);
mothercomboViewer.setLabelProvider(new ObservableMapLabelProvider(
BeansObservables.observeMap(motherComboContentProvider
.getKnownElements(), Person.class, "name")));
mothercomboViewer.setInput(viewModel.getPeople());
bindingContext.bindValue(ViewersObservables
.observeSingleSelection(mothercomboViewer),
BeansObservables.observeDetailValue(Realm.getDefault(),
selection, "mother", Person.class), null, null);
ComboViewer fatherComboViewer = new ComboViewer(fatherCombo);
ObservableListContentProvider fatherComboContentProvider = new ObservableListContentProvider();
fatherComboViewer
.setContentProvider(fatherComboContentProvider);
fatherComboViewer.setLabelProvider(new ObservableMapLabelProvider(
BeansObservables.observeMap(fatherComboContentProvider
.getKnownElements(), Person.class, "name")));
fatherComboViewer.setInput(viewModel.getPeople());
bindingContext.bindValue(ViewersObservables
.observeSingleSelection(fatherComboViewer),
BeansObservables.observeDetailValue(Realm.getDefault(),
selection, "father", Person.class), null, null);
}
}
}