EDIT

/**

* Copyright (C) 2007 EDIT

* European Distributed Institute of Taxonomy

* http://www.e-taxonomy.eu

*

* The contents of this file are subject to the Mozilla Public License Version 1.1

* See LICENSE.TXT at the top of this package for the full license terms.

*/

package eu.etaxonomy.taxeditor.bulkeditor.e4;

import java.io.File;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import java.util.Properties;

import java.util.Set;

import javax.inject.Inject;

import org.eclipse.e4.core.services.events.IEventBroker;

import org.eclipse.e4.ui.services.EMenuService;

import org.eclipse.e4.ui.workbench.modeling.ESelectionService;

import org.eclipse.jface.layout.GridDataFactory;

import org.eclipse.jface.viewers.ISelectionChangedListener;

import org.eclipse.jface.viewers.IStructuredSelection;

import org.eclipse.jface.viewers.StructuredSelection;

import org.eclipse.nebula.widgets.nattable.NatTable;

import org.eclipse.nebula.widgets.nattable.command.VisualRefreshCommand;

import org.eclipse.nebula.widgets.nattable.command.VisualRefreshCommandHandler;

import org.eclipse.nebula.widgets.nattable.config.AbstractRegistryConfiguration;

import org.eclipse.nebula.widgets.nattable.config.AbstractUiBindingConfiguration;

import org.eclipse.nebula.widgets.nattable.config.CellConfigAttributes;

import org.eclipse.nebula.widgets.nattable.config.ConfigRegistry;

import org.eclipse.nebula.widgets.nattable.config.DefaultNatTableStyleConfiguration;

import org.eclipse.nebula.widgets.nattable.config.IConfigRegistry;

import org.eclipse.nebula.widgets.nattable.config.IEditableRule;

import org.eclipse.nebula.widgets.nattable.coordinate.Range;

import org.eclipse.nebula.widgets.nattable.data.ListDataProvider;

import org.eclipse.nebula.widgets.nattable.data.convert.DefaultBooleanDisplayConverter;

import org.eclipse.nebula.widgets.nattable.edit.EditConfigAttributes;

import org.eclipse.nebula.widgets.nattable.edit.action.MouseEditAction;

import org.eclipse.nebula.widgets.nattable.edit.config.DefaultEditConfiguration;

import org.eclipse.nebula.widgets.nattable.edit.editor.TextCellEditor;

import org.eclipse.nebula.widgets.nattable.extension.e4.selection.E4SelectionListener;

import org.eclipse.nebula.widgets.nattable.extension.glazedlists.GlazedListsEventLayer;

import org.eclipse.nebula.widgets.nattable.extension.glazedlists.GlazedListsSortModel;

import org.eclipse.nebula.widgets.nattable.grid.GridRegion;

import org.eclipse.nebula.widgets.nattable.grid.data.DefaultColumnHeaderDataProvider;

import org.eclipse.nebula.widgets.nattable.grid.data.DefaultCornerDataProvider;

import org.eclipse.nebula.widgets.nattable.grid.data.DefaultRowHeaderDataProvider;

import org.eclipse.nebula.widgets.nattable.grid.layer.ColumnHeaderLayer;

import org.eclipse.nebula.widgets.nattable.grid.layer.CornerLayer;

import org.eclipse.nebula.widgets.nattable.grid.layer.GridLayer;

import org.eclipse.nebula.widgets.nattable.grid.layer.RowHeaderLayer;

import org.eclipse.nebula.widgets.nattable.layer.AbstractLayer;

import org.eclipse.nebula.widgets.nattable.layer.DataLayer;

import org.eclipse.nebula.widgets.nattable.layer.stack.DefaultBodyLayerStack;

import org.eclipse.nebula.widgets.nattable.painter.cell.CheckBoxPainter;

import org.eclipse.nebula.widgets.nattable.painter.cell.ImagePainter;

import org.eclipse.nebula.widgets.nattable.sort.SortHeaderLayer;

