Overview

Package

Class

Tree

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.bowstreet.builders.webapp.pageautomation.content
Class PageReference

java.lang.Object | +--com.bowstreet.builders.webapp.pageautomation.content.Element | +--com.bowstreet.builders.webapp.pageautomation.content.Container | +--com.bowstreet.builders.webapp.pageautomation.content.PageReference

All Implemented Interfaces:

DataDefinitionContainer, DataDefinitionElement, PageDataContainer, PageDataElement, ViewableDomainObject

public class PageReference

extends Container

A special type of Container. There should only be one per page

Field Summary
static java.lang.String	ATTRIBUTE_SEQUENCE_FLAG
static java.lang.String	KEY_PARTIALIMPLEMENTATIONOF

Fields inherited from class com.bowstreet.builders.webapp.pageautomation.content.Container

ADD_METHOD_SUFFIX, COLUMN_HEADER_SUFFIX, DELETE_SUFFIX, MAX_ORDINAL_SUFFIX, MIN_ORDINAL_SUFFIX, ORDINAL_SUFFIX, REMOVE_METHOD_SUFFIX, REPEAT_SUFFIX, SUFFIX_SUFFIX

Fields inherited from class com.bowstreet.builders.webapp.pageautomation.content.Element

CT_BLANK, CT_BUTTON, CT_CHECKBOX, CT_HIDDEN_INPUT_SPECIAL, CT_HIDDEN_WITH_TEXT, CT_IMAGE, CT_IMAGEBUTTON, CT_LINK, CT_PASSWORDINPUT, CT_RADIO, CT_RADIO_BUTTON_SPECIAL, CT_SELECT, CT_SPECIAL, CT_TEXTAREA, CT_TEXTINPUT, CT_TEXTOUTPUT, CT_UNKNOWN, KEY_ADDITIONAL_INPUTS, KEY_AUTOMATIONHELPER, KEY_BEAN_ATTRNAME, KEY_BUILDUI, KEY_COLUMNSORTTYPE, KEY_COMBINEDERRORLOCATION, KEY_CONTROLTYPE, KEY_DISABLEEVENTHANDLER, KEY_ENUMERATEDOPTIONS, KEY_ENUMTYPE, KEY_ERRORVARIABLE, KEY_GENELEMENT, KEY_GENERATED_DELETE_METHODNAME, KEY_GENERATED_PAGINGASST_NAME, KEY_GENERATELABELS, KEY_HTML_TEMPLATE, KEY_HTMLCLASSNAMEGENERATOR, KEY_INFERTYPEVALIDATION, KEY_INITIALIZEINPUTSWHEN, KEY_INPUTOUTPUTTYPE, KEY_ISBEAN, KEY_LABELTRANSLATETABLE, KEY_LOOP_VARIABLE, KEY_NAMELEVEL, KEY_PAGE_GENELEMENT, KEY_PAGE_GENERATOR, KEY_PAGEIOTYPE, KEY_PAGING_AUTORESET, KEY_PARENTNODE_OVERRIDE, KEY_REPEATED_REGION_VARIABLE, KEY_RUNTIME_AGENT, KEY_SKIP_JSP_POSTPROCESSING, KEY_SKIP_POSTSAVEMETHOD_IF_ERRORS, KEY_VALIDATIONFAILUREACTION, KEY_VALIDATIONMETHOD, KEY_VALIDATIONSUCCESSACTION, LABEL_SUFFIX, REQUIRED_SUFFIX, SN_ALWAYS, SN_RARELY, SN_USUALLY, VALIDATION_ERROR_SUFFIX

Fields inherited from interface com.bowstreet.webapp.DataDefinitionElement

