data.jsp.xml Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of languagesupport Show documentation
Show all versions of languagesupport Show documentation
A library adding code completion and other advanced features for Java, JavaScript, Perl, and other languages to RSyntaxTextArea.
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE api SYSTEM "CompletionXml.dtd">
<!--
jsp.xml - API specification for standard JSP tags.
Used by RSyntaxTextArea to provide code completion.
Author: Robert Futrell
Version: 0.1
This file was generated from: C:/dev/rsta/RSTALanguageSupport/data/jsp/create_jsp_xml.pl
on date: 2012-04-29 00:11:55
-->
<api language="JSP">
<!--
<environment paramStartChar="(" paramEndChar=")" paramSeparator=", " terminal=";" />
-->
<keywords>
<keyword name="jsp:attribute" type="tag">
<desc><![CDATA[The jsp:attribute standard action has two uses:<br>
<ul>
<li>It allows the page author to define the value of an action attribute in the body of an XML element instead of in the value of an XML attribute.
<li>It allows the page author to specify the attributes of an element dynamically generated by the <code>jsp:element</code> action, which can only appear as a subelement of a standard or custom action.
</ul><br>
All JSP standard actions and custom actions can contain a <code>jsp:attribute</code> standard element as a substitute for any of its attributes. One use case in which <code>jsp:attribute</code> is particularly helpful is where the value of an attribute is the result of a multi-line expression, which would not fit in the value of an attribute in the start tag of the action.<br>
<br>
If an action contains any <code>jsp:attribute</code> elements and the action also has a body, it must use the <code>jsp:body</code> tag to represent the body. The body of <code>jsp:attribute</code> is restricted according to the type of attribute being specified:<br>
<br>
<ul>
<li>For simple attributes that accept an EL expression, the body can be any JSP content.
<li>For simple attributes that do not accept an EL expression, the body can contain only static text.
<li>For fragment attributes, the body must not contain any scripting elements.
</ul><br>
]]></desc>
<params>
<param name="name" type="">
<desc><![CDATA[The name of an instance of a bean that has already been created or located with a jsp:useBean element. The value of name must match the value of id in jsp:useBean. The jsp:useBean element must appear before jsp:setProperty in the JSP page.<br>
]]></desc>
</param>
<param name="trim" type="">
<desc><![CDATA[The optional trim attribute determines whether or not whitespace appearing at the beginning and end of the element body should be discarded. By default, the leading and trailing whitespace (including spaces, carriage returns, line feeds, and tabs) is discarded. The whitespace is trimmed when the JSP page is translated. If a body contains a custom tag that produces leading or trailing whitespace, that whitespace is preserved regardless of the value of the trim attribute.<br>
<br>
]]></desc>
</param>
</params>
</keyword>
<keyword name="jsp:body" type="tag">
<desc><![CDATA[Normally, the body of a standard or custom action invocation is defined implicitly as the body of the XML element used to represent the invocation. The body of a standard or custom action can also be defined explicitly using the <code>jsp:body</code> standard action. This is required if one or more <code>jsp:attribute</code> elements appear in the body of the tag.<br>
<br>
<br>
If one or more <code>jsp:attribute</code> elements appear in the body of a tag invocation but no <code>jsp:body</code> element appears or an empty <code>jsp:body</code> element appears, it is the equivalent of the tag having an empty body.<br>
<br>
It is also legal to use the <code>jsp:body</code> standard action to supply bodies to any standard actions that accepts a body (except for <code>jsp:body</code>, <code>jsp:attribute</code>, <code>jsp:scriptlet</code>, <code>jsp:expression</code>, and <code>jsp:declaration</code>). The body standard action accepts no attributes.<br>
]]></desc>
</keyword>
<keyword name="jsp:element" type="tag">
<desc><![CDATA[The <code>jsp:element</code> action is used to dynamically define the value of the tag of an XML element. This action can be used in JSP pages, tag files and JSP documents.<br>
<br>
<br>
A <code>jsp:element</code> action has one mandatory attribute, name, of type String. The value of the name attribute is used as that of the tag of the element generated. The <code>jsp:element</code> action can have a body. Two forms are valid, depending on whether the element is to have attributes or not. In the first form, no attributes are present:<br>
<blockquote><pre><jsp:element name="name">
optional body
</jsp:element>
</pre></blockquote><br>
In the second form, zero or more attributes are requested, using jsp:attribute and <code>jsp:body</code>, as appropriate.<br>
<br>
<blockquote><pre><jsp:element name="name">
[jsp:attribute]+
[jsp:body]
</jsp:element>
</pre></blockquote><br>
The one valid, mandatory, attribute of <code>jsp:element</code> is its name. Unlike other standard actions, the value of the name attribute must be given as an XML-style attribute and cannot be specified using <code>jsp:attribute</code> This is because <code>jsp:attribute</code> has a special meaning when used in the body of <code>jsp:element</code>.<br>
]]></desc>
<params>
<param name="name" type="">
<desc><![CDATA[The name of an instance of a bean that has already been created or located with a jsp:useBean element. The value of name must match the value of id in jsp:useBean. The jsp:useBean element must appear before jsp:setProperty in the JSP page.<br>
]]></desc>
</param>
</params>
</keyword>
<keyword name="jsp:fallback" type="tag">
<desc><![CDATA[An optional child element of <code>jsp:plugin</code>. A text message to display for the user if the plug-in cannot be started. If the plug-in starts but the applet or bean does not, the plug-in usually displays a popup window explaining the error to the user.<br>
<br>
]]></desc>
</keyword>
<keyword name="jsp:forward" type="tag">
<desc><![CDATA[The <code>jsp:forward</code> element forwards the <code>request</code> object containing the client request information from one JSP page to another resource. The target resource can be an HTML file, another JSP page, or a servlet, as long as it is in the same application context as the forwarding JSP page. The lines in the source JSP page after the <code>jsp:forward</code> element are not processed.<br>
<br>
You can pass parameter names and values to the target resource by using a <code>jsp:param</code> clause. An example of this would be passing the parameter name <code>username</code> (with <code>name="username"</code>) and the value <code>scott</code> (with <code>value="scott"</code>) to a servlet as part of the request. If you use <code>jsp:param</code>, the target resource should be a dynamic resource that can handle the parameters.<br>
<br>
<br>
Be careful when using <code>jsp:forward</code> with unbuffered output. If you have used the page directive with <code>buffer="none"</code> to specify that the output of your JSP page should not be buffered, and if the JSP page has any data in the out object, using <code>jsp:forward</code> will cause an <code>IllegalStateException</code>.<br>
]]></desc>
<params>
<param name="page" type="">
<desc><![CDATA[The relative URL that locates the resource to be included, or an expression that evaluates to a String equivalent to the relative URL.<br>
<br>
The relative URL looks like a pathname--it cannot contain a protocol name, port number, or domain name. The URL can be absolute or relative to the current JSP page. If it is absolute (beginning with a /), the pathname is resolved by your web or application server.<br>
]]></desc>
</param>
</params>
</keyword>
<keyword name="jsp:getProperty" type="tag">
<desc><![CDATA[The <code>jsp:getProperty</code> element gets a bean property value using the property's getter methods and inserts the value into the response. You must create or locate a bean with <jsp:useBean> <em>before</em> you use <code>jsp:getProperty</code>.<br>
<br>
The <code>jsp:getProperty</code> element has a few limitations you should be aware of:<br>
<br>
<ul>
<li>You cannot use <code>jsp:getProperty</code> to retrieve the values of an indexed property.
<li>You can use <code>jsp:getProperty</code> with JavaBeans components, but not with enterprise beans. As alternatives, you can write a JSP page that retrieves values from a bean that in turn retrieves values from an enterprise bean, or you can write a custom tag that retrieves values from an enterprise bean directly.
</ul><br>
<br>
]]></desc>
<params>
<param name="name" type="">
<desc><![CDATA[The name of an instance of a bean that has already been created or located with a jsp:useBean element. The value of name must match the value of id in jsp:useBean. The jsp:useBean element must appear before jsp:setProperty in the JSP page.<br>
]]></desc>
</param>
<param name="property" type="">
<desc><![CDATA[The name of the property to set.<br>
]]></desc>
</param>
</params>
</keyword>
<keyword name="jsp:include" type="tag">
<desc><![CDATA[The <code>jsp:include</code> element allows you to include either a <em>static </em>or <em>dynamic</em> <em>resource</em> in a JSP page. The results of including static and dynamic resources are quite different. If the resource is static, its content is included in the calling JSP page. If the resource is dynamic, it acts on a request and sends back a result that is included in the JSP page. When the include action is finished, the JSP container continues processing the remainder of the JSP page.<br>
<br>
<br>
You cannot always determine from a pathname if a resource is static or dynamic. For example, <em>http://server:8080/index.html</em> might map to a servlet through a server alias. The <code>jsp:include</code> element handles both types of resources, so it is convenient to use when you don't know whether the resource is static or dynamic.<br>
<br>
If the included resource is dynamic, you can use a <code>jsp:param</code> clause to pass the name and value of a parameter to the resource. As an example, you could pass the string <code>username</code> and a user's name to a login form that is coded in a JSP page.<br>
<br>
]]></desc>
<params>
<param name="flush" type="">
<desc><![CDATA[If the page output is buffered and the flush attribute is given a true value, the buffer is flushed prior to the inclusion, otherwise the buffer is not flushed. The default value for the flush attribute is false.<br>
<br>
]]></desc>
</param>
<param name="page" type="">
<desc><![CDATA[The relative URL that locates the resource to be included, or an expression that evaluates to a String equivalent to the relative URL.<br>
<br>
The relative URL looks like a pathname--it cannot contain a protocol name, port number, or domain name. The URL can be absolute or relative to the current JSP page. If it is absolute (beginning with a /), the pathname is resolved by your web or application server.<br>
]]></desc>
</param>
</params>
</keyword>
<keyword name="jsp:invoke" type="tag">
<desc><![CDATA[The <code>jsp:invoke</code> standard action takes the name of an attribute that is a fragment, and invokes the fragment, sending the output of the result to the <code>JspWriter</code>, or to a scoped attribute that can be examined and manipulated. If the fragment identified by the given name is null, <code>jsp:invoke</code> will behave as though a fragment was passed in that produces no output.<br>
<br>
The most basic usage of this standard action will invoke a fragment with the given name with no parameters. It is also possible to invoke the fragment and send the results to a scoped attribute for further examination and manipulation. This can be accomplished by specifying the <code>var</code> or <code>varReader</code> attribute in the action. If var is specified, the container stores the result in an EL variable of type <code>String</code> with the name specified by <code>var</code>. If <code>varReader</code> is specified, the container stores the result in an EL variable of type <code>java.io.Reader</code>, with the name specified by <code>varReader</code>. The <code>Reader</code> object can then be passed to a custom tag for further processing. A translation error occurs if both <code>var</code> and <code>varReader</code> are specified.<br>
]]></desc>
<params>
<param name="fragment" type="">
<desc><![CDATA[The name used to identify this fragment during this tag invocation.<br>
]]></desc>
</param>
<param name="scope" type="[<b>page</b>, request, session, application]">
<desc><![CDATA[The scope in which the bean exists and the variable named in id is available. The default value is page. The meanings of the different scopes are shown below:<br>
<br>
page You can use the bean within the JSP page with the jsp:useBean element or any of the page's static include files, until the page sends a response back to the client or forwards a request to another resource.<br>
<br>
request You can use the bean from any JSP page processing the same request, until a JSP page sends a response to the client or forwards the request to another resource. You can use the request object to access the bean, for example, request.getAttribute(beanInstanceName).<br>
<br>
session You can use the bean from any JSP page in the same session as the JSP page that created the bean. The bean exists across the entire session, and any page that participates in the session can use it. The page in which you create the bean must have a page directive with session="true".<br>
<br>
application You can use the bean from any JSP page in the same application as the JSP page that created the bean. The bean exists across an entire JSP application, and any page in the application can use the bean.<br>
]]></desc>
</param>
<param name="var" type="">
<desc><![CDATA[The name of a scoped attribute to store the result of the fragment invocation in, as a java.lang.String object. A translation error must occur if both var and varReader are specified. If neither var nor varReader are specified, the result of the fragment goes directly to the JspWriter.<br>
]]></desc>
</param>
<param name="varReader" type="">
<desc><![CDATA[The name of a scoped attribute to store the result of the fragment invocation in, as a java.io.Reader object. A translation error must occur if both var and varReader are specified. If neither var nor varReader is specified, the result of the fragment invocation goes directly to the JspWriter.<br>
]]></desc>
</param>
</params>
</keyword>
<keyword name="jsp:output" type="tag">
<desc><![CDATA[The <code>jsp:output</code> element specifies the XML declaration or the document type declaration in the request output of the JSP document.<br>
<br>
The XML declaration and document type declaration that are declared by the <code>jsp:output</code> element are not interpreted by the JSP container. Instead, the container simply directs them to the request output.<br>
<br><br>
<h5> Generating a Document Type Declaration</h5>
A document type declaration (DTD) defines the structural rules for the XML document in which the document type declaration occurs. XML documents are not required to have a DTD associated with them.<br>
<br>
Specifying the document type declaration in the jsp:output element will not cause the JSP container to validate the JSP document against the DTD.<br>
<br>
If you want the JSP document to be validated against the DTD, you must manually include the document type declaration within the JSP document, just as you would with any XML document.<br>
<br><br>
<h5> Generating XML Declarations</h5>
Here is an example of an XML declaration:<br>
<br>
<blockquote><pre><?xml version="1.0" encoding="UTF-8" ?>
</pre></blockquote><br>
This declaration is the default XML declaration. It means that if the JSP container is generating an XML declaration, this is what the JSP container will include in the output of your JSP document.<br>
<br>
Neither a JSP document nor its request output is required to have an XML declaration. In fact, if the JSP document is not producing XML output then it shouldn't have an XML declaration.<br>
<br>
The JSP container will not include the XML declaration in the output when either of the following is true:<br>
<ul>
<li>You set the <code>omit-xml-declaration</code> attribute of the <code>jsp:output</code> element to either <code>true</code> or <code>yes</code>.
<li>You have a <code>jsp:root</code> element in your JSP document, and you do not specify <code>omit-xml-declaration="</code><em>false</em><code>"</code> in <code>jsp:output</code>.
</ul><br>
The JSP container will include the XML declaration in the output when either of the following is true:<br>
<br>
<ul>
<li>You set the <code>omit-xml-declaration</code> attribute of the <code>jsp:output</code> element to either <code>false</code> or <code>no</code>.
<li>You do not have a <code>jsp:root</code> action in your JSP document, and you do not specify the <code>omit-xml-declaration</code> attribute in <code>jsp:output</code>.
</ul><br>
The <code>jsp:output</code> element has three attributes that you use to generate the document type declaration:<br>
<ul>
<li><code>doctype-root-element</code>: Indicates the root element of the XML document
<li><code>doctype-system</code>: Indicates the URI reference to the DTD
<li><code>doctype-public</code>: A more flexible way to reference the DTD. This identifier gives more information about the DTD without giving a specific location. A public identifier resolves to the same actual document on any system even though the location of that document on each system may vary. See the XML 1.0 specification for more information.
</ul><br>
The rules for using the attributes are as follows:<br>
<ul>
<li>The doctype attributes can appear in any order
<li>The <code>doctype-root</code> attribute must be specified if the <code>doctype-system</code> attribute is specified
<li>The <code>doctype-public attribute</code> must not be specified unless <code>doctype-system</code> is specified
</ul><br>
]]></desc>
<params>
<param name="doctype-public" type="">
<desc><![CDATA[Must not be specified unless doctype-system is specified. Gives the value for the Public ID for the generat<br>
<br>
]]></desc>
</param>
<param name="doctype-root-element" type="">
<desc><![CDATA[Must be specified if and only if doctype-system is specified or a translation error must occur. Indicates the name that is to be output in the generated DOCTYPE declaration.<br>
]]></desc>
</param>
<param name="doctype-system" type="">
<desc><![CDATA[Specifies that a DOCTYPE declaration is to be generated and gives the value for the System Literal.<br>
]]></desc>
</param>
<param name="omit-xml-declaration" type="[yes, no, true, false]">
<desc><![CDATA[Indicates whether to omit the generation of an XML declaration.<br>
]]></desc>
</param>
</params>
</keyword>
<keyword name="jsp:param" type="tag">
<desc><![CDATA[Sends one or more name/value pairs as parameters to a dynamic resource. The target resource should be dynamic, that is, a JSP page, servlet, or other resource that can process the data that is sent to it as parameters.<br>
<br>
You can use more than one jsp:param clause if you need to send more than one parameter to the target resource. The name attribute specifies the parameter name and takes a case-sensitive literal string as a value. The value attribute specifies the parameter value and takes either a case-sensitive literal string or an expression that is evaluated at request time.<br>
]]></desc>
<params>
<param name="name" type="">
<desc><![CDATA[The name of an instance of a bean that has already been created or located with a jsp:useBean element. The value of name must match the value of id in jsp:useBean. The jsp:useBean element must appear before jsp:setProperty in the JSP page.<br>
]]></desc>
</param>
<param name="value" type="">
<desc><![CDATA[Sets <code>property</code> to a specific value. The value can be a String or an expression that is evaluated at runtime. If the value is a String, it is converted to the bean property's data type according to the conversion rules shown above in TABLE 2. If it is an expression, its value must have a data type that matches the data type of the value of the expression must match the data type of the bean property.<br>
<br>
If the parameter has an empty or null value, the corresponding bean property is not set. You cannot use both the <code>param</code> and <code>value</code> attributes in a jsp:setProperty element.<br>
<br>
]]></desc>
</param>
</params>
</keyword>
<keyword name="jsp:params" type="tag">
<desc><![CDATA[The parameters and values that you want to pass to the applet or bean. To specify more than one parameter value, you can use more than one jsp:param element within the jsp:params element. The name attribute specifies the parameter name and takes a case-sensitive literal string. The value attribute specifies the parameter value and takes either a case-sensitive literal string or an expression that is evaluated at runtime. If the dynamic resource you are passing the parameter to is an applet, it reads the parameter with the java.applet.Applet.getParameter method.<br>
<br>
See <code>jsp:param</code>.<br>
<br>
]]></desc>
</keyword>
<keyword name="jsp:plugin" type="tag">
<desc><![CDATA[The <code>jsp:plugin</code> element plays or displays an object (typically an applet or bean) in the client web browser, using a Java plug-in that is built in to the browser or downloaded from a specified URL.<br>
<br>
When the JSP page is translated and compiled and Java and sends back an HTML response to the client, the <code>jsp:plugin</code> element is replaced by either an <code><object></code> or <code><embed></code> element, according to the browser version. The <code><object></code> element is defined in HTML 4.0 and <code><embed></code> in HTML 3.2.<br>
<br>
<br>
In general, the attributes to the <code>jsp:plugin</code> element specify whether the object is a bean or an applet, locate the code that will be run, position the object in the browser window, specify an URL from which to download the plug-in software, and pass parameter names and values to the object. The attributes are described in detail in the next section.<br>
]]></desc>
<params>
<param name="align" type="[<b>bottom</b>, top, middle, left, right]">
<desc><![CDATA[The position of the image, object, or applet. The position descriptions listed below use the term text line to mean the line in the viewable JSP page that corresponds to the line in the JSP page where the jsp:plugin element appears. The allowed values for align are listed below:<br>
<br>
bottom Aligns the bottom of the image with the baseline of the text line.<br>
<br>
top Aligns the top of the image with the top of the text line.<br>
<br>
middle Aligns the vertical center of the image with the baseline of the text line.<br>
<br>
left Floats the image to the left margin and flows text along the image's right side.<br>
<br>
right Floats the image to the right margin and flows text along the image's left side.<br>
]]></desc>
</param>
<param name="archive" type="">
<desc><![CDATA[A comma-separated list of pathnames that locate archive files that will be preloaded with a class loader located in the directory named in codebase. The archive files are loaded securely, often over a network, and typically improve the applet's performance.<br>
]]></desc>
</param>
<param name="code" type="">
<desc><![CDATA[The name of the Java class file the plug-in will execute. You must include the .class extension in the name. The class file you specify should be in the directory named in the codebase attribute.<br>
]]></desc>
</param>
<param name="codebase" type="">
<desc><![CDATA[The directory (or path to the directory) that contains the Java class file the plug-in will execute. If you do not supply a value, the path of the JSP page that calls jsp:plugin is used.<br>
]]></desc>
</param>
<param name="height" type="">
<desc><![CDATA[The initial height, in pixels, of the image the applet or bean displays, not counting any windows or dialog boxes the applet or bean brings up.<br>
]]></desc>
</param>
<param name="hspace" type="">
<desc><![CDATA[The amount of space, in pixels, to the left and right of the image the applet or bean displays. The value must be a nonzero number. Note that hspace creates space to both the left and right and vspace creates space to both the top and bottom.<br>
]]></desc>
</param>
<param name="iepluginurl" type="">
<desc><![CDATA[The URL where the user can download the JRE plug-in for Internet Explorer. The value is a full URL, with a protocol name, optional port number, and domain name.<br>
<br>
]]></desc>
</param>
<param name="jreversion" type="">
<desc><![CDATA[The version of the Java Runtime Environment (JRE) the applet or bean requires. The default value is 1.2.<br>
]]></desc>
</param>
<param name="name" type="">
<desc><![CDATA[The name of an instance of a bean that has already been created or located with a jsp:useBean element. The value of name must match the value of id in jsp:useBean. The jsp:useBean element must appear before jsp:setProperty in the JSP page.<br>
]]></desc>
</param>
<param name="nspluginurl" type="">
<desc><![CDATA[The URL where the user can download the JRE plug-in for Netscape Navigator. The value is a full URL, with a protocol name, optional port number, and domain name.<br>
]]></desc>
</param>
<param name="type" type="[bean, applet]">
<desc><![CDATA[If the bean already exists in the scope, gives the bean a data type other than the class from which it was instantiated. The value of type must be a superclass of class or an interface implemented by class.<br>
<br>
If you use type without class or beanName, no bean is instantiated. The package and class name are case sensitive.<br>
]]></desc>
</param>
<param name="vspace" type="">
<desc><![CDATA[The amount of space, in pixels, to the top and bottom of the image the applet or bean displays. The value must be a nonzero number. Note that hspace creates space to both the left and right and vspace creates space to both the top and bottom.<br>
]]></desc>
</param>
<param name="width" type="">
<desc><![CDATA[The initial width, in pixels, of the image the applet or bean displays, not counting any windows or dialog boxes the applet or bean brings up.<br>
]]></desc>
</param>
</params>
</keyword>
<keyword name="jsp:setProperty" type="tag">
<desc><![CDATA[The <code>jsp:setProperty</code> element sets the value of one or more properties in a bean, using the bean's setter methods. You must declare the bean with <jsp:useBean> <em>before</em> you set a property value with <code>jsp:setProperty</code>. Because <code>jsp:useBean</code> and <code>jsp:setProperty</code> work together, the bean instance names they use must match (that is, the value of <code>name</code> in <code>jsp:setProperty</code> and the value of <code>id</code> in <code>jsp:useBean</code> must be the same).<br>
<br>
<br>
You can use <code>jsp:setProperty</code> to set property values in several ways:<br>
<ul>
<li>By passing all of the values the user enters (stored as parameters in the <code>request</code> object) to matching properties in the bean
<li>By passing a specific value the user enters to a specific property in the bean
<li>By setting a bean property to a value you specify as either a <code>String</code> or an expression that is evaluated at runtime
</ul><br>
Each method of setting property values has its own syntax, as described in the next section.<br>
]]></desc>
<params>
<param name="name" type="">
<desc><![CDATA[The name of an instance of a bean that has already been created or located with a jsp:useBean element. The value of name must match the value of id in jsp:useBean. The jsp:useBean element must appear before jsp:setProperty in the JSP page.<br>
]]></desc>
</param>
<param name="param" type="">
<desc><![CDATA[The name of a request parameter to set the property's value to.<br>
<br>
Note that if the bean property and request parameter have the same name, you may omit <code>param</code>.<br>
<br>
You cannot use both the <code>param</code> and <code>value</code> attributes in a jsp:setProperty element.<br>
]]></desc>
</param>
<param name="property" type="">
<desc><![CDATA[The name of the property to set.<br>
]]></desc>
</param>
<param name="value" type="">
<desc><![CDATA[Sets <code>property</code> to a specific value. The value can be a String or an expression that is evaluated at runtime. If the value is a String, it is converted to the bean property's data type according to the conversion rules shown above in TABLE 2. If it is an expression, its value must have a data type that matches the data type of the value of the expression must match the data type of the bean property.<br>
<br>
If the parameter has an empty or null value, the corresponding bean property is not set. You cannot use both the <code>param</code> and <code>value</code> attributes in a jsp:setProperty element.<br>
<br>
]]></desc>
</param>
</params>
</keyword>
<keyword name="jsp:useBean" type="tag">
<desc><![CDATA[The <code><jsp:useBean></code> element locates or instantiates a JavaBeans component. <code><jsp:useBean></code> first attempts to locate an instance of the bean. If the bean does not exist, <code><jsp:useBean></code> instantiates it from a class or serialized template.<br>
<br>
To locate or instantiate the bean, <code><jsp:useBean></code> takes the following steps, in this order:<br>
<br>
<ol>
<li>Attempts to locate a bean with the scope and name you specify.
<li>Defines an object reference variable with the name you specify.
<li>If it finds the bean, stores a reference to it in the variable. If you specified <code>type</code>, gives the bean that type.
<li>If it does not find the bean, instantiates it from the class you specify, storing a reference to it in the new variable. If the class name represents a serialized template, the bean is instantiated by <code>java.beans.Beans.instantiate</code>.
<li>If <code>jsp:useBean</code> has <em>instantiated</em> (rather than located) the bean, and if it has body tags or elements (between <<code>jsp:useBean></code> and <code></jsp:useBean></code>), executes the body tags.
</ol><br>
<br>
The body of a <code>jsp:useBean</code> element often contains a <code>jsp:setProperty</code> element that sets property values in the bean. As described in Step 5, the body tags are only processed if <code>jsp:useBean</code> instantiates the bean. If the bean already exists and <code>jsp:useBean</code> locates it, the body tags have no effect.<br>
<br>
<br>
You can use a <code>jsp:useBean</code> element to locate or instantiate a JavaBeans component, but not an enterprise bean. To create enterprise beans, you can write a <code>jsp:useBean</code> element that calls a bean that in turn calls the enterprise bean, or you can write a custom tag that calls an enterprise bean directly.<br>
]]></desc>
<params>
<param name="class" type="">
<desc><![CDATA[Instantiates a bean from a class, using the new keyword and the class constructor. The class must not be abstract and must have a public, no-argument constructor. The package and class name are case sensitive.<br>
]]></desc>
</param>
<param name="id" type="">
<desc><![CDATA[A variable that identifies the bean in the scope you specify. You can use the variable name in expressions or scriptlets in the JSP page.<br>
<br>
The name is case sensitive and must conform to the naming conventions of the scripting language used in the JSP page. If you use the Java programming language, the conventions in the Java Language Specification. If the bean has already been created by another jsp:useBean element, the value of id must match the value of id used in the original jsp:useBean element.<br>
]]></desc>
</param>
<param name="scope" type="[<b>page</b>, request, session, application]">
<desc><![CDATA[The scope in which the bean exists and the variable named in id is available. The default value is page. The meanings of the different scopes are shown below:<br>
<br>
page You can use the bean within the JSP page with the jsp:useBean element or any of the page's static include files, until the page sends a response back to the client or forwards a request to another resource.<br>
<br>
request You can use the bean from any JSP page processing the same request, until a JSP page sends a response to the client or forwards the request to another resource. You can use the request object to access the bean, for example, request.getAttribute(beanInstanceName).<br>
<br>
session You can use the bean from any JSP page in the same session as the JSP page that created the bean. The bean exists across the entire session, and any page that participates in the session can use it. The page in which you create the bean must have a page directive with session="true".<br>
<br>
application You can use the bean from any JSP page in the same application as the JSP page that created the bean. The bean exists across an entire JSP application, and any page in the application can use the bean.<br>
]]></desc>
</param>
<param name="type" type="[bean, applet]">
<desc><![CDATA[If the bean already exists in the scope, gives the bean a data type other than the class from which it was instantiated. The value of type must be a superclass of class or an interface implemented by class.<br>
<br>
If you use type without class or beanName, no bean is instantiated. The package and class name are case sensitive.<br>
]]></desc>
</param>
</params>
</keyword>
</keywords>
</api>