org.kuali.rice.krad.uif.widget
Class QuickFinder

java.lang.Object
  org.kuali.rice.krad.uif.component.ConfigurableBase
      org.kuali.rice.krad.uif.component.ComponentBase
          org.kuali.rice.krad.uif.widget.WidgetBase
              org.kuali.rice.krad.uif.widget.QuickFinder

All Implemented Interfaces:

Serializable, Component, Configurable, ScriptEventSupport, Widget, org.springframework.core.Ordered

public class QuickFinder
extends WidgetBase

Widget for navigating to a lookup from a field (called a quickfinder)

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

QuickFinder()

Method Summary

protected void	addActionParameterIfNotNull(String parameterName, Object parameterValue)
protected void	generateFieldConversions(InputField field, DataObjectRelationship relationship)
protected void	generateLookupParameters(InputField field, DataObjectRelationship relationship)
Boolean	getAutoSearch()
String	getBaseLookupUrl() Returns the URL for the lookup for which parameters will be added
List<Component>	getComponentsForLifecycle() List of components that are contained within the component and should be sent through the lifecycle
String	getDataObjectClassName() Full class name the lookup should be provided for
Boolean	getDisableSearchButtons()
Map<String,String>	getFieldConversions()
Boolean	getHeaderBarEnabled()
Boolean	getHideReturnLink()
String	getLookupCollectionName() For the case of multi-value lookup, indicates the collection that should be populated with the return results
Boolean	getLookupCriteriaEnabled()
Map<String,String>	getLookupParameters()
Boolean	getMultipleValuesSelect() Indicates whether a multi-values lookup should be requested
ActionField	getQuickfinderActionField()
String	getReadOnlySearchFields()
String	getReferencesToRefresh()
protected DataObjectRelationship	getRelationshipForField(View view, Object model, InputField field)
Boolean	getShowMaintenanceLinks()
Boolean	getSupplementalActionsEnabled()
Boolean	getSuppressActions()
String	getViewName() Specifies the name of the lookup view that should be render when the quickfinder is clicked
void	performFinalize(View view, Object model, Component parent) The following finalization is performed: Sets defaults on collectionLookup such as collectionName, and the class if not set
void	setAutoSearch(Boolean autoSearch)
void	setBaseLookupUrl(String baseLookupUrl) Setter for the lookup base url (comain, context, and controller)
void	setDataObjectClassName(String dataObjectClassName) Setter for the class name that lookup should be provided for
void	setDisableSearchButtons(Boolean disableSearchButtons)
void	setFieldConversions(Map<String,String> fieldConversions)
void	setHeaderBarEnabled(Boolean headerBarEnabled)
void	setHideReturnLink(Boolean hideReturnLink)
void	setLookupCollectionName(String lookupCollectionName) Setter for the name of the collection that should be populated with lookup results
void	setLookupCriteriaEnabled(Boolean lookupCriteriaEnabled)
void	setLookupParameters(Map<String,String> lookupParameters)
void	setMultipleValuesSelect(Boolean multipleValuesSelect) Setter for the multi-values lookup indicator
void	setQuickfinderActionField(ActionField quickfinderActionField)
void	setReadOnlySearchFields(String readOnlySearchFields)
void	setReferencesToRefresh(String referencesToRefresh)
void	setShowMaintenanceLinks(Boolean showMaintenanceLinks)
void	setSupplementalActionsEnabled(Boolean supplementalActionsEnabled)
void	setSuppressActions(Boolean suppressActions)
void	setViewName(String viewName) Setter for the lookup view name
void	updateFieldConversions(BindingInfo bindingInfo) Adjusts the path on the field conversion to property to match the binding path prefix of the given BindingInfo
void	updateLookupParameters(BindingInfo bindingInfo) Adjusts the path on the lookup parameter from property to match the binding path prefix of the given BindingInfo

Methods inherited from class org.kuali.rice.krad.uif.widget.WidgetBase

getComponentTypeName

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