import org.eclipse.nebula.widgets.nattable.sort.config.SingleClickSortConfiguration;

import org.eclipse.nebula.widgets.nattable.style.DisplayMode;

import org.eclipse.nebula.widgets.nattable.style.theme.ModernNatTableThemeConfiguration;

import org.eclipse.nebula.widgets.nattable.ui.binding.UiBindingRegistry;

import org.eclipse.nebula.widgets.nattable.ui.matcher.CellEditorMouseEventMatcher;

import org.eclipse.nebula.widgets.nattable.ui.matcher.MouseEventMatcher;

import org.eclipse.nebula.widgets.nattable.ui.menu.PopupMenuAction;

import org.eclipse.nebula.widgets.nattable.ui.menu.PopupMenuBuilder;

import org.eclipse.swt.SWT;

import org.eclipse.swt.dnd.Clipboard;

import org.eclipse.swt.dnd.TextTransfer;

import org.eclipse.swt.dnd.Transfer;

import org.eclipse.swt.layout.GridData;

import org.eclipse.swt.layout.GridLayout;

import org.eclipse.swt.widgets.Composite;

import org.eclipse.swt.widgets.Display;

import org.eclipse.swt.widgets.Menu;

import ca.odell.glazedlists.SortedList;

import eu.etaxonomy.cdm.model.common.CdmBase;

import eu.etaxonomy.cdm.model.description.SpecimenDescription;

import eu.etaxonomy.taxeditor.bulkeditor.BulkEditorQuery;

import eu.etaxonomy.taxeditor.bulkeditor.input.AbstractBulkEditorInput;

import eu.etaxonomy.taxeditor.event.WorkbenchEventConstants;

import eu.etaxonomy.taxeditor.model.ImageResources;

import eu.etaxonomy.taxeditor.store.StoreUtil;

/**

 * @author pplitzner

 * @since Sep 8, 2017

 */

public class BulkEditorE4Composite extends Composite {

    public static final String LABEL_CANDIDATE = "LABEL_CANDIDATE"; //$NON-NLS-1$

    public static final String LABEL_CANDIDATE_ICON = "LABEL_CANDIDATE_ICON"; //$NON-NLS-1$

    public static final String LABEL_TARGET = "LABEL_TARGET"; //$NON-NLS-1$

    public static final String LABEL_TARGET_ICON = "LABEL_TARGET_ICON"; //$NON-NLS-1$

    private final List<String> columnList = new ArrayList<>();

    private Composite topComposite;

    @Inject

    private ESelectionService selService;

    private ISelectionChangedListener selectionChangedListener;

    private Composite bottomComposite;

    @Inject

    private EMenuService menuService;

    private NatTable natTable;

    private DefaultBodyLayerStack bodyLayer;

    private ListDataProvider<CdmBase> bodyDataProvider;

    private BulkEditorE4 bulkEditor;

    private BulkEditorSearchE4 bulkEditorSearch;

    @Inject

    private IEventBroker eventBroker;

