com.siteview.mde.internal.ui.editor.product.FeatureSection.java Source code

Java tutorial

Introduction

Here is the source code for com.siteview.mde.internal.ui.editor.product.FeatureSection.java

Source

/*******************************************************************************
 * Copyright (c) 2005, 2009 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package com.siteview.mde.internal.ui.editor.product;

import java.util.ArrayList;
import org.eclipse.jface.action.*;
import org.eclipse.jface.util.IPropertyChangeListener;
import org.eclipse.jface.util.PropertyChangeEvent;
import org.eclipse.jface.viewers.*;
import org.eclipse.jface.window.Window;
import org.eclipse.jface.wizard.WizardDialog;
import com.siteview.mde.core.IModelChangedEvent;
import com.siteview.mde.internal.core.FeatureModelManager;
import com.siteview.mde.internal.core.MDECore;
import com.siteview.mde.internal.core.ifeature.IFeature;
import com.siteview.mde.internal.core.ifeature.IFeatureModel;
import com.siteview.mde.internal.core.iproduct.*;
import com.siteview.mde.internal.ui.*;
import com.siteview.mde.internal.ui.dialogs.FeatureSelectionDialog;
import com.siteview.mde.internal.ui.editor.*;
import com.siteview.mde.internal.ui.editor.actions.SortAction;
import com.siteview.mde.internal.ui.editor.feature.FeatureEditor;
import com.siteview.mde.internal.ui.elements.DefaultTableProvider;
import com.siteview.mde.internal.ui.parts.TablePart;
import com.siteview.mde.internal.ui.util.SWTUtil;
import com.siteview.mde.internal.ui.wizards.feature.NewFeatureProjectWizard;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.DisposeEvent;
import org.eclipse.swt.events.DisposeListener;
import org.eclipse.swt.graphics.Cursor;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.widgets.*;
import org.eclipse.ui.actions.ActionFactory;
import org.eclipse.ui.forms.widgets.FormToolkit;
import org.eclipse.ui.forms.widgets.Section;

public class FeatureSection extends TableSection implements IPropertyChangeListener {

    private SortAction fSortAction;
    private Action fNewFeatureAction;

    class ContentProvider extends DefaultTableProvider {
        public Object[] getElements(Object parent) {
            return getProduct().getFeatures();
        }
    }

    class NewFeatureAction extends Action {

        public NewFeatureAction() {
            super(MDEUIMessages.Product_FeatureSection_newFeature, IAction.AS_PUSH_BUTTON);
            setImageDescriptor(MDEPluginImages.DESC_NEWFTRPRJ_TOOL);
        }

        public void run() {
            handleNewFeature();
        }
    }

    private TableViewer fFeatureTable;

    public FeatureSection(MDEFormPage formPage, Composite parent) {
        super(formPage, parent, Section.DESCRIPTION, getButtonLabels());
    }

    private static String[] getButtonLabels() {
        String[] labels = new String[6];
        labels[0] = MDEUIMessages.Product_FeatureSection_add;
        labels[1] = MDEUIMessages.Product_FeatureSection_remove;
        labels[2] = MDEUIMessages.Product_PluginSection_removeAll;
        labels[3] = MDEUIMessages.Product_FeatureSection_properties;
        labels[4] = MDEUIMessages.Product_FeatureSection_up;
        labels[5] = MDEUIMessages.Product_FeatureSection_down;
        return labels;
    }

    /* (non-Javadoc)
     * @see org.eclipse.pde.internal.ui.editor.PDESection#createClient(org.eclipse.ui.forms.widgets.Section, org.eclipse.ui.forms.widgets.FormToolkit)
     */
    protected void createClient(Section section, FormToolkit toolkit) {

        section.setLayout(FormLayoutFactory.createClearGridLayout(false, 1));
        GridData sectionData = new GridData(GridData.FILL_BOTH);
        sectionData.verticalSpan = 2;
        section.setLayoutData(sectionData);

        Composite container = createClientContainer(section, 2, toolkit);
        createViewerPartControl(container, SWT.MULTI, 2, toolkit);
        container.setLayoutData(new GridData(GridData.FILL_BOTH));

        TablePart tablePart = getTablePart();
        fFeatureTable = tablePart.getTableViewer();
        fFeatureTable.setContentProvider(new ContentProvider());
        fFeatureTable.setLabelProvider(MDEPlugin.getDefault().getLabelProvider());
        fFeatureTable.setSorter(null);
        GridData data = (GridData) tablePart.getControl().getLayoutData();
        data.minimumWidth = 200;
        fFeatureTable.setInput(MDECore.getDefault().getFeatureModelManager());

        tablePart.setButtonEnabled(0, isEditable());

        // remove buttons updated on refresh

        tablePart.setButtonEnabled(3, isEditable());
        tablePart.setButtonEnabled(4, isEditable());
        tablePart.setButtonEnabled(5, isEditable());

        toolkit.paintBordersFor(container);
        section.setClient(container);

        section.setText(MDEUIMessages.Product_FeatureSection_title);
        section.setDescription(MDEUIMessages.Product_FeatureSection_desc); //      

        getModel().addModelChangedListener(this);
        createSectionToolbar(section, toolkit);
    }

    /**
     * @param section
     * @param toolkit
     */
    private void createSectionToolbar(Section section, FormToolkit toolkit) {
        ToolBarManager toolBarManager = new ToolBarManager(SWT.FLAT);
        ToolBar toolbar = toolBarManager.createControl(section);
        final Cursor handCursor = new Cursor(Display.getCurrent(), SWT.CURSOR_HAND);
        toolbar.setCursor(handCursor);
        // Cursor needs to be explicitly disposed
        toolbar.addDisposeListener(new DisposeListener() {
            public void widgetDisposed(DisposeEvent e) {
                if ((handCursor != null) && (handCursor.isDisposed() == false)) {
                    handCursor.dispose();
                }
            }
        });
        fNewFeatureAction = new NewFeatureAction();
        toolBarManager.add(fNewFeatureAction);
        fSortAction = new SortAction(fFeatureTable, MDEUIMessages.Product_FeatureSection_sortAlpha, null, null,
                this);
        toolBarManager.add(fSortAction);

        toolBarManager.update(true);
        section.setTextClient(toolbar);
    }

    /* (non-Javadoc)
     * @see org.eclipse.pde.internal.ui.editor.StructuredViewerSection#buttonSelected(int)
     */
    protected void buttonSelected(int index) {
        switch (index) {
        case 0:
            handleAdd();
            break;
        case 1:
            handleDelete();
            break;
        case 2:
            handleRemoveAll();
            break;
        case 3:
            handleProperties();
            break;
        case 4:
            handleUp();
            break;
        case 5:
            handleDown();
            break;
        }
    }

    private void handleProperties() {
        IStructuredSelection ssel = (IStructuredSelection) fFeatureTable.getSelection();
        if (ssel.size() == 1) {
            IProductFeature feature = (IProductFeature) ssel.toArray()[0];
            VersionDialog dialog = new VersionDialog(MDEPlugin.getActiveWorkbenchShell(), isEditable(),
                    feature.getVersion());
            dialog.create();
            SWTUtil.setDialogSize(dialog, 400, 200);
            if (dialog.open() == Window.OK) {
                feature.setVersion(dialog.getVersion());
            }
        }
    }

    private void handleNewFeature() {
        NewFeatureProjectWizard wizard = new NewFeatureProjectWizard();
        WizardDialog dialog = new WizardDialog(MDEPlugin.getActiveWorkbenchShell(), wizard);
        dialog.create();
        SWTUtil.setDialogSize(dialog, 400, 500);
        if (dialog.open() == Window.OK) {
            addFeature(wizard.getFeatureId(), wizard.getFeatureVersion());
        }
    }

    private void addFeature(String id, String version) {
        IProduct product = getProduct();
        IProductModelFactory factory = product.getModel().getFactory();
        IProductFeature feature = factory.createFeature();
        feature.setId(id);
        feature.setVersion(version);
        product.addFeatures(new IProductFeature[] { feature });
    }

    private void handleRemoveAll() {
        IProduct product = getProduct();
        product.removeFeatures(product.getFeatures());
    }

    /* (non-Javadoc)
     * @see org.eclipse.pde.internal.ui.editor.TableSection#handleDoubleClick(org.eclipse.jface.viewers.IStructuredSelection)
     */
    protected void handleDoubleClick(IStructuredSelection selection) {
        handleOpen(selection);
    }

    /* (non-Javadoc)
     * @see org.eclipse.ui.forms.AbstractFormPart#dispose()
     */
    public void dispose() {
        IProductModel model = getModel();
        if (model != null)
            model.removeModelChangedListener(this);
        super.dispose();
    }

    /* (non-Javadoc)
     * @see org.eclipse.pde.internal.ui.editor.PDESection#doGlobalAction(java.lang.String)
     */
    public boolean doGlobalAction(String actionId) {
        if (actionId.equals(ActionFactory.DELETE.getId())) {
            handleDelete();
            return true;
        }
        if (actionId.equals(ActionFactory.CUT.getId())) {
            handleDelete();
            return false;
        }
        if (actionId.equals(ActionFactory.PASTE.getId())) {
            doPaste();
            return true;
        }
        return false;
    }

    protected boolean canPaste(Object target, Object[] objects) {
        for (int i = 0; i < objects.length; i++) {
            if (objects[i] instanceof IProductFeature)
                return true;
        }
        return false;
    }

    protected void doPaste(Object target, Object[] objects) {
        IProductFeature[] features;
        if (objects instanceof IProductFeature[])
            features = (IProductFeature[]) objects;
        else {
            features = new IProductFeature[objects.length];
            for (int i = 0; i < objects.length; i++)
                if (objects[i] instanceof IProductFeature)
                    features[i] = (IProductFeature) objects[i];
        }
        getProduct().addFeatures(features);
    }

    private void handleDelete() {
        IStructuredSelection ssel = (IStructuredSelection) fFeatureTable.getSelection();
        if (ssel.size() > 0) {
            Object[] objects = ssel.toArray();
            IProductFeature[] features = new IProductFeature[objects.length];
            System.arraycopy(objects, 0, features, 0, objects.length);
            getProduct().removeFeatures(features);
        }
    }

    /* (non-Javadoc)
     * @see org.eclipse.pde.internal.ui.editor.StructuredViewerSection#fillContextMenu(org.eclipse.jface.action.IMenuManager)
     */
    protected void fillContextMenu(IMenuManager manager) {
        IStructuredSelection ssel = (IStructuredSelection) fFeatureTable.getSelection();
        if (ssel == null)
            return;

        Action openAction = new Action(MDEUIMessages.Product_FeatureSection_open) {
            public void run() {
                handleDoubleClick((IStructuredSelection) fFeatureTable.getSelection());
            }
        };
        openAction.setEnabled(isEditable() && ssel.size() == 1);
        manager.add(openAction);

        manager.add(new Separator());

        Action removeAction = new Action(MDEUIMessages.Product_FeatureSection_remove) {
            public void run() {
                handleDelete();
            }
        };
        removeAction.setEnabled(isEditable() && ssel.size() > 0);
        manager.add(removeAction);

        Action removeAll = new Action(MDEUIMessages.FeatureSection_removeAll) {
            public void run() {
                handleRemoveAll();
            }
        };
        removeAll.setEnabled(isEditable());
        manager.add(removeAll);

        manager.add(new Separator());

        getPage().getMDEEditor().getContributor().contextMenuAboutToShow(manager);
    }

    private void handleOpen(IStructuredSelection selection) {
        if (!selection.isEmpty()) {
            IProductFeature feature = (IProductFeature) selection.getFirstElement();
            FeatureModelManager manager = MDECore.getDefault().getFeatureModelManager();
            IFeatureModel model = manager.findFeatureModel(feature.getId(), feature.getVersion());
            FeatureEditor.openFeatureEditor(model);
        }
    }

    private void handleAdd() {
        FeatureSelectionDialog dialog = new FeatureSelectionDialog(MDEPlugin.getActiveWorkbenchShell(),
                getAvailableChoices(), true);
        if (dialog.open() == Window.OK) {
            Object[] models = dialog.getResult();
            for (int i = 0; i < models.length; i++) {
                IFeature feature = ((IFeatureModel) models[i]).getFeature();
                addFeature(feature.getId(), feature.getVersion());
            }
        }
    }

    private IFeatureModel[] getAvailableChoices() {
        IFeatureModel[] models = MDECore.getDefault().getFeatureModelManager().getModels();
        IProduct product = getProduct();
        ArrayList list = new ArrayList();
        for (int i = 0; i < models.length; i++) {
            String id = models[i].getFeature().getId();
            if (id != null && !product.containsFeature(id)) {
                list.add(models[i]);
            }
        }
        return (IFeatureModel[]) list.toArray(new IFeatureModel[list.size()]);
    }

    private IProduct getProduct() {
        return getModel().getProduct();
    }

    private IProductModel getModel() {
        return (IProductModel) getPage().getMDEEditor().getAggregateModel();
    }

    /* (non-Javadoc)
     * @see org.eclipse.pde.internal.ui.editor.PDESection#modelChanged(org.eclipse.pde.core.IModelChangedEvent)
     */
    public void modelChanged(IModelChangedEvent e) {
        Object[] objects = e.getChangedObjects();
        // No need to call super, handling world changed event here
        if (e.getChangeType() == IModelChangedEvent.WORLD_CHANGED) {
            handleModelEventWorldChanged(e);
            return;
        } else if (e.getChangeType() == IModelChangedEvent.INSERT) {
            for (int i = 0; i < objects.length; i++) {
                if (objects[i] instanceof IProductFeature)
                    fFeatureTable.add(objects[i]);
            }
        } else if (e.getChangeType() == IModelChangedEvent.REMOVE) {

            Table table = fFeatureTable.getTable();
            int index = table.getSelectionIndex();

            for (int i = 0; i < objects.length; i++) {
                if (objects[i] instanceof IProductFeature)
                    fFeatureTable.remove(objects[i]);
            }

            // Update Selection

            int count = table.getItemCount();

            if (count == 0) {
                // Nothing to select
            } else if (index < count) {
                table.setSelection(index);
            } else {
                table.setSelection(count - 1);
            }

        } else if (e.getChangeType() == IModelChangedEvent.CHANGE) {
            fFeatureTable.refresh();
        }
        updateButtons(false, true);
    }

    /**
     * @param event
     */
    private void handleModelEventWorldChanged(IModelChangedEvent event) {
        // This section can get disposed if the configuration is changed from
        // plugins to features or vice versa.  Subsequently, the configuration
        // page is removed and readded.  In this circumstance, abort the
        // refresh      
        if (fFeatureTable.getTable().isDisposed()) {
            return;
        }
        // Reload the input
        fFeatureTable.setInput(MDECore.getDefault().getFeatureModelManager());
        // Perform the refresh
        refresh();
    }

    /* (non-Javadoc)
     * @see org.eclipse.ui.forms.AbstractFormPart#refresh()
     */
    public void refresh() {
        fFeatureTable.refresh();
        updateButtons(true, true);
        super.refresh();
    }

    protected void selectionChanged(IStructuredSelection selection) {
        getPage().getMDEEditor().setSelection(selection);
        updateButtons(true, false);
    }

    public boolean setFormInput(Object input) {
        if (input instanceof IProductFeature) {
            fFeatureTable.setSelection(new StructuredSelection(input), true);
            return true;
        }
        return super.setFormInput(input);
    }

    private void updateButtons(boolean updateRemove, boolean updateRemoveAll) {
        TablePart tablePart = getTablePart();
        Table table = tablePart.getTableViewer().getTable();
        TableItem[] tableSelection = table.getSelection();
        boolean hasSelection = tableSelection.length > 0;
        if (updateRemove) {
            ISelection selection = getViewerSelection();
            tablePart.setButtonEnabled(1,
                    isEditable() && !selection.isEmpty() && selection instanceof IStructuredSelection
                            && ((IStructuredSelection) selection).getFirstElement() instanceof IProductFeature);
        }
        if (updateRemoveAll)
            tablePart.setButtonEnabled(2, isEditable() && fFeatureTable.getTable().getItemCount() > 0);

        tablePart.setButtonEnabled(3, isEditable() && hasSelection);

        // up/down buttons
        boolean canMove = table.getItemCount() > 1 && tableSelection.length == 1 && !fSortAction.isChecked();
        tablePart.setButtonEnabled(4, canMove && isEditable() && hasSelection && table.getSelectionIndex() > 0);
        tablePart.setButtonEnabled(5,
                canMove && hasSelection && isEditable() && table.getSelectionIndex() < table.getItemCount() - 1);
    }

    protected boolean createCount() {
        return true;
    }

    private void handleUp() {
        int index = getTablePart().getTableViewer().getTable().getSelectionIndex();
        if (index < 1)
            return;
        swap(index, index - 1);
    }

    private void handleDown() {
        Table table = getTablePart().getTableViewer().getTable();
        int index = table.getSelectionIndex();
        if (index == table.getItemCount() - 1)
            return;
        swap(index, index + 1);
    }

    public void swap(int index1, int index2) {
        Table table = getTablePart().getTableViewer().getTable();
        IProductFeature feature1 = ((IProductFeature) table.getItem(index1).getData());
        IProductFeature feature2 = ((IProductFeature) table.getItem(index2).getData());

        IProduct product = getProduct();
        product.swap(feature1, feature2);
    }

    public void propertyChange(PropertyChangeEvent event) {
        if (fSortAction.equals(event.getSource()) && IAction.RESULT.equals(event.getProperty())) {
            updateButtons(true, true);
        }
    }
}