Package org.kuali.rice.krad.uif.control

Class UserControl

java.lang.Object

org.kuali.rice.krad.datadictionary.DictionaryBeanBase

org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase

org.kuali.rice.krad.uif.component.ComponentBase

org.kuali.rice.krad.uif.element.ContentElementBase

org.kuali.rice.krad.uif.control.ControlBase

org.kuali.rice.krad.uif.control.TextControlBase

org.kuali.rice.krad.uif.control.UserControl

All Implemented Interfaces:

Serializable, Cloneable, Copyable, DictionaryBean, UifDictionaryBean, Component, Ordered, ScriptEventSupport, Control, FilterableLookupCriteriaControl, SizedControl, TextControl, ContentElement, LifecycleElement, org.springframework.core.Ordered

public class UserControl
extends TextControlBase
implements FilterableLookupCriteriaControl

Represents a user control, which is a special control to handle the input of a Person.

Author:

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

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UserControl.UserControlPostData	Holds post data for the UserControl.

Field Summary

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

templateOptions

Fields inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

componentCode, namespaceCode

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

Constructors

Constructor	Description
UserControl()

Method Summary

Modifier and Type	Method	Description
protected void	buildUserQuickfinder(Object model, InputField field)	Configures the field's quickfinder for a user lookup
Map<String,String>	filterSearchCriteria(String propertyName, Map<String,String> searchCriteria, FilterableLookupCriteriaControlPostData postData)	Invoked to perform filtering of the search criteria.
String	getPersonNamePropertyName()	The name of the property on the parent object that holds the person name
String	getPersonObjectPropertyName()	The name of the property on the parent object that holds the person object
UserControl.UserControlPostData	getPostData(String propertyName)	Returns the post data for the filterable lookup criteria control using the property name as a key.
String	getPrincipalIdPropertyName()	The name of the property on the parent object that holds the principal id
void	performApplyModel(Object model, LifecycleElement parent)	Sets the disabledExpression, if any, evaluates it and sets the disabled property
void	setPersonNamePropertyName(String personNamePropertyName)	Setter for the name of the property on the parent object that holds the person name
void	setPersonObjectPropertyName(String personObjectPropertyName)	Setter for the name of the property on the parent object that holds the person object
void	setPrincipalIdPropertyName(String principalIdPropertyName)	Setter for the name of the property on the parent object that holds the principal id

Methods inherited from class org.kuali.rice.krad.uif.control.TextControlBase

getDatePicker, getMaxLength, getMinLength, getSize, getWatermarkText, isTextExpand, performFinalize, setDatePicker, setMaxLength, setMinLength, setSize, setTextExpand, setWatermarkText

Methods inherited from class org.kuali.rice.krad.uif.control.ControlBase

completeValidation, getComponentTypeName, getDisabledConditionControlNames, getDisabledConditionJs, getDisabledReason, getDisabledWhenChangedPropertyNames, getEnabledWhenChangedPropertyNames, getTabIndex, isDisabled, isEvaluateDisabledOnKeyUp, setDisabled, setDisabledConditionControlNames, setDisabledConditionJs, setDisabledExpression, setDisabledReason, setDisabledWhenChangedPropertyNames, setEnabledWhenChangedPropertyNames, setEvaluateDisabledOnKeyUp, setTabIndex

Methods inherited from class org.kuali.rice.krad.uif.element.ContentElementBase

afterEvaluateExpression

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

addAriaAttribute, addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, appendToStyle, checkMutable, clone, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAdditionalTemplates, getAlign, getAriaAttributes, getAriaAttributesAsString, getCanCopyOnReadOnly, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContainerIdSuffix, getContext, getCssClasses, getCssGridSizes, getDataAttributes, getEventHandlerScript, getExcludeIf, getExcludeUnless, getFieldsToSendOnRefresh, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getLibraryCssClasses, getMethodToCallOnRefresh, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnInputScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getPhasePathMapping, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getReadOnly, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRole, getRowSpan, getScriptDataAttributes, getScriptDataAttributesJs, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getViewPath, getViewStatus, getWidth, getWrapperCssClasses, getWrapperCssClassesAsString, getWrapperStyle, initializeComponentSecurity, isDisableSessionPersistence, isDisclosedByAction, isEditAuthz, isFinal, isForceSessionPersistence, isHidden, isInitialized, isModelApplied, isMutable, isOmitFromFormPost, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isRefreshedByAction, isRender, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, isSkipInTabOrder, isViewAuthz, notifyCompleted, performInitialization, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setAriaAttributes, setCanCopyOnReadOnly, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContainerIdSuffix, setContext, setCssClasses, setCssGridSizes, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setEditAuthz, setExcludeIf, setExcludeUnless, setFieldsToSendOnRefresh, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setForceSessionPersistence, setHidden, setId, setLibraryCssClasses, setMethodToCallOnRefresh, setOmitFromFormPost, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnInputScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setPhasePathMapping, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRole, setRowSpan, setScriptDataAttributes, setSelfRendered, setSkipInTabOrder, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setViewAuthz, setViewPath, setViewStatus, setWidth, setWrapperCssClasses, setWrapperStyle, skipLifecycle

