Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.g2d / src / org / simantics / g2d / element / handler / InternalSize.java

diff --git a/bundles/org.simantics.g2d/src/org/simantics/g2d/element/handler/InternalSize.java b/bundles/org.simantics.g2d/src/org/simantics/g2d/element/handler/InternalSize.java
new file mode 100644 (file)
index 0000000..d23a2d9
--- /dev/null
+++ b/bundles/org.simantics.g2d/src/org/simantics/g2d/element/handler/InternalSize.java
@@ -0,0 +1,49 @@
+/*******************************************************************************\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.g2d.element.handler;\r
+\r
+import java.awt.geom.Rectangle2D;\r
+\r
+import org.simantics.g2d.element.IElement;\r
+import org.simantics.g2d.element.ElementClass.Required;\r
+import org.simantics.g2d.element.ElementClass.Single;\r
+import org.simantics.g2d.element.handler.impl.FixedSize;\r
+import org.simantics.g2d.element.handler.impl.Resizeable;\r
+\r
+/**\r
+ * This interface is used for handling elements internal size.\r
+ * \r
+ * See default implementations:\r
+ * \r
+ * @See {@link FixedSize} size is fixed\r
+ * @See {@link Resizeable} size can be changed by user\r
+ * \r
+ * @author Toni Kalajainen\r
+ */\r
+@Single\r
+@Required\r
+public interface InternalSize extends ElementHandler {\r
+\r
+    /**\r
+     * Return the size of the element (in element coordinates). It is possible\r
+     * for an element to not have bounds. See return value specification for how\r
+     * to notice this.\r
+     * \r
+     * @param e element to get bounds for\r
+     * @param size size to be written to, or null (instantiates new)\r
+     * @return internal size of the element or the size argument as is if the\r
+     *         specified element does not have bounds (i.e. is hidden or\r
+     *         otherwise does not have a visual representation)\r
+     */\r
+    Rectangle2D getBounds(IElement e, Rectangle2D size);\r
+\r
+}\r