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, DictionaryBean, UifDictionaryBean, Component, ScriptEventSupport, Field, 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 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

ActionField()

Method Summary

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()
Image	getActionImage()
String	getActionImagePlacement()
String	getActionLabel()
String	getActionParameter(String parameterName)
Map<String,String>	getActionParameters()
String	getActionScript()
List<Component>	getComponentsForLifecycle() List of components that are contained within the component and should be sent through the lifecycle
String	getDisabledReason()
String	getErrorCallback()
String	getFocusOnIdAfterSubmit()
String	getJumpToIdAfterSubmit()
String	getJumpToNameAfterSubmit()
String	getMethodToCall()
String	getNavigateToPageId()
String	getPreSubmitCall()
String	getSuccessCallback()
boolean	isAjaxSubmit()
boolean	isDisabled()
boolean	isPerformClientSideValidation()
boolean	isPerformDirtyValidation()
void	performFinalize(View view, Object model, Component 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)
void	setActionImage(Image actionImage)
void	setActionImagePlacement(String actionImageLocation)
void	setActionLabel(String actionLabel)
void	setActionParameters(Map<String,String> actionParameters)
void	setActionScript(String actionScript)
void	setAjaxSubmit(boolean ajaxSubmit)
void	setComponentSecurity(ComponentSecurity componentSecurity) Override to assert a FieldSecurity instance is set
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)
void	setNavigateToPageId(String navigateToPageId)
void	setPerformClientSideValidation(boolean clientSideValidate)
void	setPerformDirtyValidation(boolean blockValidateDirty)
void	setPreSubmitCall(String preSubmitCall)
void	setSuccessCallback(String successCallback)

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

getComponentSecurityClass, getComponentTypeName, getFieldLabel, getFieldSecurity, getLabel, getLabelColSpan, getLabelPlacement, getLabelStyleClasses, getShortLabel, isLabelRendered, performInitialization, setFieldLabel, setLabel, setLabelColSpan, setLabelPlacement, setLabelRendered, setLabelStyleClasses, setNestedComponentIdAndSuffix, setShortLabel, setShowLabel

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

addCellCssClass, addDataAttribute, addDataAttributeIfNonEmpty, addStyleClass, appendToStyle, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getBaseId, getCellCssClasses, getCellStyle, getCellStyleClassesAsString, getCellWidth, getColSpan, getComponentModifiers, getComponentPrototypes, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getEventHandlerScript, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, 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, performApplyModel, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setBaseId, setCellCssClasses, setCellStyle, setCellWidth, setColSpan, setComponentModifiers, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setForceSessionPersistence, setHidden, setId, 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, 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, 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, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getBaseId, getCellCssClasses, getCellStyle, getCellWidth, getColSpan, getComponentModifiers, getComponentPrototypes, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getEventHandlerScript, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getTemplate, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, performApplyModel, pushAllToContext, pushObjectToContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setBaseId, setCellCssClasses, setCellStyle, setCellWidth, setColSpan, setComponentModifiers, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setForceSessionPersistence, setHidden, setId, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setStyle, setTemplate, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, 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

ActionField

public ActionField()

Method Detail

performFinalize

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

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

Specified by:

performFinalize in interface Component

Overrides:

performFinalize in class FieldBase

Parameters:

view - the view

model - the model

parent - the parent component

See Also:

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

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 FieldBase

Returns:

List child components

See Also:

ComponentBase.getComponentsForLifecycle()

getAction

public Action getAction()

Nested action component

Returns:

Action instance

setAction

public void setAction(Action action)

Setter for the nested action component

Parameters:

action -

getMethodToCall

public String getMethodToCall()

See Also:

Action.getMethodToCall()

setMethodToCall

public void setMethodToCall(String methodToCall)

See Also:

Action.setMethodToCall(java.lang.String)

getActionLabel

public String getActionLabel()

See Also:

Action.getActionLabel()

setActionLabel

public void setActionLabel(String actionLabel)

See Also:

Action.setActionLabel(java.lang.String)

getActionImage

public Image getActionImage()

See Also:

Action.getActionImage()

setActionImage

public void setActionImage(Image actionImage)

See Also:

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

getNavigateToPageId

public String getNavigateToPageId()

See Also:

Action.getNavigateToPageId()

setNavigateToPageId

public void setNavigateToPageId(String navigateToPageId)

See Also:

Action.setNavigateToPageId(java.lang.String)

getActionEvent

public String getActionEvent()

See Also:

Action.getActionEvent()

setActionEvent

public void setActionEvent(String actionEvent)

See Also:

Action.setActionEvent(java.lang.String)

getActionParameters

public Map<String,String> getActionParameters()

See Also:

Action.getActionParameters()

setActionParameters

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

See Also:

org.kuali.rice.krad.uif.element.Action#setActionParameters(java.util.Map)

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)

setComponentSecurity

public void setComponentSecurity(ComponentSecurity componentSecurity)

Description copied from class: FieldBase

Override to assert a FieldSecurity instance is set

Specified by:

setComponentSecurity in interface Component

Overrides:

setComponentSecurity in class FieldBase

Parameters:

componentSecurity - instance of FieldSecurity

See Also:

Action.setComponentSecurity(org.kuali.rice.krad.uif.component.ComponentSecurity)

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)

completeValidation

public void completeValidation(ValidationTrace tracer)

Description copied from interface: Component

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

See Also:

Component.completeValidation(org.kuali.rice.krad.datadictionary.validator.ValidationTrace)