addStyleClass, appendToStyle, getAlign, getColSpan, getComponentModifiers, getComponentOptions, getComponentOptionsJSString, getComponentPrototypes, getComponentSecurity, getComponentSecurityClass, 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, getRequired, getRowSpan, getStyle, getStyleClasses, getStyleClassesAsString, getSupportsOnBlur, getSupportsOnChange, getSupportsOnClick, getSupportsOnClose, getSupportsOnDblClick, getSupportsOnDocumentReady, getSupportsOnFocus, getSupportsOnKeyDown, getSupportsOnKeyPress, getSupportsOnKeyUp, getSupportsOnLoad, getSupportsOnMouseDown, getSupportsOnMouseMove, getSupportsOnMouseOut, getSupportsOnMouseOver, getSupportsOnMouseUp, getSupportsOnSubmit, getSupportsOnUnload, getTemplate, getTitle, getValign, getWidth, isHidden, isPersistInSession, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, isSkipInTabOrder, performApplyModel, performInitialization, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAlign, setColSpan, setComponentModifiers, setComponentOptions, setComponentOptionsJSString, setComponentSecurity, 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, setRequired, 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, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getFactoryId, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshWhenChanged, getRefreshWhenChangedControlNames, getRenderOutput, getRequired, getRowSpan, getStyle, getStyleClasses, getTemplate, getTitle, isHidden, isPersistInSession, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, performApplyModel, performInitialization, pushAllToContext, pushObjectToContext, setColSpan, setComponentModifiers, setComponentOptions, setComponentOptionsJSString, setComponentSecurity, setConditionalRefresh, setContext, setFactoryId, setHidden, setId, setOrder, setPersistInSession, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefresh, setRefreshedByAction, setRefreshWhenChanged, setRender, setRenderOutput, setRequired, 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, getSupportsOnLoad, getSupportsOnMouseDown, getSupportsOnMouseMove, getSupportsOnMouseOut, getSupportsOnMouseOver, getSupportsOnMouseUp, getSupportsOnSubmit, getSupportsOnUnload, setOnBlurScript, setOnDocumentReadyScript, setOnLoadScript

Constructor Detail

QuickFinder

public QuickFinder()

Method Detail

performFinalize

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

The following finalization is performed:

• Sets defaults on collectionLookup such as collectionName, and the class if not set

  If the data object class was not configured for the lookup, the class configured for the collection group will be used if it has a lookup defined. If not data object class is found for the lookup it will be disabled. The collection name is also defaulted to the binding path for this collection group, so the results returned from the lookup will populate this collection. Finally field conversions will be generated based on the PK fields of the collection object class

Specified by:

performFinalize in interface Component

Overrides:

performFinalize in class ComponentBase

Parameters:

view - - view instance that should be finalized for rendering

model - - top level object containing the data

parent - - parent component

See Also:

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

addActionParameterIfNotNull

protected void addActionParameterIfNotNull(String parameterName,
                                           Object parameterValue)

getRelationshipForField

protected DataObjectRelationship getRelationshipForField(View view,
                                                         Object model,
                                                         InputField field)

generateFieldConversions

protected void generateFieldConversions(InputField field,
                                        DataObjectRelationship relationship)

generateLookupParameters

protected void generateLookupParameters(InputField field,
                                        DataObjectRelationship relationship)

updateFieldConversions

public void updateFieldConversions(BindingInfo bindingInfo)

Adjusts the path on the field conversion to property to match the binding path prefix of the given BindingInfo

Parameters:

bindingInfo - - binding info instance to copy binding path prefix from

updateLookupParameters

public void updateLookupParameters(BindingInfo bindingInfo)

Adjusts the path on the lookup parameter from property to match the binding path prefix of the given BindingInfo

Parameters:

bindingInfo - - binding info instance to copy binding path prefix from

getComponentsForLifecycle

public List<Component> getComponentsForLifecycle()

Description copied from interface: Component

List of components that are contained within the component and should be sent through the lifecycle

Used by ViewHelperService for the various lifecycle callbacks

Specified by:

getComponentsForLifecycle in interface Component

Overrides:

getComponentsForLifecycle in class ComponentBase

Returns:

List child components

See Also:

ComponentBase.getComponentsForLifecycle()

getBaseLookupUrl

public String getBaseLookupUrl()

Returns the URL for the lookup for which parameters will be added

The base URL includes the domain, context, and controller mapping for the lookup invocation. Parameters are then added based on configuration to complete the URL. This is generally defaulted to the application URL and internal KRAD servlet mapping, but can be changed to invoke another application such as the Rice standalone server

