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.view;

import java.util.Collection;

import org.eclipse.core.runtime.IProgressMonitor;

import org.eclipse.jface.action.GroupMarker;

import org.eclipse.jface.action.MenuManager;

import org.eclipse.jface.viewers.ArrayContentProvider;

import org.eclipse.jface.viewers.IBaseLabelProvider;

import org.eclipse.jface.viewers.ISelection;

import org.eclipse.jface.viewers.TableViewer;

import org.eclipse.jface.viewers.Viewer;

import org.eclipse.swt.SWT;

import org.eclipse.swt.events.FocusAdapter;

import org.eclipse.swt.events.FocusEvent;

import org.eclipse.swt.layout.FillLayout;

import org.eclipse.swt.widgets.Composite;

import org.eclipse.swt.widgets.Control;

import org.eclipse.swt.widgets.Menu;

import org.eclipse.ui.IMemento;

import org.eclipse.ui.IWorkbenchActionConstants;

import org.eclipse.ui.IWorkbenchPart;

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

import eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap;

import eu.etaxonomy.taxeditor.model.ContextListenerAdapter;

import eu.etaxonomy.taxeditor.model.IContextListener;

import eu.etaxonomy.taxeditor.store.CdmStore;

/**

 * @author n.hoffmann

 * @created Feb 16, 2011

 * @version 1.0

 */

public abstract class AbstractAccountViewPart<T> extends AbstractCdmViewPart {

	private class ContextListener extends ContextListenerAdapter{

		/* (non-Javadoc)

		 * @see eu.etaxonomy.taxeditor.model.IContextListener#contextStop(org.eclipse.ui.IMemento, org.eclipse.core.runtime.IProgressMonitor)

		 */

		@Override

		public void contextStop(IMemento memento, IProgressMonitor monitor) {

			monitor.subTask("Shutting down User View");

			viewer.setInput(null);

		}

		/* (non-Javadoc)

		 * @see eu.etaxonomy.taxeditor.model.IContextListener#contextStart(org.eclipse.ui.IMemento, org.eclipse.core.runtime.IProgressMonitor)

		 */

		@Override

		public void contextStart(IMemento memento, IProgressMonitor monitor) {

			monitor.subTask("Initiating User View");

			viewer.setInput(getInput());

		}

	}

	protected TableViewer viewer;

	private IContextListener contextListener;

	/* (non-Javadoc)

	 * @see org.eclipse.ui.part.WorkbenchPart#createPartControl(org.eclipse.swt.widgets.Composite)

	 */

	/** {@inheritDoc} */

	@Override

	public void createPartControl(Composite parent) {

		contextListener = new ContextListener();

		CdmStore.getContextManager().addContextListener(contextListener);

		FillLayout fillLayout = new FillLayout();

		fillLayout.marginWidth = 0;

		fillLayout.marginHeight = 0;

		fillLayout.type = SWT.VERTICAL;

		parent.setLayout(fillLayout);

		viewer = new TableViewer(parent, SWT.MULTI | SWT.H_SCROLL

				| SWT.V_SCROLL | SWT.FULL_SELECTION);

		getSite().setSelectionProvider(viewer);

		createColumns(viewer);

		MenuManager menuMgr = new MenuManager();

		menuMgr.add(new GroupMarker(IWorkbenchActionConstants.MB_ADDITIONS));

		getSite().registerContextMenu(menuMgr, viewer);

		Control control = viewer.getControl();

		Menu menu = menuMgr.createContextMenu(control);

		control.setMenu(menu);

		viewer.setContentProvider(new ArrayContentProvider());

		viewer.setLabelProvider(getLabelProvider());

		if(CdmStore.isActive()){

			viewer.setInput(getInput());

		}

		this.addListenerObject(new FocusAdapter() {

			/* (non-Javadoc)

			 * @see org.eclipse.swt.events.FocusAdapter#focusGained(org.eclipse.swt.events.FocusEvent)

			 */

			@Override

			public void focusGained(FocusEvent e) {

				super.focusGained(e);

				getConversationHolder().bind();

				if (!viewer.getControl().isDisposed()){

				    viewer.getControl().setFocus();

				}

			}

		});

	}

	/**

	 * @return

	 */

