com.github.drinkjava2.jwebbox

Class WebBox

java.lang.Object

com.github.drinkjava2.jwebbox.WebBox

public class WebBox
extends Object

WebBox is a small layout tool used in servlet environment

Since:

v1.0.0

Author:

Yong Zhu(yong9981@gmail.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebBox.WebBoxException A runtime exception caused by HtmlBox

Field Summary

Fields

Modifier and Type	Field and Description
static String	JWEBBOXID

Constructor Summary

Constructors

Constructor and Description
WebBox()
WebBox(String page) Create a HtmlBox

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.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String attributeName) Get an attribute from current page's HtmlBox instance
<T> T	getAttribute(String key) Get HtmlBox's attribute
Map<String,Object>	getAttributeMap() Get the attribute map of HtmlBox instance
static WebBox	getBox(javax.servlet.http.HttpServletRequest request) Get current pageContext's HtmlBox instance
WebBox	getFatherHtmlBox() Set the father page's HtmlBox instance
String	getName() get the name of the HtmlBox instance
<T> T	getObject(String key) Search and return an attribute object follow this order: pageContext->request->parameter->session
Object	getPage() Get the page
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
javax.servlet.http.HttpServletRequest	getRequest() Get current Box's HttpServletRequest if have
javax.servlet.http.HttpServletResponse	getResponse() Get current Box's HttpServletResponse if have
String	getText() Get the Text
static String	getWebappFolder()
static boolean	isEmptyStr(String str) Check if String null or empty
void	prepareOnly(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Prepare data, only but do not output text and do not show page
void	render(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String pageOrUrl) For subclasses override this method to do customized render
WebBox	setAttribute(String key, Object value) Set attribute for current HtmlBox instance
WebBox	setAttributeMap(Map<String,Object> attributeMap) Set the attribute map for HtmlBox instance
void	setFatherHtmlBox(WebBox fatherHtmlBox) Get the father page's HtmlBox instance
WebBox	setName(String name) Set the name of the HtmlBox instance
WebBox	setPage(Object page) Set a JSP page or URL
WebBox	setPrepareBean(Object prepareBean) Set a prepare bean which has a prepare method
WebBox	setPrepareBeanMethod(String prepareBeanMethod) Set the bean prepare method name
WebBox	setPrepareStaticMethod(String prepareStaticMethod) Set a prepare static method
WebBox	setPrepareURL(String prepareURL) Set prepare URL, this URL be called after prepare methods but before show page
void	setRequest(javax.servlet.http.HttpServletRequest request) Set HttpServletRequest to current Box
void	setRequestAttribute(String key, Object value) Set a request attribute
void	setResponse(javax.servlet.http.HttpServletResponse response) Set HttpServletResponse to current Box
void	setSessionAttribute(String key, Object value) Set a session attribute
WebBox	setText(String text) Set the text String
static void	setWebappFolder(String webappFolder)
WebBox	show(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Prepare data and out put text include page if have
static void	showAttribute(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String attributeName) Assume the value is String or HtmlBox instance, show it
WebBox	showPageOnly(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Show page only, do not call prepareStaticMethod and URL
static void	showTarget(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object target) Show an target object, target can be: HtmlBox instance or String or List of HtmlBox instance or String

Methods inherited from class java.lang.Object

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

Field Detail

JWEBBOXID

public static final String JWEBBOXID

See Also:

Constant Field Values

Constructor Detail

WebBox

public WebBox()

WebBox

public WebBox(String page)

Create a HtmlBox

Parameters:

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

Method Detail

getWebappFolder

public static String getWebappFolder()

setWebappFolder

public static void setWebappFolder(String webappFolder)

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

afterShow

public void afterShow()

For subclasses override this method to do something

show

public WebBox show(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)

Prepare data and out put text include page if have

prepareOnly

public void prepareOnly(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)

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

showPageOnly

public WebBox showPageOnly(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)

Show page only, do not call prepareStaticMethod and URL

render

public void render(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response,
                   String pageOrUrl)
            throws Exception

For subclasses override this method to do customized render

Throws:

Exception

getBox

public static WebBox getBox(javax.servlet.http.HttpServletRequest request)

Get current pageContext's HtmlBox instance

getAttribute

public static <T> T getAttribute(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 String attributeName)

Get an attribute from current page's HtmlBox instance

showAttribute

public static void showAttribute(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 String attributeName)

Assume the value is String or HtmlBox instance, show it

showTarget

public static void showTarget(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response,
                              Object target)

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

setAttribute

public WebBox setAttribute(String key,
                           Object value)

Set attribute for current HtmlBox instance

getAttribute

public <T> T getAttribute(String key)

Get HtmlBox's attribute

getObject

public <T> T getObject(String key)

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

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 WebBox 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 WebBox setPage(Object page)

Set a JSP page or URL

getText

public String getText()

Get the Text

setText

public WebBox setText(String text)

Set the text String

setPrepareStaticMethod

public WebBox 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 WebBox setPrepareBean(Object prepareBean)

Set a prepare bean which has a prepare method

getPrepareBeanMethod

public String getPrepareBeanMethod()

Get the prepare bean method name

setPrepareBeanMethod

public WebBox setPrepareBeanMethod(String prepareBeanMethod)

Set the bean prepare method name

getAttributeMap

public Map<String,Object> getAttributeMap()

Get the attribute map of HtmlBox instance

setAttributeMap

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

Set the attribute map for HtmlBox instance

getName

public String getName()

get the name of the HtmlBox instance

setName

public WebBox setName(String name)

Set the name of the HtmlBox instance

getFatherHtmlBox

public WebBox getFatherHtmlBox()

Set the father page's HtmlBox instance

setFatherHtmlBox

public void setFatherHtmlBox(WebBox fatherHtmlBox)

Get the father page's HtmlBox instance

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Get current Box's HttpServletRequest if have

setRequest

public void setRequest(javax.servlet.http.HttpServletRequest request)

Set HttpServletRequest to current Box

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

Get current Box's HttpServletResponse if have

setResponse

public void setResponse(javax.servlet.http.HttpServletResponse response)

Set HttpServletResponse to current Box