org.fujion.component

Class Page

java.lang.Object

org.fujion.component.BaseComponent

org.fujion.component.Page

All Implemented Interfaces:

IElementIdentifier, INamespace

@Component(tag="page",
           widgetClass="Page",
           content=AS_CHILD,
           childTag=@Component.ChildTag(value="*"))
public final class Page
extends BaseComponent
implements INamespace

This is the root component of a Fujion Server Page.

Nested Class Summary

Nested classes/interfaces inherited from class org.fujion.component.BaseComponent

BaseComponent.SubComponent

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
Page()

Method Summary

Modifier and Type	Method and Description
static Page	_create(String src) Creates an uninitialized page.
static void	_init(Page page, ClientRequest request, Synchronizer synchronizer) Performs final initialization of a newly created page.
BaseComponent	findById(String id) Searches for a component attached to this page given its id.
Map<String,Object>	getBrowserInfo() Returns an immutable map of information provided by the browser.
String	getBrowserInfo(String key) Returns the requested attribute value from information provided by the client browser.
<T> T	getBrowserInfo(String key, Class<T> type) Returns the requested attribute value, cast to the specified type, from information provided by the client browser.
EventQueue	getEventQueue() Returns the event queue for this page.
String	getQueryParam(String param) Returns the named query parameter from the original request URL.
Map<String,String>	getQueryParams() Returns an immutable map containing all query parameters from the original request URL.
Session	getSession() Returns the web socket session dedicated to this page.
String	getSrc() Returns the URL of the FSP resource that created this page.
Synchronizer	getSynchronizer() Returns the synchronizer for this page.
String	getTitle() Returns the page title.
protected void	onDestroy() Cleanup page resources.
void	setParent(BaseComponent parent) A Page may not have a parent.
void	setTitle(String title) Sets the page title.

Methods inherited from class org.fujion.component.BaseComponent

_attach, _initProps, addChild, addChild, addChild, addChildren, addEventForward, addEventForward, addEventListener, addEventListener, addEventListener, addEventListener, afterAddChild, afterRemoveChild, afterSetParent, areEqual, beforeAddChild, beforeRemoveChild, beforeSetParent, bringToFront, defaultify, destroy, destroyChildren, detach, finalize, findAttribute, findByName, findByName, findChildByData, findChildByLabel, fireEvent, fireEvent, getAncestor, getAncestor, getAttribute, getAttribute, getAttribute, getAttributes, getChild, getChildAt, getChildCount, getChildCount, getChildren, getChildren, getContent, getData, getData, getDefinition, getFirstChild, getId, getIndex, getLastChild, getName, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, hasAttribute, hasEventListener, hasEventListener, invoke, invoke, invokeIfAttached, isAncestor, isContainer, isContentSynced, isDead, isNamespace, notifyAncestors, notifyDescendants, nullify, onAttach, removeAttribute, removeChild, removeEventForward, removeEventForward, removeEventListener, removeEventListener, removeEventListener, removeEventListener, setAttribute, setContent, setContentSynced, setData, setIndex, setName, sub, swapChildren, sync, toString, trimify, validate, validate, validateChild, validateIsChild, validatePage, validateParent, wireController

Methods inherited from class java.lang.Object

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

Field Detail

ID_PREFIX

public static final String ID_PREFIX

See Also:

Constant Field Values

Constructor Detail

Page

public Page()

Method Detail

_create

public static Page _create(String src)

Creates an uninitialized page. For internal use only.

Parameters:

src - URL of a FSP resource that will be used to populate the page upon initialization.

Returns:

The newly created page.

_init

public static void _init(Page page,
                         ClientRequest request,
                         Synchronizer synchronizer)

Performs final initialization of a newly created page. For internal use only.

Parameters:

page - The page to initialize.

request - The initialization request from the client.

synchronizer - The synchronizer that the page will use.

getSynchronizer

public Synchronizer getSynchronizer()

Returns the synchronizer for this page.

Returns:

The page's synchronizer.

getEventQueue

public EventQueue getEventQueue()

Returns the event queue for this page. Events placed on the event queue (typically by posting the event) will be processed at the end of the execution cycle.

Returns:

The event queue.

setParent

public void setParent(BaseComponent parent)

A Page may not have a parent.

Overrides:

setParent in class BaseComponent

Parameters:

parent - The new parent.

Throws:

ComponentException - Always thrown.

See Also:

BaseComponent.setParent(org.fujion.component.BaseComponent)

getBrowserInfo

public String getBrowserInfo(String key)

Returns the requested attribute value from information provided by the client browser.

Parameters:

key - The attribute key.

Returns:

The attribute value as a string, possibly null.

getBrowserInfo

public <T> T getBrowserInfo(String key,
                            Class<T> type)

Returns the requested attribute value, cast to the specified type, from information provided by the client browser.

Type Parameters:

T - The expected return type.

Parameters:

key - The attribute key.

type - The expected return type.

Returns:

The attribute value, possibly null.

getBrowserInfo

public Map<String,Object> getBrowserInfo()

Returns an immutable map of information provided by the browser.

Returns:

An immutable map of information provided by the browser.

getQueryParam

public String getQueryParam(String param)

Returns the named query parameter from the original request URL.

Parameters:

param - Name of query parameter.

Returns:

The value of the query parameter, or null if not found.

getQueryParams

public Map<String,String> getQueryParams()

Returns an immutable map containing all query parameters from the original request URL.

Returns:

An immutable map containing all query parameters from the original request URL.

getSession

public Session getSession()

Returns the web socket session dedicated to this page.

Returns:

The web socket session dedicated to this page.

getSrc

public String getSrc()

Returns the URL of the FSP resource that created this page.

Returns:

The URL of the FSP resource that created this page.

onDestroy

protected void onDestroy()

Cleanup page resources.

Overrides:

onDestroy in class BaseComponent

See Also:

BaseComponent.onDestroy()

findById

public BaseComponent findById(String id)

Searches for a component attached to this page given its id.

Parameters:

id - Identifier of the component sought.

Returns:

The component with the specified id, or null if not found.

getTitle

@Component.PropertyGetter(value="title")
public String getTitle()

Returns the page title.

Returns:

The page title.

setTitle

@Component.PropertySetter(value="title")
public void setTitle(String title)

Sets the page title.

Parameters:

title - The page title.