	protected abstract IBaseLabelProvider getLabelProvider();

	/**

	 * @param viewer2

	 */

	protected abstract void createColumns(TableViewer viewer);

	/**

	 * @return the contextListener

	 */

	public IContextListener getContextListener() {

		if(contextListener == null){

			throw new IllegalStateException("Context listener was not initialized");

		}

		return contextListener;

	}

	/* (non-Javadoc)

	 * @see eu.etaxonomy.cdm.persistence.hibernate.ICdmPostDataChangeObserver#update(eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap)

	 */

	@Override

	public void update(CdmDataChangeMap changeEvents) {

		// data changes can only be generate here at the moment

	}

	/* (non-Javadoc)

	 * @see eu.etaxonomy.taxeditor.operation.IPostOperationEnabled#postOperation(eu.etaxonomy.cdm.model.common.CdmBase)

	 */

	@Override

	public boolean postOperation(CdmBase objectAffectedByOperation) {

		if(CdmStore.isActive()){

			viewer.setInput(getInput());

			viewer.refresh();

		}

		return true;

	}

	/**

	 * @return

	 */

	public abstract Collection getInput();

	/* (non-Javadoc)

	 * @see org.eclipse.ui.part.WorkbenchPart#dispose()

	 */

	@Override

	public void dispose() {

		CdmStore.getContextManager().removeContextListener(getContextListener());

		super.dispose();

	}

	@Override

	public void selectionChanged(IWorkbenchPart part, ISelection selection) {

		// TODO Auto-generated method stub

	}

	@Override

	public Viewer getViewer() {

		return viewer;

	}

	@Override

	public void createViewer(Composite parent) {

		// TODO Auto-generated method stub

	}

	@Override

	public void changed(Object object) {

		// do nothing

	}

	@Override

	public boolean onComplete() {

		return true;

	}

}

/**

* 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.view;

import org.eclipse.jface.viewers.StructuredSelection;

import org.eclipse.jface.viewers.Viewer;

import org.eclipse.swt.widgets.Composite;

import org.eclipse.swt.widgets.Control;

import org.eclipse.ui.forms.IFormPart;

import org.eclipse.ui.forms.ManagedForm;

import org.eclipse.ui.forms.widgets.ScrolledForm;

import eu.etaxonomy.cdm.api.conversation.ConversationHolder;

import eu.etaxonomy.cdm.api.conversation.IConversationEnabled;

import eu.etaxonomy.taxeditor.ui.element.AbstractFormSection;

import eu.etaxonomy.taxeditor.ui.element.CdmFormFactory;

import eu.etaxonomy.taxeditor.ui.element.LayoutConstants;

import eu.etaxonomy.taxeditor.ui.element.RootElement;

import eu.etaxonomy.taxeditor.view.detail.CdmSectionPart;

/**

 * @author n.hoffmann

 * @created Feb 9, 2010

 * @version 1.0

 */

public abstract class AbstractCdmDataViewer extends Viewer implements IConversationEnabled{

	protected ManagedForm managedForm;

	protected CdmFormFactory formFactory;

	protected ScrolledForm scrolledForm;

	private final Composite body;

	protected RootElement rootElement;

	//TODO: create a super class for this?

	private Object input;

	private final AbstractCdmViewPart viewPart;

	public AbstractCdmDataViewer(Composite parent, AbstractCdmViewPart viewPart) {

		this.viewPart = viewPart;

		managedForm = new ManagedForm(parent){

			@Override

			public void dirtyStateChanged() {

				markViewPartDirty();

			}

		};

		createFormFactory();

		scrolledForm = managedForm.getForm();

		body = scrolledForm.getBody();

		body.setLayout(LayoutConstants.LAYOUT());

		rootElement = new RootElement(formFactory, body);

	}

	protected void createFormFactory() {

		if(formFactory != null){

			formFactory.dispose();

			formFactory = null;

		}

//		formFactory = new CdmFormFactory(Display.getCurrent(), this);

	}

	protected void markViewPartDirty(){

		viewPart.changed(input);

	}

	protected AbstractCdmViewPart getViewPart() {

		return viewPart;

	}

	/** {@inheritDoc} */

	@Override