Returns:

String lookup base URL

setBaseLookupUrl

public void setBaseLookupUrl(String baseLookupUrl)

Setter for the lookup base url (comain, context, and controller)

Parameters:

baseLookupUrl -

getDataObjectClassName

public String getDataObjectClassName()

Full class name the lookup should be provided for

This is passed on to the lookup request for the data object the lookup should be rendered for. This is then used by the lookup framework to select the lookup view (if more than one lookup view exists for the same data object class name, the getViewName() property should be specified to select the view to render).

Returns:

String lookup class name

setDataObjectClassName

public void setDataObjectClassName(String dataObjectClassName)

Setter for the class name that lookup should be provided for

Parameters:

dataObjectClassName -

getViewName

public String getViewName()

Specifies the name of the lookup view that should be render when the quickfinder is clicked

When more than one lookup exists for the getDataObjectClassName(), the view name must be specified to select which one to render. Note when a view name is not specified, it receives a name of 'DEFAULT'. Therefore this name can be sent to select the lookup view without a view name specified.

Returns:

String name of lookup view

setViewName

public void setViewName(String viewName)

Setter for the lookup view name

Parameters:

viewName -

getReferencesToRefresh

public String getReferencesToRefresh()

setReferencesToRefresh

public void setReferencesToRefresh(String referencesToRefresh)

getFieldConversions

public Map<String,String> getFieldConversions()

setFieldConversions

public void setFieldConversions(Map<String,String> fieldConversions)

getLookupParameters

public Map<String,String> getLookupParameters()

setLookupParameters

public void setLookupParameters(Map<String,String> lookupParameters)

getReadOnlySearchFields

public String getReadOnlySearchFields()

setReadOnlySearchFields

public void setReadOnlySearchFields(String readOnlySearchFields)

getHideReturnLink

public Boolean getHideReturnLink()

setHideReturnLink

public void setHideReturnLink(Boolean hideReturnLink)

getSuppressActions

public Boolean getSuppressActions()

setSuppressActions

public void setSuppressActions(Boolean suppressActions)

getAutoSearch

public Boolean getAutoSearch()

setAutoSearch

public void setAutoSearch(Boolean autoSearch)

getLookupCriteriaEnabled

public Boolean getLookupCriteriaEnabled()

setLookupCriteriaEnabled

public void setLookupCriteriaEnabled(Boolean lookupCriteriaEnabled)

getSupplementalActionsEnabled

public Boolean getSupplementalActionsEnabled()

setSupplementalActionsEnabled

public void setSupplementalActionsEnabled(Boolean supplementalActionsEnabled)

getDisableSearchButtons

public Boolean getDisableSearchButtons()

setDisableSearchButtons

public void setDisableSearchButtons(Boolean disableSearchButtons)

getHeaderBarEnabled

public Boolean getHeaderBarEnabled()

setHeaderBarEnabled

public void setHeaderBarEnabled(Boolean headerBarEnabled)

getShowMaintenanceLinks

public Boolean getShowMaintenanceLinks()

setShowMaintenanceLinks

public void setShowMaintenanceLinks(Boolean showMaintenanceLinks)

getQuickfinderActionField

public ActionField getQuickfinderActionField()

setQuickfinderActionField

public void setQuickfinderActionField(ActionField quickfinderActionField)

getMultipleValuesSelect

public Boolean getMultipleValuesSelect()

Indicates whether a multi-values lookup should be requested

Returns:

boolean true if multi-value lookup should be requested, false for normal lookup

setMultipleValuesSelect

public void setMultipleValuesSelect(Boolean multipleValuesSelect)

Setter for the multi-values lookup indicator

Parameters:

multipleValuesSelect -

getLookupCollectionName

public String getLookupCollectionName()

For the case of multi-value lookup, indicates the collection that should be populated with the return results

Note when the quickfinder is associated with a CollectionGroup, this property is set automatically from the collection name associated with the group

Returns:

String collection name (must be full binding path)

setLookupCollectionName

public void setLookupCollectionName(String lookupCollectionName)

Setter for the name of the collection that should be populated with lookup results

Parameters:

lookupCollectionName -