com.groiss.gui

Class XHTMLPage

java.lang.Object

com.groiss.gui.AbstractComponent

com.groiss.gui.AbstractContainer

com.groiss.gui.XHTMLPage

All Implemented Interfaces:

Component, Container, Page, StreamablePage, Serializable, Cloneable

public class XHTMLPage
extends AbstractContainer
implements StreamablePage

This class creates HTML-Pages from XHTML-Source.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Element	body
static String	CLASS
protected String	contentType
protected Document	doc
protected Element	head
protected String	id

Fields inherited from class com.groiss.gui.AbstractContainer

components

Fields inherited from class com.groiss.gui.AbstractComponent

ACTIVE, browserMode, DEFAULT, ID, IE, INVISIBLE, isSensitive, label, NS, ON_BLUR, ON_CHANGE, ON_CLICK, ON_DBLCLICK, ON_FOCUS, ON_KEY_DOWN, ON_KEY_PRESS, ON_KEY_UP, ON_LOAD, ON_MOUSE_DOWN, ON_MOUSE_MOVE, ON_MOUSE_OUT, ON_MOUSE_UP, ON_RESET, ON_SELECT, ON_SUBMIT, ON_UNLOAD, parent, parentElem, READONLY, root, viewMode

Fields inherited from interface com.groiss.gui.Component

LABELLEDBY

Constructor Summary

Constructors

Constructor and Description
XHTMLPage() creates a new empty XHTMLPage object
XHTMLPage(String resource) creates a new XHTMLPage object from a specified template source and builds the JDOM.
XHTMLPage(String file, Resource resource) creates a new XHTMLPage object from a specified template source and builds the JDOM with specified ResourceBundle

Method Summary

Modifier and Type	Method and Description
void	addHeader(String header, Date value) Set a header field in the response before writing the page.
void	addHeader(String header, int value) Set a header field in the response before writing the page.
void	addHeader(String header, String value) Set a header field in the response before writing the page.
Element	getBody()
Object	getContent() Returns null.
String	getContentType() Returns the content type of the page, for example "text/html".
Document	getDocument()
Element	getHead()
List<Pair<String,Object>>	getHeaders() Returns the list of http-response-headers to be set on the HttpServletResponse
String	getTitle()
void	init(Document document)
void	output(Writer w)
void	setContent(Object o) Does nothing.
void	setContentType(String contentType)
XHTMLPage	setPage(String page)
void	setTitle(String title)
String	show() method for rendering the component as string

Methods inherited from class com.groiss.gui.AbstractContainer

add, get, getAll, getAll, getAllDeep, getByName, getComponents, getWithParent, init, remove, setBrowserMode, substitute

Methods inherited from class com.groiss.gui.AbstractComponent

addClass, clone, create, getAttribute, getBrowserMode, getId, getLabel, getName, getParent, getParentElement, getRoot, getRootName, getStyle, getViewMode, init, init, removeAttribute, removeClass, setActionListener, setAttribute, setClass, setEncoding, setExpandEmptyElements, setId, setIndenting, setLabel, setName, setNewLines, setParent, setParentElement, setRootName, setStyle, setViewMode, show, toggleClass, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.groiss.gui.Component

addClass, clone, getAttribute, getBrowserMode, getId, getLabel, getName, getParent, getParentElement, getRoot, getStyle, getViewMode, init, removeAttribute, removeClass, setActionListener, setAttribute, setClass, setId, setLabel, setName, setParent, setParentElement, setStyle, setViewMode, show, toggleClass, toString

Field Detail

CLASS

public static final String CLASS

See Also:

Constant Field Values

doc

protected Document doc

id

protected String id

head

protected Element head

body

protected Element body

contentType

protected String contentType

Constructor Detail

XHTMLPage

public XHTMLPage()

creates a new empty XHTMLPage object

XHTMLPage

public XHTMLPage(String resource)

creates a new XHTMLPage object from a specified template source and builds the JDOM. the required resource-bundles will be determined automatically

XHTMLPage

public XHTMLPage(String file,
                 Resource resource)

creates a new XHTMLPage object from a specified template source and builds the JDOM with specified ResourceBundle

Parameters:

resource - - the specified resource

Method Detail

setPage

public XHTMLPage setPage(String page)

getDocument

public Document getDocument()

init

public void init(Document document)

setTitle

public void setTitle(String title)

getTitle

public String getTitle()

setContent

public void setContent(Object o)

Does nothing.

Specified by:

setContent in interface Component

Overrides:

setContent in class AbstractComponent

Parameters:

o - - any object where the string representation is used for rendering

getContent

public Object getContent()

Returns null.

Specified by:

getContent in interface Component

Overrides:

getContent in class AbstractComponent

Returns:

nul

getContentType

public String getContentType()

Description copied from interface: Page

Returns the content type of the page, for example "text/html".

Specified by:

getContentType in interface Page

Returns:

the contents mime type as String

setContentType

public void setContentType(String contentType)

show

public String show()

Description copied from interface: Component

method for rendering the component as string

Specified by:

show in interface Component

Specified by:

show in interface Page

Overrides:

show in class AbstractComponent

Returns:

- the rendered component as String

getBody

public Element getBody()

getHead

public Element getHead()

getHeaders

public List<Pair<String,Object>> getHeaders()

Description copied from interface: Page

Returns the list of http-response-headers to be set on the HttpServletResponse

Specified by:

getHeaders in interface Page

Returns:

the http-headers (the value may be one of String, Date or Integer

addHeader

public void addHeader(String header,
                      String value)

Set a header field in the response before writing the page. Please note that HttpServletResponse.setHeader(String, String) will be used to set to the new value.

Parameters:

header - the name of the header

value - the header value

addHeader

public void addHeader(String header,
                      Date value)

Set a header field in the response before writing the page. Please note that HttpServletResponse.setDateHeader(String,long) will be used to set to the new value.

Parameters:

header - the name of the header

value - the header value

addHeader

public void addHeader(String header,
                      int value)

Set a header field in the response before writing the page. Please note that HttpServletResponse.setIntHeader(String,int) will be used to set to the new value.

Parameters:

header - the name of the header

value - the header value

output

public void output(Writer w)

Specified by:

output in interface StreamablePage