	public Control getControl() {

		if(body.isDisposed()){

			return null;

		}

		for(Control child : body.getChildren()){

			return child;

		}

		return body;

	}

	/** {@inheritDoc} */

	@Override

	public void setInput(Object input) {

		this.input = input;

		// reset selection

		setSelection(new StructuredSelection(input));

		refresh();

	}

	/** {@inheritDoc} */

	@Override

	public Object getInput() {

		return input;

	}

	/** {@inheritDoc} */

	@Override

	public void refresh() {

		showParts();

		managedForm.setInput(input);

		managedForm.refresh();

		managedForm.reflow(true);

	}

	public void layout(){

		body.layout();

	}

	protected abstract void showParts();

	protected void destroySections() {

		for (IFormPart formPart : managedForm.getParts()){

			removePart((CdmSectionPart<?>) formPart);

		}

		managedForm.setInput(null);

		formFactory.destroyElement(rootElement);

		createFormFactory();

		rootElement = new RootElement(formFactory, body);

		for(Control control : body.getChildren()){

			control.dispose();

			control = null;

		}

	}

	public void setFocus(){

		// we have to set focus to a control of this viewer

		// otherwise, after opening a dialog from the details, the focus will not be

		// given back to the details view but to the editor

		for(Control child : body.getChildren()){

			child.setFocus();

			break;

		}

	}

	public void reflow(){

		managedForm.reflow(true);

	}

	protected void removePart(CdmSectionPart<?> sectionPart){

		managedForm.removePart(sectionPart);

		formFactory.removePropertyChangeListener(sectionPart);

	}

	protected void addPart(AbstractFormSection<?> section){

		CdmSectionPart<?> sectionPart = new CdmSectionPart<>(section);

		managedForm.addPart(sectionPart);

		formFactory.addPropertyChangeListener(sectionPart);

	}

	@Override

    public ConversationHolder getConversationHolder() {

		return viewPart.getConversationHolder();

	}

}

/**

 *

 */

package eu.etaxonomy.taxeditor.view;

import org.eclipse.e4.ui.model.application.ui.basic.MPart;

import org.eclipse.jface.viewers.ISelection;

import org.eclipse.jface.viewers.IStructuredSelection;

import org.eclipse.swt.widgets.Composite;

import org.eclipse.swt.widgets.Display;

import org.eclipse.ui.IWorkbenchPart;

import eu.etaxonomy.taxeditor.model.IDirtyMarkable;

import eu.etaxonomy.taxeditor.workbench.part.ISelectionElementEditingPart;

/**

 * <p>

 * Abstract AbstractCdmEditorViewPart class.

 * </p>

 *

 * @author n.hoffmann

 * @created Sep 21, 2010

 * @version 1.0

 */

public abstract class AbstractCdmEditorViewPart extends AbstractCdmViewPart implements ISelectionElementEditingPart {

    private DelaySelection delaySelection = null;

    /**

     * This is the monitor for the DelaySelection runnable.

     * If it is <code>true</code> then it is currently delaying a selection.

     */

    private boolean isInDelay;

    protected Object selectionProvidingPart;

    /**

     * This class invokes internal_selectionChanged() in a separate thread.

     * This allows an asynchronous and/or delayed handling of selection changes

     */

    private class DelaySelection implements Runnable{

        private IWorkbenchPart part;

        private ISelection selection;

        public DelaySelection(IWorkbenchPart part, ISelection selection) {

            super();

            this.part = part;

            this.selection = selection;

        }

        @Override

        public void run() {

            try{

                selectionChanged_internal(part, selection);

            }

            finally{

                isInDelay = false;

            }

        }

        public synchronized void setSelection(ISelection selection) {

            this.selection = selection;

        }

        public synchronized void setPart(IWorkbenchPart part) {

            this.part = part;

        }

    }

    /**

     * Handle selection change events here and <b>not</b> in

     * {@link AbstractCdmEditorViewPart#selectionChanged(IWorkbenchPart, ISelection)}

     * if you want asynchronous selection handling.

     * @param part The workbench part that has issued the selection change

     * @param selection the new selection

     */

    protected abstract void selectionChanged_internal(IWorkbenchPart part, ISelection selection);

    /** {@inheritDoc} */

    @Override