    public BulkEditorE4Composite(BulkEditorE4 bulkEditor, Composite parent, int style) {

        super(parent, style);

        parent.setLayout(new GridLayout());

        this.bulkEditor = bulkEditor;

        this.setLayout(new GridLayout());

        topComposite = new Composite(parent, SWT.NONE);

        topComposite.setLayout(new GridLayout());

        GridData gridData = new GridData(SWT.FILL, SWT.TOP, true, false);

        topComposite.setLayoutData(gridData);

        bottomComposite = new Composite(parent, SWT.NONE);

        bottomComposite.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));

        bottomComposite.setLayout(new GridLayout());

	}

    public void init(AbstractBulkEditorInput<?> input){

        input.getPropertyKeys().forEach(key->columnList.add(key));

	    bulkEditorSearch = new BulkEditorSearchE4(this, topComposite, SWT.NONE);

	    //layout needed because the search bar is added after @PostConstuct method

	    topComposite.getParent().layout();

        if(input.getEntityUuid()!=null){

            performSearch(new BulkEditorQuery(input.getEntityUuid().toString()));

        }

        createTable();

        configureTable();

        styleTable();

        GridDataFactory.fillDefaults().grab(true, true).applyTo(natTable);

        //propagate selection

        // selection listener

        E4SelectionListener<CdmBase> selectionListener = new CellSelectionListener(selService, bodyLayer.getSelectionLayer(), bodyDataProvider, this);

        bodyLayer.getSelectionLayer().addLayerListener(selectionListener);

        selectionListener.setFullySelectedRowsOnly(false);

        bottomComposite.layout();

	}

	private void createTable(){

	    ConfigRegistry configRegistry = new ConfigRegistry();

	    //property map

        Map<String, String> propertyToLabels = new HashMap<>();

        columnList.forEach(columnLabel->propertyToLabels.put(columnLabel, columnLabel));

        String[] propertyNames = columnList.toArray(columnList.toArray(new String[columnList.size()]));

        //sorted list

        SortedList<CdmBase> sortedList = new SortedList<>(bulkEditor.getEditorInput().getModel(), bulkEditor.getEditorInput().getTitleComparator());

        //data provider

        BulkEditorPropertyAccessor columnPropertyAccessor = new BulkEditorPropertyAccessor(this, bulkEditor.getEditorInput());

        bodyDataProvider = new ListDataProvider<CdmBase>(sortedList,

                columnPropertyAccessor);

        DefaultColumnHeaderDataProvider colHeaderDataProvider = new DefaultColumnHeaderDataProvider(

                propertyNames, propertyToLabels);

        DefaultRowHeaderDataProvider rowHeaderDataProvider = new DefaultRowHeaderDataProvider(

                bodyDataProvider);

        //body

        DataLayer dataLayer = new DataLayer(bodyDataProvider);

        dataLayer.registerCommandHandler(new VisualRefreshCommandHandler());

        GlazedListsEventLayer<CdmBase> eventLayer = new GlazedListsEventLayer<>(dataLayer, bulkEditor.getEditorInput().getModel());

        bodyLayer = new DefaultBodyLayerStack(eventLayer);

        dataLayer.setColumnPercentageSizing(0, true);

        dataLayer.setColumnWidthPercentageByPosition(0, 45);

        for(int i=1;i<columnList.size();i++){

            if(bulkEditor.getEditorInput().isCacheProperty(columnList.get(i))){

                dataLayer.setColumnWidthByPosition(i, 16);

            }

            else{

                dataLayer.setColumnWidthByPosition(i, 100);

            }

        }

        //column

        DataLayer columnHeaderDataLayer = new DataLayer(colHeaderDataProvider);

        ColumnHeaderLayer columnHeaderLayer = new ColumnHeaderLayer(

                columnHeaderDataLayer,

                bodyLayer, bodyLayer.getSelectionLayer());

        // add the SortHeaderLayer to the column header layer stack

        // as we use GlazedLists, we use the GlazedListsSortModel which

        // delegates the sorting to the SortedList

        final SortHeaderLayer<SpecimenDescription> sortHeaderLayer = new SortHeaderLayer<>(

                columnHeaderLayer,

                new GlazedListsSortModel<>(

                        sortedList,

                        columnPropertyAccessor,

                        configRegistry,

                        columnHeaderDataLayer));

        columnHeaderDataLayer.setConfigLabelAccumulator(

                new BulkEditorConfigLabelAccumulatorHeader(colHeaderDataProvider, bulkEditor.getEditorInput()));

        //row

        DataLayer rowHeaderDataLayer = new DataLayer(rowHeaderDataProvider);

        RowHeaderLayer rowHeaderLayer = new RowHeaderLayer(rowHeaderDataLayer,

                bodyLayer, bodyLayer.getSelectionLayer());

        rowHeaderDataLayer.setColumnWidthByPosition(0, 50);

        //corner

        DefaultCornerDataProvider cornerDataProvider = new DefaultCornerDataProvider(

                colHeaderDataProvider, rowHeaderDataProvider);

        DataLayer cornerDataLayer = new DataLayer(cornerDataProvider);

        CornerLayer cornerLayer = new CornerLayer(cornerDataLayer, rowHeaderLayer, sortHeaderLayer);

        //grid

        GridLayer gridLayer = new GridLayer(bodyLayer, sortHeaderLayer,

                rowHeaderLayer, cornerLayer, false);//set autoconfigure to false to get rid of the single click editing

        natTable = new NatTable(bottomComposite, gridLayer, false);

        dataLayer.setConfigLabelAccumulator(new BulkEditorConfigLabelAccumulator(bodyDataProvider, colHeaderDataProvider,

                bulkEditor.getEditorInput()));

        natTable.setConfigRegistry(configRegistry);

        //add tooltip to table

        new BulkEditorTooltip(natTable, colHeaderDataProvider);

	}

	private void configureTable(){

	    //this configuration enables cell to be editable in general

	    //necessary because we disabled this beforehand by setting autoconfigure=false

	    //in the GridLayer constructor

	    ((AbstractLayer) natTable.getLayer()).addConfiguration(new DefaultEditConfiguration());

        natTable.addConfiguration(new AbstractUiBindingConfiguration() {

            @Override

            public void configureUiBindings(UiBindingRegistry uiBindingRegistry) {

                uiBindingRegistry.registerFirstDoubleClickBinding(new CellEditorMouseEventMatcher(GridRegion.BODY),

                        new MouseEditAction());

            }

        });

        //make cells editable to allow selecting the text

        natTable.addConfiguration(new AbstractRegistryConfiguration() {

            @Override

            public void configureRegistry(IConfigRegistry configRegistry) {

                //make cell editable

                configRegistry.registerConfigAttribute(

                        EditConfigAttributes.CELL_EDITABLE_RULE,

                        IEditableRule.ALWAYS_EDITABLE,

                        DisplayMode.EDIT);

                //register editor

                TextCellEditor editor = new TextCellEditor();

                editor.setEditable(false);

                configRegistry.registerConfigAttribute(

                        EditConfigAttributes.CELL_EDITOR,

                        editor,

                        DisplayMode.NORMAL);

            }

        });

        //+++CONTEXT MENU+++

        menuService.registerContextMenu(natTable, "eu.etaxonomy.taxeditor.bulkeditor.popupmenu.bulkeditor"); //$NON-NLS-1$

        // get the menu registered by EMenuService

        final Menu e4Menu = natTable.getMenu();

        // remove the menu reference from NatTable instance

        natTable.setMenu(null);

        natTable.addConfiguration(

                new AbstractUiBindingConfiguration() {

            @Override

            public void configureUiBindings(

                    UiBindingRegistry uiBindingRegistry) {

                // add e4 menu to NatTable

                new PopupMenuBuilder(natTable, e4Menu)

                	.withHideColumnMenuItem()

                	.withShowAllColumnsMenuItem()

                	.build();

                // register the UI binding for header, corner and body region

                uiBindingRegistry.registerMouseDownBinding(

                        new MouseEventMatcher(

                                SWT.NONE,

                                null,

                                MouseEventMatcher.RIGHT_BUTTON),

                        new PopupMenuAction(e4Menu));

            }

        });

        //enable sorting

        natTable.addConfiguration(new SingleClickSortConfiguration());

        // Custom style for deduplication labels

        natTable.addConfiguration(new BulkEditorLabelStyleConfiguration());

        //add default configuration because autoconfigure is set to false in constructor

        natTable.addConfiguration(new DefaultNatTableStyleConfiguration());

        //show boolean values as check boxes

        natTable.addConfiguration(new AbstractRegistryConfiguration() {

            @Override

            public void configureRegistry(IConfigRegistry configRegistry) {

                configRegistry.registerConfigAttribute(

                        CellConfigAttributes.CELL_PAINTER,

                        new CheckBoxPainter(),

                        DisplayMode.NORMAL,

                        BulkEditorConfigLabelAccumulatorHeader.BOOLEAN_COLUMN);

                configRegistry.registerConfigAttribute(

                        CellConfigAttributes.DISPLAY_CONVERTER,

                        new DefaultBooleanDisplayConverter(),

                        DisplayMode.NORMAL,

                        BulkEditorConfigLabelAccumulatorHeader.BOOLEAN_COLUMN);

            }

        });

        natTable.addConfiguration(new AbstractRegistryConfiguration() {

            @Override

            public void configureRegistry(IConfigRegistry configRegistry) {

                configRegistry.registerConfigAttribute(

                        CellConfigAttributes.CELL_PAINTER,

                        new ImagePainter(ImageResources.getImage(ImageResources.LOCK_ICON)),

                        DisplayMode.NORMAL,

                        BulkEditorConfigLabelAccumulatorHeader.CACHE_COLUMN);

            }

        });

        //register handler for view configuration menu

        natTable.registerCommandHandler(bulkEditorSearch.getDisplayPersistenceDialogCommandHandler());

        natTable.configure();

	}

	private void styleTable(){

	    natTable.setTheme(new ModernNatTableThemeConfiguration());

	}

	public void performSearch(BulkEditorQuery query) {

	    eventBroker.post(WorkbenchEventConstants.CURRENT_ACTIVE_EDITOR, null);

	    performSearch(query, null);

	}

    public void performSearch(BulkEditorQuery query, IStructuredSelection selection) {

        if (query != null) {

            if(StoreUtil.promptCheckIsDirty(bulkEditor)){

                return;

            }

            bulkEditor.getEditorInput().performSearch(query, selection);

            bulkEditor.setLastQuery(query);

        }

    }

    public void refresh(){

        natTable.doCommand(new VisualRefreshCommand());

    }

    public List<String> getColumnList() {

        return columnList;

    }

    public IStructuredSelection getSelection(){

        Set<Range> selectedRowPositions = bodyLayer.getSelectionLayer().getSelectedRowPositions();

        List<Object> selectedObjects = new ArrayList<>();

        for (Range range : selectedRowPositions) {

            for(int i=range.start;i<range.end;i++){

                if (i>=0){

                    selectedObjects.add(bodyDataProvider.getRowObject(i));

                }

            }

        }

        return new StructuredSelection(selectedObjects);

    }

    public void setSelection(IStructuredSelection selection){

        Object[] objects = selection.toArray();

        for (Object object : objects) {

            if(object instanceof CdmBase &&  bulkEditor.getEditorInput().getModel().contains(object)){

                object = bulkEditor.getEditorInput().getModel().get(bulkEditor.getEditorInput().getModel().indexOf(object));

                bodyLayer.getSelectionLayer().selectRow(0, bodyDataProvider.indexOfRowObject((CdmBase) object), false, false);

            }

        }

    }

    public void copyDataToClipboard() {

        String textData = ""; //$NON-NLS-1$

        IStructuredSelection selection = getSelection();

        Object[] objects = selection.toArray();

        for (Object object : objects) {

            if(object instanceof CdmBase){

                textData += bulkEditor.getEditorInput().getText((CdmBase)object);

            }

        }

        final TextTransfer textTransfer = TextTransfer.getInstance();

        final Clipboard clipboard = new Clipboard(Display.getDefault());

        try {

            clipboard.setContents(new Object[] { textData.toString() },

                    new Transfer[] { textTransfer });

        } finally {

            clipboard.dispose();

        }

    }

    ListDataProvider<CdmBase> getBodyDataProvider() {

        return bodyDataProvider;

    }

    ESelectionService getSelService() {

        return selService;

    }

    NatTable getNatTable() {

        return natTable;

    }

    public Properties getNatTableState() {

        return bulkEditorSearch.getNatTableState();

    }

    File getStatePropertiesFile() {

        return bulkEditorSearch.getStatePropertiesFile();

    }

}