Methods inherited from class org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase

getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions

Methods inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

copy, dataDictionaryPostProcessing, getComponentCode, getNamespaceCode, setComponentCode, setNamespaceCode

Methods inherited from class java.lang.Object

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

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

addAriaAttribute, addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, afterEvaluateExpression, appendToStyle, completeValidation, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAdditionalTemplates, getAlign, getAriaAttributes, getAriaAttributesAsString, getCanCopyOnReadOnly, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getComponentTypeName, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getCssGridSizes, getDataAttributes, getEventHandlerScript, getExcludeIf, getExcludeUnless, getFieldsToSendOnRefresh, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getLibraryCssClasses, getMethodToCallOnRefresh, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getReadOnly, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRole, getRowSpan, getScriptDataAttributes, getScriptDataAttributesJs, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, getWrapperCssClasses, getWrapperStyle, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isOmitFromFormPost, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isRefreshedByAction, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setAriaAttributes, setCanCopyOnReadOnly, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setCssGridSizes, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setFieldsToSendOnRefresh, setForceSessionPersistence, setHidden, setLibraryCssClasses, setOmitFromFormPost, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRole, setRowSpan, setScriptDataAttributes, setSelfRendered, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setViewStatus, setWidth, setWrapperCssClasses, setWrapperStyle

Methods inherited from interface org.kuali.rice.krad.uif.control.Control

getDisabledReason, getTabIndex, isDisabled, setDisabled, setDisabledReason, setTabIndex

Methods inherited from interface org.kuali.rice.krad.datadictionary.Copyable

clone

Methods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean

dataDictionaryPostProcessing, getComponentCode, getNamespaceCode

Methods inherited from interface org.kuali.rice.krad.uif.util.LifecycleElement

checkMutable, getContainerIdSuffix, getId, getPhasePathMapping, getViewPath, getViewStatus, isFinal, isInitialized, isModelApplied, isMutable, isRender, notifyCompleted, performInitialization, pushAllToContext, pushObjectToContext, setContainerIdSuffix, setId, setPhasePathMapping, setRender, setViewPath, skipLifecycle

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

getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnInputScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnInputScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript

Methods inherited from interface org.kuali.rice.krad.datadictionary.uif.UifDictionaryBean

getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions

Constructor Details

UserControl

public UserControl()

Method Details

performApplyModel

public void performApplyModel(Object model,
 LifecycleElement parent)

Sets the disabledExpression, if any, evaluates it and sets the disabled property

Specified by:

performApplyModel in interface LifecycleElement

Overrides:

performApplyModel in class ControlBase

Parameters:

model - top level object containing the data (could be the form or a top level business object, dto)

parent -

filterSearchCriteria

public Map<String,String> filterSearchCriteria(String propertyName,
 Map<String,String> searchCriteria,
 FilterableLookupCriteriaControlPostData postData)

Invoked to perform filtering of the search criteria.

Specified by:

filterSearchCriteria in interface FilterableLookupCriteriaControl

Parameters:

propertyName - the propertyName of the current component

searchCriteria - the search criteria to be filtered

postData - the post data to consider during the search

Returns:

filtered search criteria

buildUserQuickfinder

protected void buildUserQuickfinder(Object model,
 InputField field)

Configures the field's quickfinder for a user lookup

Parameters:

model - object containing the view's data

field - field instance the quickfinder should be associated with

getPrincipalIdPropertyName

public String getPrincipalIdPropertyName()

The name of the property on the parent object that holds the principal id

Returns:

principalIdPropertyName

setPrincipalIdPropertyName

public void setPrincipalIdPropertyName(String principalIdPropertyName)

Setter for the name of the property on the parent object that holds the principal id

Parameters:

principalIdPropertyName -

getPersonNamePropertyName

public String getPersonNamePropertyName()

The name of the property on the parent object that holds the person name

Returns:

personNamePropertyName

setPersonNamePropertyName

public void setPersonNamePropertyName(String personNamePropertyName)

Setter for the name of the property on the parent object that holds the person name

Parameters:

personNamePropertyName -

getPersonObjectPropertyName

public String getPersonObjectPropertyName()

The name of the property on the parent object that holds the person object

Returns:

personObjectPropertyName

setPersonObjectPropertyName

public void setPersonObjectPropertyName(String personObjectPropertyName)

Setter for the name of the property on the parent object that holds the person object

Parameters:

personObjectPropertyName -

getPostData

public UserControl.UserControlPostData getPostData(String propertyName)

Returns the post data for the filterable lookup criteria control using the property name as a key.

Specified by:

getPostData in interface FilterableLookupCriteriaControl

Parameters:

propertyName - the property name for the control

Returns:

the post data for the filterable lookup criteria control