Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.browsing.ui.common / src / org / simantics / browsing / ui / common / views / IViewArguments.java

diff --git a/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/views/IViewArguments.java b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/views/IViewArguments.java
new file mode 100644 (file)
index 0000000..b73a5e0
--- /dev/null
+++ b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/views/IViewArguments.java
@@ -0,0 +1,38 @@
+/*******************************************************************************\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.views;\r
+\r
+/**\r
+ * Generally usable arguments that can be provided to viewparts in their\r
+ * secondary ID.\r
+ * \r
+ * <p>\r
+ * The arguments are encoded in the secondary ID in a similar fashion as\r
+ * parameters are in HTTP request URLs. Arguments are separated by & characters.\r
+ * Each argument follows the pattern ([^:&=]*)=([^:&=]*). For example the full ID\r
+ * of a view might look like:\r
+ * </p>\r
+ * \r
+ * <pre>\r
+ *   view.id:input=foo&amp;another=bar\r
+ * </pre>\r
+ * \r
+ * <p>\r
+ * If the characters ':', '&' or '=' need to be used in parameter names or\r
+ * argument values, they must be escaped into %nn strings as in URIs.\r
+ * </p>\r
+ */\r
+public final class IViewArguments {\r
+\r
+    public static final String INPUT = "input";\r
+\r
+}\r