taxeditor-store/src/main/java/eu/etaxonomy/taxeditor/model/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.model;
  12
  13 import org.eclipse.jface.viewers.ISelection;
  14 import org.eclipse.jface.viewers.IStructuredSelection;
  15 import org.eclipse.jface.viewers.Viewer;
  16 import org.eclipse.swt.SWT;
  17 import org.eclipse.swt.custom.SashForm;
  18 import org.eclipse.swt.widgets.Composite;
  19 import org.eclipse.swt.widgets.Label;
  20 import org.eclipse.ui.ISelectionListener;
  21 import org.eclipse.ui.ISelectionService;
  22 import org.eclipse.ui.IWorkbenchPart;
  23 import org.eclipse.ui.part.PageBook;
  24 import org.eclipse.ui.part.ViewPart;
  25
  26 import eu.etaxonomy.cdm.api.conversation.ConversationHolder;
  27 import eu.etaxonomy.cdm.api.conversation.IConversationEnabled;
  28 import eu.etaxonomy.cdm.model.common.CdmBase;
  29 import eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap;
  30 import eu.etaxonomy.taxeditor.operation.IPostOperationEnabled;
  31 import eu.etaxonomy.taxeditor.store.StoreUtil;
  32
  33 /**
  34  * <p>Abstract AbstractCdmViewPart class.</p>
  35  *
  36  * @author n.hoffmann
  37  * @created Jun 15, 2010
  38  * @version 1.0
  39  */
  40 public abstract class AbstractCdmViewPart extends ViewPart implements ISelectionListener, IPostOperationEnabled, IConversationEnabled, IDirtyMarkableSelectionProvider{
  41
  42         protected ISelectionService selectionService;
  43
  44         protected IWorkbenchPart part;
  45
  46     private PageBook pageBook;
  47
  48         private Label emptySelectionLabel;
  49
  50         private Composite viewerComposite;
  51
  52         /** {@inheritDoc} */
  53         @Override
  54         public void createPartControl(Composite parent) {
  55                 selectionService = getSite().getWorkbenchWindow().getSelectionService();
  56                 selectionService.addSelectionListener(this);
  57
  58                 pageBook = new PageBook(parent, SWT.NULL);
  59                 createViewerComposite(pageBook);
  60                 createViewer(viewerComposite);
  61
  62                 // Page 2: Nothing selected
  63         emptySelectionLabel = new Label(pageBook, SWT.TOP + SWT.LEFT + SWT.WRAP);
  64
  65         setInitialSelection();
  66         }
  67
  68         /**
  69          *
  70          */
  71         private void setInitialSelection() {
  72                 selectionChanged(StoreUtil.getActivePart(), getInitialSelection());
  73         }
  74
  75         /**
  76          * <p>getInitialSelection</p>
  77          *
  78          * @return a {@link org.eclipse.jface.viewers.ISelection} object.
  79          */
  80         protected ISelection getInitialSelection() {
  81                 return selectionService.getSelection();
  82         }
  83
  84         private void createViewerComposite(Composite parent) {
  85                 viewerComposite = new SashForm(parent, SWT.HORIZONTAL);
  86         }
  87
  88         /**
  89          * <p>showEmptyPage</p>
  90          */
  91         public void showEmptyPage(){
  92                 pageBook.showPage(emptySelectionLabel);
  93         }
  94
  95     /**
  96      * <p>showViewer</p>
  97      *
  98      * @param part a {@link org.eclipse.ui.IWorkbenchPart} object.
  99      * @param selection a {@link org.eclipse.jface.viewers.ISelection} object.
 100      */
 101     public void showViewer(IWorkbenchPart part, IStructuredSelection selection){
 102         this.part = part;
 103
 104                 Object element = selection.getFirstElement();
 105
 106                 getViewer().setInput(element);
 107
 108                 showViewer();
 109     }
 110
 111     /**
 112      * <p>getViewer</p>
 113      *
 114      * @return a {@link org.eclipse.jface.viewers.Viewer} object.
 115      */
 116     public abstract Viewer getViewer();
 117
 118         /**
 119          * <p>showViewer</p>
 120          */
 121         public void showViewer(){
 122                 pageBook.showPage(viewerComposite);
 123     }
 124
 125
 126         /** {@inheritDoc} */
 127         @Override
 128         public void setFocus() {
 129                 if(getConversationHolder() != null){
 130                         getConversationHolder().bind();
 131                 }
 132                 getViewer().getControl().setFocus();
 133         }
 134
 135         /**
 136          * <p>createViewer</p>
 137          *
 138          * @param parent a {@link org.eclipse.swt.widgets.Composite} object.
 139          */
 140         public abstract void createViewer(Composite parent);
 141
 142         /** {@inheritDoc} */
 143         public boolean postOperation(CdmBase objectAffectedByOperation) {
 144                 changed(objectAffectedByOperation);
 145                 return true;
 146         }
 147
 148         /** {@inheritDoc} */
 149         public abstract void changed(Object object);
 150
 151         /**
 152          * <p>getConversationHolder</p>
 153          *
 154          * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
 155          */
 156         public ConversationHolder getConversationHolder() {
 157                 if(part != null)
 158                         return ((IConversationEnabled) part).getConversationHolder();
 159
 160                 return null;
 161         }
 162
 163         /** {@inheritDoc} */
 164         public void update(CdmDataChangeMap changeEvents) {
 165                 // TODO Auto-generated method stub
 166
 167         }
 168
 169         /** {@inheritDoc} */
 170         @Override
 171         public void dispose() {
 172                 selectionService.removeSelectionListener(this);
 173                 super.dispose();
 174         }
 175 }