Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.g2d / src / org / simantics / g2d / chassis / ICanvasChassis.java

diff --git a/bundles/org.simantics.g2d/src/org/simantics/g2d/chassis/ICanvasChassis.java b/bundles/org.simantics.g2d/src/org/simantics/g2d/chassis/ICanvasChassis.java
new file mode 100644 (file)
index 0000000..eff04cd
--- /dev/null
+++ b/bundles/org.simantics.g2d/src/org/simantics/g2d/chassis/ICanvasChassis.java
@@ -0,0 +1,76 @@
+/*******************************************************************************\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
+/*\r
+ *\r
+ * @author Toni Kalajainen\r
+ */\r
+package org.simantics.g2d.chassis;\r
+\r
+import org.simantics.g2d.canvas.ICanvasContext;\r
+import org.simantics.utils.datastructures.hints.IHintContext;\r
+import org.simantics.utils.threads.IThreadWorkQueue;\r
+\r
+\r
+/**\r
+ * Canvas chassis is a user operable base for canvas contexts\r
+ *\r
+ * @See {@link AWTChassis}\r
+ * @See {@link SWTChassis}\r
+ * @See {@link FullscreenChassis} Full screen chassis\r
+ * @See {@link ImageChassis} Renders to a bitmap\r
+ */\r
+public interface ICanvasChassis {\r
+\r
+    /**\r
+     * Get the hint context of the chassis\r
+     * @return\r
+     */\r
+    IHintContext getHintContext();\r
+    \r
+    /**\r
+     * Set canvas context into the chassis\r
+     */\r
+    void setCanvasContext(ICanvasContext canvasContext);\r
+    \r
+    /**\r
+     * Get canvas context\r
+     * @return <code>null</code> if the chassis has no canvas context at the moment\r
+     */\r
+    ICanvasContext getCanvasContext();\r
+    \r
+    /**\r
+     * Add chassis listener\r
+     * @param threadAccess\r
+     * @param listener\r
+     */\r
+    void addChassisListener(IThreadWorkQueue threadAccess, IChassisListener listener);\r
+    \r
+    /**\r
+     * \r
+     * @param threadAccess\r
+     * @param listener\r
+     */\r
+    void removeChassisListener(IThreadWorkQueue threadAccess, IChassisListener listener);\r
+    \r
+    /**\r
+     * \r
+     * @param listener\r
+     */\r
+    void addChassisListener(IChassisListener listener);\r
+    \r
+    /**\r
+     * \r
+     * @param listener\r
+     */\r
+    void removeChassisListener(IChassisListener listener);\r
+    \r
+}\r