com.iplanet.jato.taglib
Class TagBase

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagSupport
        |
        +--com.iplanet.jato.taglib.TagBase
All Implemented Interfaces:
java.io.Serializable, javax.servlet.jsp.tagext.Tag
Direct Known Subclasses:
ContentTag, DisplayFieldTagBase, FormTag, ModelFieldTagBase, PageletTag, UseContainerViewTag, UseTiledViewTag, UseTreeViewTag, UseViewBeanTag

public class TagBase
extends javax.servlet.jsp.tagext.TagSupport

Base class for nearly all JATO tag handlers. It provides helper methods for obtaining various context objects.

Version:
JATO/1.2.2 $Id: TagBase.java,v 1.23 2002/03/16 03:26:35 todd Exp $
See Also:
Serialized Form

Field Summary
static boolean USE_TEI
           
static java.lang.String VAR_CURRENT_CONTAINER_VIEW
           
static java.lang.String VAR_CURRENT_TILED_VIEW
           
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
TagBase()
           
 
Method Summary
protected  void appendStyleAttributes(NonSyncStringBuffer buffer)
           
protected  void checkChildType(View child, java.lang.Class clazz)
           
protected  boolean fireBeginDisplayEvent()
           
protected  java.lang.String fireEndDisplayEvent(java.lang.String html)
           
 java.lang.String getElementId()
           
 java.lang.String getFireDisplayEvents()
           
 java.lang.String getName()
           
protected  ContainerView getParentContainerView()
           
protected  ContainerViewTag getParentContainerViewTag()
           
protected  ViewBean getParentViewBean()
           
protected  RequestContext getRequestContext()
          Gets the request context from the page context
 java.lang.String getStyle()
           
 java.lang.String getStyleClass()
           
 java.lang.Object getValue(java.lang.String name)
           
 java.util.Map getValueMap()
           
 java.util.Enumeration getValues()
           
protected  boolean isTrue(java.lang.String value)
           
protected  java.lang.Object peekContextValue(java.lang.String name)
           
protected  void popContainerView(ContainerView origView)
           
protected  java.lang.Object popContextValue(java.lang.String name)
           
protected  void popPageletContainerViewTag()
          Pop the current container tag from the request attributes
protected  ContainerView pushContainerView(ContainerView view)
          / protected TiledView getParentTiledView() throws JspException { ContainerView parentContainer=getParentContainerView(); if (!(parentContainer instanceof TiledView)) throw new JspException("The container view available from the "+ "parent tag was not of type "+TiledView.class.getName()); return (TiledView)parentContainer; } /**
protected  void pushContextValue(java.lang.String name, java.lang.Object value)
           
protected  void pushPageletContainerViewTag()
          Push the current container tag into the request attributes for use by pagelets
 void release()
           
 void removeValue(java.lang.String name)
           
 void reset()
          Reset any cached state to allow for a new rendering of this tag instance
 void setElementId(java.lang.String value)
           
 void setFireDisplayEvents(java.lang.String value)
           
 void setName(java.lang.String value)
           
 void setStyle(java.lang.String value)
           
 void setStyleClass(java.lang.String value)
           
 void setValue(java.lang.String name, java.lang.Object value)
           
protected  boolean shouldFireDisplayEvents()
           
protected  void writeOutput(NonSyncStringBuffer output)
           
protected  void writeOutput(java.lang.Object value)
           
protected  void writeOutput(java.lang.String output)
           
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doEndTag, doStartTag, findAncestorWithClass, getId, getParent, setId, setPageContext, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

VAR_CURRENT_CONTAINER_VIEW

public static final java.lang.String VAR_CURRENT_CONTAINER_VIEW

VAR_CURRENT_TILED_VIEW

public static final java.lang.String VAR_CURRENT_TILED_VIEW

USE_TEI

public static final boolean USE_TEI
Constructor Detail

TagBase

public TagBase()
Method Detail

reset

public void reset()
Reset any cached state to allow for a new rendering of this tag instance

getValueMap

public java.util.Map getValueMap()

getValues

public java.util.Enumeration getValues()
Overrides:
getValues in class javax.servlet.jsp.tagext.TagSupport

getValue

public java.lang.Object getValue(java.lang.String name)
Overrides:
getValue in class javax.servlet.jsp.tagext.TagSupport

setValue

public void setValue(java.lang.String name,
                     java.lang.Object value)
Overrides:
setValue in class javax.servlet.jsp.tagext.TagSupport

removeValue

public void removeValue(java.lang.String name)
Overrides:
removeValue in class javax.servlet.jsp.tagext.TagSupport

release

public void release()
Overrides:
release in class javax.servlet.jsp.tagext.TagSupport

fireBeginDisplayEvent

protected boolean fireBeginDisplayEvent()
                                 throws javax.servlet.jsp.JspException

fireEndDisplayEvent

protected java.lang.String fireEndDisplayEvent(java.lang.String html)
                                        throws javax.servlet.jsp.JspException

shouldFireDisplayEvents

protected boolean shouldFireDisplayEvents()
                                   throws javax.servlet.jsp.JspException

getName

public java.lang.String getName()

setName

public void setName(java.lang.String value)

getStyle

public java.lang.String getStyle()

setStyle

public void setStyle(java.lang.String value)

getStyleClass

public java.lang.String getStyleClass()

setStyleClass

public void setStyleClass(java.lang.String value)

getElementId

public java.lang.String getElementId()

setElementId

public void setElementId(java.lang.String value)

getFireDisplayEvents

public java.lang.String getFireDisplayEvents()

setFireDisplayEvents

public void setFireDisplayEvents(java.lang.String value)

getRequestContext

protected RequestContext getRequestContext()
Gets the request context from the page context
Since:
JATO 1.1.2

checkChildType

protected void checkChildType(View child,
                              java.lang.Class clazz)
                       throws javax.servlet.jsp.JspException

getParentViewBean

protected ViewBean getParentViewBean()
                              throws javax.servlet.jsp.JspException

getParentContainerViewTag

protected ContainerViewTag getParentContainerViewTag()
                                              throws javax.servlet.jsp.JspException

getParentContainerView

protected ContainerView getParentContainerView()
                                        throws javax.servlet.jsp.JspException

pushContainerView

protected ContainerView pushContainerView(ContainerView view)
/ protected TiledView getParentTiledView() throws JspException { ContainerView parentContainer=getParentContainerView(); if (!(parentContainer instanceof TiledView)) throw new JspException("The container view available from the "+ "parent tag was not of type "+TiledView.class.getName()); return (TiledView)parentContainer; } /**

popContainerView

protected void popContainerView(ContainerView origView)

pushContextValue

protected void pushContextValue(java.lang.String name,
                                java.lang.Object value)

peekContextValue

protected java.lang.Object peekContextValue(java.lang.String name)

popContextValue

protected java.lang.Object popContextValue(java.lang.String name)

pushPageletContainerViewTag

protected void pushPageletContainerViewTag()
Push the current container tag into the request attributes for use by pagelets

popPageletContainerViewTag

protected void popPageletContainerViewTag()
                                   throws javax.servlet.jsp.JspException
Pop the current container tag from the request attributes

writeOutput

protected void writeOutput(java.lang.Object value)
                    throws javax.servlet.jsp.JspException

writeOutput

protected void writeOutput(NonSyncStringBuffer output)
                    throws javax.servlet.jsp.JspException

writeOutput

protected void writeOutput(java.lang.String output)
                    throws javax.servlet.jsp.JspException

isTrue

protected boolean isTrue(java.lang.String value)

appendStyleAttributes

protected void appendStyleAttributes(NonSyncStringBuffer buffer)