blob: db513996e19d436cc960dfe5ae8dded011609d36 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
/*******************************************************************************
* Copyright (c) 2001, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jst.j2ee.taglib.internal;
import org.eclipse.emf.common.util.EList;
import org.eclipse.jem.java.JavaClass;
import org.eclipse.jst.j2ee.common.DescriptionGroup;
/**
* The tag element defines an action in this tag library. The tag element has one attribute, id.
* The tag element may have several subelements defining:
* name -- The unique action name
* tag-class -- The tag handler class implementing javax.servlet.jsp.tagext.Tag
* tei-class -- An optional subclass of javax.servlet.jsp.tagext.TagExtraInfo
* body-content -- The body content type
* display-name -- A short name that is intended to be displayed by tools
* small-icon -- Optional small-icon that can be used by tools
* large-icon -- Optional large-icon that can be used by tools
* description -- Optional tag-specific information
* variable -- Optional scripting variable information
* attribute -- All attributes of this action
* example -- Optional informal description of an example of a use of this action.
*/
public interface JSPTag extends DescriptionGroup{
/**
* @generated This field/method will be replaced during code generation
* @return The value of the BodyContent attribute
* Provides a hint as to the content of the body of this tag. Primarily intended
* for use by page composition tools.There are currently three values specified:
*
* tagdependent - The body of the tag is interpreted by the tag implementation
* itself, and is most likely in a different "langage", e.g embedded SQL
* statements.
*
* JSP - The body of the tag contains nested JSP syntax
*
* empty - The body must be emptyThe default (if not defined) is JSP#PCDATA ::=
* tagdependent | JSP | empty
*/
BodyContentType getBodyContent();
/**
* Sets the value of the '{@link org.eclipse.jst.j2ee.taglib.internal.JSPTag#getBodyContent <em>Body Content</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Body Content</em>' attribute.
* @see org.eclipse.jst.j2ee.taglib.internal.BodyContentType
* @see #isSetBodyContent()
* @see #unsetBodyContent()
* @see #getBodyContent()
* @generated
*/
void setBodyContent(BodyContentType value);
/**
* Unsets the value of the '{@link org.eclipse.jst.j2ee.taglib.internal.JSPTag#getBodyContent <em>Body Content</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #isSetBodyContent()
* @see #getBodyContent()
* @see #setBodyContent(BodyContentType)
* @generated
*/
void unsetBodyContent();
/**
* Returns whether the value of the '{@link org.eclipse.jst.j2ee.taglib.internal.JSPTag#getBodyContent <em>Body Content</em>}' attribute is set.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return whether the value of the '<em>Body Content</em>' attribute is set.
* @see #unsetBodyContent()
* @see #getBodyContent()
* @see #setBodyContent(BodyContentType)
* @generated
*/
boolean isSetBodyContent();
/**
* @generated This field/method will be replaced during code generation
* @return The value of the Example attribute
* The example element provides an informal description of an example of the use
* of a tag.
*/
String getExample();
/**
* @generated This field/method will be replaced during code generation
* @param value The new value of the Example attribute
*/
void setExample(String value);
/**
* Returns the value of the '<em><b>Name</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Name</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Name</em>' attribute.
* @see #setName(String)
* @see org.eclipse.jst.j2ee.taglib.internal.TaglibPackage#getJSPTag_Name()
* @model
* @generated
*/
String getName();
/**
* Sets the value of the '{@link org.eclipse.jst.j2ee.taglib.internal.JSPTag#getName <em>Name</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Name</em>' attribute.
* @see #getName()
* @generated
*/
void setName(String value);
/**
* Returns the value of the '<em><b>Dynamic Attributes</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Dynamic Attributes</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Dynamic Attributes</em>' attribute.
* @see #setDynamicAttributes(boolean)
* @see org.eclipse.jst.j2ee.taglib.internal.TaglibPackage#getJSPTag_DynamicAttributes()
* @model
* @generated
*/
boolean isDynamicAttributes();
/**
* Sets the value of the '{@link org.eclipse.jst.j2ee.taglib.internal.JSPTag#isDynamicAttributes <em>Dynamic Attributes</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Dynamic Attributes</em>' attribute.
* @see #isDynamicAttributes()
* @generated
*/
void setDynamicAttributes(boolean value);
/**
* @generated This field/method will be replaced during code generation
* @return The list of Attributes references
*/
EList getAttributes();
/**
* @generated This field/method will be replaced during code generation
* @return The list of Variables references
* The variable element provides information on the scripting variables defined by
* this tag.
* It is a (translation time) error for an action that has one or more variable
* subelements to have a TagExtraInfo class that returns a non-null object.
* The subelements of variable are of the form:
* name-given -- The variable name as a constant
* name-from-attribute -- The name of an attribute whose (translation time) value
* will give the name of the variable. One of name-given or namefrom-attribute is
* required.
* variable-class -- Name of the class of the variable. java.lang.String is
* default.
* declare -- Whether the variable is declared or not. True is the default.
* scope -- The scope of the scripting variable defined. NESTED is default.
*/
EList getVariables();
/**
* @generated This field/method will be replaced during code generation
* @return The TagClass reference
* The tag-class element indicates the subclass of javax.serlvet.jsp.tagext.Tag
* that implements the request time semantics for this tag. This element is
* required.
* @regexp fully qualified Java class name
*/
JavaClass getTagClass();
/**
* @generated This field/method will be replaced during code generation
* @param l The new value of the TagClass reference
*/
void setTagClass(JavaClass value);
/**
* @generated This field/method will be replaced during code generation
* @return The TeiClass reference
* The tei-class element indicates the subclass of
* javax.servlet.jsp.tagext.TagExtraInfo for this tag. The class is instantiated
* at translation time. This element is optional.
* @regexp fully qualified Java class name
*/
JavaClass getTeiClass();
/**
* @generated This field/method will be replaced during code generation
* @param l The new value of the TeiClass reference
*/
void setTeiClass(JavaClass value);
}
|
