org.apache.struts2.components
Class Include

java.lang.Object
  org.apache.struts2.components.Component
      org.apache.struts2.components.Include

public class Include
extends Component

Include a servlet's output (result of servlet or a JSP page).

Note: Any additional params supplied to the included page are not accessible within the rendered page through the <s:property...> tag!

• value* (String) - jsp page to be included

Examples

 
 <-- One: -->
 <s:include value="myJsp.jsp" />

 <-- Two: -->
 <s:include value="myJsp.jsp">
    <s:param name="param1" value="value2" />
    <s:param name="param2" value="value2" />
 </s:include>

 <-- Three: -->
 <s:include value="myJsp.jsp">
    <s:param name="param1">value1</s:param>
    <s:param name="param2">value2<s:param>
 </s:include>
 

 
 Example one - do an include myJsp.jsp page
 Example two - do an include to myJsp.jsp page with parameters param1=value1 and param2=value2
 Example three - do an include to myJsp.jsp page with parameters param1=value1 and param2=value2
 
 

Field Summary

protected java.lang.String

value

Fields inherited from class org.apache.struts2.components.Component

COMPONENT_STACK, id, parameters, stack

Constructor Summary

Include(com.opensymphony.xwork2.util.OgnlValueStack stack, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)

Method Summary

void	addParameter(java.lang.String key, java.lang.Object value) Add's the given key and value to this components own parameter.
boolean	end(java.io.Writer writer, java.lang.String body) Callback for the end tag of this component.
static java.lang.String	getContextRelativePath(javax.servlet.ServletRequest request, java.lang.String relativePath)
static void	include(java.lang.String aResult, java.io.Writer writer, javax.servlet.ServletRequest request, javax.servlet.http.HttpServletResponse response)
void	setValue(java.lang.String value) The jsp/servlet output to include

Methods inherited from class org.apache.struts2.components.Component

addAllParameters, altSyntax, copyParams, determineActionURL, determineNamespace, end, fieldError, findAncestor, findString, findString, findValue, findValue, findValue, getComponentStack, getId, getParameters, getStack, popComponentStack, setId, start, toString, usesBody

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

value

protected java.lang.String value

Constructor Detail

Include

public Include(com.opensymphony.xwork2.util.OgnlValueStack stack,
               javax.servlet.http.HttpServletRequest req,
               javax.servlet.http.HttpServletResponse res)

Method Detail

end

public boolean end(java.io.Writer writer,
                   java.lang.String body)

Description copied from class: Component

Callback for the end tag of this component. Should the body be evaluated again?

NOTE: will pop component stack.

Overrides:

end in class Component

Parameters:

writer - the output writer.

body - the rendered body.

Returns:

true if the body should be evaluated again

setValue

public void setValue(java.lang.String value)

The jsp/servlet output to include

getContextRelativePath

public static java.lang.String getContextRelativePath(javax.servlet.ServletRequest request,
                                                      java.lang.String relativePath)

addParameter

public void addParameter(java.lang.String key,
                         java.lang.Object value)

Description copied from class: Component

Add's the given key and value to this components own parameter.

If the provided key is null nothing happends. If the provided value is null any existing parameter with the given key name is removed.

Overrides:

addParameter in class Component

Parameters:

key - the key of the new parameter to add.

value - the value assoicated with the key.

include

public static void include(java.lang.String aResult,
                           java.io.Writer writer,
                           javax.servlet.ServletRequest request,
                           javax.servlet.http.HttpServletResponse response)
                    throws javax.servlet.ServletException,
                           java.io.IOException

Throws:

javax.servlet.ServletException

java.io.IOException