    public void selectionChanged(IWorkbenchPart part, ISelection selection) {

    	/*to avoid widget is disposed exceptions

        if(getViewer().getControl().isDisposed()){

            return;

        }*/

    	if(delaySelection==null){

            delaySelection = new DelaySelection(part, selection);

        }

        delaySelection.setPart(part);

        delaySelection.setSelection(selection);

        if(!isInDelay){

            isInDelay = true;

            Display.getCurrent().asyncExec(delaySelection);

        }

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public void showViewer(Object part, IStructuredSelection selection) {

        super.showViewer(part, selection);

        selectionProvidingPart = part;

    }

    @Override

    public MPart getSelectionProvidingPart() {

        return (MPart) selectionProvidingPart;

    }

    /** {@inheritDoc} */

    @Override

    public void createPartControl(Composite parent) {

        super.createPartControl(parent);

        isInDelay = false;

    }

//    /**

//     * <p>

//     * getEditor

//     * </p>

//     *

//     * @return the currently active editor

//     */

//    public IEditorPart getEditor() {

////        return AbstractUtility.getActiveEditor();

//    }

    /**

     * {@inheritDoc}

     */

    @Override

    public void showEmptyPage() {

        selectionProvidingPart = null;

        super.showEmptyPage();

    }

    /** {@inheritDoc} */

    @Override

    public void setFocus() {

        super.setFocus();

//        if(getEditor() != null && ISecuredEditor.class.isAssignableFrom(getEditor().getClass())){

//            boolean doEnable = ((ISecuredEditor)getEditor()).permissionsSatisfied();

//            setEnabled(doEnable);

//        }

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public void dispose() {

        selectionProvidingPart = null;

        super.dispose();

    }

    /** {@inheritDoc} */

    @Override

    public void changed(Object object) {

        if(part instanceof IDirtyMarkable){

            ((IDirtyMarkable) part).changed(object);

        }

        else {

//            IEditorPart editor = getEditor();

//            if (editor != null && editor instanceof IDirtyMarkable) {

//                ((IDirtyMarkable) editor).changed(object);

//            }

        }

    }

}

/**

 * 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.view;

import java.util.Arrays;

import java.util.List;

import java.util.Map;

import org.eclipse.jface.viewers.ISelection;

import org.eclipse.jface.viewers.IStructuredSelection;

import org.eclipse.jface.viewers.StructuredSelection;

import org.eclipse.jface.viewers.Viewer;

import org.eclipse.swt.SWT;

import org.eclipse.swt.custom.SashForm;

import org.eclipse.swt.widgets.Composite;

import org.eclipse.swt.widgets.Label;

import org.eclipse.ui.ISelectionListener;

import org.eclipse.ui.ISelectionService;

import org.eclipse.ui.part.PageBook;

import org.eclipse.ui.part.ViewPart;

import eu.etaxonomy.cdm.api.conversation.ConversationHolder;

import eu.etaxonomy.cdm.api.conversation.IConversationEnabled;

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

import eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap;

import eu.etaxonomy.taxeditor.model.IDirtyMarkable;

import eu.etaxonomy.taxeditor.operation.IPostOperationEnabled;

import eu.etaxonomy.taxeditor.session.ICdmEntitySession;

import eu.etaxonomy.taxeditor.session.ICdmEntitySessionEnabled;

/**

 * <p>Abstract AbstractCdmViewPart class.</p>

 *

 * @author n.hoffmann

 * @created Jun 15, 2010

 * @version 1.0

 */

public abstract class AbstractCdmViewPart extends ViewPart implements ISelectionListener, IPostOperationEnabled, IConversationEnabled, ICdmEntitySessionEnabled, IDirtyMarkable{

    protected ISelectionService selectionService;

    public static IStructuredSelection EMPTY_SELECTION = new StructuredSelection();

    protected Object part;

    private PageBook pageBook;

    private Label emptySelectionLabel;

    private Composite viewerComposite;

    /** {@inheritDoc} */

    @Override

    public void createPartControl(Composite parent) {

        selectionService = getSite().getWorkbenchWindow().getSelectionService();

        selectionService.addSelectionListener(this);

        pageBook = new PageBook(parent, SWT.NULL);

        //create viewerComposite

        viewerComposite = new SashForm(pageBook, SWT.HORIZONTAL);

        createViewer(viewerComposite);

        // Page 2: Nothing selected

        emptySelectionLabel = new Label(pageBook, SWT.TOP + SWT.LEFT + SWT.WRAP);

        setInitialSelection();

    }

    private void setInitialSelection() {

//        selectionChanged(AbstractUtility.getActiveWorkbenchPart(), getInitialSelection());

    }

    /**

     * <p>getInitialSelection</p>

     *

     * @return a {@link org.eclipse.jface.viewers.ISelection} object.

     */

    protected ISelection getInitialSelection() {

        return selectionService.getSelection();

    }

    /**

     * <p>showEmptyPage</p>

     */

    public void showEmptyPage(){

    	setPartName(createPartTitle(null));

        pageBook.showPage(emptySelectionLabel);

    }

    /**

     * <p>showViewer</p>

     *

     * @param part a {@link org.eclipse.ui.IWorkbenchPart} object.

     * @param selection a {@link org.eclipse.jface.viewers.ISelection} object.

     */

    public void showViewer(Object part, IStructuredSelection selection){

        this.part = part;

        Object element = selection.getFirstElement();

      //avoid widget is disposed exceptions

        if (getViewer().getControl()==null || getViewer().getControl().isDisposed()){

            return;

        }

        setPartName(createPartTitle(element));

        getViewer().setInput(element);

        showViewer();

    }

    /**

     * <p>getViewer</p>

     *

     * @return a {@link org.eclipse.jface.viewers.Viewer} object.

     */

    public abstract Viewer getViewer();

    /**

     * <p>showViewer</p>

     */

    public void showViewer(){

        pageBook.showPage(viewerComposite);

    }

    public void setEnabled(boolean enabled){

        pageBook.setEnabled(enabled);

    }

    /** {@inheritDoc} */

    @Override

    public void setFocus() {

        if(getConversationHolder() != null){

            getConversationHolder().bind();

        }

        if(getCdmEntitySession() != null){

            getCdmEntitySession().bind();

        }

        getViewer().getControl().setFocus();

    }

    /**

     * <p>createViewer</p>

     *

     * @param parent a {@link org.eclipse.swt.widgets.Composite} object.

     */

    public abstract void createViewer(Composite parent);

    /** {@inheritDoc} */

    @Override

    public boolean postOperation(CdmBase objectAffectedByOperation) {

        changed(objectAffectedByOperation);

        return true;

    }

    /** {@inheritDoc} */

    @Override

    public abstract void changed(Object object);

    /**

     * <p>getConversationHolder</p>

     *

     * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.

     */

    @Override

    public ConversationHolder getConversationHolder() {

        if(part != null && part instanceof IConversationEnabled) {

            return ((IConversationEnabled) part).getConversationHolder();

        }

        return null;

    }

    @Override

    public ICdmEntitySession getCdmEntitySession() {

        if(part != null && part instanceof ICdmEntitySessionEnabled) {

            return ((ICdmEntitySessionEnabled) part).getCdmEntitySession();

        }

        return null;

    }

    @Override

    public  List<? extends CdmBase> getRootEntities() {

        return Arrays.asList((CdmBase)getViewer().getInput());

    }

    /** {@inheritDoc} */

    @Override

    public void update(CdmDataChangeMap changeEvents) {

    }

    /** {@inheritDoc} */

    @Override

    public void dispose() {

        selectionService.removeSelectionListener(this);

        super.dispose();

    }

    /* (non-Javadoc)

     * @see eu.etaxonomy.taxeditor.model.IDirtyMarkableSelectionProvider#forceDirty()

     */

    @Override

    public void forceDirty() {

        changed(null);

    }

    /* (non-Javadoc)

     * @see eu.etaxonomy.taxeditor.session.ICdmEntitySessionEnabled#getPropertyPathsMap()

     */

    @Override

    public Map<Object, List<String>> getPropertyPathsMap() {

        // TODO Auto-generated method stub

        return null;

    }

	protected String createPartTitle(Object selectedObject){

	    if(selectedObject!=null){

	        return getViewName()+": "+selectedObject; //$NON-NLS-1$

	    }

        return getViewName();

	}

    protected abstract String getViewName();

}