|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.container.ContainerBase org.kuali.rice.krad.uif.view.View org.kuali.rice.krad.uif.view.FormView org.kuali.rice.krad.uif.view.LookupView
public class LookupView
View type for lookups
Supports doing a search against a data object class or performing a more advanced query. The view type is primarily made up of two groups, the search (or criteria) group and the results group. Many options are supported on the view to enable/disable certain features, like what actions are available on the search results.
Works in conjunction with LookupableImpl
which customizes the view and carries out the
business functionality
Field Summary | |
---|---|
protected boolean |
defaultSortAscending
|
Fields inherited from class org.kuali.rice.krad.uif.view.View |
---|
viewIndex |
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 | |
---|---|
LookupView()
|
Method Summary | ||
---|---|---|
void |
applyConditionalLogicForFieldDisplay()
|
|
protected
|
copyProperties(T component)
Copies the properties over for the copy method |
|
List<Component> |
getComponentPrototypes()
List of components that are maintained by the component as prototypes for creating other component instances |
|
List<Component> |
getCriteriaFields()
|
|
Group |
getCriteriaGroup()
|
|
Class<?> |
getDataObjectClassName()
Class name for the object the lookup applies to |
|
List<String> |
getDefaultSortAttributeNames()
|
|
String |
getMaintenanceUrlMapping()
String that maps to the maintenance controller for the maintenance document (if any) associated with the lookup data object class |
|
Integer |
getMultipleValuesSelectResultSetLimit()
Retrieves the maximum number of records that will be listed as a result of the multiple values select lookup search |
|
Message |
getRangedToMessage()
The Message to render between the two range fields for ranged criteria fields |
|
FieldGroup |
getRangeFieldGroupPrototype()
The field group prototype that will be copied and used for range fields |
|
List<Component> |
getResultFields()
|
|
Integer |
getResultSetLimit()
Retrieves the maximum number of records that will be listed as a result of the lookup search |
|
CollectionGroup |
getResultsGroup()
|
|
String |
getReturnTarget()
|
|
boolean |
hasMultipleValuesSelectResultSetLimit()
Indicates whether a multiple values select result set limit has been specified for the view |
|
boolean |
hasResultSetLimit()
Indicates whether a result set limit has been specified for the view |
|
protected void |
initializeGroups()
|
|
boolean |
isAutoAddActiveCriteria()
Indicates whether the 'active' criteria field must be added automatically for Inactivatable BO's |
|
boolean |
isDefaultSortAscending()
|
|
boolean |
isHideReturnLinks()
|
|
boolean |
isMultipleValuesSelect()
Indicates whether multiple values select should be enabled for the lookup |
|
boolean |
isRenderHeader()
Indicates whether the lookup header should be rendered |
|
boolean |
isRenderLookupCriteria()
Indicates whether the lookup criteria group should be rendered |
|
boolean |
isRenderSearchButtons()
Indicates that the action buttons like search in the criteria section should be rendered |
|
boolean |
isReturnByScript()
|
|
boolean |
isShowMaintenanceLinks()
|
|
boolean |
isSuppressActions()
|
|
boolean |
isTriggerOnChange()
Indicates that the search must execute on changing of a value in all lookup input fields |
|
void |
performApplyModel(View view,
Object model,
Component parent)
The following updates are done here: Invoke expression evaluation on view theme Invoke theme to configure defaults |
|
void |
performFinalize(View view,
Object model,
Component parent)
The following is performed: Adds to its document ready script the setupValidator js function for setting up the validator for this view |
|
void |
performInitialization(View view,
Object model)
The following initialization is performed: Set the abstractTypeClasses map for the lookup object path |
|
void |
setAutoAddActiveCriteria(boolean autoAddActiveCriteria)
Setter for the flag that indicates whether the 'active' criteria field must be added automatically for Inactivatable BO's |
|
void |
setCriteriaFields(List<Component> criteriaFields)
|
|
void |
setCriteriaGroup(Group criteriaGroup)
|
|
void |
setDataObjectClassName(Class<?> dataObjectClassName)
Setter for the object class name |
|
void |
setDefaultSortAscending(boolean defaultSortAscending)
|
|
void |
setDefaultSortAttributeNames(List<String> defaultSortAttributeNames)
|
|
void |
setHideReturnLinks(boolean hideReturnLinks)
|
|
void |
setMaintenanceUrlMapping(String maintenanceUrlMapping)
Setter for the URL mapping string that will be used to build up maintenance action URLs |
|
void |
setMultipleValuesSelect(boolean multipleValuesSelect)
Setter for the multiple values select indicator |
|
void |
setMultipleValuesSelectResultSetLimit(Integer multipleValuesSelectResultSetLimit)
Setter for the multiple values select result set limit |
|
void |
setRangedToMessage(Message rangedToMessage)
Setter for the Message rendered between the two range fields for ranged criteria fields |
|
void |
setRangeFieldGroupPrototype(FieldGroup rangeFieldGroupPrototype)
Setter for the range FieldGroup prototype |
|
void |
setRenderHeader(boolean renderHeader)
Setter for the header render flag |
|
void |
setRenderLookupCriteria(boolean renderLookupCriteria)
Setter for the lookup criteria group render flag |
|
void |
setRenderSearchButtons(boolean renderSearchButtons)
Setter for the render search buttons flag |
|
void |
setResultFields(List<Component> resultFields)
|
|
void |
setResultSetLimit(Integer resultSetLimit)
Setter for the result list limit |
|
void |
setResultsGroup(CollectionGroup resultsGroup)
|
|
void |
setReturnByScript(boolean returnByScript)
Setter for the flag to indicate that lookups will return the value by script and not a post |
|
void |
setReturnTarget(String returnTarget)
|
|
void |
setShowMaintenanceLinks(boolean showMaintenanceLinks)
|
|
void |
setSuppressActions(boolean suppressActions)
|
|
void |
setTriggerOnChange(boolean triggerOnChange)
Setter for the trigger search on change flag |
Methods inherited from class org.kuali.rice.krad.uif.view.FormView |
---|
getFormPostUrl, isRenderForm, isValidateClientSide, isValidateServerSide, setFormPostUrl, setRenderForm, setValidateClientSide, setValidateServerSide |
Methods inherited from class org.kuali.rice.krad.uif.container.ContainerBase |
---|
getDefaultItemPosition, getFooter, getHeader, getHeaderText, getHelp, getHelpTitle, getInstructionalMessage, getInstructionalText, getLayoutManager, getValidationMessages, setDefaultItemPosition, setFooter, setHeader, setHeaderText, setHelp, setInstructionalMessage, setInstructionalText, setLayoutManager, setRenderFooter, setTooltipOfComponent, setValidationMessages |
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, setComponentCode |
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.datadictionary.uif.UifDictionaryBean |
---|
getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph |
Methods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean |
---|
getComponentCode |
Field Detail |
---|
protected boolean defaultSortAscending
Constructor Detail |
---|
public LookupView()
Method Detail |
---|
public void performInitialization(View view, Object model)
performInitialization
in interface Component
performInitialization
in class View
view
- - view instance in which the component belongsmodel
- - object instance containing the view dataContainerBase.performInitialization(org.kuali.rice.krad.uif.view.View,
java.lang.Object)
protected void initializeGroups()
public void performApplyModel(View view, Object model, Component parent)
View
performApplyModel
in interface Component
performApplyModel
in class View
view
- - view instance to which the component belongsmodel
- - Top level object containing the data (could be the form or a
top level business object, dto)ContainerBase.performApplyModel(View, Object,
org.kuali.rice.krad.uif.component.Component)
public void performFinalize(View view, Object model, Component parent)
View
performFinalize
in interface Component
performFinalize
in class View
view
- - view instance that should be finalized for renderingmodel
- - top level object containing the dataparent
- - parent componentContainerBase.performFinalize(org.kuali.rice.krad.uif.view.View,
Object, org.kuali.rice.krad.uif.component.Component)
public List<Component> getComponentPrototypes()
Component
Prototypes are held for configuring how a component should be created during the lifecycle. An example of this are the fields in a collection group that are created for each collection record. They only participate in the initialize phase.
getComponentPrototypes
in interface Component
getComponentPrototypes
in class ContainerBase
Component.getComponentPrototypes()
public void applyConditionalLogicForFieldDisplay()
public Class<?> getDataObjectClassName()
The object class name is used to pick up a dictionary entry which will
feed the attribute field definitions and other configuration. In addition
it is to configure the Lookupable
which will carry out the
lookup action
public void setDataObjectClassName(Class<?> dataObjectClassName)
dataObjectClassName
- public boolean isHideReturnLinks()
public void setHideReturnLinks(boolean hideReturnLinks)
hideReturnLinks
- the hideReturnLinks to setpublic boolean isSuppressActions()
public void setSuppressActions(boolean suppressActions)
suppressActions
- the suppressActions to setpublic boolean isShowMaintenanceLinks()
public void setShowMaintenanceLinks(boolean showMaintenanceLinks)
showMaintenanceLinks
- the showMaintenanceLinks to setpublic boolean isMultipleValuesSelect()
When set to true, the select field is enabled for the lookup results group that allows the user to select one or more rows for returning
public void setMultipleValuesSelect(boolean multipleValuesSelect)
multipleValuesSelect
- public Group getCriteriaGroup()
public void setCriteriaGroup(Group criteriaGroup)
public CollectionGroup getResultsGroup()
public void setResultsGroup(CollectionGroup resultsGroup)
public List<Component> getCriteriaFields()
public void setCriteriaFields(List<Component> criteriaFields)
public List<Component> getResultFields()
public void setResultFields(List<Component> resultFields)
public List<String> getDefaultSortAttributeNames()
public void setDefaultSortAttributeNames(List<String> defaultSortAttributeNames)
public boolean isDefaultSortAscending()
public void setDefaultSortAscending(boolean defaultSortAscending)
public Integer getResultSetLimit()
public void setResultSetLimit(Integer resultSetLimit)
resultSetLimit
- Integer specifying limitpublic boolean hasResultSetLimit()
public Integer getMultipleValuesSelectResultSetLimit()
public void setMultipleValuesSelectResultSetLimit(Integer multipleValuesSelectResultSetLimit)
multipleValuesSelectResultSetLimit
- Integer specifying limitpublic boolean hasMultipleValuesSelectResultSetLimit()
public void setReturnTarget(String returnTarget)
returnTarget
- the returnTarget to setpublic String getReturnTarget()
public boolean isReturnByScript()
public void setReturnByScript(boolean returnByScript)
returnByScript
- the returnByScript flagpublic String getMaintenanceUrlMapping()
Mapping will be used to build the maintenance action links (such as edit, copy, and new). If not given, the default maintenance mapping will be used
public void setMaintenanceUrlMapping(String maintenanceUrlMapping)
maintenanceUrlMapping
- public boolean isRenderSearchButtons()
public void setRenderSearchButtons(boolean renderSearchButtons)
renderSearchButtons
- public boolean isRenderLookupCriteria()
Defaults to true. Can be set as bean property or passed as a request parameter in the lookup url.
public void setRenderLookupCriteria(boolean renderLookupCriteria)
renderLookupCriteria
- public boolean isRenderHeader()
Defaults to true. Can be set as bean property or passed as a request parameter in the lookup url.
public void setRenderHeader(boolean renderHeader)
setRenderHeader
in class ContainerBase
renderHeader
- public boolean isTriggerOnChange()
public void setTriggerOnChange(boolean triggerOnChange)
triggerOnChange
- public FieldGroup getRangeFieldGroupPrototype()
public void setRangeFieldGroupPrototype(FieldGroup rangeFieldGroupPrototype)
rangeFieldGroupPrototype
- public boolean isAutoAddActiveCriteria()
public void setAutoAddActiveCriteria(boolean autoAddActiveCriteria)
autoAddActiveCriteria
- public Message getRangedToMessage()
public void setRangedToMessage(Message rangedToMessage)
rangedToMessage
- protected <T> void copyProperties(T component)
ComponentBase
copyProperties
in class FormView
component
- base beanComponentBase.copy()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |