org.kuali.rice.krad.uif.field
Class LookupInputField

java.lang.Object
  org.kuali.rice.krad.uif.component.ConfigurableBase
      org.kuali.rice.krad.uif.component.ComponentBase
          org.kuali.rice.krad.uif.field.FieldBase
              org.kuali.rice.krad.uif.field.DataField
                  org.kuali.rice.krad.uif.field.InputField
                      org.kuali.rice.krad.uif.field.LookupInputField

All Implemented Interfaces:

Serializable, CaseConstrainable, Constrainable, LengthConstrainable, MustOccurConstrainable, PrerequisiteConstrainable, RangeConstrainable, SimpleConstrainable, ValidCharactersConstrainable, Constraint, DataTypeConstraint, LengthConstraint, RangeConstraint, Component, Configurable, DataBinding, ScriptEventSupport, Field, org.springframework.core.Ordered

public class LookupInputField
extends InputField

Custom InputField for search fields within a lookup view

Author:

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

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.krad.uif.field.DataField

additionalDisplayPropertyName, alternateDisplayPropertyName

Fields inherited from interface org.kuali.rice.krad.uif.component.Ordered

INITIAL_ORDER_VALUE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

LookupInputField()

Method Summary

protected static Control	convertControlToLookupControl(AttributeDefinition attributeDefinition) If control definition is defined on the given attribute definition, converts to an appropriate control for searching (if necessary) and returns a copy for setting on the field
void	copyFromAttributeDefinition(View view, AttributeDefinition attributeDefinition) Override of InputField copy to setup properties necessary to make the field usable for inputting search criteria
boolean	isAddAllOption() Indicates whether the option for all values (blank key, 'All' label) should be added to the lookup field, note this is only supported for MultiValueControl instance
boolean	isTreatWildcardsAndOperatorsAsLiteral()
void	performFinalize(View view, Object model, Component parent) The following actions are performed: Add all option if enabled and control is multi-value
void	setAddAllOption(boolean addAllOption) Setter for the add all option indicator
void	setTreatWildcardsAndOperatorsAsLiteral(boolean treatWildcardsAndOperatorsAsLiteral)

Methods inherited from class org.kuali.rice.krad.uif.field.InputField

adjustMustOccurConstraintBinding, adjustPrerequisiteConstraintBinding, getCaseConstraint, getComponentsForLifecycle, getConstraintMessageField, getConstraintText, getControl, getDataType, getDependencyConstraints, getDirectInquiryRender, getErrorsField, getExclusiveMin, getFieldAttributeQuery, getFieldDirectInquiry, getFieldLookup, getFieldSuggest, getInclusiveMax, getInstructionalMessageField, getInstructionalText, getMaxLength, getMinLength, getMustOccurConstraints, getName, getOptionsFinder, getPrerequisiteConstraints, getRequired, getSimpleConstraint, getSupportsOnLoad, getValidCharactersConstraint, isInputAllowed, isPerformUppercase, setCaseConstraint, setConstraintMessageField, setConstraintText, setControl, setDataType, setDataType, setDependencyConstraints, setDirectInquiryRender, setErrorsField, setExclusiveMin, setFieldAttributeQuery, setFieldDirectInquiry, setFieldLookup, setFieldSuggest, setInclusiveMax, setInstructionalMessageField, setInstructionalText, setMaxLength, setMinLength, setMustOccurConstraints, setOptionsFinder, setOptionsFinderClass, setPerformUppercase, setRequired, setSimpleConstraint, setupFieldQuery, setupIds, setValidCharactersConstraint

Methods inherited from class org.kuali.rice.krad.uif.field.DataField

getAdditionalDisplayPropertyName, getAdditionalDisplayValue, getAlternateDisplayPropertyName, getAlternateDisplayValue, getBindingInfo, getComponentSecurity, getComponentSecurityClass, getDefaultValue, getDefaultValueFinderClass, getDictionaryAttributeName, getDictionaryObjectEntry, getFieldInquiry, getHelpDescription, getHelpSummary, getHiddenPropertyNames, getInformationalDisplayPropertyNames, getMaskFormatter, getPropertyEditor, getPropertyName, hasSecureValue, isApplyValueMask, isEscapeHtmlInPropertyValue, isReadOnlyHidden, performApplyModel, performInitialization, setAdditionalDisplayPropertyName, setAdditionalDisplayValue, setAlternateAndAdditionalDisplayValue, setAlternateDisplayPropertyName, setAlternateDisplayValue, setApplyValueMask, setBindingInfo, setComponentSecurity, setDefaultValue, setDefaultValueFinderClass, setDictionaryAttributeName, setDictionaryObjectEntry, setEscapeHtmlInPropertyValue, setFieldInquiry, setHelpDescription, setHelpSummary, setHiddenPropertyNames, setInformationalDisplayPropertyNames, setMaskFormatter, setPropertyEditor, setPropertyEditorClass, setPropertyName, setReadOnlyHidden

Methods inherited from class org.kuali.rice.krad.uif.field.FieldBase

getComponentTypeName, getLabel, getLabelField, getLabelPlacement, getShortLabel, isLabelFieldRendered, setLabel, setLabelField, setLabelFieldRendered, setLabelPlacement, setShortLabel, setShowLabel

Methods inherited from class org.kuali.rice.krad.uif.component.ComponentBase

