org.csstudio.opibuilder.visualparts.PropertiesEditDialog.java Source code

Introduction

Here is the source code for org.csstudio.opibuilder.visualparts.PropertiesEditDialog.java

Source

/*******************************************************************************
 * Copyright (c) 2010 Oak Ridge National Laboratory.
 * 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
 ******************************************************************************/
package org.csstudio.opibuilder.visualparts;

import org.csstudio.opibuilder.datadefinition.PropertyData;
import org.csstudio.opibuilder.properties.AbstractWidgetProperty;
import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.viewers.ArrayContentProvider;
import org.eclipse.jface.viewers.EditingSupport;
import org.eclipse.jface.viewers.TableViewer;
import org.eclipse.jface.viewers.TableViewerColumn;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Shell;

/**The dialog to edit an array of properties.
 * @author Xihui Chen
 *
 */
public class PropertiesEditDialog extends Dialog {

    private TableViewer propertiesViewer;
    private PropertyData[] propertyDataArray;
    private String dialogTitle;

    public PropertiesEditDialog(Shell parentShell, AbstractWidgetProperty[] properties, String dialogTitle) {
        super(parentShell);
        this.dialogTitle = dialogTitle;
        propertyDataArray = new PropertyData[properties.length];
        int i = 0;
        for (AbstractWidgetProperty prop : properties) {
            propertyDataArray[i++] = new PropertyData(prop, prop.getPropertyValue());
        }

        // Allow resize
        setShellStyle(getShellStyle() | SWT.RESIZE);
    }

    public PropertyData[] getOutput() {
        return propertyDataArray;
    }

    @Override
    protected void configureShell(Shell newShell) {
        super.configureShell(newShell);
        newShell.setText(dialogTitle);
    }

    @Override
    protected Control createDialogArea(Composite parent) {
        final Composite parent_Composite = (Composite) super.createDialogArea(parent);
        Composite rightComposite = new Composite(parent_Composite, SWT.NONE);
        rightComposite.setLayout(new GridLayout(1, false));
        GridData gd = new GridData(SWT.FILL, SWT.FILL, true, true);
        gd.widthHint = 320;
        rightComposite.setLayoutData(gd);

        propertiesViewer = createPropertiesViewer(rightComposite);

        propertiesViewer.setInput(propertyDataArray);

        return parent_Composite;

    }

    private TableViewer createPropertiesViewer(Composite parent) {
        TableViewer viewer = new TableViewer(parent, SWT.V_SCROLL | SWT.H_SCROLL | SWT.BORDER | SWT.FULL_SELECTION);
        viewer.getTable().setLinesVisible(true);
        viewer.getTable().setHeaderVisible(true);
        TableViewerColumn tvColumn = new TableViewerColumn(viewer, SWT.NONE);
        tvColumn.getColumn().setText("Property");
        tvColumn.getColumn().setMoveable(false);
        tvColumn.getColumn().setWidth(150);
        tvColumn = new TableViewerColumn(viewer, SWT.NONE);
        tvColumn.getColumn().setText("Value");
        tvColumn.getColumn().setMoveable(false);
        tvColumn.getColumn().setWidth(150);
        EditingSupport editingSupport = new PropertyDataEditingSupport(viewer, viewer.getTable());
        tvColumn.setEditingSupport(editingSupport);

        viewer.setContentProvider(new ArrayContentProvider());
        viewer.setLabelProvider(new PropertyDataLabelProvider());
        viewer.getTable().setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
        return viewer;
    }

}

//
//
///**
// * The {@link EditingSupport} for the value columns of the property table.
// *
// * @author Xihui Chen
// *
// */
//class PropertyDataEditingSupport extends EditingSupport {
//
//    /**
//     * The {@link Table} where this {@link EditingSupport} is embedded.
//     */
//    private final Table table;
//
//
//    /**
//     * Constructor.
//     *
//     * @param viewer
//     *            The {@link ColumnViewer} for this
//     *            {@link EditingSupport}.
//     * @param table
//     *            The {@link Table}
//     */
//    public PropertyDataEditingSupport(final ColumnViewer viewer,
//            final Table table) {
//        super(viewer);
//        this.table = table;
//    }
//
//    /**
//     * {@inheritDoc}
//     */
//    @Override
//    protected boolean canEdit(final Object element) {
//        return true;
//    }
//
//    /**
//     * {@inheritDoc}
//     */
//    @Override
//    protected CellEditor getCellEditor(final Object element) {
//        PropertyData propertyData;
//        if((propertyData = getSelectedProperty()) != null){
//            return propertyData.property.getPropertyDescriptor().createPropertyEditor(table);
//        }
//        return null;
//    }
//
//    private PropertyData getSelectedProperty(){
//        IStructuredSelection selection = (IStructuredSelection) this
//                .getViewer().getSelection();
//        if(selection.getFirstElement() instanceof PropertyData){
//            PropertyData property = (PropertyData) selection
//                    .getFirstElement();
//            return property;
//        }
//        return null;
//    }
//
//
//    /**
//     * {@inheritDoc}
//     */
//    @Override
//    protected Object getValue(final Object element) {
//        if (element instanceof PropertyData) {
//                return ((PropertyData)element).tmpValue;
//            }
//
//        return null;
//    }
//
//    /**
//     * {@inheritDoc}
//     */
//    @Override
//    protected void setValue(final Object element, final Object value) {
//        if (element instanceof PropertyData) {
//            PropertyData prop = (PropertyData) element;
//            if (prop != null) {
//                prop.tmpValue = value;
//                getViewer().refresh();
//            }
//        }
//    }
//}
//
//
///**
//* The {@link LabelProvider} for the properties table.
//*
//* @author Xihui Chen
//*
//*/
//class PropertyDataLabelProvider extends LabelProvider implements
//                ITableLabelProvider {
//
//            /**
//             * {@inheritDoc}
//             */
//            public Image getColumnImage(final Object element,
//                    final int columnIndex) {
//                if (columnIndex == 1 && element instanceof PropertyData) {
//                    PropertyData propertyData = (PropertyData) element;
//
//                    if (propertyData != null) {
//                        if (propertyData.property.getPropertyDescriptor().getLabelProvider() != null)
//                            return propertyData.property.getPropertyDescriptor().getLabelProvider().
//                                getImage(propertyData.tmpValue);
//                    }
//                }
//                return null;
//            }
//
//            /**
//             * {@inheritDoc}
//             */
//            public String getColumnText(final Object element,
//                    final int columnIndex) {
//                if (element instanceof PropertyData) {
//                    PropertyData propertyData = (PropertyData) element;
//                    if (columnIndex == 0) {
//                        return propertyData.property.getDescription();
//                    }
//
//                    if (propertyData != null && propertyData.property.getPropertyDescriptor().getLabelProvider() != null) {
//                        return propertyData.property.getPropertyDescriptor().getLabelProvider().getText(
//                                propertyData.tmpValue);
//                    }
//                }
//                if (element != null) {
//                    return element.toString();
//                }
//                return "error";
//            }
//
//
//}