bundles/org.simantics.selectionview/src/org/simantics/selectionview/PropertyPage.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
   3  * in Industry THTH ry.\r
   4  * All rights reserved. This program and the accompanying materials\r
   5  * are made available under the terms of the Eclipse Public License v1.0\r
   6  * which accompanies this distribution, and is available at\r
   7  * http://www.eclipse.org/legal/epl-v10.html\r
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 package org.simantics.selectionview;\r
  13 \r
  14 import java.util.function.Consumer;\r
  15 \r
  16 import org.eclipse.core.runtime.IAdaptable;\r
  17 import org.eclipse.jface.action.IMenuManager;\r
  18 import org.eclipse.jface.action.IToolBarManager;\r
  19 import org.eclipse.jface.viewers.ISelection;\r
  20 import org.eclipse.jface.viewers.ISelectionProvider;\r
  21 import org.eclipse.jface.viewers.StructuredSelection;\r
  22 import org.eclipse.swt.SWT;\r
  23 import org.eclipse.swt.widgets.Composite;\r
  24 import org.eclipse.swt.widgets.Control;\r
  25 import org.eclipse.swt.widgets.Event;\r
  26 import org.eclipse.swt.widgets.Listener;\r
  27 import org.eclipse.ui.IPartListener2;\r
  28 import org.eclipse.ui.IWorkbenchPart;\r
  29 import org.eclipse.ui.IWorkbenchPartReference;\r
  30 import org.eclipse.ui.IWorkbenchPartSite;\r
  31 import org.eclipse.ui.part.IPageSite;\r
  32 import org.simantics.Simantics;\r
  33 import org.simantics.browsing.ui.common.IPageBookViewPagePartInit;\r
  34 import org.simantics.browsing.ui.common.views.IFilterAreaProvider;\r
  35 import org.simantics.browsing.ui.swt.PartNameListener;\r
  36 import org.simantics.browsing.ui.swt.PropertyPageUtil;\r
  37 import org.simantics.db.ReadGraph;\r
  38 import org.simantics.db.Session;\r
  39 import org.simantics.db.exception.DatabaseException;\r
  40 import org.simantics.db.management.ISessionContext;\r
  41 import org.simantics.db.management.ISessionContextChangedListener;\r
  42 import org.simantics.db.management.ISessionContextProvider;\r
  43 import org.simantics.db.management.SessionContextChangedEvent;\r
  44 import org.simantics.db.request.Read;\r
  45 import org.simantics.ui.workbench.IPropertyPage;\r
  46 \r
  47 /**\r
  48  * <p>\r
  49  * Subclasses may extend or reimplement the following methods as required:\r
  50  * <ul>\r
  51  *   <li><code>createPageControls</code> - to create the page's controls</li>\r
  52  *   <li><code>fillToolBar</code> - to add actions to the page's toolbar</li>\r
  53  *   <li><code>fillDropDownMenu</code> - to add actions to the page's drop-down menu</li>\r
  54  *   <li><code>getControl</code> - to retrieve the page's control</li>\r
  55  *   <li><code>setFocus</code> - implement to accept focus</li>\r
  56  *   <li><code>sourceSelectionChanged</code> - puts the incoming ISelection into use in this page</li>\r
  57  *   <li><code>sourcePartClosed</code> - cleans up the page controls after a current selection source part has been closed</li>\r
  58  *   <li><code>dispose</code> - extend to provide additional cleanup</li>\r
  59  *   <li><code>setActionBars</code> - reimplement to make contributions</li>\r
  60  *   <li><code>makeContributions</code> - this method exists to support previous versions</li>\r
  61  *   <li><code>setActionBars</code> - this method exists to support previous versions</li>\r
  62  *   <li><code>init</code> - extend to provide additional setup for the view before any controls are created</li>\r
  63  *   <li><code>sessionContextChanged</code> - reimplement to take actions when the source database session changes</li>\r
  64  * </ul>\r
  65  * </p>\r
  66  * \r
  67  * @author Tuukka Lehtonen\r
  68  */\r
  69 public class PropertyPage extends AbstractPropertyPage implements IPropertyPage, IAdaptable, IPartListener2, IPageBookViewPagePartInit {\r
  70 \r
  71     protected static final int MAX_SELECTION_LENGTH_TO_SHOW = PropertyPageUtil.MAX_SELECTION_LENGTH_TO_SHOW;\r
  72 \r
  73     protected ISessionContext  sessionContext;\r
  74 \r
  75     protected IPropertyTab     tab;\r
  76 \r
  77     protected ISelection       latestSelection = StructuredSelection.EMPTY;\r
  78 \r
  79     protected IWorkbenchPart   propertyPageView;\r
  80     \r
  81     protected boolean visible = true;\r
  82 \r
  83     /**\r
  84      * @param site the workbench part site that contains this page or\r
  85      *        <code>null</code> if there is no site, i.e. the page is within a\r
  86      *        dialog or a plain shell.\r
  87      */\r
  88     public PropertyPage(IWorkbenchPartSite site) {\r
  89         super(site);\r
  90     }\r
  91 \r
  92     @Override\r
  93     public void init(IPageSite pageSite) {\r
  94         \r
  95         super.init(pageSite);\r
  96         \r
  97         if(getSite() != null)\r
  98                 getSite().getPage().addPartListener(this);\r
  99         \r
 100     }\r
 101     \r
 102     @Override\r
 103     public void initPart(IWorkbenchPart part) {\r
 104         propertyPageView = part;\r
 105     }\r
 106     \r
 107     @Override\r
 108     public void dispose() {\r
 109 \r
 110         if(getSite() != null)\r
 111                 getSite().getPage().removePartListener(this);\r
 112         \r
 113         // Stop listening for title changes.\r
 114         if (currentPartNameListener != null) {\r
 115             currentPartNameListener.dispose();\r
 116             currentPartNameListener = null;\r
 117         }\r
 118 \r
 119         ISessionContextProvider contextProvider = getSessionContextProvider();\r
 120         if (contextProvider != null)\r
 121             contextProvider.removeContextChangedListener(contextChangeListener);\r
 122 \r
 123         //System.out.println("dispose " + this);\r
 124         // Must invoke dispose before nullifying table since super will dispose the widget.\r
 125         super.dispose();\r
 126         tab = null;\r
 127         sessionContext = null;\r
 128     }\r
 129 \r
 130     protected ISessionContextProvider getSessionContextProvider() {\r
 131         return Simantics.getSessionContextProvider();\r
 132     }\r
 133 \r
 134     protected ISessionContext getSessionContext() {\r
 135         return sessionContext;\r
 136     }\r
 137 \r
 138     protected Session getSession() {\r
 139         if (sessionContext == null)\r
 140             throw new IllegalStateException("null session context");\r
 141         return sessionContext.getSession();\r
 142     }\r
 143 \r
 144     @Override\r
 145     public final void createControl(Composite parent) {\r
 146         createPageControls(parent);\r
 147 \r
 148         // Attach to current session context provider to keep the UI intact even\r
 149         // when the current UI session changes.\r
 150         ISessionContextProvider contextProvider = getSessionContextProvider();\r
 151         contextProvider.addContextChangedListener(contextChangeListener);\r
 152         setSessionContext(contextProvider.getSessionContext());\r
 153     }\r
 154 \r
 155     /**\r
 156      * Override to customize the UI component created on this page.\r
 157      * \r
 158      * @param parent\r
 159      */\r
 160     protected void createPageControls(Composite parent) {\r
 161         PropertyTable pt = new PropertyTable(sourceSite, parent, SWT.NONE);\r
 162         tab = pt;\r
 163         tab.createControl(pt, getSessionContext());\r
 164         tab.getControl().addListener(SWT.Dispose, new Listener() {\r
 165             @Override\r
 166             public void handleEvent(Event event) {\r
 167                 PropertyPage.this.dispose();\r
 168             }\r
 169         });\r
 170         ISelectionProvider pv = pt.getSelectionProvider();\r
 171         getSite().setSelectionProvider(pv);\r
 172 \r
 173         fillToolBar(getSite().getActionBars().getToolBarManager());\r
 174         fillDropDownMenu(getSite().getActionBars().getMenuManager());\r
 175     }\r
 176 \r
 177     protected void fillToolBar(IToolBarManager manager) {\r
 178     }\r
 179 \r
 180     protected void fillDropDownMenu(IMenuManager manager) {\r
 181     }\r
 182 \r
 183     /**\r
 184      * @param newContext\r
 185      */\r
 186     protected final void setSessionContext(ISessionContext newContext) {\r
 187 //        ISessionContext oldContext = this.sessionContext;\r
 188         this.sessionContext = newContext;\r
 189 //        System.out.println("PropertyPage.setSessionContext: " + oldContext + " -> " + newContext);\r
 190     }\r
 191 \r
 192     protected ISessionContextChangedListener contextChangeListener = new ISessionContextChangedListener() {\r
 193         @Override\r
 194         public void sessionContextChanged(SessionContextChangedEvent event) {\r
 195             setSessionContext(event.getNewValue());\r
 196         }\r
 197     };\r
 198 \r
 199     @Override\r
 200     public Control getControl() {\r
 201         return (tab != null) ? tab.getControl() : null;\r
 202     }\r
 203 \r
 204     @Override\r
 205     public ISelection getSelection() {\r
 206         if (tab != null && !tab.isDisposed()) {\r
 207             ISelectionProvider provider = tab.getSelectionProvider();\r
 208             if (provider != null)\r
 209                 return provider.getSelection();\r
 210         }\r
 211         return null;\r
 212     }\r
 213 \r
 214     /**\r
 215      * Sets focus to a part in the page.\r
 216      * @see org.eclipse.ui.part.Page#setFocus()\r
 217      */\r
 218     @Override\r
 219     public void setFocus() {\r
 220         if (tab != null && !tab.isDisposed()) {\r
 221             tab.requestFocus();\r
 222         }\r
 223     }\r
 224 \r
 225     @Override\r
 226     protected void sourcePartClosed(IWorkbenchPart part) {\r
 227         if (tab != null && !tab.isDisposed()) {\r
 228             tab.setInput(getSessionContext(), StructuredSelection.EMPTY, false);\r
 229         }\r
 230     }\r
 231 \r
 232     @Override\r
 233     protected void sourceSelectionChanged(ISelection selection) {\r
 234         if (tab != null && !tab.isDisposed()) {\r
 235             latestSelection = selection;\r
 236             if(visible)\r
 237                 tab.setInput(getSessionContext(), selection, false);\r
 238         }\r
 239     }\r
 240 \r
 241     protected void refresh() {\r
 242         if (tab != null && !tab.isDisposed()) {\r
 243             tab.setInput(getSessionContext(), latestSelection, true);\r
 244         }\r
 245     }\r
 246 \r
 247     protected PartNameListener currentPartNameListener = null;\r
 248 \r
 249     @Override\r
 250     public void updatePartName(final ISelection forSelection, Consumer<String> updateCallback) {\r
 251         \r
 252         if(!visible) {\r
 253                 updateCallback.accept("Selection");\r
 254                 return;\r
 255         }\r
 256         \r
 257         PartNameListener oldListener = currentPartNameListener;\r
 258         PartNameListener newListener = new PartNameListener(updateCallback);\r
 259         currentPartNameListener = newListener;\r
 260         if (oldListener != null)\r
 261             oldListener.dispose();\r
 262 \r
 263         if (sessionContext != null) {\r
 264             sessionContext.getSession().asyncRequest(new Read<String>() {\r
 265                 @Override\r
 266                 public String perform(ReadGraph graph) throws DatabaseException {\r
 267                     return computeTitle(graph, forSelection);\r
 268                 }\r
 269             }, newListener);\r
 270         }\r
 271     }\r
 272 \r
 273     protected String computeTitle(ReadGraph graph, ISelection forSelection) throws DatabaseException {\r
 274         return PropertyPageUtil.computeTitle(graph, forSelection);\r
 275     }\r
 276 \r
 277     @SuppressWarnings("unchecked")\r
 278     @Override\r
 279     public <T> T getAdapter(Class<T> adapter) {\r
 280         if (adapter == IFilterAreaProvider.class)\r
 281             return (T) tab;\r
 282         return null;\r
 283     }\r
 284 \r
 285         @Override\r
 286         public void partActivated(IWorkbenchPartReference partRef) {\r
 287         }\r
 288 \r
 289         @Override\r
 290         public void partBroughtToTop(IWorkbenchPartReference partRef) {\r
 291         }\r
 292 \r
 293         @Override\r
 294         public void partClosed(IWorkbenchPartReference partRef) {\r
 295         }\r
 296 \r
 297         @Override\r
 298         public void partDeactivated(IWorkbenchPartReference partRef) {\r
 299         }\r
 300 \r
 301         @Override\r
 302         public void partOpened(IWorkbenchPartReference partRef) {\r
 303         }\r
 304 \r
 305         @Override\r
 306         public void partInputChanged(IWorkbenchPartReference partRef) {\r
 307         }\r
 308         \r
 309     @Override\r
 310     public void partHidden(IWorkbenchPartReference partRef) {\r
 311         IWorkbenchPart part = partRef.getPart(false);\r
 312         if (propertyPageView.equals(part)) {\r
 313                 visible = false;\r
 314         }\r
 315     }\r
 316 \r
 317     @Override\r
 318     public void partVisible(IWorkbenchPartReference partRef) {\r
 319         IWorkbenchPart part = partRef.getPart(false);\r
 320         if (propertyPageView.equals(part)) {\r
 321                 visible = true;\r
 322                 sourceSelectionChanged(latestSelection);\r
 323                 //System.err.println("[" + this + "]selection view was shown");\r
 324         }\r
 325     }\r
 326         \r
 327 }\r