cat.inspiracio.orange

Class Template

java.lang.Object

cat.inspiracio.orange.Template

public abstract class Template
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.servlet.ServletContext	application
protected javax.servlet.ServletConfig	config
protected Throwable	exception
protected javax.servlet.jsp.JspWriter	out
protected Template	page
protected javax.servlet.jsp.PageContext	pageContext
protected javax.servlet.http.HttpServletRequest	request
protected javax.servlet.http.HttpServletResponse	response
protected javax.servlet.http.HttpSession	session

Constructor Summary

Constructors

Constructor and Description
Template()

Method Summary

Modifier and Type	Method and Description
protected void	attribute(String key, boolean b) Boolean attribute: write the key if the value is true.
protected void	attribute(String key, Object v) Attribute: If the value is empty, writes just the key, otherwise key and value, quoted.
protected String	escape(int i) Escapes an int for html: just convert it to String.
protected String	escape(Object o) escape for html: < & Called from generated write().
protected String	escape(String s) escape for html: < & Called from generated write().
protected String	quote(Object o) Quotes a value so that it can be an attribute's value.
protected String	quote(String value) Quotes a value so that it can be an attribute's value.
void	setPageContext(javax.servlet.jsp.PageContext pc) The only setter you need to call.
protected void	substitute(String v) Called for an element with attribute data-substitute=v.
abstract void	write() This is the method that template must implement.
Template	write(int i) Writes an int to out.
Template	write(Object o) Writes an object to out.
Template	write(String s) Writes a String to out.
Template	writeln() Write a string to output.
Template	writeln(String s) Write a string to output.

Methods inherited from class java.lang.Object

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

Field Detail

out

protected javax.servlet.jsp.JspWriter out

request

protected javax.servlet.http.HttpServletRequest request

response

protected javax.servlet.http.HttpServletResponse response

session

protected javax.servlet.http.HttpSession session

pageContext

protected javax.servlet.jsp.PageContext pageContext

application

protected javax.servlet.ServletContext application

config

protected javax.servlet.ServletConfig config

page

protected Template page

exception

protected Throwable exception

Constructor Detail

Template

public Template()

Method Detail

setPageContext

public final void setPageContext(javax.servlet.jsp.PageContext pc)

The only setter you need to call. It sets all fields.

write

public abstract void write()
                    throws Exception

This is the method that template must implement.

Throws:

Exception - Java-islands threw an exception.

substitute

protected final void substitute(String v)
                         throws Exception

Called for an element with attribute data-substitute=v. The attribute value is a path. The servlet reads a file at the path. The file contains an HTML fragment. The fragment is inserted in the document, substituting the original element. Example:

The attribute value is literally a path. It is not a javascript expression which when evaluated results in a path. The path is relative to the location of the document in which it occurs, or absolute if it starts with /.

Throws:

IOException

Exception

quote

protected final String quote(Object o)

Quotes a value so that it can be an attribute's value. Escapes " by " and encloses in ". Called from generated write().

quote

protected final String quote(String value)

Quotes a value so that it can be an attribute's value. Escapes " by " and encloses in ". Called from generated write().

escape

protected final String escape(Object o)

escape for html: < & Called from generated write().

escape

protected final String escape(String s)

escape for html: < & Called from generated write().

escape

protected final String escape(int i)

Escapes an int for html: just convert it to String. Called from generated write().

attribute

protected final void attribute(String key,
                               boolean b)
                        throws IOException

Boolean attribute: write the key if the value is true. Called from generated write().

Throws:

IOException

attribute

protected final void attribute(String key,
                               Object v)
                        throws IOException

Attribute: If the value is empty, writes just the key, otherwise key and value, quoted.

Throws:

IOException

write

public final Template write(int i)
                     throws IOException

Writes an int to out. Called from generated write(). Public and returns this for fluent style.

Throws:

IOException

write

public final Template write(Object o)
                     throws IOException

Writes an object to out. Does nothing if the object is empty (null or its toString() is null or ""). Called from generated write(). Public and returns this for fluent style.

Throws:

IOException

write

public final Template write(String s)
                     throws IOException

Writes a String to out. Does nothing if the String is null or "". Called from generated write(). Public and returns this for fluent style.

Throws:

IOException

writeln

public final Template writeln()
                       throws IOException

Write a string to output. Called from generated write(). Public and returns this for fluid style.

Throws:

IOException

writeln

public final Template writeln(String s)
                       throws IOException

Write a string to output. Called from generated write(). Public and returns this for fluid style.

Throws:

IOException