org.appng.taglib

## Class TagletAdapter

- java.lang.Object
- - javax.servlet.jsp.tagext.TagSupport
  - - javax.servlet.jsp.tagext.BodyTagSupport
    - - org.appng.taglib.TagletAdapter

- All Implemented Interfaces:
    Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, ParameterOwner

      public class TagletAdapter
      extends javax.servlet.jsp.tagext.BodyTagSupport
      implements ParameterOwner

  This class wraps an appNG taglet ( `Taglet`/`GlobalTaglet`/`XMLTaglet`/`GlobalXMLTaglet` ) into an `Tag`.

  Attributes:
  - application - the name of the `Application` that contains the taglet
  - method - the bean name of the taglet
  - type - the type of the taglet, one of `text` or `xml`

  Usage:

       <appNG:taglet application="acme" method="tagletname">
         <appNG:param name="foo">bar</appNG:param>
         <appNG:param name="jin">fizzbar</appNG:param>
       </appNG:taglet>

  Author:
    Matthias Herlitzius, Matthias Müller
  See Also:
    `Taglet`, `GlobalTaglet`, `XMLTaglet`, `GlobalXMLTaglet`, Serialized Form

- - ### Field Summary

    - ### Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport

      `bodyContent`

    - ### Fields inherited from class javax.servlet.jsp.tagext.TagSupport

      `id, pageContext`

    - ### Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

      `EVAL_BODY_BUFFERED, EVAL_BODY_TAG`

    - ### Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

      `EVAL_BODY_AGAIN`

    - ### Fields inherited from interface javax.servlet.jsp.tagext.Tag

      `EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `TagletAdapter()`

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `addParameter(String name, String value)`
    `int` | `doEndTag()`
    `int` | `doStartTag()`
    `protected Environment` | `getEnvironment()`
    `protected MultiSiteSupport` | `getMultiSiteSupport(javax.servlet.http.HttpServletRequest servletRequest, Environment environment)`
    `static Request` | `getRequest(javax.servlet.jsp.PageContext pageContext)`
    `void` | `setApplication(String application)` set the application name
    `void` | `setMethod(String method)` set the method name
    `void` | `setPageContext(javax.servlet.jsp.PageContext pageContext)`
    `void` | `setType(String type)` set the taglet type

    - ### Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport

      `doAfterBody, doInitBody, getBodyContent, getPreviousOut, release, setBodyContent`

    - ### Methods inherited from class javax.servlet.jsp.tagext.TagSupport

      `findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setParent, setValue`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

    - ### Methods inherited from interface javax.servlet.jsp.tagext.Tag

      `getParent, setParent`

- - ### Constructor Detail

    - #### TagletAdapter

          public TagletAdapter()

  - ### Method Detail

    - #### setApplication

          public void setApplication(String application)

      set the application name
      Parameters:
        `application` -

    - #### setMethod

          public void setMethod(String method)

      set the method name
      Parameters:
        `method` -

    - #### setType

          public void setType(String type)

      set the taglet type
      Parameters:
        `type` -

    - #### setPageContext

          public void setPageContext(javax.servlet.jsp.PageContext pageContext)

      Specified by:
        `setPageContext` in interface `javax.servlet.jsp.tagext.Tag`
      Overrides:
        `setPageContext` in class `javax.servlet.jsp.tagext.TagSupport`

    - #### getRequest

          public static Request getRequest(javax.servlet.jsp.PageContext pageContext)

    - #### doStartTag

          public int doStartTag()
                         throws javax.servlet.jsp.JspException

      Specified by:
        `doStartTag` in interface `javax.servlet.jsp.tagext.Tag`
      Overrides:
        `doStartTag` in class `javax.servlet.jsp.tagext.BodyTagSupport`
      Throws:
        `javax.servlet.jsp.JspException`

    - #### doEndTag

          public final int doEndTag()

      Specified by:
        `doEndTag` in interface `javax.servlet.jsp.tagext.Tag`
      Overrides:
        `doEndTag` in class `javax.servlet.jsp.tagext.BodyTagSupport`

    - #### getMultiSiteSupport

          protected MultiSiteSupport getMultiSiteSupport(javax.servlet.http.HttpServletRequest servletRequest,
                                                         Environment environment)
                                                  throws javax.servlet.jsp.JspException

      Throws:
        `javax.servlet.jsp.JspException`

    - #### getEnvironment

          protected Environment getEnvironment()

    - #### addParameter

          public void addParameter(String name,
                                   String value)

      Specified by:
        `addParameter` in interface `ParameterOwner`

Copyright © 2011–2023 aiticon GmbH. All rights reserved.