net.sourceforge.stripes.tag.layout
Class LayoutTag

java.lang.Object
  extended by net.sourceforge.stripes.tag.StripesTagSupport
      extended by net.sourceforge.stripes.tag.layout.LayoutTag
All Implemented Interfaces:
JspTag, Tag
Direct Known Subclasses:
LayoutComponentTag, LayoutDefinitionTag, LayoutRenderTag

public abstract class LayoutTag
extends StripesTagSupport

Abstract base class for the tags that handle rendering of layouts.

Since:
Stripes 1.5.4
Author:
Ben Gunter

Field Summary
 
Fields inherited from class net.sourceforge.stripes.tag.StripesTagSupport
pageContext, parentTag
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
LayoutTag()
           
 
Method Summary
 void cleanUpComponentRenderers()
          Pop this tag's page context off each of the component renderers' page context stacks.
 void exportComponentRenderers()
          Starting from the outer-most context and working up the stack, put a reference to each component renderer by name into the page context and push this tag's page context onto the renderer's page context stack.
 String getCurrentPagePath()
          Get the context-relative path of the page that invoked this tag.
<T extends LayoutTag>
T
getLayoutParent()
          Get the nearest ancestor of this tag that is an instance of LayoutTag.
 boolean isChildOfComponent()
          True if the nearest ancestor of this tag that is an instance of LayoutTag is also an instance of LayoutComponentTag.
 boolean isChildOfDefinition()
          True if the nearest ancestor of this tag that is an instance of LayoutTag is also an instance of LayoutDefinitionTag.
 boolean isChildOfRender()
          True if the nearest ancestor of this tag that is an instance of LayoutTag is also an instance of LayoutRenderTag.
 
Methods inherited from class net.sourceforge.stripes.tag.StripesTagSupport
doEndTag, doStartTag, getActionBeanType, getActionBeanUrl, getPageContext, getParent, getParentTag, getTagStack, popPageContextAttributes, pushPageContextAttributes, release, setPageContext, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LayoutTag

public LayoutTag()
Method Detail

getCurrentPagePath

public String getCurrentPagePath()
Get the context-relative path of the page that invoked this tag.


isChildOfRender

public boolean isChildOfRender()
True if the nearest ancestor of this tag that is an instance of LayoutTag is also an instance of LayoutRenderTag.


isChildOfDefinition

public boolean isChildOfDefinition()
True if the nearest ancestor of this tag that is an instance of LayoutTag is also an instance of LayoutDefinitionTag.


isChildOfComponent

public boolean isChildOfComponent()
True if the nearest ancestor of this tag that is an instance of LayoutTag is also an instance of LayoutComponentTag.


getLayoutParent

public <T extends LayoutTag> T getLayoutParent()
Get the nearest ancestor of this tag that is an instance of LayoutTag. If no ancestor of that type is found then null.


exportComponentRenderers

public void exportComponentRenderers()
Starting from the outer-most context and working up the stack, put a reference to each component renderer by name into the page context and push this tag's page context onto the renderer's page context stack. Working from the bottom of the stack up ensures that newly defined components override any that might have been defined previously by the same name.


cleanUpComponentRenderers

public void cleanUpComponentRenderers()
Pop this tag's page context off each of the component renderers' page context stacks.



© Copyright 2005-2006, Stripes Development Team.