StubTag (Metawidget API Documentation)

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- javax.servlet.jsp.tagext.TagSupport
- - javax.servlet.jsp.tagext.BodyTagSupport
  - - org.metawidget.jsp.tagext.StubTag

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

Direct Known Subclasses:

HtmlStubTag, SpringStubTag, StrutsStubTag
```
public abstract class StubTag
extends javax.servlet.jsp.tagext.BodyTagSupport
```
Base Stub for JSP environments.
A Stub takes a path but does nothing with it. Stubs are used to 'stub out' what Metawidget would normally create - either to suppress widget creation entirely or to create child widgets with a different path.
StubTags differ from FacetTags in that they define a path and override widget creation.

Author:

Richard Kennard

See Also:
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

StubTag()

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`doEndTag()`
`Map<String,String>`	`getAttributesMap()`
`String`	`getSavedBodyContent()` Get the body content as saved during `doEndTag`.
`void`	`setAttributes(String attributes)`
`protected void`	`setPathInternal(String path)` Sets the path.

Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doAfterBody, doInitBody, doStartTag, getBodyContent, getPreviousOut, release, setBodyContent

Methods inherited from class javax.servlet.jsp.tagext.TagSupport
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, 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, setPageContext, setParent

- Constructor Detail
  - StubTag
```
public StubTag()
```
- Method Detail
  - setAttributes
```
public void setAttributes(String attributes)
                   throws javax.servlet.jsp.JspException
```
    Throws:
    
    javax.servlet.jsp.JspException
  - getAttributesMap
```
public Map<String,String> getAttributesMap()
```
  - getSavedBodyContent
```
public String getSavedBodyContent()
```
    Get the body content as saved during doEndTag.
    It seems getBodyContent().toString only returns a meaningful result while we are in the doEndTag method. We capture it there for use later.
  - doEndTag
```
public int doEndTag()
             throws javax.servlet.jsp.JspException
```
    Specified by:
    
    doEndTag in interface javax.servlet.jsp.tagext.Tag
    
    Overrides:
    
    doEndTag in class javax.servlet.jsp.tagext.BodyTagSupport
    
    Throws:
    
    javax.servlet.jsp.JspException
  - setPathInternal
```
protected void setPathInternal(String path)
```
    Sets the path.
    Set by subclasses according to what they prefer to call it (eg. name for Struts, property for Spring).

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2015. All Rights Reserved.