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

java.lang.Object
  org.kuali.rice.krad.uif.component.ConfigurableBase
      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, Component, Configurable, 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)
Action	getAction() Nested action component
String	getActionEvent()
Image	getActionImage()
String	getActionImagePlacement()
String	getActionLabel()
String	getActionParameter(String parameterName)
Map<String,String>	getActionParameters()
String	getClientSideJs()
ActionSecurity	getComponentSecurity() Field Security object that indicates what authorization (permissions) exist for the field
List<Component>	getComponentsForLifecycle() List of components that are contained within the component and should be sent through the lifecycle
String	getDisabledReason()
String	getFocusOnIdAfterSubmit()
String	getJumpToIdAfterSubmit()
String	getJumpToNameAfterSubmit()
LightBox	getLightBoxDirectInquiry()
LightBox	getLightBoxLookup()
String	getMethodToCall()
String	getNavigateToPageId()
boolean	isDisabled()
boolean	isPerformClientSideValidation()
boolean	isPerformDirtyValidation()
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	setClientSideJs(String clientSideJs)
void	setComponentSecurity(ComponentSecurity componentSecurity) Override to assert a FieldSecurity instance is set
void	setDisabled(boolean disabled)
void	setDisabledReason(String disabledReason)
void	setFocusOnIdAfterSubmit(String focusOnAfterSubmit)
void	setJumpToIdAfterSubmit(String jumpToIdAfterSubmit)
void	setJumpToNameAfterSubmit(String jumpToNameAfterSubmit)
void	setLightBoxDirectInquiry(LightBox lightBoxDirectInquiry)
void	setLightBoxLookup(LightBox lightBoxLookup)
void	setMethodToCall(String methodToCall)
void	setNavigateToPageId(String navigateToPageId)
void	setPerformClientSideValidation(boolean clientSideValidate)
void	setPerformDirtyValidation(boolean blockValidateDirty)

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

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

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

addDataAttribute, addStyleClass, appendToStyle, getAlign, getAllDataAttributesJs, getBaseId, getColSpan, getComplexDataAttributesJs, getComponentModifiers, getComponentPrototypes, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getDataMetaAttribute, getDataRoleAttribute, getDataTypeAttribute, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getMethodToCallOnRefresh, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, isDisableSessionPersistence, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, isSkipInTabOrder, performApplyModel, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAlign, setBaseId, setColSpan, setComponentModifiers, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDataMetaAttribute, setDataRoleAttribute, setDataTypeAttribute, setDisableSessionPersistence, 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, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setSkipInTabOrder, setStyle, setTemplate, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, 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

addDataAttribute, addStyleClass, appendToStyle, getAllDataAttributesJs, getBaseId, getColSpan, getComplexDataAttributesJs, getComponentModifiers, getComponentPrototypes, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getTemplate, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, isDisableSessionPersistence, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, performApplyModel, pushAllToContext, pushObjectToContext, setBaseId, setColSpan, setComponentModifiers, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setForceSessionPersistence, setHidden, setId, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setStyle, setTemplate, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip

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, setOnBlurScript, setOnLoadScript

Constructor Detail

ActionField

public ActionField()

Method Detail

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)

getComponentSecurity

public ActionSecurity getComponentSecurity()

Description copied from class: FieldBase

Field Security object that indicates what authorization (permissions) exist for the field

Specified by:

getComponentSecurity in interface Component

Overrides:

getComponentSecurity in class FieldBase

Returns:

FieldSecurity instance

See Also:

Action.getComponentSecurity()

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)

setLightBoxLookup

public void setLightBoxLookup(LightBox lightBoxLookup)

See Also:

Action.setLightBoxLookup(org.kuali.rice.krad.uif.widget.LightBox)

getLightBoxLookup

public LightBox getLightBoxLookup()

See Also:

Action.getLightBoxLookup()

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)

getClientSideJs

public String getClientSideJs()

See Also:

Action.getClientSideJs()

setClientSideJs

public void setClientSideJs(String clientSideJs)

setLightBoxDirectInquiry

public void setLightBoxDirectInquiry(LightBox lightBoxDirectInquiry)

See Also:

Action.setLightBoxDirectInquiry(org.kuali.rice.krad.uif.widget.LightBox)

getLightBoxDirectInquiry

public LightBox getLightBoxDirectInquiry()

See Also:

Action.getLightBoxDirectInquiry()

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)