eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/view/AbstractCdmViewPart.java

   1 // $Id$
   2 /**
   3  * Copyright (C) 2007 EDIT
   4  * European Distributed Institute of Taxonomy
   5  * http://www.e-taxonomy.eu
   6  *
   7  * The contents of this file are subject to the Mozilla Public License Version 1.1
   8  * See LICENSE.TXT at the top of this package for the full license terms.
   9  */
  10
  11 package eu.etaxonomy.taxeditor.view;
  12
  13 import java.util.Arrays;
  14 import java.util.List;
  15
  16 import org.eclipse.jface.viewers.ISelection;
  17 import org.eclipse.jface.viewers.IStructuredSelection;
  18 import org.eclipse.jface.viewers.StructuredSelection;
  19 import org.eclipse.jface.viewers.Viewer;
  20 import org.eclipse.swt.SWT;
  21 import org.eclipse.swt.custom.SashForm;
  22 import org.eclipse.swt.widgets.Composite;
  23 import org.eclipse.swt.widgets.Label;
  24 import org.eclipse.ui.ISelectionListener;
  25 import org.eclipse.ui.ISelectionService;
  26 import org.eclipse.ui.IWorkbenchPart;
  27 import org.eclipse.ui.part.PageBook;
  28 import org.eclipse.ui.part.ViewPart;
  29
  30 import eu.etaxonomy.cdm.api.conversation.ConversationHolder;
  31 import eu.etaxonomy.cdm.api.conversation.IConversationEnabled;
  32 import eu.etaxonomy.cdm.model.common.CdmBase;
  33 import eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap;
  34 import eu.etaxonomy.taxeditor.model.AbstractUtility;
  35 import eu.etaxonomy.taxeditor.model.IDirtyMarkable;
  36 import eu.etaxonomy.taxeditor.operation.IPostOperationEnabled;
  37 import eu.etaxonomy.taxeditor.session.ICdmEntitySession;
  38 import eu.etaxonomy.taxeditor.session.ICdmEntitySessionEnabled;
  39
  40 /**
  41  * <p>Abstract AbstractCdmViewPart class.</p>
  42  *
  43  * @author n.hoffmann
  44  * @created Jun 15, 2010
  45  * @version 1.0
  46  */
  47 public abstract class AbstractCdmViewPart extends ViewPart implements ISelectionListener, IPostOperationEnabled, IConversationEnabled, ICdmEntitySessionEnabled, IDirtyMarkable{
  48
  49     protected ISelectionService selectionService;
  50
  51     public static IStructuredSelection EMPTY_SELECTION = new StructuredSelection();
  52
  53     protected IWorkbenchPart part;
  54
  55     private PageBook pageBook;
  56
  57     private Label emptySelectionLabel;
  58
  59     private Composite viewerComposite;
  60
  61     /** {@inheritDoc} */
  62     @Override
  63     public void createPartControl(Composite parent) {
  64         selectionService = getSite().getWorkbenchWindow().getSelectionService();
  65         selectionService.addSelectionListener(this);
  66
  67         pageBook = new PageBook(parent, SWT.NULL);
  68         //create viewerComposite
  69         viewerComposite = new SashForm(pageBook, SWT.HORIZONTAL);
  70         createViewer(viewerComposite);
  71
  72         // Page 2: Nothing selected
  73         emptySelectionLabel = new Label(pageBook, SWT.TOP + SWT.LEFT + SWT.WRAP);
  74
  75         setInitialSelection();
  76     }
  77
  78     /**
  79      *
  80      */
  81     private void setInitialSelection() {
  82         selectionChanged(AbstractUtility.getActivePart(), getInitialSelection());
  83     }
  84
  85     /**
  86      * <p>getInitialSelection</p>
  87      *
  88      * @return a {@link org.eclipse.jface.viewers.ISelection} object.
  89      */
  90     protected ISelection getInitialSelection() {
  91         return selectionService.getSelection();
  92     }
  93
  94     /**
  95      * <p>showEmptyPage</p>
  96      */
  97     public void showEmptyPage(){
  98         pageBook.showPage(emptySelectionLabel);
  99     }
 100
 101     /**
 102      * <p>showViewer</p>
 103      *
 104      * @param part a {@link org.eclipse.ui.IWorkbenchPart} object.
 105      * @param selection a {@link org.eclipse.jface.viewers.ISelection} object.
 106      */
 107     public void showViewer(IWorkbenchPart part, IStructuredSelection selection){
 108         this.part = part;
 109
 110         Object element = selection.getFirstElement();
 111
 112         getViewer().setInput(element);
 113
 114         showViewer();
 115     }
 116
 117     /**
 118      * <p>getViewer</p>
 119      *
 120      * @return a {@link org.eclipse.jface.viewers.Viewer} object.
 121      */
 122     public abstract Viewer getViewer();
 123
 124     /**
 125      * <p>showViewer</p>
 126      */
 127     public void showViewer(){
 128         pageBook.showPage(viewerComposite);
 129     }
 130
 131     public void setEnabled(boolean enabled){
 132         pageBook.setEnabled(enabled);
 133     }
 134
 135     /** {@inheritDoc} */
 136     @Override
 137     public void setFocus() {
 138         if(getConversationHolder() != null){
 139             getConversationHolder().bind();
 140         }
 141         if(getCdmEntitySession() != null){
 142             getCdmEntitySession().bind();
 143         }
 144         getViewer().getControl().setFocus();
 145     }
 146
 147     /**
 148      * <p>createViewer</p>
 149      *
 150      * @param parent a {@link org.eclipse.swt.widgets.Composite} object.
 151      */
 152     public abstract void createViewer(Composite parent);
 153
 154     /** {@inheritDoc} */
 155     @Override
 156     public boolean postOperation(CdmBase objectAffectedByOperation) {
 157         changed(objectAffectedByOperation);
 158         return true;
 159     }
 160
 161     /** {@inheritDoc} */
 162     @Override
 163     public abstract void changed(Object object);
 164
 165     /**
 166      * <p>getConversationHolder</p>
 167      *
 168      * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
 169      */
 170     @Override
 171     public ConversationHolder getConversationHolder() {
 172         if(part != null && part instanceof IConversationEnabled) {
 173             return ((IConversationEnabled) part).getConversationHolder();
 174         }
 175
 176         return null;
 177     }
 178
 179     @Override
 180     public ICdmEntitySession getCdmEntitySession() {
 181         if(part != null && part instanceof ICdmEntitySessionEnabled) {
 182             return ((ICdmEntitySessionEnabled) part).getCdmEntitySession();
 183         }
 184         return null;
 185     }
 186
 187     @Override
 188     public  List<CdmBase> getRootEntities() {
 189         return Arrays.asList((CdmBase)getViewer().getInput());
 190     }
 191
 192     /** {@inheritDoc} */
 193     @Override
 194     public void update(CdmDataChangeMap changeEvents) {
 195
 196     }
 197
 198     /** {@inheritDoc} */
 199     @Override
 200     public void dispose() {
 201         selectionService.removeSelectionListener(this);
 202         super.dispose();
 203     }
 204
 205     /* (non-Javadoc)
 206      * @see eu.etaxonomy.taxeditor.model.IDirtyMarkableSelectionProvider#forceDirty()
 207      */
 208     @Override
 209     public void forceDirty() {
 210         changed(null);
 211     }
 212 }