DISPLAY_AUTO, DISPLAY_HORIZONTAL, DISPLAY_NO_VISIBLE, DISPLAY_NONE, DISPLAY_VERTICAL, KEY_ACTIONTYPE, KEY_APPEND_BAD_VALUE_TO_ERROR_MSG, KEY_ATTRIBUTES, KEY_COLUMN_SUMMARY, KEY_COLUMN_SUMMARY_ARGUMENT, KEY_COLUMN_SUMMARY_COLUMN1, KEY_COLUMN_SUMMARY_COLUMN2, KEY_COLUMN_SUMMARY_NODE, KEY_COLUMN_SUMMARY_OPERATION, KEY_COLUMN_SUMMARY_STANDARD_VARIABLE, KEY_COLUMN_SUMMARY_TEXTAFTER, KEY_COLUMN_SUMMARY_TEXTBEFORE, KEY_COLUMNALIGNMENT, KEY_COLUMNWIDTH, KEY_CREATE_ROW_METHOD, KEY_CREATE_ROW_METHODS, KEY_CUSTOMHIDELOCATION, KEY_DATA_SOURCE_MANAGER, KEY_DELETE_METHOD, KEY_DELETE_METHOD_TYPE, KEY_EMPTYDATAACTION, KEY_EMPTYDATAMESSAGE, KEY_EMPTYDATAMESSAGE_NAMEDLOCATION, KEY_EMPTYDATAMESSAGE_NODE, KEY_GENELEMENT, KEY_GENERATELABELS, KEY_HANDLEEXISTING, KEY_INFERCONTROLTYPE, KEY_IS_DATA_TRANSPARENT_CONTAINER, KEY_IS_POST_GENERATED_ELEMENT, KEY_ISMODELACTION, KEY_KEY_FIELD, KEY_LABELCLASS_ERROR, KEY_LABELCLASS_NOERROR, KEY_LABELTRANSLATETABLE, KEY_LOOKUP_TABLE, KEY_MODIFIERSLIST_DATAENTRY, KEY_MODIFIERSLIST_DISPLAYONLY, KEY_NO_ASSIGN_IF_VALIDATION_ERROR, KEY_ORIGINAL_DATASOURCE, KEY_PAGE_GENELEMENT, KEY_PUT_ASSIGN_IN_TRY_CATCH, KEY_RADIO_GROUP_STYLE_CLASS, KEY_RENDEROUTERPAGE, KEY_REQUIREDPROMPT, KEY_REQUIREDPROMPTPLACEMENT, KEY_RESOURCE_KEY_PREFIX, KEY_SEPARATOR, KEY_SPLIT_CHILDREN_INTO_COLUMNS, KEY_TRANSLATE_HTML_LABELS, KEY_USINGCHECKBOXES, KEY_VALIDATIONERRORPLACEMENT, KEY_VARIABLENAME, TYPE_ANYTYPE, TYPE_BOOLEAN, TYPE_BYTE, TYPE_DATE, TYPE_DATETIME, TYPE_DOUBLE, TYPE_FLOATINGPOINT, TYPE_INT, TYPE_INTEGER, TYPE_LONG, TYPE_NEGINT, TYPE_NONNEGINT, TYPE_NONPOSINT, TYPE_POSINT, TYPE_SHORT, TYPE_STRING, TYPE_TIME

Constructor Summary

PageReference(WebApp webApp, BuilderCall builderCall, Page page)

PageReference(WebApp webApp, BuilderCall builderCall, java.lang.String name, Page page)

