public class LocationSuggest extends Suggest
| Modifier and Type | Class and Description |
|---|---|
static class |
LocationSuggest.LocationSuggestPostData
Holds post data for the location suggest component.
|
Suggest.SuggestPostDatatemplateOptionscomponentCode, namespaceCodeINITIAL_ORDER_VALUE| Constructor and Description |
|---|
LocationSuggest() |
| Modifier and Type | Method and Description |
|---|---|
Map<String,String> |
getAdditionalRequestParameters()
AdditionalRequestParameters specify the static(constant) request parameters that should be appended to the url.
|
String |
getAdditionalRequestParameterString()
Gets the constant additionalRequestParameters as a request string value to use as part of the url
|
String |
getAdditionalUrlPathPropertyName()
AdditionalUrlPathProperty specifies the property on the retrieved suggestion result that contains a url
appendage
to be appended to the baseUrl when this selection is chosen.
|
String |
getBaseUrl()
BaseUrl for the suggestions.
|
String |
getHrefPropertyName()
The hrefPropertyName specifies the property on the retrieved suggestion result that contains the href
value (full url).
|
String |
getObjectIdPropertyName()
The objectIdPropertyName that represents the key for getting the object as a request parameter.
|
LocationSuggest.LocationSuggestPostData |
getPostData()
Returns object containing post data to store for the suggest request.
|
String |
getRequestParameterPropertyNameJsObject()
Gets an object translated to js for the requestParameterPropertyNames.
|
Map<String,String> |
getRequestParameterPropertyNames()
RequestParameterPropertyNames specify the properties that should be included in the request parameters.
|
void |
performFinalize(Object model,
LifecycleElement parent)
Process the objectIdPropertyName, if set
The following actions are performed:
Adjusts the query field mappings on the query based on the binding configuration of the field
TODO: determine query if render is true and query is not set
The following finalization is done here:
progressiveRender and conditionalRefresh variables are processed if set
If any of the style properties were given, sets the style string on the style property
Set the skipInTabOrder flag for nested components
The last phase before the view is rendered
|
void |
setAdditionalRequestParameters(Map<String,String> additionalRequestParameters)
Get the additionalRequestParameters
|
void |
setAdditionalUrlPathPropertyName(String additionalUrlPathPropertyName)
Set additionalUrlPathProperty
|
void |
setBaseUrl(String baseUrl)
Set the baseUrl
|
void |
setHrefPropertyName(String hrefPropertyName)
Set the hrefPropertyName
|
void |
setObjectIdPropertyName(String objectIdPropertyName)
Set the objectIdPropertyName
|
void |
setRequestParameterPropertyNames(Map<String,String> requestParameterPropertyNames)
Set the requestParameterPropertyNames
|
getAdditionalPropertiesToReturn, getLabelPropertyName, getSuggestOptions, getSuggestOptionsJsString, getSuggestQuery, getValuePropertyName, isRetrieveAllSuggestions, isReturnFullQueryObject, isSuggestConfigured, performApplyModel, retrieveSuggestOptions, setAdditionalPropertiesToReturn, setLabelPropertyName, setRetrieveAllSuggestions, setReturnFullQueryObject, setSuggestOptions, setSuggestOptionsJsString, setSuggestQuery, setValuePropertyNamegetComponentTypeNameaddAriaAttribute, addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, afterEvaluateExpression, appendToStyle, checkMutable, clone, completeValidation, 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, skipLifecyclegetExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressionscopy, dataDictionaryPostProcessing, getComponentCode, getNamespaceCode, setComponentCode, setNamespaceCodeequals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddAriaAttribute, addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, afterEvaluateExpression, appendToStyle, completeValidation, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAdditionalTemplates, getAlign, getAriaAttributes, getAriaAttributesAsString, getCanCopyOnReadOnly, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, 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, setWrapperStylegetExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressionsdataDictionaryPostProcessing, getComponentCode, getNamespaceCodecheckMutable, getContainerIdSuffix, getId, getPhasePathMapping, getViewPath, getViewStatus, isFinal, isInitialized, isModelApplied, isMutable, isRender, notifyCompleted, performInitialization, pushAllToContext, pushObjectToContext, setContainerIdSuffix, setId, setPhasePathMapping, setRender, setViewPath, skipLifecyclegetOnBlurScript, 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, setOnUnloadScriptpublic LocationSuggest()
public void performFinalize(Object model, LifecycleElement parent)
Here final preparations can be made based on the updated view state.
performFinalize in interface LifecycleElementperformFinalize in class Suggestmodel - - top level object containing the dataparent - - parent componentpublic LocationSuggest.LocationSuggestPostData getPostData()
getPostData in class Suggestpublic String getBaseUrl()
public void setBaseUrl(String baseUrl)
baseUrl - public String getAdditionalUrlPathPropertyName()
One use case for setting this is to retrieve a controllerMapping that changes based on selection. Note: for suggestions that all point to the same controllerMapping, simply set it as part of the baseUrl.
public void setAdditionalUrlPathPropertyName(String additionalUrlPathPropertyName)
additionalUrlPathPropertyName - public String getHrefPropertyName()
This property must contain a full url if it exists on the object. If this property name is matched on the suggestion result, it takes precedence over any other settings set on this locationSuggest and is used as the navigation url. If the property name does not exist on the object, the suggest will fall back to building the url dynamically with baseUrl.
public void setHrefPropertyName(String hrefPropertyName)
hrefPropertyName - public String getObjectIdPropertyName()
This convenience method is essentially equivalent to having a property by objectIdPropertyName as a key and value in the requestParameterPropertyNames.
public void setObjectIdPropertyName(String objectIdPropertyName)
objectIdPropertyName - public Map<String,String> getRequestParameterPropertyNames()
The key is used as the key of the request parameter and the value is used as the property name to look for in the suggestion result object. If the property name specified exists on the result object, the request parameter in the url will appear as key=propertyValue in the request parameters.
public void setRequestParameterPropertyNames(Map<String,String> requestParameterPropertyNames)
requestParameterPropertyNames - public Map<String,String> getAdditionalRequestParameters()
The key represents the key of the request parameter and the value represents the value of the request parameter. This will be used on each suggestion which uses a generated url (using baseUrl construction).
public void setAdditionalRequestParameters(Map<String,String> additionalRequestParameters)
additionalRequestParameters - public String getRequestParameterPropertyNameJsObject()
public String getAdditionalRequestParameterString()
Copyright © 2005–2018 The Kuali Foundation. All rights reserved.