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

java.lang.Object
  extended by org.kuali.rice.krad.datadictionary.DictionaryBeanBase
      extended by org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase
          extended by org.kuali.rice.krad.uif.component.ComponentBase
              extended by org.kuali.rice.krad.uif.field.FieldBase
                  extended by org.kuali.rice.krad.uif.field.DataField
                      extended by org.kuali.rice.krad.uif.field.InputField
                          extended by org.kuali.rice.krad.uif.field.LookupInputField
All Implemented Interfaces:
Serializable, DictionaryBean, UifDictionaryBean, CaseConstrainable, Constrainable, MustOccurConstrainable, PrerequisiteConstrainable, SimpleConstrainable, ValidCharactersConstrainable, Component, DataBinding, ScriptEventSupport, Field, Helpable, 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
readOnlyDisplayReplacementPropertyName, readOnlyDisplaySuffixPropertyName
 
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 isAddControlSelectAllOption()
          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 isDisableWildcardsAndOperators()
           
 void performFinalize(View view, Object model, Component parent)
          The following actions are performed: Add all option if enabled and control is multi-value
 void setAddControlSelectAllOption(boolean addControlSelectAllOption)
          Setter for the add all option indicator
 void setDisableWildcardsAndOperators(boolean disableWildcardsAndOperators)
           
 
Methods inherited from class org.kuali.rice.krad.uif.field.InputField
adjustMustOccurConstraintBinding, adjustPrerequisiteConstraintBinding, completeValidation, getAttributeQuery, getCaseConstraint, getComponentsForLifecycle, getConstraintMessage, getConstraintText, getControl, getDataType, getDependencyConstraints, getExclusiveMin, getInclusiveMax, getInstructionalMessage, getInstructionalText, getMaxLength, getMinLength, getMustOccurConstraints, getName, getOptionsFinder, getOptionsFinderClass, getPrerequisiteConstraints, getQuickfinder, getRequired, getSimpleConstraint, getSuggest, getValidationMessages, getValidCharactersConstraint, isInputAllowed, isRenderFieldset, isUppercaseValue, performApplyModel, performInitialization, processReadOnlyListDisplay, setAttributeQuery, setCaseConstraint, setConstraintMessage, setConstraintText, setControl, setDataType, setDataType, setDependencyConstraints, setExclusiveMin, setInclusiveMax, setInstructionalMessage, setInstructionalText, setMaxLength, setMinLength, setMustOccurConstraints, setOptionsFinder, setOptionsFinderClass, setQuickfinder, setRequired, setSimpleConstraint, setSuggest, setupFieldQuery, setupIds, setUppercaseValue, setValidationMessages, setValidCharactersConstraint
 
Methods inherited from class org.kuali.rice.krad.uif.field.DataField
generateReadOnlyListDisplayReplacement, getAdditionalHiddenPropertyNames, getBindingInfo, getComponentSecurityClass, getDataFieldSecurity, getDefaultValue, getDefaultValueFinderClass, getDefaultValues, getDictionaryAttributeName, getDictionaryObjectEntry, getHelp, getHelpSummary, getHelpTitle, getInquiry, getMaskFormatter, getPropertyEditor, getPropertyName, getPropertyNamesForAdditionalDisplay, getReadOnlyDisplayReplacement, getReadOnlyDisplayReplacementPropertyName, getReadOnlyDisplaySuffix, getReadOnlyDisplaySuffixPropertyName, getReadOnlyListDelimiter, getReadOnlyListDisplayType, hasSecureValue, isAddHiddenWhenReadOnly, isApplyMask, isEscapeHtmlInPropertyValue, isMultiLineReadOnlyDisplay, setAddHiddenWhenReadOnly, setAdditionalHiddenPropertyNames, setAlternateAndAdditionalDisplayValue, setApplyMask, setBindingInfo, setComponentSecurity, setDefaultValue, setDefaultValueFinderClass, setDefaultValues, setDictionaryAttributeName, setDictionaryObjectEntry, setEscapeHtmlInPropertyValue, setHelp, setHelpSummary, setInquiry, setMaskFormatter, setMultiLineReadOnlyDisplay, setPropertyEditor, setPropertyEditorClass, setPropertyName, setPropertyNamesForAdditionalDisplay, setReadOnlyDisplayReplacement, setReadOnlyDisplayReplacementPropertyName, setReadOnlyDisplaySuffix, setReadOnlyDisplaySuffixPropertyName, setReadOnlyListDelimiter, setReadOnlyListDisplayType, setTooltipOfComponent
 
