IncludeTag (Revolution Systems Open Library TRUNK-SNAPSHOT API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- javax.servlet.jsp.tagext.TagSupport
- - com.revolsys.ui.web.taglib.IncludeTag

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
```
public class IncludeTag
extends javax.servlet.jsp.tagext.TagSupport
```
Include the file that is defined within the child Component that has the specified name. The Layout for this template must be in the "nice.layout" attribute. The name parameter will be used to obtain the child attribute from the Layout and if found the url from the child will be included. The "nice.layout" attribute for the included template will be equal to it's Component.

Example
```
      <%@ taglib uri="http://dev.nhigh.com/taglibs/nice" prefix="nice" %>
      <html>
      <head>
      <nhigh:Styles />
      </head>
      <body>
        .
      <nice:Include name="body" />
        .
      </body>
      </html>

 
```
Input Attributes:
nice- A Layout bean containing the component for the current template.
Version:

1.0

Author:

P. D. Austin

See Also:
Component, Layout, Serialized Form

Field Summary
- 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

Constructors
Constructor and Description

IncludeTag()

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`doEndTag()` Process the end tag.
`int`	`doStartTag()` Process the start tag.
`String`	`getName()` Get the name of the component to be included.
`void`	`setName(String name)` Set the name of the component to be included.

Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IncludeTag
```
public IncludeTag()
```
- Method Detail
  - doEndTag
```
public int doEndTag()
             throws javax.servlet.jsp.JspException
```
    Process the end tag.
    
    Specified by:
    
    doEndTag in interface javax.servlet.jsp.tagext.Tag
    
    Overrides:
    
    doEndTag in class javax.servlet.jsp.tagext.TagSupport
    
    Returns:
    EVAL_PAGE
    
    Throws:
    
    javax.servlet.jsp.JspException
  - doStartTag
```
public int doStartTag()
               throws javax.servlet.jsp.JspException
```
    Process the start tag.
    
    Specified by:
    
    doStartTag in interface javax.servlet.jsp.tagext.Tag
    
    Overrides:
    
    doStartTag in class javax.servlet.jsp.tagext.TagSupport
    
    Returns:
    SKIP_BODY
    
    Throws:
    
    javax.servlet.jsp.JspException
  - getName
```
public String getName()
```
    Get the name of the component to be included.
    
    Returns:
    name the name of the child component to be included
  - setName
```
public void setName(String name)
```
    Set the name of the component to be included.
    
    Parameters:
    name - the name of the child component to be included

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2015 Revolution Systems Inc.. All rights reserved.