-/*******************************************************************************\r
- * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
- * in Industry THTH ry.\r
- * All rights reserved. This program and the accompanying materials\r
- * are made available under the terms of the Eclipse Public License v1.0\r
- * which accompanies this distribution, and is available at\r
- * http://www.eclipse.org/legal/epl-v10.html\r
- *\r
- * Contributors:\r
- * VTT Technical Research Centre of Finland - initial API and implementation\r
- *******************************************************************************/\r
-package org.simantics.selectionview;\r
-\r
-import org.eclipse.jface.viewers.ISelection;\r
-import org.eclipse.jface.viewers.ISelectionProvider;\r
-import org.eclipse.jface.viewers.IStructuredSelection;\r
-import org.eclipse.swt.widgets.Composite;\r
-import org.eclipse.swt.widgets.Control;\r
-import org.simantics.db.management.ISessionContext;\r
-\r
-/**\r
- * @author Tuukka Lehtonen\r
- * \r
- * @see PropertyTabAdapter\r
- * @see PropertyTabContributorImpl\r
- */\r
-public interface IPropertyTab {\r
-\r
- /**\r
- * Creates the SWT control for this page under the given parent\r
- * control.\r
- * <p>\r
- * Clients should not call this method (the workbench calls this method when\r
- * it needs to, which may be never).\r
- * </p>\r
- *\r
- * @param parent the parent control\r
- */\r
- void createControl(Composite parent, ISessionContext context);\r
-\r
- /**\r
- * Notifies that the container of the tab has been disposed.\r
- * \r
- * <p>\r
- * Note, this means that any Dispose-listeners attached to SWT controls\r
- * created for this tab have been invoked before this already.\r
- * </p>\r
- * <p>\r
- * Also note that there is no guarantee that\r
- * {@link #createControl(Composite, ISessionContext)} has been called before\r
- * this method so the control may never have been created.\r
- * </p>\r
- */\r
- void dispose();\r
-\r
- /**\r
- * @return <code>true</code> if this tab has been disposed either through\r
- * {@link #dispose()} or internally by the UI toolkit\r
- */\r
- boolean isDisposed();\r
-\r
- /**\r
- * @return the main UI control created by this tab\r
- */\r
- Control getControl();\r
-\r
- /**\r
- * Must be invoked from the SWT UI thread.\r
- * \r
- * @param selection the new selection\r
- * @param force <code>true</code> to force the resetting of the new input\r
- * even if it is the same as the previous one.\r
- */\r
- void setInput(ISessionContext context, ISelection selection, boolean force);\r
-\r
- /**\r
- * Returns the selection provider for this property tab. It shall provide\r
- * the currently active selection for this tab. If the tab does not wish to\r
- * provide its selection to external parties, <code>null</code> may be\r
- * returned. The selections must be instances of\r
- * {@link IStructuredSelection}.\r
- * \r
- * @return structured selection provider or <code>null</code> if no\r
- * selection is provided\r
- */\r
- ISelectionProvider getSelectionProvider();\r
-\r
- /**\r
- * Requests this property tab to transfer UI focus to itself.\r
- */\r
- void requestFocus();\r
-\r
+/*******************************************************************************
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management
+ * in Industry THTH ry.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * VTT Technical Research Centre of Finland - initial API and implementation
+ *******************************************************************************/
+package org.simantics.selectionview;
+
+import org.eclipse.jface.viewers.ISelection;
+import org.eclipse.jface.viewers.ISelectionProvider;
+import org.eclipse.jface.viewers.IStructuredSelection;
+import org.eclipse.swt.widgets.Composite;
+import org.eclipse.swt.widgets.Control;
+import org.simantics.db.management.ISessionContext;
+
+/**
+ * @author Tuukka Lehtonen
+ *
+ * @see PropertyTabAdapter
+ * @see PropertyTabContributorImpl
+ */
+public interface IPropertyTab {
+
+ /**
+ * Creates the SWT control for this page under the given parent
+ * control.
+ * <p>
+ * Clients should not call this method (the workbench calls this method when
+ * it needs to, which may be never).
+ * </p>
+ *
+ * @param parent the parent control
+ */
+ void createControl(Composite parent, ISessionContext context);
+
+ /**
+ * Notifies that the container of the tab has been disposed.
+ *
+ * <p>
+ * Note, this means that any Dispose-listeners attached to SWT controls
+ * created for this tab have been invoked before this already.
+ * </p>
+ * <p>
+ * Also note that there is no guarantee that
+ * {@link #createControl(Composite, ISessionContext)} has been called before
+ * this method so the control may never have been created.
+ * </p>
+ */
+ void dispose();
+
+ /**
+ * @return <code>true</code> if this tab has been disposed either through
+ * {@link #dispose()} or internally by the UI toolkit
+ */
+ boolean isDisposed();
+
+ /**
+ * @return the main UI control created by this tab
+ */
+ Control getControl();
+
+ /**
+ * Must be invoked from the SWT UI thread.
+ *
+ * @param selection the new selection
+ * @param force <code>true</code> to force the resetting of the new input
+ * even if it is the same as the previous one.
+ */
+ void setInput(ISessionContext context, ISelection selection, boolean force);
+
+ /**
+ * Returns the selection provider for this property tab. It shall provide
+ * the currently active selection for this tab. If the tab does not wish to
+ * provide its selection to external parties, <code>null</code> may be
+ * returned. The selections must be instances of
+ * {@link IStructuredSelection}.
+ *
+ * @return structured selection provider or <code>null</code> if no
+ * selection is provided
+ */
+ ISelectionProvider getSelectionProvider();
+
+ /**
+ * Requests this property tab to transfer UI focus to itself.
+ */
+ void requestFocus();
+
}
\ No newline at end of file
Code Review / simantics / platform.git / blobdiff