Package org.kuali.rice.krad.uif.field

Class ActionField

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.field.FieldBase

org.kuali.rice.krad.uif.field.ActionField

All Implemented Interfaces:

Serializable, Cloneable, Copyable, DictionaryBean, UifDictionaryBean, Component, Ordered, ScriptEventSupport, Field, LifecycleElement, org.springframework.core.Ordered

public class ActionField
extends FieldBase

Field that encloses an @{link org.kuali.rice.krad.uif.element.Action} element

Author:

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

See Also:

• Serialized Form

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
ActionField()	Initializes wrapped action instance.

Method Summary

Modifier and Type	Method	Description
void	addActionParameter(String parameterName, String parameterValue)
void	completeValidation(ValidationTrace tracer)	Validates different requirements of component compiling a series of reports detailing information on errors found in the component.
Action	getAction()	Nested action component.
String	getActionEvent()	Delegates to Action.getActionEvent().
Image	getActionImage()	Delegates actionImage property reference to the action.
String	getActionImagePlacement()
String	getActionLabel()	Delegates actionLabel property reference to the action.
String	getActionParameter(String parameterName)
Map<String,String>	getActionParameters()
String	getActionScript()
Map<String,String>	getAdditionalSubmitData()
String	getDisabledReason()
String	getErrorCallback()
String	getFocusOnIdAfterSubmit()
String	getJumpToIdAfterSubmit()
String	getJumpToNameAfterSubmit()
String	getMethodToCall()	Delegates methodToCall property reference to the action.
String	getNavigateToPageId()	Delegates to Action.getNavigateToPageId().
String	getPreSubmitCall()
String	getRefreshId()
String	getSuccessCallback()
boolean	isAjaxSubmit()
boolean	isDisableBlocking()
boolean	isDisabled()
boolean	isPerformClientSideValidation()
boolean	isPerformDirtyValidation()
void	performFinalize(Object model, LifecycleElement parent)	PerformFinalize override - calls super, corrects the field's Label for attribute to point to this field's content.
void	setAction(Action action)	Setter for the nested action component.
void	setActionEvent(String actionEvent)	Setter for Action.setActionEvent(java.lang.String).
void	setActionImage(Image actionImage)	Delegates actionImage property reference to the action.
void	setActionImagePlacement(String actionImageLocation)
void	setActionLabel(String actionLabel)	Delegates actionLabel property reference to the action.
void	setActionParameters(Map<String,String> actionParameters)	Setter for getActionParameters()
void	setActionScript(String actionScript)
void	setAdditionalSubmitData(Map<String,String> additionalSubmitData)	Setter for getAdditionalSubmitData()
void	setAjaxSubmit(boolean ajaxSubmit)
void	setDisableBlocking(boolean disableBlocking)
void	setDisabled(boolean disabled)
void	setDisabledReason(String disabledReason)
void	setErrorCallback(String errorCallback)
void	setFocusOnIdAfterSubmit(String focusOnAfterSubmit)
void	setJumpToIdAfterSubmit(String jumpToIdAfterSubmit)
void	setJumpToNameAfterSubmit(String jumpToNameAfterSubmit)
void	setMethodToCall(String methodToCall)	Delegates methodToCall property reference to the action.
void	setNavigateToPageId(String navigateToPageId)	Setter for Action.setNavigateToPageId(java.lang.String).
void	setPerformClientSideValidation(boolean clientSideValidate)
void	setPerformDirtyValidation(boolean blockValidateDirty)
void	setPreSubmitCall(String preSubmitCall)
void	setRefreshId(String refreshId)
void	setSuccessCallback(String successCallback)

Methods inherited from class org.kuali.rice.krad.uif.field.FieldBase

