org.kuali.rice.kns.web.ui
Class Field

java.lang.Object
  org.kuali.rice.kns.web.ui.Field

All Implemented Interfaces:

java.io.Serializable, PropertyRenderingConfigElement

Direct Known Subclasses:

DocumentSearchField_DEPR

public class Field
extends java.lang.Object
implements java.io.Serializable, PropertyRenderingConfigElement

Represents a Field (form field or read only)

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Field Summary

static java.lang.String	BLANK_SPACE
static java.lang.String	BUTTON
java.lang.String	cellAlign
static java.lang.String	CHECKBOX
static java.lang.String	CONTAINER
static java.lang.String	CURRENCY
static java.lang.String	DATEPICKER
static int	DEFAULT_MAXLENGTH
static int	DEFAULT_SIZE
static java.lang.String	DROPDOWN
static java.lang.String	DROPDOWN_APC
static java.lang.String	DROPDOWN_REFRESH
static java.lang.String	DROPDOWN_SCRIPT
static java.lang.String	EDITABLE
boolean	fieldLevelHelpDisabled
boolean	fieldLevelHelpEnabled
java.lang.String	fieldLevelHelpUrl
static java.lang.String	FILE
static java.lang.String	HIDDEN
static java.lang.String	IMAGE_SUBMIT
static java.lang.String	KUALIUSER
static java.lang.String	LINK
static java.lang.String	LOOKUP_HIDDEN
static java.lang.String	LOOKUP_READONLY
static java.lang.String	LOOKUP_RESULT_ONLY
static java.lang.String	MASKED
static java.util.Set<java.lang.String>	MULTI_VALUE_FIELD_TYPES
static java.lang.String	MULTIBOX
static java.lang.String	MULTISELECT
static java.lang.String	PARTIALLY_MASKED
static java.lang.String	QUICKFINDER
static java.lang.String	RADIO
static java.lang.String	READONLY
static java.util.Set<java.lang.String>	SEARCH_RESULT_DISPLAYABLE_FIELD_TYPES
static java.lang.String	SUB_SECTION_SEPARATOR
static java.lang.String	TEXT
static java.lang.String	TEXT_AREA
protected java.util.List<java.lang.String>	webUILeaveFieldFunctionParameters
static java.lang.String	WORKFLOW_WORKGROUP

Constructor Summary

Field()
No-args constructor

Field(java.lang.String propertyName, java.lang.String fieldLabel)
Constructor that creates an instance of this class to support inquirable

Field(java.lang.String fieldLabel, java.lang.String fieldHelpUrl, java.lang.String fieldType, boolean clear, java.lang.String propertyName, java.lang.String propertyValue, boolean fieldRequired, boolean dateField, java.util.List<KeyLabelPair> fieldValidValues, java.lang.String quickFinderClassNameImpl)
Constructor that creates an instance of this class.

Field(java.lang.String fieldLabel, java.lang.String fieldHelpUrl, java.lang.String fieldType, boolean clear, java.lang.String propertyName, java.lang.String propertyValue, boolean fieldRequired, boolean dateField, java.util.List<KeyLabelPair> fieldValidValues, java.lang.String quickFinderClassNameImpl, int size, int maxLength)
Constructor that creates an instance of this class.

Method Summary

