| /******************************************************************************* |
| * Copyright (c) 2008, 2010 Oracle. 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: |
| * Oracle - initial API and implementation |
| ******************************************************************************/ |
| package org.eclipse.jpt.ui.internal.persistence.details; |
| |
| import java.util.ListIterator; |
| |
| import org.eclipse.jface.resource.ImageDescriptor; |
| import org.eclipse.jface.viewers.CellEditor; |
| import org.eclipse.jface.viewers.IBaseLabelProvider; |
| import org.eclipse.jface.viewers.ICellModifier; |
| import org.eclipse.jface.viewers.ITableLabelProvider; |
| import org.eclipse.jface.viewers.LabelProvider; |
| import org.eclipse.jface.viewers.TableViewer; |
| import org.eclipse.jface.viewers.TextCellEditor; |
| import org.eclipse.jpt.common.ui.WidgetFactory; |
| import org.eclipse.jpt.common.ui.internal.swt.ColumnAdapter; |
| import org.eclipse.jpt.common.ui.internal.util.SWTUtil; |
| import org.eclipse.jpt.common.ui.internal.widgets.AddRemoveTablePane; |
| import org.eclipse.jpt.common.ui.internal.widgets.Pane; |
| import org.eclipse.jpt.core.context.persistence.PersistenceUnit; |
| import org.eclipse.jpt.ui.details.JpaPageComposite; |
| import org.eclipse.jpt.ui.internal.JpaHelpContextIds; |
| import org.eclipse.jpt.ui.internal.details.java.BaseJavaUiFactory; |
| import org.eclipse.jpt.ui.internal.persistence.JptUiPersistenceMessages; |
| import org.eclipse.jpt.utility.internal.model.value.ListAspectAdapter; |
| import org.eclipse.jpt.utility.internal.model.value.PropertyAspectAdapter; |
| import org.eclipse.jpt.utility.internal.model.value.SimplePropertyValueModel; |
| import org.eclipse.jpt.utility.internal.model.value.swing.ObjectListSelectionModel; |
| import org.eclipse.jpt.utility.model.event.ListAddEvent; |
| import org.eclipse.jpt.utility.model.event.ListChangeEvent; |
| import org.eclipse.jpt.utility.model.event.ListRemoveEvent; |
| import org.eclipse.jpt.utility.model.value.ListValueModel; |
| import org.eclipse.jpt.utility.model.value.PropertyValueModel; |
| import org.eclipse.jpt.utility.model.value.WritablePropertyValueModel; |
| import org.eclipse.swt.graphics.Image; |
| import org.eclipse.swt.layout.GridData; |
| import org.eclipse.swt.widgets.Composite; |
| import org.eclipse.swt.widgets.Table; |
| import org.eclipse.swt.widgets.TableColumn; |
| import org.eclipse.swt.widgets.TableItem; |
| |
| /** |
| * Here the layout of this pane: |
| * <pre> |
| * ----------------------------------------------------------------------------- |
| * | - Properties ------------------------------------------------------------ | |
| * | | |
| * | Description | |
| * | | |
| * | ----------------------------------------------------------------------- | |
| * | | | | |
| * | | AddRemoveTablePane | | |
| * | | | | |
| * | ----------------------------------------------------------------------- | |
| * -----------------------------------------------------------------------------</pre> |
| * |
| * @see PersistenceUnit |
| * @see BaseJavaUiFactory - The invoker |
| * @see AddRemoveTablePane |
| * |
| * @version 2.3 |
| * @since 2.0 |
| */ |
| @SuppressWarnings("nls") |
| public class PersistenceUnitPropertiesComposite extends Pane<PersistenceUnit> |
| implements JpaPageComposite |
| { |
| private WritablePropertyValueModel<PersistenceUnit.Property> propertyHolder; |
| private TablePane tablePane; |
| |
| /** |
| * Creates a new <code>PersistenceUnitPropertiesComposite</code>. |
| * |
| * @param subjectHolder The holder of this pane's subject |
| * @param parent The parent container |
| * @param widgetFactory The factory used to create various common widgets |
| */ |
| public PersistenceUnitPropertiesComposite(PropertyValueModel<PersistenceUnit> subjectHolder, |
| Composite container, |
| WidgetFactory widgetFactory) { |
| |
| super(subjectHolder, container, widgetFactory); |
| } |
| |
| private ListValueModel<PersistenceUnit.Property> buildPropertiesListHolder() { |
| return new ListAspectAdapter<PersistenceUnit, PersistenceUnit.Property>(getSubjectHolder(), PersistenceUnit.PROPERTIES_LIST) { |
| @Override |
| protected ListIterator<PersistenceUnit.Property> listIterator_() { |
| return subject.properties(); |
| } |
| |
| @Override |
| protected int size_() { |
| return subject.propertiesSize(); |
| } |
| }; |
| } |
| |
| private ITableLabelProvider buildPropertyLabelProvider() { |
| return new TableLabelProvider(); |
| } |
| |
| private AddRemoveTablePane.Adapter buildTableAdapter() { |
| return new AddRemoveTablePane.AbstractAdapter() { |
| |
| public void addNewItem(ObjectListSelectionModel listSelectionModel) { |
| |
| PersistenceUnit.Property property = getSubject().addProperty(); |
| propertyHolder.setValue(property); |
| |
| tablePane.getTableViewer().editElement( |
| property, |
| PropertyColumnAdapter.NAME_COLUMN |
| ); |
| } |
| |
| public void removeSelectedItems(ObjectListSelectionModel listSelectionModel) { |
| for (Object item : listSelectionModel.selectedValues()) { |
| getSubject().removeProperty((PersistenceUnit.Property) item); |
| } |
| } |
| }; |
| } |
| |
| public String getHelpID() { |
| return JpaHelpContextIds.PERSISTENCE_XML_PROPERTIES; |
| } |
| |
| public ImageDescriptor getPageImageDescriptor() { |
| return null; |
| } |
| |
| public String getPageText() { |
| return JptUiPersistenceMessages.PersistenceUnitPropertiesComposite_properties; |
| } |
| |
| @Override |
| protected void initialize() { |
| super.initialize(); |
| propertyHolder = new SimplePropertyValueModel<PersistenceUnit.Property>(); |
| } |
| |
| @Override |
| protected void initializeLayout(Composite container) { |
| |
| addLabel( |
| container, |
| JptUiPersistenceMessages.PersistenceUnitPropertiesComposite_properties_description |
| ); |
| |
| tablePane = new TablePane(container); |
| container.setLayoutData(new GridData(GridData.FILL_BOTH)); |
| } |
| |
| private static class PropertyColumnAdapter implements ColumnAdapter<PersistenceUnit.Property> { |
| |
| public static final int COLUMN_COUNT = 3; |
| public static final int NAME_COLUMN = 1; |
| public static final int SELECTION_COLUMN = 0; |
| public static final int VALUE_COLUMN = 2; |
| |
| private WritablePropertyValueModel<String> buildNameHolder(PersistenceUnit.Property subject) { |
| return new PropertyAspectAdapter<PersistenceUnit.Property, String>(PersistenceUnit.Property.NAME_PROPERTY, subject) { |
| @Override |
| protected String buildValue_() { |
| return subject.getName(); |
| } |
| |
| @Override |
| protected void setValue_(String value) { |
| subject.setName(value); |
| } |
| }; |
| } |
| |
| private WritablePropertyValueModel<String> buildValueHolder(PersistenceUnit.Property subject) { |
| return new PropertyAspectAdapter<PersistenceUnit.Property, String>(PersistenceUnit.Property.VALUE_PROPERTY, subject) { |
| @Override |
| protected String buildValue_() { |
| return subject.getValue(); |
| } |
| |
| @Override |
| protected void setValue_(String value) { |
| subject.setValue(value); |
| } |
| }; |
| } |
| |
| public WritablePropertyValueModel<?>[] cellModels(PersistenceUnit.Property subject) { |
| WritablePropertyValueModel<?>[] holders = new WritablePropertyValueModel<?>[COLUMN_COUNT]; |
| holders[SELECTION_COLUMN] = new SimplePropertyValueModel<Object>(); |
| holders[NAME_COLUMN] = buildNameHolder(subject); |
| holders[VALUE_COLUMN] = buildValueHolder(subject); |
| return holders; |
| } |
| |
| public int columnCount() { |
| return COLUMN_COUNT; |
| } |
| |
| public String columnName(int columnIndex) { |
| |
| switch (columnIndex) { |
| case PropertyColumnAdapter.NAME_COLUMN: { |
| return JptUiPersistenceMessages.PersistenceUnitPropertiesComposite_nameColumn; |
| } |
| |
| case PropertyColumnAdapter.VALUE_COLUMN: { |
| return JptUiPersistenceMessages.PersistenceUnitPropertiesComposite_valueColumn; |
| } |
| |
| default: { |
| return null; |
| } |
| } |
| } |
| } |
| |
| private class TableLabelProvider extends LabelProvider |
| implements ITableLabelProvider { |
| |
| public Image getColumnImage(Object element, int columnIndex) { |
| return null; |
| } |
| |
| public String getColumnText(Object element, int columnIndex) { |
| |
| PersistenceUnit.Property property = (PersistenceUnit.Property) element; |
| String value = null; |
| |
| switch (columnIndex) { |
| case PropertyColumnAdapter.NAME_COLUMN: { |
| value = property.getName(); |
| break; |
| } |
| |
| case PropertyColumnAdapter.VALUE_COLUMN: { |
| value = property.getValue(); |
| break; |
| } |
| } |
| |
| if (value == null) { |
| value = ""; |
| } |
| |
| return value; |
| } |
| } |
| |
| private class TablePane extends AddRemoveTablePane<PersistenceUnit> { |
| |
| private final String SELECTION_COLUMN = "selection"; |
| |
| private TableViewer tableViewer; |
| |
| private TablePane(Composite parent) { |
| super(PersistenceUnitPropertiesComposite.this, |
| parent, |
| buildTableAdapter(), |
| buildPropertiesListHolder(), |
| propertyHolder, |
| buildPropertyLabelProvider()); |
| } |
| |
| @Override |
| protected Composite addContainer(Composite parent) { |
| Composite container = super.addContainer(parent); |
| container.setLayoutData(new GridData(GridData.FILL_BOTH)); |
| return container; |
| } |
| |
| private CellEditor[] buildCellEditors(Table table) { |
| return new CellEditor[] { |
| null, |
| new TextCellEditor(table), |
| new TextCellEditor(table) |
| }; |
| } |
| |
| private ICellModifier buildCellModifier() { |
| return new ICellModifier() { |
| |
| public boolean canModify(Object element, String property) { |
| return !SELECTION_COLUMN.equals(property); |
| } |
| |
| public Object getValue(Object element, String property) { |
| PersistenceUnit.Property propertyModel = (PersistenceUnit.Property) element; |
| String value = null; |
| |
| if (property == PersistenceUnit.Property.NAME_PROPERTY) { |
| value = propertyModel.getName(); |
| } |
| else if (property == PersistenceUnit.Property.VALUE_PROPERTY) { |
| value = propertyModel.getValue(); |
| } |
| |
| if (value == null) { |
| value = ""; |
| } |
| |
| return value; |
| } |
| |
| public void modify(Object element, String property, Object value) { |
| PersistenceUnit.Property propertyModel; |
| |
| if (element instanceof TableItem) { |
| TableItem tableItem = (TableItem) element; |
| propertyModel = (PersistenceUnit.Property) tableItem.getData(); |
| } |
| else { |
| propertyModel = (PersistenceUnit.Property) element; |
| } |
| |
| if (property == PersistenceUnit.Property.NAME_PROPERTY) { |
| propertyModel.setName(value.toString()); |
| } |
| else if (property == PersistenceUnit.Property.VALUE_PROPERTY) { |
| propertyModel.setValue(value.toString()); |
| } |
| } |
| }; |
| } |
| |
| @Override |
| protected ColumnAdapter<?> buildColumnAdapter() { |
| return new PropertyColumnAdapter(); |
| } |
| |
| private String[] buildColumnProperties() { |
| return new String[] { |
| SELECTION_COLUMN, |
| PersistenceUnit.Property.NAME_PROPERTY, |
| PersistenceUnit.Property.VALUE_PROPERTY |
| }; |
| } |
| |
| TableViewer getTableViewer() { |
| return tableViewer; |
| } |
| |
| @Override |
| protected void initializeMainComposite(Composite container, |
| Adapter adapter, |
| ListValueModel<?> listHolder, |
| WritablePropertyValueModel<?> selectedItemHolder, |
| IBaseLabelProvider labelProvider, |
| String helpId) { |
| |
| super.initializeMainComposite( |
| container, |
| adapter, |
| listHolder, |
| selectedItemHolder, |
| labelProvider, |
| helpId |
| ); |
| |
| Table table = getMainControl(); |
| table.setLayoutData(new GridData(GridData.FILL_BOTH)); |
| |
| // Make the selection column non-resizable since it's only used to |
| // ease the selection of rows |
| TableColumn selectionColumn = table.getColumn(PropertyColumnAdapter.SELECTION_COLUMN); |
| selectionColumn.setResizable(false); |
| selectionColumn.setWidth(20); |
| |
| // Install the editors |
| tableViewer = new TableViewer(table); |
| tableViewer.setCellEditors(buildCellEditors(table)); |
| tableViewer.setCellModifier(buildCellModifier()); |
| tableViewer.setColumnProperties(buildColumnProperties()); |
| } |
| |
| @Override |
| protected void itemsAdded(ListAddEvent e) { |
| super.itemsAdded(e); |
| revalidateLayout(); |
| } |
| |
| @Override |
| protected void itemsRemoved(ListRemoveEvent e) { |
| super.itemsRemoved(e); |
| revalidateLayout(); |
| } |
| |
| @Override |
| protected void listChanged(ListChangeEvent e) { |
| super.listChanged(e); |
| revalidateLayout(); |
| } |
| |
| /** |
| * Revalidates the table layout after the list of items has changed. The |
| * layout has to be done in a new UI thread because our listener might be |
| * notified before the table has been updated (table column added or removed). |
| */ |
| private void revalidateLayout() { |
| SWTUtil.asyncExec(new Runnable() { public void run() { |
| Table table = getMainControl(); |
| if (!table.isDisposed()) { |
| // We have to do a total relayout of the tab otherwise the |
| // table might become cut off at the bottom |
| SWTUtil.reflow(table); |
| } |
| }}); |
| } |
| } |
| } |