afterEvaluateExpression, getComponentTypeName, getFieldLabel, getFieldSecurity, getLabel, getLabelColSpan, getLabelStyleClasses, getShortLabel, initializeComponentSecurity, isEditInLineAuthz, isLabelLeft, isLabelRendered, isViewInLineAuthz, performApplyModel, setComponentSecurity, setEditInLineAuthz, setFieldLabel, setLabel, setLabelColSpan, setLabelLeft, setLabelRendered, setLabelStyleClasses, setNestedComponentIdAndSuffix, setShortLabel, setShowLabel, setViewInLineAuthz

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, 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, 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, appendToStyle, 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, 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.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

ActionField

public ActionField()

Initializes wrapped action instance.

Method Details

performFinalize

public void performFinalize(Object model,
 LifecycleElement parent)

PerformFinalize override - calls super, corrects the field's Label for attribute to point to this field's content.

Specified by:

performFinalize in interface LifecycleElement

Overrides:

performFinalize in class FieldBase

Parameters:

model - the model

parent - the parent component

getAction

public Action getAction()

Nested action component.

Returns:

Action instance

setAction

public void setAction(Action action)

Setter for the nested action component.

Parameters:

action - property value

getMethodToCall

public String getMethodToCall()

Delegates methodToCall property reference to the action.

Returns:

method to call

See Also:

• Action.getMethodToCall()

setMethodToCall

public void setMethodToCall(String methodToCall)

Delegates methodToCall property reference to the action.

Parameters:

methodToCall - method to call

See Also:

• Action.setMethodToCall(java.lang.String)

getActionLabel

public String getActionLabel()

Delegates actionLabel property reference to the action.

Returns:

action label

See Also:

• Action.getActionLabel()

setActionLabel

public void setActionLabel(String actionLabel)

Delegates actionLabel property reference to the action.

Parameters:

actionLabel - action label

See Also:

• Action.setActionLabel(java.lang.String)

getActionImage

@ViewLifecycleRestriction
public Image getActionImage()

Delegates actionImage property reference to the action.

Returns:

action image

See Also:

• Action.getActionImage()

setActionImage

public void setActionImage(Image actionImage)

Delegates actionImage property reference to the action.

Parameters:

actionImage - action image

See Also:

• Action.setActionImage(org.kuali.rice.krad.uif.element.Image)

getNavigateToPageId

public String getNavigateToPageId()

Delegates to Action.getNavigateToPageId().

Returns:

page ID to navigate to

setNavigateToPageId

public void setNavigateToPageId(String navigateToPageId)

Setter for Action.setNavigateToPageId(java.lang.String).

Parameters:

navigateToPageId - property value

getActionEvent

public String getActionEvent()

Delegates to Action.getActionEvent().

Returns:

action event

setActionEvent

public void setActionEvent(String actionEvent)

Setter for Action.setActionEvent(java.lang.String).

Parameters:

actionEvent - property value

getActionParameters

public Map<String,String> getActionParameters()

See Also:

• Action.getActionParameters()

setActionParameters

public void setActionParameters(Map<String,String> actionParameters)

Setter for getActionParameters()

Parameters:

actionParameters - action parameters

getAdditionalSubmitData

public Map<String,String> getAdditionalSubmitData()

See Also:

• Action.getAdditionalSubmitData()

setAdditionalSubmitData

public void setAdditionalSubmitData(Map<String,String> additionalSubmitData)

Setter for getAdditionalSubmitData()

Parameters:

additionalSubmitData - property value

addActionParameter

public void addActionParameter(String parameterName,
 String parameterValue)

See Also:

• Action.addActionParameter(java.lang.String, java.lang.String)

getActionParameter

public String getActionParameter(String parameterName)

See Also:

• Action.getActionParameter(java.lang.String)

getJumpToIdAfterSubmit

public String getJumpToIdAfterSubmit()

See Also:

• Action.getJumpToIdAfterSubmit()

setJumpToIdAfterSubmit

public void setJumpToIdAfterSubmit(String jumpToIdAfterSubmit)

See Also:

• Action.setJumpToIdAfterSubmit(java.lang.String)

getJumpToNameAfterSubmit

