net.ontopia.topicmaps.nav2.taglibs.tolog
Class BaseOutputProducingTag

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by net.ontopia.topicmaps.nav2.taglibs.tolog.BaseOutputProducingTag
All Implemented Interfaces:
Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
Direct Known Subclasses:
ObjectIdTag, OutTag, SymbolicIdTag

public abstract class BaseOutputProducingTag
extends javax.servlet.jsp.tagext.TagSupport

INTERNAL: Abstract super-class of an Output-Producing Tag.

See Also:
Serialized Form

Field Summary
protected  boolean escapeEntities
           
protected  String fallbackValue
           
protected  String query
           
protected  String variableName
           
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
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
  BaseOutputProducingTag()
           
protected BaseOutputProducingTag(boolean escapeEntities)
           
 
Method Summary
 int doEndTag()
           
 int doStartTag()
          Process the start tag for this instance.
abstract  void generateOutput(javax.servlet.jsp.JspWriter out, Object outObject)
           
 Object generateOutputObject()
          Get the object to write out (either through a variable or query).
protected abstract  String getName()
           
protected  void print2Writer(javax.servlet.jsp.JspWriter out, String string)
          INTERNAL: prints out string to specified JspWriter object with respect if the entities should be escaped.
 void release()
          reset the state of the Tag.
 void setFallback(String fallbackValue)
           
 void setQuery(String query)
           
 void setVar(String variableName)
           
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, 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
 

Field Detail

escapeEntities

protected boolean escapeEntities

variableName

protected String variableName

query

protected String query

fallbackValue

protected String fallbackValue
Constructor Detail

BaseOutputProducingTag

public BaseOutputProducingTag()

BaseOutputProducingTag

protected BaseOutputProducingTag(boolean escapeEntities)
Method Detail

getName

protected abstract String getName()

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspTagException
Process the start tag for this instance.

Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doStartTag in class javax.servlet.jsp.tagext.TagSupport
Throws:
javax.servlet.jsp.JspTagException

doEndTag

public final int doEndTag()
Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doEndTag in class javax.servlet.jsp.tagext.TagSupport

release

public void release()
reset the state of the Tag.

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

generateOutput

public abstract void generateOutput(javax.servlet.jsp.JspWriter out,
                                    Object outObject)
                             throws javax.servlet.jsp.JspTagException,
                                    IOException
Throws:
javax.servlet.jsp.JspTagException
IOException

generateOutputObject

public Object generateOutputObject()
                            throws javax.servlet.jsp.JspTagException
Get the object to write out (either through a variable or query).

Throws:
javax.servlet.jsp.JspTagException

setQuery

public void setQuery(String query)

setVar

public final void setVar(String variableName)

setFallback

public final void setFallback(String fallbackValue)

print2Writer

protected final void print2Writer(javax.servlet.jsp.JspWriter out,
                                  String string)
                           throws IOException
INTERNAL: prints out string to specified JspWriter object with respect if the entities should be escaped.

Throws:
IOException


Copyright © 2000-2012 Ontopia.