com.bowstreet.webapp
Interface Page

All Superinterfaces:

IExemplar, WebAppEventContainer, WebAppObject

public interface Page
extends WebAppObject, WebAppEventContainer

Represents a Page object, with IXml contents

Field Summary

static java.lang.String	DESIGN_VIEW_STYLE_SHEET
static java.lang.String	EVENT_ONLOAD
static java.lang.String	INDIVIDUAL_CONTROL_CONTAINER Name of the PageDataContainer which holds all the individual Controls
static java.lang.String	JSP_PAGE_PROCESSOR Name of the internal JSP PageProcessor ( *this is the default if none specified)
static java.lang.String	PAGE_PROCESSOR_PROPERTY Property for specifying a special Page Processor for this page.
static java.lang.String	PAGELOCATION_REDIRECT
static java.lang.String	PROCESSED_PAGE_REQUEST_ATTRIBUTE The name of the request attribute that specified that a page has been processed.
static java.lang.String	REDIRECT_TO_PAGE
static java.lang.String	STATIC_PAGE_PROCESSOR Name of the internal Static PageProcessor

Fields inherited from interface com.bowstreet.webapp.WebAppObject

ALWAYS_VISIBLE, INFORMATION_PROPERTY, NEVER_VISIBLE, SOMETIMES_VISIBLE

Method Summary

void	addContents(IXml contents) Adds contents to a page.
PageDataContainer	addPageDataContainer(java.lang.String name) Create an empty PageDataContainer
void	addScriptReference(java.lang.String script) Add a reference to the specified JavaScript file.
void	addStyleSheet(java.lang.String styleSheet) Add another stylesheet reference to the list of non-primary style sheets
PageDataContainer	associateVariable(java.lang.String variableName, java.lang.String dataPageReferenceName, java.lang.String namedNode) Associate an existing Variable in the WebApp with this Page.
PageDataContainer	associateVariable(Variable variable, java.lang.String dataPageReferenceName, java.lang.String namedNode) Associate an existing Variable in the WebApp with this Page.
void	clearContents() Clears the contents of the page.
PageDataContainer	findPageDataContainer(java.lang.String name) Find a named PageDataContainer
IXml	getContents() Get contents of page This is an IXml container for the page contents, e.g.
java.util.List	getPageDataContainers() Gets all the top-level PageDataContainers that are associated with this page.
java.lang.String	getPrimaryStyleSheet() Gets the current value for the primary Style sheet.
java.util.Collection	getScriptReferences()
java.util.Collection	getStyleSheets()
void	setPrimaryStyleSheet(java.lang.String styleSheet) Set the the current value for the primary Style sheet, overwriting the existing value

Methods inherited from interface com.bowstreet.webapp.WebAppObject

clone, getBuilderCall, getName, getProperties, getProperty, getVisibility, isHidden, putProperty, setBuilderCall, setHidden, setName, setVisibility

Methods inherited from interface com.bowstreet.util.IExemplar

newInstance

Methods inherited from interface com.bowstreet.webapp.WebAppEventContainer

addEventListener, getEventListeners, getEventListeners

Field Detail

DESIGN_VIEW_STYLE_SHEET

static final java.lang.String DESIGN_VIEW_STYLE_SHEET

See Also:

Constant Field Values

EVENT_ONLOAD

static final java.lang.String EVENT_ONLOAD

See Also:

Constant Field Values

INDIVIDUAL_CONTROL_CONTAINER

static final java.lang.String INDIVIDUAL_CONTROL_CONTAINER

Name of the PageDataContainer which holds all the individual Controls

See Also:

Constant Field Values

JSP_PAGE_PROCESSOR

static final java.lang.String JSP_PAGE_PROCESSOR

Name of the internal JSP PageProcessor ( *this is the default if none specified)

See Also:

Constant Field Values

PAGE_PROCESSOR_PROPERTY

static final java.lang.String PAGE_PROCESSOR_PROPERTY

Property for specifying a special Page Processor for this page. Processor is specified in pageprocessors.properties

See Also:

Constant Field Values

PAGELOCATION_REDIRECT

static final java.lang.String PAGELOCATION_REDIRECT

See Also:

Constant Field Values

PROCESSED_PAGE_REQUEST_ATTRIBUTE

static final java.lang.String PROCESSED_PAGE_REQUEST_ATTRIBUTE

The name of the request attribute that specified that a page has been processed. The attribute value will be the name of the page

See Also:

Constant Field Values

REDIRECT_TO_PAGE

static final java.lang.String REDIRECT_TO_PAGE

See Also:

Constant Field Values

STATIC_PAGE_PROCESSOR

static final java.lang.String STATIC_PAGE_PROCESSOR

Name of the internal Static PageProcessor

See Also:

Constant Field Values

Method Detail

addContents

void addContents(IXml contents)

Adds contents to a page.

Parameters:

contents - for page

addPageDataContainer

PageDataContainer addPageDataContainer(java.lang.String name)

Create an empty PageDataContainer

Parameters:

name - must be unique within this entire Page

Returns:

a new PageDataContainer

addScriptReference

void addScriptReference(java.lang.String script)

Add a reference to the specified JavaScript file.

Parameters:

script -

addStyleSheet

void addStyleSheet(java.lang.String styleSheet)

Add another stylesheet reference to the list of non-primary style sheets

Parameters:

styleSheet -

associateVariable

PageDataContainer associateVariable(java.lang.String variableName,
                                    java.lang.String dataPageReferenceName,
                                    java.lang.String namedNode)

Associate an existing Variable in the WebApp with this Page.

Parameters:

variableName - The name of the Variable. This may include wildcards!!

Returns:

The new PageDataContainer created for this variable or group.

associateVariable

PageDataContainer associateVariable(Variable variable,
                                    java.lang.String dataPageReferenceName,
                                    java.lang.String namedNode)

Associate an existing Variable in the WebApp with this Page.

Parameters:

variable -

Returns:

The new PageDataContainer created for this variable

clearContents

void clearContents()

Clears the contents of the page. Any content that was previously added will be lost.

findPageDataContainer

PageDataContainer findPageDataContainer(java.lang.String name)

Find a named PageDataContainer

Parameters:

name - case-sensitive name

Returns:

Container with the name -- possibly null

getContents

IXml getContents()

Get contents of page This is an IXml container for the page contents, e.g. HTML would be a child element.

Returns:

IXml parent node for all the page contents

getPageDataContainers

java.util.List getPageDataContainers()

Gets all the top-level PageDataContainers that are associated with this page. If multiple Data Page Builders, for instance, have been applied to the page, there will be one per Data Page Builder. All of the single Controls that have been placed on the page will be collected into a single PageDataContainer which is named "IndividualControlContainer"

Returns:

List of elements of type PageDataCollections. Might be empty but never null.

getPrimaryStyleSheet

java.lang.String getPrimaryStyleSheet()

Gets the current value for the primary Style sheet. Might be null

Returns:

the current value for the primary Style sheet -- might be null

getScriptReferences

java.util.Collection getScriptReferences()

Returns:

All the JavaScript refrerences declared for this page.

getStyleSheets

java.util.Collection getStyleSheets()

Returns:

All the style sheets declared for this page, INCLUDING the primary one, if defined.

setPrimaryStyleSheet

void setPrimaryStyleSheet(java.lang.String styleSheet)

Set the the current value for the primary Style sheet, overwriting the existing value

Parameters:

styleSheet - - new value for the primary Style sheet