com.bowstreet.webapp
Interface DataDefinitionLeaf

All Superinterfaces:

DataDefinitionElement

All Known Subinterfaces:

PageDataLeaf

All Known Implementing Classes:

Leaf

public interface DataDefinitionLeaf
extends DataDefinitionElement

DDLeaf.java

Author:

szagieboylo Copyright (c) 2004 Bowstreet, Inc. Interface for DataDefinitionLeaf. The DataDefinition is an object-based abstract of a schema. A Container will have a list of children. A Leaf will never have children.

Field Summary

static java.lang.String	ctBLANK
static java.lang.String	ctBUTTON
static java.lang.String	ctCHECKBOX
static java.lang.String	ctHIDDEN_INPUT_SPECIAL
static java.lang.String	ctHIDDEN_WITH_TEXT
static java.lang.String	ctIMAGE
static java.lang.String	ctIMAGEBUTTON
static java.lang.String	ctLINK
static java.lang.String	ctPASSWORDINPUT
static java.lang.String	ctRADIO
static java.lang.String	ctRADIO_BUTTON_SPECIAL
static java.lang.String	ctSELECT
static java.lang.String	ctTEXTAREA
static java.lang.String	ctTEXTINPUT
static java.lang.String	ctTEXTOUTPUT
static java.lang.String	ctUNKNOWN
static int	EO_HTML
static int	EO_MERGE
static int	EO_SCHEMA
static int	EO_SPECIAL
static int	EO_UNKNOWN

Fields inherited from interface com.bowstreet.webapp.DataDefinitionElement

DISPLAY_AUTO, DISPLAY_HORIZONTAL, DISPLAY_NO_VISIBLE, DISPLAY_NONE, DISPLAY_VERTICAL, KEY_ACTIONTYPE, KEY_ALWAYS_ADD_VALIDATION_CODE, 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_ERROR_MESSAGE_OVERRIDE, KEY_ESCAPEOUTPUTTEXT, KEY_FIELD_MERGE_DEFINITION, KEY_GENELEMENT, KEY_GENERATELABELS, KEY_HANDLEEXISTING, KEY_HAS_BEEN_RDD_PROCESSED, KEY_INFERCONTROLTYPE, KEY_IS_DATA_TRANSPARENT_CONTAINER, KEY_IS_POST_GENERATED_ELEMENT, KEY_IS_VISUALLY_TRANSPARENT_CONTAINER, KEY_ISMODELACTION, KEY_KEY_FIELD, KEY_LABELCLASS_ERROR, KEY_LABELCLASS_NOERROR, KEY_LABELTRANSLATETABLE, KEY_LABELTRANSLATEVARIABLE, KEY_LAYOUT_GRID, 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_SELECT_OPTIONS, KEY_SEPARATOR, KEY_SPLIT_CHILDREN_INTO_COLUMNS, KEY_TRANSLATE_HTML_LABELS, KEY_UNIQUE_ID_LEVEL, KEY_USINGCHECKBOXES, KEY_VALIDATIONERRORPLACEMENT, KEY_VARIABLENAME, TYPE_ANYTYPE, TYPE_BOOLEAN, TYPE_BYTE, TYPE_DATE, TYPE_DATETIME, TYPE_DECIMAL, TYPE_DOUBLE, TYPE_FLOATINGPOINT, TYPE_INT, TYPE_INTEGER, TYPE_LONG, TYPE_NEGINT, TYPE_NONNEGINT, TYPE_NONPOSINT, TYPE_POSINT, TYPE_SHORT, TYPE_STRING, TYPE_TIME

Method Summary