Method Summary
boolean	addDataSaveCode(java.lang.StringBuffer buffer, java.lang.String dataRootName, java.lang.String requestInputsSuffix, int dataSource, IXml formNode)
void	addElementNames(java.util.List list, java.lang.String prefix, boolean containersOnly) Name here is a bit of a misnomer.
void	addFormInfo(com.bowstreet.builders.webapp.pageautomation.content.PageReference.FormInfo formInfo)
boolean	constructSaveDataMethod(com.bowstreet.builders.webapp.pageautomation.content.CodeGenerationContext context, java.lang.String postSaveAction)
boolean	generateJSP(GenContext genContext, java.lang.String nameMorphSuffix) Create the actual JSP.
IXml	generateNode(IXml wrapper) Here to generate the XML which will become the page.
java.util.List	getDataChildren() Get the Data tree, which might be different from the display tree
java.lang.String	getDataSourceString() Unless this node has a DataSourceOverride, then the DataSourceString is constructed by the DataSourceManager.
java.util.Map	getElementNames()
static java.lang.String	getErrorVariableName(PageDataElement element, boolean constructIfNeeded)
java.util.Collection	getFormInfos()
Page	getPage() get the Page that this is part of
Container	getParent()
void	setDataChildren(java.util.List dataChildren) Set the Data tree, making it different from the display tree
void	setElementNames(java.util.Map map)
void	setParent(Element parent)
java.lang.String	toString()

Methods inherited from class com.bowstreet.builders.webapp.pageautomation.content.Container

addChild, addChild, addCodeToCallUserDeleteByKeyMethod, addCodeToRefreshPagingAsst, addDDContainerChild, addDDLeafChild, addPDContainerChild, addPDLeafChild, childrenGenerateJSP, clone, constructHiddenChildren, copyPropertiesTo, findChild, findNode, getChildren, getChildrenDataSaveCode, getChildrenDataSaveCode, getChildrenRepeatNode, getCounterVarName, getDataPagingPageSize, getDeleteMethodName, getDisplayMode, getPagingAssistantName, getRepeatingParentDataSourceString, getRepeatNode, getSchemaPath, hasInputFields, hasSummaryChildren, hasValidatedInputFields, isHidden, isMatchedToPage, needsEmptyDataHTML, removeChild, removeChild, setChildrenRepeatNode, setColumnWidthAndAlignment, setCounterVarName, setDataPagingPageSize

Methods inherited from class com.bowstreet.builders.webapp.pageautomation.content.Element

addDataSaveCode, bestReadableName, constructPageLocation, constructPageLocation, findDDChild, findPDChild, getAppliedDataSourceString, getAutomationHelper, getBooleanProperty, getBuilderCall, getClearVariableBeforeSaving, getDataSourceExtension, getDataSourceManager, getDataSourceOverride, getDDParent, getDescription, getHTMLClassNameGenerator, getIntProperty, getIsRepeated, getIsRequired, getLabel, getLabelNode, getLocalProperties, getMaxOccurs, getMinOccurs, getName, getNode, getPageGenerationAgent, getPDParent, getProperties, getProperty, getRequiredPromptNode, getRuntimeAgent, getShortLabel, getStringProperty, getType, getUntranslatedLabel, getValidateErrorNode, getWebApp, getXmlProperty, isDataEntryPage, isDirectlyHidden, isRepeated, makePropertyLocalOnly, putBothProperties, putLocalProperty, putProperty, setBuilderCall, setClearVariableBeforeSaving, setDataSourceExtension, setDataSourceOverride, setDefaultLabel, setDescription, setDisplayMode, setIsRepeated, setIsRequired, setLabel, setLabelNode, setMaxOccurs, setMinOccurs, setName, setNode, setParent, setRequiredPromptNode, setShortLabel, setType, setValidateErrorNode, setWebApp, shouldBuildUI

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.bowstreet.webapp.DataDefinitionElement

bestReadableName, findDDChild, getBooleanProperty, getBuilderCall, getDataSourceExtension, getDDParent, getDescription, getIntProperty, getIsRepeated, getIsRequired, getLabel, getName, getProperty, getShortLabel, getStringProperty, getType, getXmlProperty, putBothProperties, putLocalProperty, putProperty, setBuilderCall, setDataSourceExtension, setDescription, setDisplayMode, setIsRepeated, setIsRequired, setLabel, setShortLabel, setType

Methods inherited from interface com.bowstreet.webapp.PageDataElement

findPDChild, getAppliedDataSourceString, getLabelNode, getNode, getPDParent, setDataSourceOverride, setLabelNode, setNode

