JSPTag

This type is a class for model objects.

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.

Package: taglib
Supertype: DescriptionGroup

Classifier ID:  -1
Instance class name:  * Unspecified *
Instance class:  * Unspecified *

Collection attributes having this type:
  TagLib.tags



Attributes Summary
bodyContent : BodyContentType 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
example : EString The example element provides an informal description of an example of the use of a tag.
name : EString * No description is available *
dynamicAttributes : EBoolean * No description is available *
attributes : JSPTagAttribute * * No description is available *
variables : JSPVariable * 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.
tagClass : JavaClass @ 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
teiClass : JavaClass @ 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



Attribute Details

bodyContent  -  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
    Data Type: BodyContentType
    Default value:  unspecified
    Allowed values:
        0 - tagdependent
        1 - JSP
        2 - empty
        3 - scriptless
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

example  -  The example element provides an informal description of an example of the use of a tag.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

name  -  * No description is available *
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

dynamicAttributes  -  * No description is available *
    Data Type: EBoolean
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

attributes  -  * No description is available *
    Reference Type: JSPTagAttribute *
    Containment:  true
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  true
    Ordered:  true
    Lower bound:  0
    Upper bound:  Unbounded
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

variables  -  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.
    Reference Type: JSPVariable *
    Containment:  true
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  true
    Ordered:  true
    Lower bound:  0
    Upper bound:  Unbounded
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

tagClass  -  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
    Reference Type: JavaClass @
    Containment:  false
    Container:  false
    Required:  true
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  1
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

teiClass  -  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
    Reference Type: JavaClass @
    Containment:  false
    Container:  false
    Required:  true
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  1
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false



(C) COPYRIGHT International Business Machines Corp. 1996-2006