public String getJumpToNameAfterSubmit()

See Also:

• Action.getJumpToNameAfterSubmit()

setJumpToNameAfterSubmit

public void setJumpToNameAfterSubmit(String jumpToNameAfterSubmit)

See Also:

• Action.setJumpToNameAfterSubmit(java.lang.String)

getFocusOnIdAfterSubmit

public String getFocusOnIdAfterSubmit()

See Also:

• Action.getFocusOnIdAfterSubmit()

setFocusOnIdAfterSubmit

public void setFocusOnIdAfterSubmit(String focusOnAfterSubmit)

See Also:

• Action.setFocusOnIdAfterSubmit(java.lang.String)

isPerformClientSideValidation

public boolean isPerformClientSideValidation()

See Also:

• Action.isPerformClientSideValidation()

setPerformClientSideValidation

public void setPerformClientSideValidation(boolean clientSideValidate)

See Also:

• Action.setPerformClientSideValidation(boolean)

getActionScript

public String getActionScript()

See Also:

• Action.getActionScript()

setActionScript

public void setActionScript(String actionScript)

See Also:

• Action.setActionScript(java.lang.String)

isPerformDirtyValidation

public boolean isPerformDirtyValidation()

See Also:

• Action.isPerformDirtyValidation()

setPerformDirtyValidation

public void setPerformDirtyValidation(boolean blockValidateDirty)

See Also:

• Action.setPerformDirtyValidation(boolean)

isDisabled

public boolean isDisabled()

See Also:

• Action.isDisabled()

setDisabled

public void setDisabled(boolean disabled)

See Also:

• Action.setDisabled(boolean)

getDisabledReason

public String getDisabledReason()

See Also:

• Action.getDisabledReason()

setDisabledReason

public void setDisabledReason(String disabledReason)

See Also:

• Action.setDisabledReason(java.lang.String)

getActionImagePlacement

public String getActionImagePlacement()

See Also:

• Action.getActionImagePlacement()

setActionImagePlacement

public void setActionImagePlacement(String actionImageLocation)

See Also:

• Action.setActionImagePlacement(java.lang.String)

getPreSubmitCall

public String getPreSubmitCall()

See Also:

• Action.getPreSubmitCall()

setPreSubmitCall

public void setPreSubmitCall(String preSubmitCall)

See Also:

• Action.setPreSubmitCall(java.lang.String)

isAjaxSubmit

public boolean isAjaxSubmit()

See Also:

• Action.isAjaxSubmit()

setAjaxSubmit

public void setAjaxSubmit(boolean ajaxSubmit)

See Also:

• Action.setAjaxSubmit(boolean)

getSuccessCallback

public String getSuccessCallback()

See Also:

• Action.getSuccessCallback()

setSuccessCallback

public void setSuccessCallback(String successCallback)

Parameters:

successCallback -

See Also:

• Action.setSuccessCallback(java.lang.String)

getErrorCallback

public String getErrorCallback()

See Also:

• Action.getErrorCallback()

setErrorCallback

public void setErrorCallback(String errorCallback)

Parameters:

errorCallback -

See Also:

• Action.setErrorCallback(java.lang.String)

getRefreshId

public String getRefreshId()

See Also:

• Action.getRefreshId()

setRefreshId

public void setRefreshId(String refreshId)

See Also:

• Action.setRefreshId(java.lang.String)

isDisableBlocking

public boolean isDisableBlocking()

See Also:

• Action.isDisableBlocking()

setDisableBlocking

public void setDisableBlocking(boolean disableBlocking)

See Also:

• Action.setDisableBlocking(boolean)

completeValidation

public void completeValidation(ValidationTrace tracer)

Validates different requirements of component compiling a series of reports detailing information on errors found in the component. Used by the RiceDictionaryValidator.

Specified by:

completeValidation in interface Component

Overrides:

completeValidation in class ComponentBase

Parameters:

tracer - Record of component's location