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