com.github.drinkjava2.jwebbox

Class JspBox

java.lang.Object

com.github.drinkjava2.jwebbox.JspBox

public class JspBox
extends Object

JspBox is a small layout tool used only for JSP pages, playing the same role like Apache Tiles

Version:

2.1.2

Author:

Yong Zhu(yong9981@gmail.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JspBox.JspBoxException A runtime exception caused by JspBox
static class	JspBox.Show This is a custom TagLib for JSP and also can be used in FreeMaker

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSPBOXID

Constructor Summary

Constructors

Constructor and Description
JspBox()
JspBox(String page) Create a JspBox

Method Summary

Modifier and Type	Method and Description
void	afterExecute() For subclasses override this method to do something
void	afterPrepared() For subclasses override this method to do something
void	afterShow() For subclasses override this method to do something
void	beforeExecute() For subclasses override this method to do something
void	execute() For subclasses override this method to do something
static <T> T	getAttribute(javax.servlet.jsp.PageContext pageContext, String attributeName) Get an attribute from current page's JspBox instance
<T> T	getAttribute(String key) Get JspBox's attribute
Map<String,Object>	getAttributeMap() Get the attribute map of JspBox instance
static JspBox	getBox(javax.servlet.jsp.PageContext pageContext) Get current pageContext's JspBox instance
JspBox	getFatherJspBox() Set the father page's JspBox instance
String	getName() get the name of the JspBox instance
<T> T	getObject(String key) Search and return an attribute object follow this order: pageContext->request->parameter->session
Object	getPage() Get the page
javax.servlet.jsp.PageContext	getPageContext() Get current pageContext if have
Object	getPrepareBean() Get the prepare bean instance
String	getPrepareBeanMethod() Get the prepare bean method name
String	getPrepareStaticMethod() Get the Prepare static method name
String	getPrepareURL() Get the prepare URL
String	getText() Get the Text
static boolean	isEmptyStr(String str) Check if String null or empty
void	prepareOnly(javax.servlet.jsp.PageContext pageContext) Prepare data, only but do not output text and do not show page
void	render() For subclasses override this method to do something
JspBox	setAttribute(String key, Object value) Set attribute for current JspBox instance
JspBox	setAttributeMap(Map<String,Object> attributeMap) Set the attribute map for JspBox instance
void	setFatherJspBox(JspBox fatherJspBox) Get the father page's JspBox instance
JspBox	setName(String name) Set the name of the JspBox instance
JspBox	setPage(Object page) Set a JSP page or URL
void	setPageContext(javax.servlet.jsp.PageContext pageContext) Set pageContext to it
void	setPageContextAttribute(String key, Object value) Set a pageContext attribute
JspBox	setPrepareBean(Object prepareBean) Set a prepare bean which has a prepare method
JspBox	setPrepareBeanMethod(String prepareBeanMethod) Set the bean prepare method name
JspBox	setPrepareStaticMethod(String prepareStaticMethod) Set a prepare static method
JspBox	setPrepareURL(String prepareURL) Set prepare URL, this URL be called after prepare methods but before show page
void	setRequestAttribute(String key, Object value) Set a request attribute
void	setSessionAttribute(String key, Object value) Set a session attribute
JspBox	setText(String text) Set the text String
JspBox	show(javax.servlet.jsp.PageContext pageContext) Prepare data and out put text include page if have
static void	showAttribute(javax.servlet.jsp.PageContext pageContext, String attributeName) Assume the value is String or JspBox instance, show it
JspBox	showPageOnly(javax.servlet.jsp.PageContext pageContext) Show page only, do not call prepareStaticMethod and URL
static void	showTarget(javax.servlet.jsp.PageContext pageContext, Object target) Show an target object, target can be: JspBox instance or String or List of JspBox instance or String

Methods inherited from class java.lang.Object

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

Field Detail

JSPBOXID

public static final String JSPBOXID

See Also:

Constant Field Values

Constructor Detail

JspBox

public JspBox()

JspBox

public JspBox(String page)

Create a JspBox

Parameters:

page - The JSP or FTL or any URL, for example: "/template/abc.jsp"

Method Detail

isEmptyStr

public static boolean isEmptyStr(String str)

Check if String null or empty

beforeExecute

public void beforeExecute()

For subclasses override this method to do something

execute

public void execute()

For subclasses override this method to do something

afterExecute

public void afterExecute()

For subclasses override this method to do something

afterPrepared

public void afterPrepared()

For subclasses override this method to do something

render

public void render()

For subclasses override this method to do something

afterShow

public void afterShow()

For subclasses override this method to do something

show

public JspBox show(javax.servlet.jsp.PageContext pageContext)

Prepare data and out put text include page if have

prepareOnly

public void prepareOnly(javax.servlet.jsp.PageContext pageContext)

Prepare data, only but do not output text and do not show page

showPageOnly

public JspBox showPageOnly(javax.servlet.jsp.PageContext pageContext)

Show page only, do not call prepareStaticMethod and URL

getBox

public static JspBox getBox(javax.servlet.jsp.PageContext pageContext)

Get current pageContext's JspBox instance

getAttribute

public static <T> T getAttribute(javax.servlet.jsp.PageContext pageContext,
                                 String attributeName)

Get an attribute from current page's JspBox instance

showAttribute

public static void showAttribute(javax.servlet.jsp.PageContext pageContext,
                                 String attributeName)

Assume the value is String or JspBox instance, show it

showTarget

public static void showTarget(javax.servlet.jsp.PageContext pageContext,
                              Object target)

Show an target object, target can be: JspBox instance or String or List of JspBox instance or String

setAttribute

public JspBox setAttribute(String key,
                           Object value)

Set attribute for current JspBox instance

getAttribute

public <T> T getAttribute(String key)

Get JspBox's attribute

getObject

public <T> T getObject(String key)

Search and return an attribute object follow this order: pageContext->request->parameter->session

setPageContextAttribute

public void setPageContextAttribute(String key,
                                    Object value)

Set a pageContext attribute

setRequestAttribute

public void setRequestAttribute(String key,
                                Object value)

Set a request attribute

setSessionAttribute

public void setSessionAttribute(String key,
                                Object value)

Set a session attribute

getPrepareURL

public String getPrepareURL()

Get the prepare URL

setPrepareURL

public JspBox setPrepareURL(String prepareURL)

Set prepare URL, this URL be called after prepare methods but before show page

getPage

public Object getPage()

Get the page

setPage

public JspBox setPage(Object page)

Set a JSP page or URL

getText

public String getText()

Get the Text

setText

public JspBox setText(String text)

Set the text String

setPrepareStaticMethod

public JspBox setPrepareStaticMethod(String prepareStaticMethod)

Set a prepare static method

getPrepareStaticMethod

public String getPrepareStaticMethod()

Get the Prepare static method name

getPrepareBean

public Object getPrepareBean()

Get the prepare bean instance

setPrepareBean

public JspBox setPrepareBean(Object prepareBean)

Set a prepare bean which has a prepare method

getPrepareBeanMethod

public String getPrepareBeanMethod()

Get the prepare bean method name

setPrepareBeanMethod

public JspBox setPrepareBeanMethod(String prepareBeanMethod)

Set the bean prepare method name

getAttributeMap

public Map<String,Object> getAttributeMap()

Get the attribute map of JspBox instance

setAttributeMap

public JspBox setAttributeMap(Map<String,Object> attributeMap)

Set the attribute map for JspBox instance

getName

public String getName()

get the name of the JspBox instance

setName

public JspBox setName(String name)

Set the name of the JspBox instance

getFatherJspBox

public JspBox getFatherJspBox()

Set the father page's JspBox instance

setFatherJspBox

public void setFatherJspBox(JspBox fatherJspBox)

Get the father page's JspBox instance

getPageContext

public javax.servlet.jsp.PageContext getPageContext()

Get current pageContext if have

setPageContext

public void setPageContext(javax.servlet.jsp.PageContext pageContext)

Set pageContext to it