net.sourceforge.stripes.tag.layout
Class LayoutDefinitionTag
java.lang.Object
net.sourceforge.stripes.tag.StripesTagSupport
net.sourceforge.stripes.tag.layout.LayoutTag
net.sourceforge.stripes.tag.layout.LayoutDefinitionTag
- All Implemented Interfaces:
- JspTag, Tag
public class LayoutDefinitionTag
- extends LayoutTag
On the surface, allows a developer to define a layout using a custom tag - but is actually
the tag responsible for generating the output of the layout. A layout can have zero or more
nested components, as well as regular text and other custom tags nested within it.
- Since:
- Stripes 1.1
- Author:
- Tim Fennell, Ben Gunter
Method Summary |
int |
doEndTag()
Causes page evaluation to end once the end of the layout definition is reached. |
int |
doStartTag()
Looks up the layout context that has been setup by a LayoutRenderTag . |
void |
setPageContext(PageContext pageContext)
Called by the Servlet container to set the page context on the tag. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
LayoutDefinitionTag
public LayoutDefinitionTag()
setPageContext
public void setPageContext(PageContext pageContext)
- Description copied from class:
StripesTagSupport
- Called by the Servlet container to set the page context on the tag.
- Specified by:
setPageContext
in interface Tag
- Overrides:
setPageContext
in class StripesTagSupport
doStartTag
public int doStartTag()
throws JspException
- Looks up the layout context that has been setup by a
LayoutRenderTag
. Uses the
context to push any dynamic attributes supplied to the render tag in to the page context
available during the body of the LayoutDefinitionTag
.
- Specified by:
doStartTag
in interface Tag
- Specified by:
doStartTag
in class StripesTagSupport
- Returns:
EVAL_BODY_INCLUDE
in all cases.
- Throws:
JspException
doEndTag
public int doEndTag()
throws JspException
- Causes page evaluation to end once the end of the layout definition is reached.
- Specified by:
doEndTag
in interface Tag
- Specified by:
doEndTag
in class StripesTagSupport
- Returns:
- SKIP_PAGE in all cases
- Throws:
JspException
© Copyright 2005-2006, Stripes Development Team.