void	addModifierBuilder(IXml modifierBuilderCall, boolean useWhenDataEntry, boolean useWhenDisplayOnly) Used to add a modifier Which will be used after the control is rendered.
void	clearFormatterInfo(boolean clearFormat, boolean clearTranslate, boolean clearValidate) Because nulls mean that the associated inputs are ignored in setFormatterInfo, use this to clear an existing one
BuilderInputs	getDataEntryBuilderInputs()
java.lang.String	getDataEntryControlType()
BuilderInputs	getDisplayBuilderInputs()
java.lang.String	getDisplayControlType()
java.util.List	getEnumerationValues() Several of the rendering types consider the enumeration values
int	getEnumOptions()
FormatData	getFormatData() Gets the FormatData for this element.
java.lang.String	getInitialValue() InitialValue is used in construction a method which initializes the fields
boolean	getIsKeyField() Is this field used as a key in the original data source
boolean	getIsReadOnly() Is this field prevented from being an input field.
ValidationData	getValidationData() Gets the ValidationData for this element.
void	setDataEntryControl(java.lang.String builderDefID, BuilderInputs builderInputs) The control is now set always using a builderDefID.
void	setDisplayControl(java.lang.String builderDefID, BuilderInputs builderInputs) The control is now set always using a builderDefID.
void	setEnumerationValues(java.util.List vals)
void	setEnumOptions(int i)
void	setFormatterInfo(java.lang.String variable, java.lang.String formatExpr, java.lang.String formatArg, java.lang.String translateExpr, java.lang.String translateArg, java.lang.String validateExpr, java.lang.String validateArg) Used to set format, translate, and validate expressions.
void	setInitialValue(java.lang.String s)
void	setIsKeyField(boolean isKey) Set whether or not this field is used as a key in the original data source
void	setIsReadOnly(boolean b) If true, this element is not allowed to become an input field.

Methods inherited from interface com.bowstreet.webapp.DataDefinitionElement

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

Field Detail

ctBLANK

static final java.lang.String ctBLANK

See Also:

Constant Field Values

ctBUTTON

static final java.lang.String ctBUTTON

See Also:

Constant Field Values

ctCHECKBOX

static final java.lang.String ctCHECKBOX

See Also:

Constant Field Values

ctHIDDEN_INPUT_SPECIAL

static final java.lang.String ctHIDDEN_INPUT_SPECIAL

See Also:

Constant Field Values

ctHIDDEN_WITH_TEXT

static final java.lang.String ctHIDDEN_WITH_TEXT

See Also:

Constant Field Values

ctIMAGE

static final java.lang.String ctIMAGE

See Also:

Constant Field Values

ctIMAGEBUTTON

static final java.lang.String ctIMAGEBUTTON

See Also:

Constant Field Values

ctLINK

static final java.lang.String ctLINK

See Also:

Constant Field Values

ctPASSWORDINPUT

static final java.lang.String ctPASSWORDINPUT

See Also:

Constant Field Values

ctRADIO

static final java.lang.String ctRADIO

See Also:

Constant Field Values

ctRADIO_BUTTON_SPECIAL

static final java.lang.String ctRADIO_BUTTON_SPECIAL

See Also:

Constant Field Values

ctSELECT

static final java.lang.String ctSELECT

See Also:

Constant Field Values

ctTEXTAREA

static final java.lang.String ctTEXTAREA

See Also:

Constant Field Values

ctTEXTINPUT

static final java.lang.String ctTEXTINPUT

See Also:

Constant Field Values

ctTEXTOUTPUT

static final java.lang.String ctTEXTOUTPUT

See Also:

Constant Field Values

ctUNKNOWN

static final java.lang.String ctUNKNOWN

EO_HTML

static final int EO_HTML

See Also:

Constant Field Values

EO_MERGE

static final int EO_MERGE

See Also:

Constant Field Values

EO_SCHEMA

static final int EO_SCHEMA

See Also:

Constant Field Values

EO_SPECIAL

static final int EO_SPECIAL

See Also:

Constant Field Values

EO_UNKNOWN

static final int EO_UNKNOWN

See Also:

Constant Field Values

Method Detail

addModifierBuilder

