Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.browsing.ui.common / src / org / simantics / browsing / ui / common / node / IDeletable.java

diff --git a/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/node/IDeletable.java b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/node/IDeletable.java
new file mode 100644 (file)
index 0000000..5260644
--- /dev/null
+++ b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/node/IDeletable.java
@@ -0,0 +1,40 @@
+/*******************************************************************************\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.browsing.ui.common.node;\r
+\r
+/**\r
+ * A tag interface for indicating that a browser node may be considered\r
+ * deletable. It is used by model browser menu extensions to check whether to\r
+ * show the "delete" option to the user or not.\r
+ * \r
+ * <p>\r
+ * There are several ways of specifying the actual deletion procedure for your\r
+ * nodes.\r
+ * \r
+ * <ol>\r
+ * <li>To specify your own custom deletion logic, you can make your node\r
+ * implement {@link IDeletableNode}</li>\r
+ * <li>If your nodes are backed by database resources, you can make the nodes\r
+ * adaptable to Resource (which {@link AbstractNode} already is), and make your\r
+ * specific resource type adaptable to {@link Remover} (see <a\r
+ * href="https://www.simantics.org/wiki/index.php/Resource_Adaptation"\r
+ * >instructions</a>)</li>\r
+ * <li>Specify your own Eclipse command framework <code>IHandler</code>, using the\r
+ * org.eclipse.ui.handlers extension point, that is active only for your\r
+ * particular node input. Don't use this method unless you have to.</li>\r
+ * </ol>\r
+ * \r
+ * @see IDeletableNode\r
+ * @see AbstractNode\r
+ */\r
+public interface IDeletable {\r
+}
\ No newline at end of file