Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.editors.win32 / src / org / simantics / editors / win32 / ole / EditorDefinition.java

diff --git a/bundles/org.simantics.editors.win32/src/org/simantics/editors/win32/ole/EditorDefinition.java b/bundles/org.simantics.editors.win32/src/org/simantics/editors/win32/ole/EditorDefinition.java
new file mode 100644 (file)
index 0000000..2e7fa1f
--- /dev/null
+++ b/bundles/org.simantics.editors.win32/src/org/simantics/editors/win32/ole/EditorDefinition.java
@@ -0,0 +1,52 @@
+/*******************************************************************************\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.editors.win32.ole;\r
+\r
+import org.eclipse.swt.ole.win32.OleAutomation;\r
+import org.eclipse.swt.ole.win32.OleClientSite;\r
+import org.eclipse.swt.ole.win32.OleFrame;\r
+\r
+/**\r
+ * ControllerFactory for embedding OLE editors into eclipse\r
+ * There are three different methods to integrate editors to eclipse\r
+ * 1. Use browser integration\r
+ * 2. Use OLE's automatic resolver\r
+ * 3. Using progID to get ActiveX control, and managing that control by self supplied code.\r
+ * \r
+ * @author Marko Luukkainen <marko.luukkainen@vtt.fi>\r
+ *\r
+ */\r
+public interface EditorDefinition {\r
+       \r
+       public boolean supportSuffix(String suffix);\r
+       \r
+       /**\r
+        * Use embedded browser to show the input\r
+        * @return\r
+        */\r
+       public boolean useBrowser();\r
+       \r
+       /**\r
+        * Use OLE's automatic resolver for embedding\r
+        * @return\r
+        */\r
+       public boolean useFileInput();\r
+       \r
+       /**\r
+        * Returns ActiveX component's progID\r
+        * @return\r
+        */\r
+       public String getProgID();\r
+       \r
+       public OleController createController(OleFrame frame, OleClientSite site, OleAutomation auto);\r
+\r
+}\r