void	appendFieldConversions(java.lang.String fieldConversions)
void	appendLookupParameters(java.lang.String lookupParameters) This method appends the passed-in lookupParameters to the existing
boolean	containsBOData()
java.lang.String	getAdditionalDisplayPropertyName()
java.lang.String	getAdditionalDisplayPropertyValue()
java.lang.String	getAlternateDisplayPropertyName()
java.lang.String	getAlternateDisplayPropertyValue()
java.lang.String	getBaseLookupUrl()
java.lang.String	getBLANK_SPACE()
java.lang.String	getBusinessObjectClassName()
java.lang.String	getBUTTON()
java.lang.String	getCellAlign() The td alignment to use for the Field.
java.lang.String	getCHECKBOX()
int	getCols()
java.lang.String	getCONTAINER()
java.util.List<Field>	getContainerDisplayFields() Gets the containerDisplayFields attribute.
java.lang.String	getContainerElementName() Gets the containerElementName attribute.
java.lang.String	getContainerName()
java.util.List<Row>	getContainerRows()
java.lang.String	getCURRENCY()
java.lang.String	getDefaultValue()
java.lang.String	getDisplayEditMode() Gets the displayEditMode attribute.
Mask	getDisplayMask() Gets the displayMask attribute.
java.lang.String	getDisplayMaskValue() Gets the displayMaskValue attribute.
java.lang.String	getDROPDOWN_APC()
java.lang.String	getDROPDOWN_REFRESH()
java.lang.String	getDROPDOWN_SCRIPT()
java.lang.String	getDROPDOWN()
java.lang.String	getEncryptedValue() Gets the encryptedValue attribute.
java.util.Map<java.lang.String,java.lang.String>	getFieldConversionMap()
java.lang.String	getFieldConversions()
java.lang.String	getFieldDataType()
java.lang.String	getFieldHelpName()
java.lang.String	getFieldHelpSummary()
java.lang.String	getFieldHelpUrl()
java.util.List	getFieldInactiveValidValues()
java.lang.String	getFieldLabel()
java.lang.String	getFieldLevelHelpUrl()
java.lang.String	getFieldType()
java.util.List<KeyLabelPair>	getFieldValidValues()
java.lang.String	getFILE()
int	getFormattedMaxLength()
Formatter	getFormatter()
boolean	getHasBlankValidValue()
boolean	getHasLookupable()
java.lang.String	getHIDDEN()
java.lang.String	getHrefText()
java.lang.String	getIMAGE_SUBMIT()
java.lang.String	getImageSrc()
java.lang.String	getInquiryParameters()
HtmlData	getInquiryURL()
java.lang.String	getKUALIUSER()
java.lang.String	getLINK()
java.lang.String	getLOOKUP_HIDDEN()
java.lang.String	getLOOKUP_READONLY()
java.lang.String	getLookupParameters()
java.lang.String	getMainFieldLabel()
int	getMaxLength()
java.lang.String	getMultipleValueLookedUpCollectionName() For container fields (i.e.
java.lang.String	getMultipleValueLookupClassLabel() The DD defined objectLabel of the class on which a multiple value lookup is performed
java.lang.String	getMultipleValueLookupClassName() For container fields (i.e.
java.lang.String	getMULTISELECT()
int	getNumberOfColumnsForCollection()
java.lang.String	getPersonNameAttributeName() Gets the personNameAttributeName attribute.
java.lang.String	getPersonNameValue()
java.lang.String	getPropertyName()
java.lang.String	getPropertyPrefix() Gets the propertyPrefix attribute.
java.lang.String	getPropertyValue()
java.lang.String[]	getPropertyValues()
java.lang.String	getQUICKFINDER()
java.lang.String	getQuickFinderClassNameImpl()
java.lang.String	getRADIO()
java.lang.Boolean	getRangeFieldInclusive()
java.lang.String	getReferencesToRefresh()
int	getRows()
java.lang.String	getScript() Gets the script attribute.
int	getSize()
java.lang.String	getStyleClass()
java.lang.String	getSUB_SECTION_SEPARATOR()
java.lang.String	getTarget()
java.lang.String	getTEXT_AREA()
java.lang.String	getTEXT()
java.lang.String	getUniversalIdAttributeName() Gets the universalIdAttributeName attribute.
java.lang.String	getUniversalIdValue()
java.lang.String	getUserIdAttributeName() Gets the userIdAttributeName attribute.
java.lang.String	getWebOnBlurHandler() Returns the method name of a function present in the page which should be called when the user tabs away from the field.
java.lang.String	getWebOnBlurHandlerCallback() Returns the method name of a function present in the page which should be called after an AJAX call from the onblur handler.
java.util.List<java.lang.String>	getWebUILeaveFieldFunctionParameters()
java.lang.String	getWebUILeaveFieldFunctionParametersString()
java.lang.String	getWORKFLOW_WORKGROUP()
boolean	isAllowInlineRange()
boolean	isClear()
boolean	isColumnVisible()
boolean	isDateField()
boolean	isDatePicker()
boolean	isExpandedTextArea()
boolean	isFieldDirectInquiryEnabled()
boolean	isFieldLevelHelpDisabled() Returns whether field level help is disabled for this field.
boolean	isFieldLevelHelpEnabled() Returns whether field level help is enabled for this field.
boolean	isFieldRequired()
boolean	isHidden() Deprecated.
boolean	isHighlightField()
boolean	isInclusive()
boolean	isIndexedForSearch()
static boolean	isInputField(java.lang.String fieldType) Helper method to determine if this is an INPUT type field
boolean	isKeyField() Gets the keyField attribute.
boolean	isMemberOfRange()
boolean	isRanged()
boolean	isReadOnly()
boolean	isSecure() Gets the secure attribute.
boolean	isSkipBlankValidValue()
boolean	isTriggerOnChange()
boolean	isUpperCase()
void	setAdditionalDisplayPropertyName(java.lang.String additionalDisplayPropertyName)
void	setAdditionalDisplayPropertyValue(java.lang.Object additionalDisplayPropertyValue)
void	setAllowInlineRange(boolean allowInlineRange)
void	setAlternateDisplayPropertyName(java.lang.String alternateDisplayPropertyName)
void	setAlternateDisplayPropertyValue(java.lang.Object alternateDisplayPropertyValue)
void	setBaseLookupUrl(java.lang.String baseLookupURL)
void	setBusinessObjectClassName(java.lang.String businessObjectClassName)
void	setCellAlign(java.lang.String cellAlign) Sets the td alignment for the Field.
void	setClear(boolean clear)
void	setCols(int cols)
void	setColumnVisible(boolean isColumnVisible)
void	setContainerDisplayFields(java.util.List<Field> containerDisplayFields) Sets the containerDisplayFields attribute value.
void	setContainerElementName(java.lang.String containerElementName) Sets the containerElementName attribute value.
void	setContainerName(java.lang.String containerName)
void	setContainerRows(java.util.List<Row> containerRows)
void	setDateField(boolean dateField)
void	setDatePicker(boolean isDatePicker)
void	setDefaultValue(java.lang.String defaultValue)
void	setDisplayEditMode(java.lang.String displayEditMode) Sets the displayEditMode attribute value.
void	setDisplayMask(Mask displayMask) Sets the displayMask attribute value.
void	setDisplayMaskValue(java.lang.String displayMaskValue) Sets the displayMaskValue attribute value.
void	setEncryptedValue(java.lang.String encryptedValue) Sets the encryptedValue attribute value.
void	setExpandedTextArea(boolean expandedTextArea)
void	setFieldConversions(java.util.Map fieldConversionsMap)
void	setFieldConversions(java.lang.String fieldConversions)
void	setFieldDataType(java.lang.String fieldDataType)
void	setFieldDirectInquiryEnabled(boolean fieldDirectInquiryEnabled)
void	setFieldHelpName(java.lang.String fieldHelpName)
void	setFieldHelpSummary(java.lang.String fieldHelpSummary)
void	setFieldHelpUrl(java.lang.String fieldHelpUrl)
void	setFieldInactiveValidValues(java.util.List fieldInactiveValidValues)
void	setFieldLabel(java.lang.String fieldLabel)
void	setFieldLevelHelpDisabled(boolean fieldLevelHelpDisabled)
void	setFieldLevelHelpEnabled(boolean fieldLevelHelpEnabled)
void	setFieldLevelHelpUrl(java.lang.String fieldLevelHelpUrl)
void	setFieldRequired(boolean fieldRequired)
void	setFieldType(java.lang.String fieldType)
void	setFieldValidValues(java.util.List<KeyLabelPair> fieldValidValues)
void	setFormattedMaxLength(int formattedMaxLength)
void	setFormatter(Formatter formatter)
void	setHidden(boolean hidden) Deprecated.
void	setHighlightField(boolean highlightField)
void	setHrefText(java.lang.String hrefText)
void	setImageSrc(java.lang.String imageSrc)
void	setIndexedForSearch(boolean indexedForSearch)
void	setInquiryParameters(java.lang.String inquiryParameters)
void	setInquiryURL(HtmlData propertyURL)
void	setKeyField(boolean keyField) Sets the keyField attribute value.
void	setLookupParameters(java.util.Map lookupParametersMap)
void	setLookupParameters(java.lang.String lookupParameters)
void	setMainFieldLabel(java.lang.String mainFieldLabel)
void	setMaxLength(int maxLength)
void	setMemberOfRange(boolean memberOfRange)
void	setMultipleValueLookedUpCollectionName(java.lang.String multipleValueLookedUpCollectionName) For container fields (i.e.
void	setMultipleValueLookupClassLabel(java.lang.String multipleValueLookupClassLabel) The DD defined objectLabel of the class on which a multiple value lookup is performed
void	setMultipleValueLookupClassName(java.lang.String multipleValueLookupClassName) For container fields (i.e.
void	setNumberOfColumnsForCollection(int numberOfColumnsForCollection)
void	setPersonNameAttributeName(java.lang.String personNameAttributeName) Sets the personNameAttributeName attribute value.
void	setPersonNameValue(java.lang.String personNameValue)
void	setPropertyName(java.lang.String propertyName)
void	setPropertyPrefix(java.lang.String propertyPrefix) Sets the propertyPrefix attribute value.
void	setPropertyValue(java.lang.Object propertyValue)
void	setPropertyValue(java.lang.String propertyValue) Sets the propertyValue attribute value.
void	setPropertyValues(java.lang.String[] propertyValues)
void	setQuickFinderClassNameImpl(java.lang.String quickFinderClassNameImpl)
void	setRanged(boolean ranged)
void	setRangeFieldInclusive(java.lang.Boolean rangeFieldInclusive)
void	setReadOnly(boolean isReadOnly)
void	setReferencesToRefresh(java.lang.String referencesToRefresh)
void	setRows(int rows)
void	setScript(java.lang.String script) Sets the script attribute value.
void	setSecure(boolean secure) Sets the secure attribute value.
void	setSize(int size)
void	setSkipBlankValidValue(boolean skipBlankValidValue)
void	setStyleClass(java.lang.String styleClass)
void	setTarget(java.lang.String target)
void	setTriggerOnChange(boolean triggerOnChange)
void	setUniversalIdAttributeName(java.lang.String universalIdAttributeName) Sets the universalIdAttributeName attribute value.
void	setUniversalIdValue(java.lang.String universalIdValue)
void	setUpperCase(boolean upperCase)
void	setUserIdAttributeName(java.lang.String userIdAttributeName) Sets the userIdAttributeName attribute value.
void	setWebOnBlurHandler(java.lang.String webOnBlurHandler)
void	setWebOnBlurHandlerCallback(java.lang.String webOnBlurHandlerCallback)
void	setWebUILeaveFieldFunctionParameters(java.util.List<java.lang.String> webUILeaveFieldFunctionParameters)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAXLENGTH

public static final int DEFAULT_MAXLENGTH

See Also:

Constant Field Values

DEFAULT_SIZE

public static final int DEFAULT_SIZE

See Also:

Constant Field Values

HIDDEN

public static final java.lang.String HIDDEN

See Also:

Constant Field Values

TEXT

public static final java.lang.String TEXT

See Also:

Constant Field Values

DROPDOWN

public static final java.lang.String DROPDOWN

See Also:

Constant Field Values

MULTIBOX

public static final java.lang.String MULTIBOX

See Also:

Constant Field Values

MULTISELECT

public static final java.lang.String MULTISELECT

See Also:

Constant Field Values

RADIO

public static final java.lang.String RADIO

See Also:

Constant Field Values

QUICKFINDER

public static final java.lang.String QUICKFINDER

See Also:

Constant Field Values

LOOKUP_RESULT_ONLY

public static final java.lang.String LOOKUP_RESULT_ONLY

See Also:

Constant Field Values

DROPDOWN_REFRESH

public static final java.lang.String DROPDOWN_REFRESH

See Also:

Constant Field Values

DROPDOWN_SCRIPT

public static final java.lang.String DROPDOWN_SCRIPT

See Also:

Constant Field Values

DROPDOWN_APC

public static final java.lang.String DROPDOWN_APC

See Also:

Constant Field Values

CHECKBOX

public static final java.lang.String CHECKBOX

See Also:

Constant Field Values

CURRENCY

public static final java.lang.String CURRENCY

See Also:

Constant Field Values

TEXT_AREA

public static final java.lang.String TEXT_AREA

See Also:

Constant Field Values

FILE

public static final java.lang.String FILE

See Also:

Constant Field Values

IMAGE_SUBMIT

public static final java.lang.String IMAGE_SUBMIT

See Also:

Constant Field Values

CONTAINER

public static final java.lang.String CONTAINER

See Also:

Constant Field Values

KUALIUSER

public static final java.lang.String KUALIUSER

See Also:

Constant Field Values

READONLY

public static final java.lang.String READONLY

See Also:

Constant Field Values

EDITABLE

public static final java.lang.String EDITABLE

See Also:

Constant Field Values

LOOKUP_HIDDEN

public static final java.lang.String LOOKUP_HIDDEN

See Also:

Constant Field Values

LOOKUP_READONLY

public static final java.lang.String LOOKUP_READONLY

See Also:

Constant Field Values

WORKFLOW_WORKGROUP

public static final java.lang.String WORKFLOW_WORKGROUP

See Also:

Constant Field Values

MASKED

public static final java.lang.String MASKED

See Also:

Constant Field Values

PARTIALLY_MASKED

public static final java.lang.String PARTIALLY_MASKED

See Also:

Constant Field Values

SUB_SECTION_SEPARATOR

public static final java.lang.String SUB_SECTION_SEPARATOR

See Also:

Constant Field Values

BLANK_SPACE

public static final java.lang.String BLANK_SPACE

See Also:

Constant Field Values

BUTTON

public static final java.lang.String BUTTON

See Also:

Constant Field Values

LINK

public static final java.lang.String LINK

See Also:

Constant Field Values

DATEPICKER

public static final java.lang.String DATEPICKER

See Also:

Constant Field Values

SEARCH_RESULT_DISPLAYABLE_FIELD_TYPES

public static final java.util.Set<java.lang.String> SEARCH_RESULT_DISPLAYABLE_FIELD_TYPES

MULTI_VALUE_FIELD_TYPES

public static final java.util.Set<java.lang.String> MULTI_VALUE_FIELD_TYPES

webUILeaveFieldFunctionParameters

protected java.util.List<java.lang.String> webUILeaveFieldFunctionParameters

cellAlign

public java.lang.String cellAlign

fieldLevelHelpEnabled

public boolean fieldLevelHelpEnabled

fieldLevelHelpDisabled

public boolean fieldLevelHelpDisabled

fieldLevelHelpUrl

public java.lang.String fieldLevelHelpUrl

Constructor Detail

Field

public Field()

No-args constructor

Field

public Field(java.lang.String propertyName,
             java.lang.String fieldLabel)

Constructor that creates an instance of this class to support inquirable

Parameters:

propertyName - property attribute of the bean

fieldLabel - label of the display field

Field

public Field(java.lang.String fieldLabel,
             java.lang.String fieldHelpUrl,
             java.lang.String fieldType,
             boolean clear,
             java.lang.String propertyName,
             java.lang.String propertyValue,
             boolean fieldRequired,
             boolean dateField,
             java.util.List<KeyLabelPair> fieldValidValues,
             java.lang.String quickFinderClassNameImpl)

Constructor that creates an instance of this class.

Parameters:

fieldLabel - label of the search criteria field

fieldHelpUrl - url of a help link to help instructions

fieldType - type of input field for this search criteria

clear - clear action flag

propertyName - name of the bean attribute for this search criteria

propertyValue - value of the bean attribute

fieldRequired - flag to denote if field is required

dateField - falg to denot if field should be validated as a date object

fieldValidValues - used for drop down list

quickFinderClassNameImpl - class name to transfer control to quick finder

Field

public Field(java.lang.String fieldLabel,
             java.lang.String fieldHelpUrl,
             java.lang.String fieldType,
             boolean clear,
             java.lang.String propertyName,
             java.lang.String propertyValue,
             boolean fieldRequired,
             boolean dateField,
             java.util.List<KeyLabelPair> fieldValidValues,
             java.lang.String quickFinderClassNameImpl,
             int size,
             int maxLength)

Constructor that creates an instance of this class.

Parameters:

fieldLabel - label of the search criteria field

fieldHelpUrl - url of a help link to help instructions

fieldType - type of input field for this search criteria

clear - clear action flag

propertyName - name of the bean attribute for this search criteria

propertyValue - value of the bean attribute

fieldRequired - flag to denote if field is required

dateField - falg to denot if field should be validated as a date object

fieldValidValues - used for drop down list

quickFinderClassNameImpl - class name to transfer control to quick finder

size - size of the input field

maxLength - maxLength of the input field

Method Detail

isInputField

public static boolean isInputField(java.lang.String fieldType)

Helper method to determine if this is an INPUT type field

Parameters:

fieldType -

getImageSrc

public java.lang.String getImageSrc()

Returns:

the imageSrc

setImageSrc

public void setImageSrc(java.lang.String imageSrc)

Parameters:

imageSrc - the imageSrc to set

getTarget

public java.lang.String getTarget()

Returns:

the target

setTarget

public void setTarget(java.lang.String target)

Parameters:

target - the target to set

getHrefText

public java.lang.String getHrefText()

Returns:

the hrefText

setHrefText

public void setHrefText(java.lang.String hrefText)

Parameters:

hrefText - the hrefText to set

getInquiryURL

public HtmlData getInquiryURL()

setInquiryURL

public void setInquiryURL(HtmlData propertyURL)

getNumberOfColumnsForCollection

public int getNumberOfColumnsForCollection()

setNumberOfColumnsForCollection

public void setNumberOfColumnsForCollection(int numberOfColumnsForCollection)

isDatePicker

public boolean isDatePicker()

setDatePicker

public void setDatePicker(boolean isDatePicker)

isRanged

public boolean isRanged()

setRanged

public void setRanged(boolean ranged)

isExpandedTextArea

public boolean isExpandedTextArea()

setExpandedTextArea

public void setExpandedTextArea(boolean expandedTextArea)

getDefaultValue

public java.lang.String getDefaultValue()

Returns:

Returns the defaultValue.

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)

Parameters:

defaultValue - The defaultValue to set.

containsBOData

public boolean containsBOData()

getCHECKBOX

public java.lang.String getCHECKBOX()

Returns:

Returns the CHECKBOX.

getCONTAINER

public java.lang.String getCONTAINER()

Returns:

Returns the CONTAINER.

getDROPDOWN

public java.lang.String getDROPDOWN()

Returns:

Returns the dROPDOWN.

getTEXT_AREA

public java.lang.String getTEXT_AREA()

Returns:

Returns the TEXT_AREA.

getDROPDOWN_REFRESH

public java.lang.String getDROPDOWN_REFRESH()

Returns:

Returns the DROPDOWN_REFRESH

getDROPDOWN_SCRIPT

public java.lang.String getDROPDOWN_SCRIPT()

Returns:

Returns DROPDOWN_SCRIPT

getDROPDOWN_APC

public java.lang.String getDROPDOWN_APC()

Returns:

Returns DROPDOWN_APC

getMULTISELECT

public java.lang.String getMULTISELECT()

Returns:

Returns DROPDOWN_APC

getKUALIUSER

public java.lang.String getKUALIUSER()

Returns:

Returns KUALIUSER

getFILE

public java.lang.String getFILE()

Returns:

Returns the FILE.

getSUB_SECTION_SEPARATOR

public java.lang.String getSUB_SECTION_SEPARATOR()

Returns:

Returns SUB_SECTION_SEPARATOR

getBLANK_SPACE

public java.lang.String getBLANK_SPACE()

Returns:

Returns BLANK_SPACE

getBUTTON

public java.lang.String getBUTTON()

Returns:

the BUTTON

getLINK

public java.lang.String getLINK()

Returns:

the LINK

getFieldConversions

public java.lang.String getFieldConversions()

Returns:

Returns the fieldConversions.

getFieldConversionMap

public java.util.Map<java.lang.String,java.lang.String> getFieldConversionMap()

getFieldHelpUrl

public java.lang.String getFieldHelpUrl()

Returns:

Returns the fieldHelpUrl.

getFieldLabel

public java.lang.String getFieldLabel()

Returns:

Returns the fieldLabel.

getFieldType

public java.lang.String getFieldType()

Returns:

Returns the fieldType.

getFieldValidValues

public java.util.List<KeyLabelPair> getFieldValidValues()

Returns:

Returns the fieldValidValues.

getFormatter

public Formatter getFormatter()

Specified by:

getFormatter in interface PropertyRenderingConfigElement

Returns:

Returns the formatter.

getHIDDEN

public java.lang.String getHIDDEN()

Returns:

Returns the hIDDEN.

getLookupParameters

public java.lang.String getLookupParameters()

Returns:

Returns the lookupParameters.

getMaxLength

public int getMaxLength()

Returns:

Returns the maxLength.

getPropertyName

public java.lang.String getPropertyName()

Specified by:

getPropertyName in interface PropertyRenderingConfigElement

Returns:

Returns the propertyName.

getPropertyValue

public java.lang.String getPropertyValue()

Specified by:

getPropertyValue in interface PropertyRenderingConfigElement

Returns:

Returns the propertyValue.

getPropertyPrefix

public java.lang.String getPropertyPrefix()

Gets the propertyPrefix attribute.

Returns:

Returns the propertyPrefix.

setPropertyPrefix

public void setPropertyPrefix(java.lang.String propertyPrefix)

Sets the propertyPrefix attribute value.

Parameters:

propertyPrefix - The propertyPrefix to set.

getQUICKFINDER

public java.lang.String getQUICKFINDER()

Returns:

Returns the qUICKFINDER.

getQuickFinderClassNameImpl

public java.lang.String getQuickFinderClassNameImpl()

Returns:

Returns the quickFinderClassNameImpl.

getRADIO

public java.lang.String getRADIO()

Returns:

Returns the rADIO.

getSize

public int getSize()

Returns:

Returns the size.

getTEXT

public java.lang.String getTEXT()

Returns:

Returns the TEXT.

getCURRENCY

public java.lang.String getCURRENCY()

getIMAGE_SUBMIT

public java.lang.String getIMAGE_SUBMIT()

Returns:

Returns the iMAGE_SUBMIT.

getLOOKUP_HIDDEN

public java.lang.String getLOOKUP_HIDDEN()

Returns:

Returns the LOOKUP_HIDDEN.

getLOOKUP_READONLY

public java.lang.String getLOOKUP_READONLY()

Returns:

Returns the LOOKUP_READONLY.

getWORKFLOW_WORKGROUP

public java.lang.String getWORKFLOW_WORKGROUP()

Returns:

Returns the WORKFLOW_WORKGROUP.

isClear

public boolean isClear()

Returns:

Returns the clear.

isDateField

public boolean isDateField()

Returns:

Returns the dateField.

isFieldRequired

public boolean isFieldRequired()

Returns:

Returns the fieldRequired.

isHighlightField

public boolean isHighlightField()

Returns:

Returns the highlightField.

isReadOnly

public boolean isReadOnly()

Returns:

Returns the isReadOnly.

isUpperCase

public boolean isUpperCase()

Returns:

Returns the upperCase.

setClear

public void setClear(boolean clear)

Parameters:

clear - The clear to set.

setDateField

public void setDateField(boolean dateField)

Parameters:

dateField - The dateField to set.

setFieldConversions

public void setFieldConversions(java.util.Map fieldConversionsMap)

Parameters:

fieldConversions - The fieldConversions to set.

setFieldConversions

public void setFieldConversions(java.lang.String fieldConversions)

Parameters:

fieldConversions - The fieldConversions to set.

appendFieldConversions

public void appendFieldConversions(java.lang.String fieldConversions)

setFieldHelpUrl

public void setFieldHelpUrl(java.lang.String fieldHelpUrl)

Parameters:

fieldHelpUrl - The fieldHelpUrl to set.

setFieldLabel

public void setFieldLabel(java.lang.String fieldLabel)

Parameters:

fieldLabel - The fieldLabel to set.

setFieldRequired

public void setFieldRequired(boolean fieldRequired)

Parameters:

fieldRequired - The fieldRequired to set.

setFieldType

public void setFieldType(java.lang.String fieldType)

Parameters:

fieldType - The fieldType to set.

setFieldValidValues

public void setFieldValidValues(java.util.List<KeyLabelPair> fieldValidValues)

Parameters:

fieldValidValues - The fieldValidValues to set.

getHasBlankValidValue

public boolean getHasBlankValidValue()

setFormatter

public void setFormatter(Formatter formatter)

Specified by:

setFormatter in interface PropertyRenderingConfigElement

Parameters:

formatter - The formatter to set.

setHighlightField

public void setHighlightField(boolean highlightField)

Parameters:

highlightField - The highlightField to set.

setLookupParameters

public void setLookupParameters(java.util.Map lookupParametersMap)

Parameters:

lookupParameters - The lookupParameters to set.

setLookupParameters

public void setLookupParameters(java.lang.String lookupParameters)

Parameters:

lookupParameters - The lookupParameters to set.

appendLookupParameters

public void appendLookupParameters(java.lang.String lookupParameters)

This method appends the passed-in lookupParameters to the existing

Parameters:

lookupParameters -

setMaxLength

public void setMaxLength(int maxLength)

Parameters:

maxLength - The maxLength to set.

setPropertyName

public void setPropertyName(java.lang.String propertyName)

Specified by:

setPropertyName in interface PropertyRenderingConfigElement

Parameters:

propertyName - The propertyName to set.

setPropertyValue

public void setPropertyValue(java.lang.Object propertyValue)

Parameters:

propertyValue - The propertyValue to set.

setQuickFinderClassNameImpl

public void setQuickFinderClassNameImpl(java.lang.String quickFinderClassNameImpl)

Parameters:

quickFinderClassNameImpl - The quickFinderClassNameImpl to set.

setReadOnly

public void setReadOnly(boolean isReadOnly)

Parameters:

isReadOnly - The isReadOnly to set.

setSize

public void setSize(int size)

Parameters:

size - The size to set.

setUpperCase

public void setUpperCase(boolean upperCase)

Parameters:

upperCase - The upperCase to set.

getCols

public int getCols()

Returns:

Returns the cols.

setCols

public void setCols(int cols)

Parameters:

cols - The cols to set.

getRows

public int getRows()

Returns:

Returns the rows.

setRows

public void setRows(int rows)

Parameters:

rows - The rows to set.

getContainerRows

public java.util.List<Row> getContainerRows()

Returns:

Returns the containerRows.

setContainerRows

public void setContainerRows(java.util.List<Row> containerRows)

Parameters:

containerRows - The containerRows to set.

getBusinessObjectClassName

public java.lang.String getBusinessObjectClassName()

Returns:

Returns the businessObjectClassName.

setBusinessObjectClassName

public void setBusinessObjectClassName(java.lang.String businessObjectClassName)

Parameters:

businessObjectClassName - The businessObjectClassName to set.

getFieldHelpSummary

public java.lang.String getFieldHelpSummary()

Returns:

Returns the fieldHelpSummary.

setFieldHelpSummary

public void setFieldHelpSummary(java.lang.String fieldHelpSummary)

Parameters:

fieldHelpSummary - The fieldHelpSummary to set.

getFieldHelpName

public java.lang.String getFieldHelpName()

Returns:

Returns the fieldHelpName.

setFieldHelpName

public void setFieldHelpName(java.lang.String fieldHelpName)

Parameters:

fieldHelpName - The fieldHelpName to set.

getScript

public java.lang.String getScript()

Gets the script attribute.

Returns:

Returns the script.

setScript

public void setScript(java.lang.String script)

Sets the script attribute value.

Parameters:

script - The script to set.

getPersonNameAttributeName

public java.lang.String getPersonNameAttributeName()

Gets the personNameAttributeName attribute.

Returns:

Returns the personNameAttributeName.

setPersonNameAttributeName

public void setPersonNameAttributeName(java.lang.String personNameAttributeName)

Sets the personNameAttributeName attribute value.

Parameters:

personNameAttributeName - The personNameAttributeName to set.

getUniversalIdAttributeName

public java.lang.String getUniversalIdAttributeName()

Gets the universalIdAttributeName attribute.

Returns:

Returns the universalIdAttributeName.

setUniversalIdAttributeName

public void setUniversalIdAttributeName(java.lang.String universalIdAttributeName)

Sets the universalIdAttributeName attribute value.

Parameters:

universalIdAttributeName - The universalIdAttributeName to set.

getUserIdAttributeName

public java.lang.String getUserIdAttributeName()

Gets the userIdAttributeName attribute.

Returns:

Returns the userIdAttributeName.

setUserIdAttributeName

public void setUserIdAttributeName(java.lang.String userIdAttributeName)

Sets the userIdAttributeName attribute value.

Parameters:

userIdAttributeName - The userIdAttributeName to set.

isKeyField

public boolean isKeyField()

Gets the keyField attribute.

Returns:

Returns the keyField.

setKeyField

public void setKeyField(boolean keyField)

Sets the keyField attribute value.

Parameters:

keyField - The keyField to set.

getDisplayEditMode

public java.lang.String getDisplayEditMode()

Gets the displayEditMode attribute.

Returns:

Returns the displayEditMode.

setDisplayEditMode

public void setDisplayEditMode(java.lang.String displayEditMode)

Sets the displayEditMode attribute value.

Parameters:

displayEditMode - The displayEditMode to set.

getDisplayMask

public Mask getDisplayMask()

Gets the displayMask attribute.

Returns:

Returns the displayMask.

setDisplayMask

public void setDisplayMask(Mask displayMask)

Sets the displayMask attribute value.

Parameters:

displayMask - The displayMask to set.

getDisplayMaskValue

public java.lang.String getDisplayMaskValue()

Gets the displayMaskValue attribute.

Returns:

Returns the displayMaskValue.

setDisplayMaskValue

public void setDisplayMaskValue(java.lang.String displayMaskValue)

Sets the displayMaskValue attribute value.

Parameters:

displayMaskValue - The displayMaskValue to set.

getEncryptedValue

public java.lang.String getEncryptedValue()

Gets the encryptedValue attribute.

Returns:

Returns the encryptedValue.

setEncryptedValue

public void setEncryptedValue(java.lang.String encryptedValue)

Sets the encryptedValue attribute value.

Parameters:

encryptedValue - The encryptedValue to set.

isSecure

public boolean isSecure()

Gets the secure attribute.

Returns:

Returns the secure.

setSecure

public void setSecure(boolean secure)

Sets the secure attribute value.

Parameters:

secure - The secure to set.

getWebOnBlurHandler

public java.lang.String getWebOnBlurHandler()

Returns the method name of a function present in the page which should be called when the user tabs away from the field.

Returns:

setWebOnBlurHandler

public void setWebOnBlurHandler(java.lang.String webOnBlurHandler)

getWebOnBlurHandlerCallback

public java.lang.String getWebOnBlurHandlerCallback()

Returns the method name of a function present in the page which should be called after an AJAX call from the onblur handler.

Returns:

setWebOnBlurHandlerCallback

public void setWebOnBlurHandlerCallback(java.lang.String webOnBlurHandlerCallback)

setPropertyValue

public void setPropertyValue(java.lang.String propertyValue)

Sets the propertyValue attribute value.

Specified by:

setPropertyValue in interface PropertyRenderingConfigElement

Parameters:

propertyValue - The propertyValue to set.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getStyleClass

public java.lang.String getStyleClass()

setStyleClass

public void setStyleClass(java.lang.String styleClass)

getFormattedMaxLength

public int getFormattedMaxLength()

setFormattedMaxLength

public void setFormattedMaxLength(int formattedMaxLength)

getContainerName

public java.lang.String getContainerName()

setContainerName

public void setContainerName(java.lang.String containerName)

getContainerElementName

public java.lang.String getContainerElementName()

Gets the containerElementName attribute.

Returns:

Returns the containerElementName.

setContainerElementName

public void setContainerElementName(java.lang.String containerElementName)

Sets the containerElementName attribute value.

Parameters:

containerElementName - The containerElementName to set.

getContainerDisplayFields

public java.util.List<Field> getContainerDisplayFields()

Gets the containerDisplayFields attribute.

Returns:

Returns the containerDisplayFields.

setContainerDisplayFields

public void setContainerDisplayFields(java.util.List<Field> containerDisplayFields)

Sets the containerDisplayFields attribute value.

Parameters:

containerDisplayFields - The containerDisplayFields to set.

getReferencesToRefresh

public java.lang.String getReferencesToRefresh()

setReferencesToRefresh

public void setReferencesToRefresh(java.lang.String referencesToRefresh)

getMultipleValueLookupClassLabel

public java.lang.String getMultipleValueLookupClassLabel()

The DD defined objectLabel of the class on which a multiple value lookup is performed

Returns:

The DD defined objectLabel of the class on which a multiple value lookup is performed

setMultipleValueLookupClassLabel

public void setMultipleValueLookupClassLabel(java.lang.String multipleValueLookupClassLabel)

The DD defined objectLabel of the class on which a multiple value lookup is performed

Parameters:

multipleValueLookupClassLabel - The DD defined objectLabel of the class on which a multiple value lookup is performed

getMultipleValueLookedUpCollectionName

public java.lang.String getMultipleValueLookedUpCollectionName()

For container fields (i.e. fieldType.equals(CONTAINER)) with MV lookups enabled, this is the name of the collection on the doc on which the MV lookup is performed

Returns:

setMultipleValueLookedUpCollectionName

public void setMultipleValueLookedUpCollectionName(java.lang.String multipleValueLookedUpCollectionName)

For container fields (i.e. fieldType.equals(CONTAINER)) with MV lookups enabled, this is the name of the collection on the doc on which the MV lookup is performed

Parameters:

multipleValueLookedUpCollectionName -

getMultipleValueLookupClassName

public java.lang.String getMultipleValueLookupClassName()

For container fields (i.e. fieldType.equals(CONTAINER)) with MV lookups enabled, this is the class to perform a lookup upon

Returns:

setMultipleValueLookupClassName

public void setMultipleValueLookupClassName(java.lang.String multipleValueLookupClassName)

For container fields (i.e. fieldType.equals(CONTAINER)) with MV lookups enabled, this is the class to perform a lookup upon

Parameters:

multipleValueLookupClassName -

getCellAlign

public java.lang.String getCellAlign()

The td alignment to use for the Field.

Returns:

the cellAlign

setCellAlign

public void setCellAlign(java.lang.String cellAlign)

Sets the td alignment for the Field.

Parameters:

cellAlign - the cellAlign to set

getInquiryParameters

public java.lang.String getInquiryParameters()

setInquiryParameters

public void setInquiryParameters(java.lang.String inquiryParameters)

isFieldLevelHelpEnabled

public boolean isFieldLevelHelpEnabled()

Returns whether field level help is enabled for this field. If this value is true, then the field level help will be enabled. If false, then whether a field is enabled is determined by the value returned by isFieldLevelHelpDisabled() and the system-wide parameter setting. Note that if a field is read-only, that may cause field-level help to not be rendered.

Returns:

true if field level help is enabled, false if the value of this method should NOT be used to determine whether this method's return value affects the enablement of field level help

setFieldLevelHelpEnabled

public void setFieldLevelHelpEnabled(boolean fieldLevelHelpEnabled)

isFieldLevelHelpDisabled

public boolean isFieldLevelHelpDisabled()

Returns whether field level help is disabled for this field. If this value is true and isFieldLevelHelpEnabled() returns false, then the field level help will not be rendered. If both this and isFieldLevelHelpEnabled() return false, then the system-wide setting will determine whether field level help is enabled. Note that if a field is read-only, that may cause field-level help to not be rendered.

Returns:

true if field level help is disabled, false if the value of this method should NOT be used to determine whether this method's return value affects the enablement of field level help

setFieldLevelHelpDisabled

public void setFieldLevelHelpDisabled(boolean fieldLevelHelpDisabled)

isFieldDirectInquiryEnabled

public boolean isFieldDirectInquiryEnabled()

setFieldDirectInquiryEnabled

public void setFieldDirectInquiryEnabled(boolean fieldDirectInquiryEnabled)

getFieldInactiveValidValues

public java.util.List getFieldInactiveValidValues()

Returns:

the fieldInactiveValidValues

setFieldInactiveValidValues

public void setFieldInactiveValidValues(java.util.List fieldInactiveValidValues)

Parameters:

fieldInactiveValidValues - the fieldInactiveValidValues to set

isTriggerOnChange

public boolean isTriggerOnChange()

setTriggerOnChange

public void setTriggerOnChange(boolean triggerOnChange)

getHasLookupable

public boolean getHasLookupable()

getAlternateDisplayPropertyName

public java.lang.String getAlternateDisplayPropertyName()

Specified by:

getAlternateDisplayPropertyName in interface PropertyRenderingConfigElement

Returns:

name of the property that should be displayed in place of property we are rendering (only applies when read-only)

setAlternateDisplayPropertyName

public void setAlternateDisplayPropertyName(java.lang.String alternateDisplayPropertyName)

Specified by:

setAlternateDisplayPropertyName in interface PropertyRenderingConfigElement

Parameters:

alternateDisplayPropertyName - - name of the property that should be displayed in place of property we are rendering (only applies when read-only)

getAlternateDisplayPropertyValue

public java.lang.String getAlternateDisplayPropertyValue()

setAlternateDisplayPropertyValue

public void setAlternateDisplayPropertyValue(java.lang.Object alternateDisplayPropertyValue)

getAdditionalDisplayPropertyName

public java.lang.String getAdditionalDisplayPropertyName()

Specified by:

getAdditionalDisplayPropertyName in interface PropertyRenderingConfigElement

Returns:

name of the property that should be displayed in addition to the property we are rendering (only applies when read-only)

setAdditionalDisplayPropertyName

public void setAdditionalDisplayPropertyName(java.lang.String additionalDisplayPropertyName)

Specified by:

setAdditionalDisplayPropertyName in interface PropertyRenderingConfigElement

Parameters:

additionalDisplayPropertyName - - name of the property that should be displayed in addition to the property we are rendering (only applies when read-only)

getAdditionalDisplayPropertyValue

public java.lang.String getAdditionalDisplayPropertyValue()

setAdditionalDisplayPropertyValue

public void setAdditionalDisplayPropertyValue(java.lang.Object additionalDisplayPropertyValue)

isIndexedForSearch

public boolean isIndexedForSearch()

setIndexedForSearch

public void setIndexedForSearch(boolean indexedForSearch)

getMainFieldLabel

public java.lang.String getMainFieldLabel()

getRangeFieldInclusive

public java.lang.Boolean getRangeFieldInclusive()

isMemberOfRange

public boolean isMemberOfRange()

setMainFieldLabel

public void setMainFieldLabel(java.lang.String mainFieldLabel)

setRangeFieldInclusive

public void setRangeFieldInclusive(java.lang.Boolean rangeFieldInclusive)

setMemberOfRange

public void setMemberOfRange(boolean memberOfRange)

isInclusive

public boolean isInclusive()

getFieldDataType

public java.lang.String getFieldDataType()

setFieldDataType

public void setFieldDataType(java.lang.String fieldDataType)

isHidden

public boolean isHidden()

Deprecated.

Use fieldType=Field.HIDDEN instead

Returns:

isColumnVisible

public boolean isColumnVisible()

setHidden

public void setHidden(boolean hidden)

Deprecated.

Use fieldType=Field.HIDDEN instead

Parameters:

hidden -

setColumnVisible

public void setColumnVisible(boolean isColumnVisible)

getPropertyValues

public java.lang.String[] getPropertyValues()

setPropertyValues

public void setPropertyValues(java.lang.String[] propertyValues)

isSkipBlankValidValue

public boolean isSkipBlankValidValue()

Returns:

the skipBlankValidValue

setSkipBlankValidValue

public void setSkipBlankValidValue(boolean skipBlankValidValue)

Parameters:

skipBlankValidValue - the skipBlankValidValue to set

isAllowInlineRange

public boolean isAllowInlineRange()

Returns:

the allowInlineRange

setAllowInlineRange

public void setAllowInlineRange(boolean allowInlineRange)

Parameters:

allowInlineRange - the allowInlineRange to set

getUniversalIdValue

public java.lang.String getUniversalIdValue()

setUniversalIdValue

public void setUniversalIdValue(java.lang.String universalIdValue)

getPersonNameValue

public java.lang.String getPersonNameValue()

setPersonNameValue

public void setPersonNameValue(java.lang.String personNameValue)

getBaseLookupUrl

public java.lang.String getBaseLookupUrl()

setBaseLookupUrl

public void setBaseLookupUrl(java.lang.String baseLookupURL)

getFieldLevelHelpUrl

public java.lang.String getFieldLevelHelpUrl()

setFieldLevelHelpUrl

public void setFieldLevelHelpUrl(java.lang.String fieldLevelHelpUrl)

getWebUILeaveFieldFunctionParameters

public java.util.List<java.lang.String> getWebUILeaveFieldFunctionParameters()

Returns:

the webUILeaveFieldFunctionParameters

setWebUILeaveFieldFunctionParameters

public void setWebUILeaveFieldFunctionParameters(java.util.List<java.lang.String> webUILeaveFieldFunctionParameters)

Parameters:

webUILeaveFieldFunctionParameters - the webUILeaveFieldFunctionParameters to set

getWebUILeaveFieldFunctionParametersString

public java.lang.String getWebUILeaveFieldFunctionParametersString()