addStyleClass, appendToStyle, getAlign, getColSpan, getComponentModifiers, getComponentOptions, getComponentOptionsJSString, getComponentPrototypes, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getEventCode, getFactoryId, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshDiscloseMethodToCall, getRefreshWhenChanged, getRefreshWhenChangedControlNames, getRenderOutput, getRowSpan, getStyle, getStyleClasses, getStyleClassesAsString, getSupportsOnBlur, getSupportsOnChange, getSupportsOnClick, getSupportsOnClose, getSupportsOnDblClick, getSupportsOnDocumentReady, getSupportsOnFocus, getSupportsOnKeyDown, getSupportsOnKeyPress, getSupportsOnKeyUp, getSupportsOnMouseDown, getSupportsOnMouseMove, getSupportsOnMouseOut, getSupportsOnMouseOver, getSupportsOnMouseUp, getSupportsOnSubmit, getSupportsOnUnload, getTemplate, getTitle, getValign, getWidth, isHidden, isPersistInSession, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, isSkipInTabOrder, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAlign, setColSpan, setComponentModifiers, setComponentOptions, setComponentOptionsJSString, setConditionalRefresh, setContext, setFactoryId, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setHidden, setId, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setPersistInSession, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefresh, setRefreshDiscloseMethodToCall, setRefreshedByAction, setRefreshWhenChanged, setRender, setRenderOutput, setResetDataOnRefresh, setRowSpan, setSelfRendered, setSkipInTabOrder, setStyle, setStyleClasses, setTemplate, setTitle, setValign, setWidth

Methods inherited from class org.kuali.rice.krad.uif.component.ConfigurableBase

getPropertyExpression, getPropertyExpressions, setPropertyExpressions

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.krad.uif.component.Component

addStyleClass, appendToStyle, getColSpan, getComponentModifiers, getComponentOptions, getComponentOptionsJSString, getComponentPrototypes, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getFactoryId, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshWhenChanged, getRefreshWhenChangedControlNames, getRenderOutput, getRowSpan, getStyle, getStyleClasses, getTemplate, getTitle, isHidden, isPersistInSession, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, pushAllToContext, pushObjectToContext, setColSpan, setComponentModifiers, setComponentOptions, setComponentOptionsJSString, setConditionalRefresh, setContext, setFactoryId, setHidden, setId, setOrder, setPersistInSession, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefresh, setRefreshedByAction, setRefreshWhenChanged, setRender, setRenderOutput, setResetDataOnRefresh, setRowSpan, setSelfRendered, setStyle, setStyleClasses, setTemplate, setTitle

Methods inherited from interface org.kuali.rice.krad.uif.component.Configurable

getPropertyExpression, getPropertyExpressions, setPropertyExpressions

Methods inherited from interface org.kuali.rice.krad.uif.component.ScriptEventSupport

getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getSupportsOnBlur, getSupportsOnChange, getSupportsOnClick, getSupportsOnClose, getSupportsOnDblClick, getSupportsOnDocumentReady, getSupportsOnFocus, getSupportsOnKeyDown, getSupportsOnKeyPress, getSupportsOnKeyUp, getSupportsOnMouseDown, getSupportsOnMouseMove, getSupportsOnMouseOut, getSupportsOnMouseOver, getSupportsOnMouseUp, getSupportsOnSubmit, getSupportsOnUnload, setOnBlurScript, setOnDocumentReadyScript, setOnLoadScript

Constructor Detail

LookupInputField

public LookupInputField()

Method Detail

performFinalize

public void performFinalize(View view,
                            Object model,
                            Component parent)

The following actions are performed:

• Add all option if enabled and control is multi-value

Specified by:

performFinalize in interface Component

Overrides:

performFinalize in class InputField

Parameters:

view - - view instance that should be finalized for rendering

model - - top level object containing the data

parent - - parent component

See Also:

ComponentBase.performFinalize(org.kuali.rice.krad.uif.view.View, java.lang.Object, org.kuali.rice.krad.uif.component.Component)

copyFromAttributeDefinition

public void copyFromAttributeDefinition(View view,
                                        AttributeDefinition attributeDefinition)

Override of InputField copy to setup properties necessary to make the field usable for inputting search criteria

Overrides:

copyFromAttributeDefinition in class InputField

Parameters:

attributeDefinition - - AttributeDefinition instance the property values should be copied from

view - - view instance the field belongs to

See Also:

DataField.copyFromAttributeDefinition(org.kuali.rice.krad.uif.view.View, org.kuali.rice.krad.datadictionary.AttributeDefinition)

convertControlToLookupControl

protected static Control convertControlToLookupControl(AttributeDefinition attributeDefinition)

If control definition is defined on the given attribute definition, converts to an appropriate control for searching (if necessary) and returns a copy for setting on the field

Parameters:

attributeDefinition - - attribute definition instance to retrieve control from

Returns:

Control instance or null if not found

isTreatWildcardsAndOperatorsAsLiteral

public boolean isTreatWildcardsAndOperatorsAsLiteral()

Returns:

the treatWildcardsAndOperatorsAsLiteral

setTreatWildcardsAndOperatorsAsLiteral

public void setTreatWildcardsAndOperatorsAsLiteral(boolean treatWildcardsAndOperatorsAsLiteral)

Parameters:

treatWildcardsAndOperatorsAsLiteral - the treatWildcardsAndOperatorsAsLiteral to set

isAddAllOption

public boolean isAddAllOption()

Indicates whether the option for all values (blank key, 'All' label) should be added to the lookup field, note this is only supported for MultiValueControl instance

Returns:

boolean true if all option should be added, false if not

setAddAllOption

public void setAddAllOption(boolean addAllOption)

Setter for the add all option indicator

Parameters:

addAllOption -