Methods inherited from class org.kuali.rice.krad.uif.field.FieldBase
getComponentTypeName, getFieldLabel, getFieldSecurity, getLabel, getLabelColSpan, getLabelPlacement, getLabelStyleClasses, getShortLabel, isLabelRendered, setFieldLabel, setLabel, setLabelColSpan, setLabelPlacement, setLabelRendered, setLabelStyleClasses, setNestedComponentIdAndSuffix, setShortLabel, setShowLabel
 
Methods inherited from class org.kuali.rice.krad.uif.component.ComponentBase
addCellCssClass, addDataAttribute, addDataAttributeIfNonEmpty, addStyleClass, appendToStyle, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAlign, getAllDataAttributesJs, getBaseId, getCellCssClasses, getCellStyle, getCellStyleClassesAsString, getCellWidth, getColSpan, getComplexDataAttributesJs, getComponentModifiers, getComponentPrototypes, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getMethodToCallOnRefresh, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRowSpan, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, isSkipInTabOrder, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAdditionalComponentsToRefresh, setAlign, setBaseId, setCellCssClasses, setCellStyle, setCellWidth, setColSpan, setComponentModifiers, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setForceSessionPersistence, setHidden, setId, setMethodToCallOnRefresh, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setResetDataOnRefresh, setRowSpan, setSelfRendered, setSkipInTabOrder, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setWidth
 
Methods inherited from class org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase
getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph
 
Methods inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase
getComponentCode, getNamespaceCode, setComponentCode, setNamespaceCode
 
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
addCellCssClass, addDataAttribute, addStyleClass, appendToStyle, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAlign, getAllDataAttributesJs, getBaseId, getCellCssClasses, getCellStyle, getCellWidth, getColSpan, getComplexDataAttributesJs, getComponentModifiers, getComponentPrototypes, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRowSpan, getSimpleDataAttributes, getStyle, getTemplate, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, pushAllToContext, pushObjectToContext, setAdditionalComponentsToRefresh, setAlign, setBaseId, setCellCssClasses, setCellStyle, setCellWidth, setColSpan, setComponentModifiers, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setForceSessionPersistence, setHidden, setId, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setResetDataOnRefresh, setRowSpan, setSelfRendered, setStyle, setTemplate, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setWidth
 
Methods inherited from interface org.kuali.rice.krad.datadictionary.uif.UifDictionaryBean
getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph
 
Methods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean
getComponentCode, getNamespaceCode
 
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, setOnBlurScript, setOnLoadScript
 

Constructor Detail

LookupInputField

public LookupInputField()
Method Detail

performFinalize

public void performFinalize(View view,
                            Object model,
                            Component parent)
The following actions are performed:

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

isDisableWildcardsAndOperators

public boolean isDisableWildcardsAndOperators()
Returns:
the treatWildcardsAndOperatorsAsLiteral

setDisableWildcardsAndOperators

public void setDisableWildcardsAndOperators(boolean disableWildcardsAndOperators)
Parameters:
disableWildcardsAndOperators - the treatWildcardsAndOperatorsAsLiteral to set

isAddControlSelectAllOption

public boolean isAddControlSelectAllOption()
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

setAddControlSelectAllOption

public void setAddControlSelectAllOption(boolean addControlSelectAllOption)
Setter for the add all option indicator

Parameters:
addControlSelectAllOption -


Copyright © 2005-2013 The Kuali Foundation. All Rights Reserved.