|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sourceforge.stripes.tag.StripesTagSupport
net.sourceforge.stripes.tag.layout.LayoutTag
net.sourceforge.stripes.tag.layout.LayoutComponentTag
public class LayoutComponentTag
Defines a component in a layout. Used both to define the components in a layout definition and to provide overridden component definitions during a layout rendering request.
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 | |
---|---|
LayoutComponentTag()
|
Method Summary | |
---|---|
int |
doEndTag()
If this tag is the component that needs to be rendered, as indicated by LayoutContext.getComponent() , then set the current component name back to null to
indicate that the component has rendered. |
int |
doStartTag()
If this tag is nested within a LayoutDefinitionTag , then evaluate the corresponding
LayoutComponentTag nested within the LayoutRenderTag that invoked the parent
LayoutDefinitionTag . |
String |
getName()
Gets the name of the component. |
boolean |
isCurrentComponent()
True if this tag is the component to be rendered on this pass from LayoutDefinitionTag . |
void |
setName(String name)
Sets the name of the component. |
void |
setPageContext(PageContext pageContext)
Called by the Servlet container to set the page context on the tag. |
Methods inherited from class net.sourceforge.stripes.tag.layout.LayoutTag |
---|
cleanUpComponentRenderers, exportComponentRenderers, getCurrentPagePath, getLayoutParent, isChildOfComponent, isChildOfDefinition, isChildOfRender |
Methods inherited from class net.sourceforge.stripes.tag.StripesTagSupport |
---|
getActionBeanType, getActionBeanUrl, getPageContext, getParent, getParentTag, getTagStack, popPageContextAttributes, pushPageContextAttributes, release, setParent |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LayoutComponentTag()
Method Detail |
---|
public String getName()
public void setName(String name)
public void setPageContext(PageContext pageContext)
StripesTagSupport
setPageContext
in interface Tag
setPageContext
in class StripesTagSupport
public boolean isCurrentComponent() throws StripesJspException
LayoutDefinitionTag
.
StripesJspException
- If a LayoutContext
is not found.public int doStartTag() throws JspException
If this tag is nested within a LayoutDefinitionTag
, then evaluate the corresponding
LayoutComponentTag
nested within the LayoutRenderTag
that invoked the parent
LayoutDefinitionTag
. If, after evaluating the corresponding tag, the component has
not been rendered then evaluate this tag's body by returning EVAL_BODY_INCLUDE
.
If this tag is nested within a LayoutRenderTag
and this tag is the current component,
as indicated by LayoutContext.getComponent()
, then evaluate this tag's body by
returning EVAL_BODY_INCLUDE
.
In all other cases, skip this tag's body by returning SKIP_BODY.
doStartTag
in interface Tag
doStartTag
in class StripesTagSupport
EVAL_BODY_INCLUDE
or SKIP_BODY
, as described above.
JspException
public int doEndTag() throws JspException
LayoutContext.getComponent()
, then set the current component name back to null to
indicate that the component has rendered.
doEndTag
in interface Tag
doEndTag
in class StripesTagSupport
JspException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |