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.TextControl
                          org.kuali.rice.krad.uif.control.UserControl

All Implemented Interfaces:

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

public class UserControl
extends TextControl
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

Field Summary

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

UserControl()

Method Summary

protected void	buildUserQuickfinder(View view, InputField field) Configures the field's quickfinder for a user lookup
protected <T> void	copyProperties(T component) Copies the properties over for the copy method
Map<String,String>	filterSearchCriteria(String propertyName, Map<String,String> searchCriteria) Removes any searchCriteria that are not part of the database lookup
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
String	getPrincipalIdPropertyName() The name of the property on the parent object that holds the principal id
void	performApplyModel(View view, Object model, Component 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.TextControl

getComponentsForLifecycle, 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, getDisabledExpression, getDisabledReason, getDisabledWhenChangedPropertyNames, getEnabledWhenChangedPropertyNames, getTabIndex, isDisabled, isEvaluateDisabledOnKeyUp, setDisabled, setDisabledConditionControlNames, setDisabledConditionJs, setDisabledExpression, setDisabledReason, setDisabledWhenChangedPropertyNames, setEnabledWhenChangedPropertyNames, setEvaluateDisabledOnKeyUp, setTabIndex

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

addCellCssClass, addDataAttribute, addDataAttributeIfNonEmpty, addStyleClass, appendToStyle, copy, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getBaseId, getCellCssClasses, getCellStyle, getCellStyleClassesAsString, getCellWidth, getColSpan, getComponentModifiers, getComponentPrototypes, getComponentSecurity, getComponentSecurityClass, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getEventHandlerScript, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getLibraryCssClasses, getMethodToCallOnRefresh, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, isSkipInTabOrder, isUseAjaxCallForContent, performInitialization, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setBaseId, setCellCssClasses, setCellStyle, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setForceSessionPersistence, setHidden, setId, setLibraryCssClasses, setMethodToCallOnRefresh, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setSkipInTabOrder, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setUseAjaxCallForContent, 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, getLabelFromCamelCasedName, 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, copy, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getBaseId, getCellCssClasses, getCellStyle, getCellWidth, getColSpan, getComponentModifiers, getComponentPrototypes, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getEventHandlerScript, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getLibraryCssClasses, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, isUseAjaxCallForContent, performInitialization, pushAllToContext, pushObjectToContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setBaseId, setCellCssClasses, setCellStyle, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setForceSessionPersistence, setHidden, setId, setLibraryCssClasses, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setUseAjaxCallForContent, 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, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript

Constructor Detail

UserControl

public UserControl()

Method Detail

performApplyModel

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

Description copied from class: ControlBase

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

Specified by:

performApplyModel in interface Component

Overrides:

performApplyModel in class ControlBase

Parameters:

view - view instance to which the component belongs

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

See Also:

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

filterSearchCriteria

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

Description copied from interface: FilterableLookupCriteriaControl

Removes any searchCriteria that are not part of the database lookup

Specified by:

filterSearchCriteria in interface FilterableLookupCriteriaControl

Parameters:

propertyName - the propertyName of the current component

searchCriteria - the search criteria to be filtered

Returns:

the filteredSearchCriteria

See Also:

FilterableLookupCriteriaControl.filterSearchCriteria(String, java.util.Map)

buildUserQuickfinder

protected void buildUserQuickfinder(View view,
                                    InputField field)

Configures the field's quickfinder for a user lookup

Parameters:

view - view instance that contains the field

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 -

copyProperties

protected <T> void copyProperties(T component)

Description copied from class: ComponentBase

Copies the properties over for the copy method

Overrides:

copyProperties in class TextControl

Parameters:

component - base bean

See Also:

ComponentBase.copy()