KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > internal > cheatsheets > data > IParserTags


1 /*******************************************************************************
2  * Copyright (c) 2002, 2007 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/

11 package org.eclipse.ui.internal.cheatsheets.data;
12
13 /**
14  * Interface containing the constants used by the cheatsheet parser
15  * to identify the tags used in the cheatsheet file.
16  */

17 public interface IParserTags {
18
19     /*
20      * <!ELEMENT cheatsheet (intro, item+)>
21      * <!ATTLIST cheatsheet
22      * title CDATA #REQUIRED
23      * >
24      */

25     public static final String JavaDoc CHEATSHEET = "cheatsheet"; //$NON-NLS-1$
26
public static final String JavaDoc TITLE = "title"; //$NON-NLS-1$
27

28     /*
29      * <!ELEMENT intro (description)>
30      * <!ATTLIST intro
31      * contextId CDATA #IMPLIED
32      * href CDATA #IMPLIED
33      * >
34      */

35     public static final String JavaDoc INTRO = "intro"; //$NON-NLS-1$
36
public static final String JavaDoc CONTEXTID = "contextId"; //$NON-NLS-1$
37
public static final String JavaDoc HREF = "href"; //$NON-NLS-1$
38

39     /*
40      * <!ELEMENT description ()>
41      * <!ATTLIST description
42      * >
43      */

44     public static final String JavaDoc DESCRIPTION = "description"; //$NON-NLS-1$
45
public static final String JavaDoc BOLD = "b"; //$NON-NLS-1$
46
public static final String JavaDoc BREAK = "br"; //$NON-NLS-1$
47
public static final String JavaDoc BOLD_START_TAG = "<b>"; //$NON-NLS-1$
48
public static final String JavaDoc BOLD_END_TAG = "</b>"; //$NON-NLS-1$
49
public static final String JavaDoc BREAK_TAG = "<br/>"; //$NON-NLS-1$
50
public static final String JavaDoc FORM_START_TAG = "<form><p>"; //$NON-NLS-1$
51
public static final String JavaDoc FORM_END_TAG = "</p></form>"; //$NON-NLS-1$
52

53     
54     /*
55      * <!ELEMENT item (description [action|perform-when] | (subitem|repeated-subitem|conditional-subitem)*)>
56      * <!ATTLIST item
57      * title CDATA #REQUIRED
58      * dialog ("true" | "false") "false"
59      * skip ("true" | "false") "false"
60      * contextId CDATA #IMPLIED
61      * href CDATA #IMPLIED
62      * >
63      */

64     public static final String JavaDoc ITEM = "item"; //$NON-NLS-1$
65
public static final String JavaDoc DIALOG = "dialog"; //$NON-NLS-1$
66
public static final String JavaDoc SKIP = "skip"; //$NON-NLS-1$
67

68     /*
69      * <!ELEMENT subitem ( [action|perform-when] )>
70      * <!ATTLIST subitem
71      * label CDATA #REQUIRED
72      * skip ("true" | "false") "false"
73      * when CDATA #IMPLIED
74      * >
75      */

76     public static final String JavaDoc SUBITEM = "subitem"; //$NON-NLS-1$
77
public static final String JavaDoc LABEL = "label"; //$NON-NLS-1$
78
public static final String JavaDoc WHEN = "when"; //$NON-NLS-1$
79

80     /*
81      * <!ELEMENT conditional-subitem (subitem+)>
82      * <!ATTLIST conditional-subitem
83      * condition CDATA #REQUIRED
84      * >
85      */

86     public static final String JavaDoc CONDITIONALSUBITEM = "conditional-subitem"; //$NON-NLS-1$
87
public static final String JavaDoc CONDITION = "condition"; //$NON-NLS-1$
88

89     /*
90      * <!ELEMENT repeated-subitem (subitem)>
91      * <!ATTLIST repeated-subitem
92      * values CDATA #REQUIRED
93      * >
94      */

95     public static final String JavaDoc REPEATEDSUBITM = "repeated-subitem"; //$NON-NLS-1$
96
public static final String JavaDoc VALUES = "values"; //$NON-NLS-1$
97

98     /*
99      * <!ELEMENT action EMPTY>
100      * <!ATTLIST action
101      * class CDATA #REQUIRED
102      * pluginId CDATA #REQUIRED
103      * param1 CDATA #IMPLIED
104      * ...
105      * param9 CDATA #IMPLIED
106      * confirm ("true" | "false") "false"
107      * when CDATA #IMPLIED
108      * >
109      */

110     public static final String JavaDoc ACTION = "action"; //$NON-NLS-1$
111
public static final String JavaDoc CLASS = "class"; //$NON-NLS-1$
112
public static final String JavaDoc PLUGINID = "pluginId"; //$NON-NLS-1$
113
public static final String JavaDoc PARAM = "param"; //$NON-NLS-1$
114
public static final String JavaDoc CONFIRM = "confirm"; //$NON-NLS-1$
115

116     /*
117      * <!ELEMENT perform-when (action+)>
118      * <!ATTLIST perform-when
119      * condition CDATA #REQUIRED
120      * >
121      */

122     public static final String JavaDoc PERFORMWHEN = "perform-when"; //$NON-NLS-1$
123

124     // Miscellaneous tags
125
public static final String JavaDoc COMMAND = "command"; //$NON-NLS-1$
126
public static final String JavaDoc SERIALIZATION = "serialization"; //$NON-NLS-1$
127
public static final String JavaDoc RETURNS = "returns"; //$NON-NLS-1$
128
public static final String JavaDoc ON_COMPLETION = "onCompletion"; //$NON-NLS-1$
129
public static final String JavaDoc CONTENT_URL = "contentURL"; //$NON-NLS-1$
130
public static final String JavaDoc REQUIRED = "required"; //$NON-NLS-1$
131
public static final String JavaDoc TRANSLATE = "translate"; //$NON-NLS-1$
132

133     // Constants for re-escaping XML characters
134
public static final String JavaDoc LESS_THAN = "&lt;"; //$NON-NLS-1$
135
public static final String JavaDoc GREATER_THAN = "&gt;"; //$NON-NLS-1$
136
public static final String JavaDoc AMPERSAND = "&amp;"; //$NON-NLS-1$
137
public static final String JavaDoc APOSTROPHE = "&apos;"; //$NON-NLS-1$
138
public static final String JavaDoc QUOTE = "&quot;"; //$NON-NLS-1$
139

140
141     // Cheat Sheet state data key
142
public static final String JavaDoc ID = "id";//$NON-NLS-1$
143
public static final String JavaDoc MANAGERDATA = "CSMData";//$NON-NLS-1$
144
public static final String JavaDoc MANAGERDATAKEY = "key"; //$NON-NLS-1$
145
public static final String JavaDoc MANAGERDATAVALUE = "value"; //$NON-NLS-1$
146
public static final String JavaDoc COMPLETED ="completed"; //$NON-NLS-1$
147
public static final String JavaDoc CURRENT = "current"; //$NON-NLS-1$
148
public static final String JavaDoc SUBITEMCOMPLETED ="subitemcompleted"; //$NON-NLS-1$
149
public static final String JavaDoc SUBITEMSKIPPED ="subitemskipped"; //$NON-NLS-1$
150
public static final String JavaDoc EXPANDED = "expanded"; //$NON-NLS-1$
151
public static final String JavaDoc EXPANDRESTORE = "expandRestore"; //$NON-NLS-1$
152
public static final String JavaDoc BUTTON = "button"; //$NON-NLS-1$
153
public static final String JavaDoc BUTTONSTATE = "buttonstate"; //$NON-NLS-1$
154
public static final String JavaDoc PATH = "path"; //$NON-NLS-1$
155
public static final String JavaDoc CHEATSHEET_STATE_REFERENCE = "CHEATSHEET_STATE_REFERENCE"; //$NON-NLS-1$
156
public static final String JavaDoc CHEATSHEET_STATE = "cheatsheetState"; //$NON-NLS-1$
157

158 }
159
Popular Tags