bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/views/IViewArguments.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
   3  * in Industry THTH ry.\r
   4  * All rights reserved. This program and the accompanying materials\r
   5  * are made available under the terms of the Eclipse Public License v1.0\r
   6  * which accompanies this distribution, and is available at\r
   7  * http://www.eclipse.org/legal/epl-v10.html\r
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 package org.simantics.browsing.ui.common.views;\r
  13 \r
  14 /**\r
  15  * Generally usable arguments that can be provided to viewparts in their\r
  16  * secondary ID.\r
  17  * \r
  18  * <p>\r
  19  * The arguments are encoded in the secondary ID in a similar fashion as\r
  20  * parameters are in HTTP request URLs. Arguments are separated by & characters.\r
  21  * Each argument follows the pattern ([^:&=]*)=([^:&=]*). For example the full ID\r
  22  * of a view might look like:\r
  23  * </p>\r
  24  * \r
  25  * <pre>\r
  26  *   view.id:input=foo&amp;another=bar\r
  27  * </pre>\r
  28  * \r
  29  * <p>\r
  30  * If the characters ':', '&' or '=' need to be used in parameter names or\r
  31  * argument values, they must be escaped into %nn strings as in URIs.\r
  32  * </p>\r
  33  */\r
  34 public final class IViewArguments {\r
  35 \r
  36     public static final String INPUT = "input";\r
  37 \r
  38 }\r