Field Detail

ATTRIBUTE_SEQUENCE_FLAG

public static final java.lang.String ATTRIBUTE_SEQUENCE_FLAG

KEY_PARTIALIMPLEMENTATIONOF

public static final java.lang.String KEY_PARTIALIMPLEMENTATIONOF

Constructor Detail

PageReference

public PageReference(WebApp webApp, BuilderCall builderCall, Page page)

PageReference

public PageReference(WebApp webApp, BuilderCall builderCall, java.lang.String name, Page page)

Method Detail

addDataSaveCode

public boolean addDataSaveCode(java.lang.StringBuffer buffer, java.lang.String dataRootName, java.lang.String requestInputsSuffix, int dataSource, IXml formNode)

addElementNames

public void addElementNames(java.util.List list, java.lang.String prefix, boolean containersOnly)

Name here is a bit of a misnomer. This adds all the selectors to a list, for use by the widget.

Overrides:

addElementNames in class Container

Following copied from class: com.bowstreet.builders.webapp.pageautomation.content.Element

Parameters:

list - Add your own and your children's names to this list

prefix - Prefix all names with this string.

containersOnly - Only include containers

addFormInfo

public final void addFormInfo(com.bowstreet.builders.webapp.pageautomation.content.PageReference.FormInfo formInfo)

constructSaveDataMethod

public boolean constructSaveDataMethod(com.bowstreet.builders.webapp.pageautomation.content.CodeGenerationContext context, java.lang.String postSaveAction)

generateJSP

public boolean generateJSP(GenContext genContext, java.lang.String nameMorphSuffix)

Description copied from class: Container

Create the actual JSP. This is called after generateNode. For the non-repeating case, the only work we have to do is to cascade down to the kids.

Overrides:

generateJSP in class Container

Following copied from class: com.bowstreet.builders.webapp.pageautomation.content.Container

Parameters:

genContext -

Returns:

true for success

generateNode

public IXml generateNode(IXml wrapper)

Description copied from class: Container

Here to generate the XML which will become the page.

Overrides:

generateNode in class Container

Following copied from class: com.bowstreet.builders.webapp.pageautomation.content.Container

Parameters:

wrapper - This will be a TABLE node, if it is not null, and you are expected to put one or more TR's in it.

Returns:

this Element's node, whether just generated or already known

getDataChildren

public java.util.List getDataChildren()

Get the Data tree, which might be different from the display tree

Overrides:

getDataChildren in class Container

Returns:

the data tree if it is different, else just the display tree

getDataSourceString

public java.lang.String getDataSourceString()

Description copied from interface: PageDataElement

Unless this node has a DataSourceOverride, then the DataSourceString is constructed by the DataSourceManager. WebAppDataSourceManager will make Variables/Foo/Bar JSFDataSourceManager will make Foo.Bar

Overrides:

getDataSourceString in class Element

Following copied from interface: com.bowstreet.webapp.PageDataElement

Returns:

The string for accessing this data element, minus the wrapper

getElementNames

public final java.util.Map getElementNames()

getErrorVariableName

public static java.lang.String getErrorVariableName(PageDataElement element, boolean constructIfNeeded)

Parameters:

pageReference -

Returns:

getFormInfos

public final java.util.Collection getFormInfos()

getPage

public Page getPage()

Description copied from interface: PageDataElement

get the Page that this is part of

Overrides:

getPage in class Element

Following copied from interface: com.bowstreet.webapp.PageDataElement

Returns:

The Page that this element sits on

getParent

public Container getParent()

Overrides:

getParent in class Element

setDataChildren

public void setDataChildren(java.util.List dataChildren)

Set the Data tree, making it different from the display tree

Parameters:

dataChildren - new data tree root

setElementNames

public final void setElementNames(java.util.Map map)

setParent

public void setParent(Element parent)

toString

public java.lang.String toString()

Overrides:

toString in class Container