web-jsptaglibrary_1_2.dtd

web-jsptaglibrary_1_2.dtd

Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.

The taglib tag is the document root, it defines:

<taglib>'s children Name Cardinality description One or none display-name One or none jsp-version Only one large-icon One or none listener Any number short-name Only one small-icon One or none tag At least one tlib-version Only one uri One or none validator One or none

<taglib>'s attributes Name Values Default id ID xmlns http://java.sun.com/JSP/TagLibraryDescriptor

(tlib-version,jsp-version,short-name,uri?,display-name?,small-icon?,large-icon?,description?,validator?,listener*,tag+)

Sorry, no documentation.

Possible values : ID

Sorry, no documentation.

Required

Describes this version (number) of the taglibrary (dewey decimal)

#PCDATA ::= [0-9]*{ "."[0-9] }0..3

<tlib-version>'s attributes Name Values Default id ID

Describes the JSP version (number) this taglibrary requires in order to function (dewey decimal)

The default is 1.2

#PCDATA ::= [0-9]*{ "."[0-9] }0..3

<jsp-version>'s attributes Name Values Default id ID

Defines a short (default) short-name to be used for tags and variable names used/created by this tag library. Do not use white space, and do not start with digits or underscore.

#PCDATA ::= NMTOKEN

<short-name>'s attributes Name Values Default id ID

Defines a public URI that uniquely identifies this version of the taglibrary. Leave it empty if it does not apply.

<uri>'s attributes Name Values Default id ID

Defines an arbitrary text string descirbing the tag library

<description>'s attributes Name Values Default id ID

Defines an optional validator that can be used to validate the conformance of a JSP page to using this tag library.

<validator>'s children Name Cardinality description One or none init-param Any number validator-class Only one

(validator-class,init-param*,description?)

Defines the TagLibraryValidator class that can be used to validate the conformance of a JSP page to using this tag library.

The init-param element contains a name/value pair as an initialization param

<init-param>'s children Name Cardinality description One or none param-name Only one param-value Only one

(param-name,param-value,description?)

The param-name element contains the name of a parameter.

<param-name>'s attributes Name Values Default id ID

The param-value element contains the value of a parameter.

<param-value>'s attributes Name Values Default id ID

Defines an optional event listener object to be instantiated and registered automatically.

<listener>'s children Name Cardinality listener-class Only one

<listener>'s attributes Name Values Default id ID

(listener-class)

The listener-class element declares a class in the application that must be registered as a web application listener bean. See the Servlet 2.3 specification for details.

<listener-class>'s attributes Name Values Default id ID

The tag defines a unique tag in this tag library. It has one attribute, id.

The tag element may have several subelements defining:

<tag>'s children Name Cardinality attribute Any number body-content One or none description One or none display-name One or none example One or none large-icon One or none name Only one small-icon One or none tag-class Only one tei-class One or none variable Any number

<tag>'s attributes Name Values Default id ID

(name,tag-class,tei-class?,body-content?,display-name?,small-icon?,large-icon?,description?,variable*,attribute*,example?)

Defines the subclass of javax.serlvet.jsp.tagext.Tag that implements the request time semantics for this tag. (required)

#PCDATA ::= fully qualified Java class name

<tag-class>'s attributes Name Values Default id ID

Defines the subclass of javax.servlet.jsp.tagext.TagExtraInfo for this tag. (optional)

If this is not given, the class is not consulted at translation time.

#PCDATA ::= fully qualified Java class name

<tei-class>'s attributes Name Values Default id ID

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:

JSP The body of the tag contains nested JSP syntax

The default (if not defined) is JSP

#PCDATA ::= tagdependent | JSP | empty

<body-content>'s attributes Name Values Default id ID

The display-name element contains a short name that is intended to be displayed by tools.

The large-icon element contains the name of a file containing a large (32 x 32) icon image. The file name is a relative path within the tag library. The image must be either in the JPEG or GIF format, and the file name must end with the suffix ".jpg" or ".gif" respectively. The icon can be used by tools.

The small-icon element contains the name of a file containing a large (32 x 32) icon image. The file name is a relative path within the tag library. The image must be either in the JPEG or GIF format, and the file name must end with the suffix ".jpg" or ".gif" respectively. The icon can be used by tools.

The example element contains an informal description of an example of the use of a tag.

<example>'s attributes Name Values Default id ID

The variable tag provides information on the scripting variables defined by this tag. It is a (translation time) error for a tag 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:

<variable>'s children Name Cardinality declare One or none description One or none name-from-attribute One or none name-given One or none scope One or none variable-class One or none

((name-given | name-from-attribute),variable-class?,declare?,scope?,description?)

The name for the scripting variable. One of name-given or name-from-attribute is required.

The name of an attribute whose (translation-time) value will give the name of the variable. One of name-given or name-from-attribute is required.

The optional name of the class for the scripting variable. The default is java.lang.String.

Whether the scripting variable is to be defined or not. See TagExtraInfo for details. This element is optional and "true" is the default.

The scope of the scripting variable. See TagExtraInfo for details. The element is optional and "NESTED" is the default. Other legal values are "AT_BEGIN" and "AT_END".

The attribute tag defines an attribute for the nesting tag

An attribute definition is composed of:

- the attributes name (required)

- if the attribute is required or optional (optional)

- if the attributes value may be dynamically calculated at runtime by a scriptlet expression (optional)

- the type of the attributes value (optional)

- an informal description of the meaning of the attribute (optional)

<attribute>'s children Name Cardinality description One or none name Only one required One or none rtexprvalue One or none type One or none

<attribute>'s attributes Name Values Default id ID

(name,required?,rtexprvalue?,type?,description?)

Defines the canonical name of a tag or attribute being defined

#PCDATA ::= NMTOKEN

<name>'s attributes Name Values Default id ID

Defines if the nesting attribute is required or optional.

#PCDATA ::= true | false | yes | no

If not present then the default is "false", i.e the attribute is optional.

<required>'s attributes Name Values Default id ID

Defines if the nesting attribute can have scriptlet expressions as a value, i.e the value of the attribute may be dynamically calculated at request time, as opposed to a static value determined at translation time.

#PCDATA ::= true | false | yes | no

If not present then the default is "false", i.e the attribute has a static value

<rtexprvalue>'s attributes Name Values Default id ID

Defines the Java type of the attributes value. For static values (those determined at translation time) the type is always java.lang.String.

ID attributes

Possible values : ID

Sorry, no documentation.

Possible values : ID

Sorry, no documentation.

Possible values : ID

Sorry, no documentation.

Possible values : ID

Sorry, no documentation.

Possible values : ID

Sorry, no documentation.

Possible values : ID

Sorry, no documentation.

Possible values : ID

Sorry, no documentation.

Possible values : ID

Sorry, no documentation.

Possible values : ID

Sorry, no documentation.

Possible values : ID

Sorry, no documentation.

Possible values : ID

Sorry, no documentation.

Possible values : ID

Sorry, no documentation.

Possible values : ID

Sorry, no documentation.

Possible values : ID

Sorry, no documentation.

Possible values : ID

Sorry, no documentation.

Possible values : ID

Sorry, no documentation.

Possible values : ID

Sorry, no documentation.

Possible values : ID