void addModifierBuilder(IXml modifierBuilderCall,
                        boolean useWhenDataEntry,
                        boolean useWhenDisplayOnly)

Used to add a modifier Which will be used after the control is rendered.

Parameters:

modifierBuilderCall - XML that exactly corresponds to a BuilderCall -- cut & paste from Model XML view is recommended

useWhenDataEntry - true if you want this modifier applied when Leaf is used for DataEntry

useWhenDisplayOnly - true if you want this modifier applied when Leaf is used for DisplayOnly

clearFormatterInfo

void clearFormatterInfo(boolean clearFormat,
                        boolean clearTranslate,
                        boolean clearValidate)

Because nulls mean that the associated inputs are ignored in setFormatterInfo, use this to clear an existing one

Parameters:

clearFormat - if true, clear the formatExpr

clearTranslate - if true, clear the translateExpr

clearValidate - if true, clear the validateExpr

getDataEntryBuilderInputs

BuilderInputs getDataEntryBuilderInputs()

getDataEntryControlType

java.lang.String getDataEntryControlType()

getDisplayBuilderInputs

BuilderInputs getDisplayBuilderInputs()

getDisplayControlType

java.lang.String getDisplayControlType()

getEnumerationValues

java.util.List getEnumerationValues()

Several of the rendering types consider the enumeration values

Returns:

list of the enumeration values

getEnumOptions

int getEnumOptions()

getFormatData

FormatData getFormatData()

Gets the FormatData for this element.

getInitialValue

java.lang.String getInitialValue()

InitialValue is used in construction a method which initializes the fields

Returns:

This initialValue for this element

getIsKeyField

boolean getIsKeyField()

Is this field used as a key in the original data source

Returns:

true if this field is a key field

getIsReadOnly

boolean getIsReadOnly()

Is this field prevented from being an input field.

Returns:

true if element is read only

getValidationData

ValidationData getValidationData()

Gets the ValidationData for this element.

setDataEntryControl

void setDataEntryControl(java.lang.String builderDefID,
                         BuilderInputs builderInputs)

The control is now set always using a builderDefID. Note, however, that the ones listed below are given special handling, and might be redirected by the RuntimeAgent

Parameters:

builderDefID - One of the strings below, OR a builderDefID

builderInputs - Additional builder inputs to be passed to the builder -- Name, PageLocation, and Value will be filled in for you.

setDisplayControl

void setDisplayControl(java.lang.String builderDefID,
                       BuilderInputs builderInputs)

The control is now set always using a builderDefID. Note, however, that the ones listed below are given special handling, and might be redirected by the RuntimeAgent

Parameters:

builderDefID - One of the strings below, OR a builderDefID

builderInputs - Additional builder inputs to be passed to the builder -- Name, PageLocation, and Value will be filled in for you.

setEnumerationValues

void setEnumerationValues(java.util.List vals)

setEnumOptions

void setEnumOptions(int i)

setFormatterInfo

void setFormatterInfo(java.lang.String variable,
                      java.lang.String formatExpr,
                      java.lang.String formatArg,
                      java.lang.String translateExpr,
                      java.lang.String translateArg,
                      java.lang.String validateExpr,
                      java.lang.String validateArg)

Used to set format, translate, and validate expressions.

Parameters:

variable - Model variable name, or DataPageBuilder.STANDARD_FORMATTER, which will be converted to the Model StandardFormatter

formatExpr - expression to use in formatting for screen (or null)

translateExpr - expression to use in translating info from user (or null)

validateExpr - expression to use in validating the result of translation (or null)

setInitialValue

void setInitialValue(java.lang.String s)

setIsKeyField

void setIsKeyField(boolean isKey)

Set whether or not this field is used as a key in the original data source

setIsReadOnly

void setIsReadOnly(boolean b)

If true, this element is not allowed to become an input field. Note that PageDataLeaf.setInputOutputType() will throw an exception if you try to set it to be a Data Entry type if this value is set.

Parameters:

b - true to make this field read only