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

java.lang.Object
  org.kuali.rice.krad.uif.core.ComponentBase
      org.kuali.rice.krad.uif.field.FieldBase
          org.kuali.rice.krad.uif.field.GeneratedField

All Implemented Interfaces:

Serializable, Component, ScriptEventSupport, Field, org.springframework.core.Ordered

Deprecated.

public class GeneratedField
extends FieldBase

Field instance whose output is produced by invoking a method

Generated fields can be used to produce any kind of HTML output using code. The properties configured for the GeneratedField configure the class and method that should be invoked to render the component. The method that will be invoked should take the GeneratedField instance as a parameter and return a String (which can include state HTML)

If the renderingMethodToCall is set, it is assumed to be a method on the configured ViewHelperService. For invoking other class methods the renderMethodInvoker must be configured

e.g. public String sayHiInBold(GeneratedField field) { return "HI!"; }

Author:

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

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.kuali.rice.krad.uif.core.Ordered

INITIAL_ORDER_VALUE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

GeneratedField()
Deprecated.

Method Summary

org.springframework.util.MethodInvoker	getRenderingMethodInvoker() Deprecated. MethodInvoker instance for the method that should be invoked for rendering the component
String	getRenderingMethodToCall() Deprecated. Name of the method that should be invoked for rendering the component (full method name, without parameters or return type)
String	getRenderOutput() Deprecated. Rendering output for the component that will be sent as part of the response (can contain static text and HTML)
void	performFinalize(View view, Object model, Component parent) Deprecated. The following finalization is done here: Setup the method invoker and invoke method to get the render output
void	setRenderingMethodInvoker(org.springframework.util.MethodInvoker renderingMethodInvoker) Deprecated. Setter for the method invoker instance
void	setRenderingMethodToCall(String renderingMethodToCall) Deprecated. Setter for the rendering method

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

getComponentTypeName, getLabel, getLabelField, getLabelPlacement, getNestedComponents, getShortLabel, isLabelFieldRendered, performInitialization, setLabel, setLabelField, setLabelFieldRendered, setLabelPlacement, setShortLabel, setShowLabel

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

addStyleClass, appendToStyle, getAlign, getBaseId, getColSpan, getComponentModifiers, getComponentOptions, getComponentOptionsJSString, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getEventCode, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertiesForReferenceCopy, getPropertyExpression, getPropertyExpressions, getPropertyReplacers, getRefreshWhenChanged, getRefreshWhenChangedControlNames, getRequired, getRowSpan, getStyle, getStyleClasses, getStyleClassesAsString, getSupportsOnBlur, getSupportsOnChange, getSupportsOnClick, getSupportsOnClose, getSupportsOnDblClick, getSupportsOnDocumentReady, getSupportsOnFocus, getSupportsOnKeyDown, getSupportsOnKeyPress, getSupportsOnKeyUp, getSupportsOnLoad, getSupportsOnMouseDown, getSupportsOnMouseMove, getSupportsOnMouseOut, getSupportsOnMouseOver, getSupportsOnMouseUp, getSupportsOnSubmit, getSupportsOnUnload, getTemplate, getTitle, getValign, getWidth, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRender, isSelfRendered, isSkipInTabOrder, performApplyModel, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAlign, setBaseId, setColSpan, setComponentModifiers, setComponentOptions, setConditionalRefresh, setContext, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setHidden, setId, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyExpressions, setPropertyReplacers, setReadOnly, setRefresh, setRefreshWhenChanged, setRender, setRenderOutput, setRequired, setRowSpan, setSelfRendered, setSkipInTabOrder, setStyle, setStyleClasses, setTemplate, setTitle, setValign, setWidth

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.core.Component

addStyleClass, appendToStyle, getBaseId, getColSpan, getComponentModifiers, getComponentOptions, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertiesForReferenceCopy, getPropertyExpression, getPropertyExpressions, getPropertyReplacers, getRefreshWhenChanged, getRefreshWhenChangedControlNames, getRequired, getRowSpan, getStyle, getStyleClasses, getTemplate, getTitle, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRender, isSelfRendered, performApplyModel, pushAllToContext, pushObjectToContext, setBaseId, setColSpan, setComponentModifiers, setComponentOptions, setConditionalRefresh, setContext, setHidden, setId, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyExpressions, setPropertyReplacers, setReadOnly, setRefresh, setRefreshWhenChanged, setRender, setRenderOutput, setRequired, setRowSpan, setSelfRendered, setStyle, setStyleClasses, setTemplate, setTitle

Methods inherited from interface org.kuali.rice.krad.uif.core.ScriptEventSupport

getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getSupportsOnBlur, getSupportsOnChange, getSupportsOnClick, getSupportsOnClose, getSupportsOnDblClick, getSupportsOnDocumentReady, getSupportsOnFocus, getSupportsOnKeyDown, getSupportsOnKeyPress, getSupportsOnKeyUp, getSupportsOnLoad, getSupportsOnMouseDown, getSupportsOnMouseMove, getSupportsOnMouseOut, getSupportsOnMouseOver, getSupportsOnMouseUp, getSupportsOnSubmit, getSupportsOnUnload, setOnBlurScript

Constructor Detail

GeneratedField

public GeneratedField()

Deprecated.

Method Detail

performFinalize

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

Deprecated.

The following finalization is done here:

• Setup the method invoker and invoke method to get the render output

Specified by:

performFinalize in interface Component

Overrides:

performFinalize in class FieldBase

Parameters:

view - - view instance that should be finalized for rendering

model - - top level object containing the data

parent - - parent component

See Also:

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

getRenderingMethodToCall

public String getRenderingMethodToCall()

Deprecated.

Name of the method that should be invoked for rendering the component (full method name, without parameters or return type)

Note the method can also be set with the renderingMethodInvoker targetMethod property. If the method is on the configured ViewHelperService, only this property needs to be configured

Returns:

String method name

setRenderingMethodToCall

public void setRenderingMethodToCall(String renderingMethodToCall)

Deprecated.

Setter for the rendering method

Parameters:

renderingMethodToCall -

getRenderingMethodInvoker

public org.springframework.util.MethodInvoker getRenderingMethodInvoker()

Deprecated.

MethodInvoker instance for the method that should be invoked for rendering the component

MethodInvoker can be configured to specify the class or object the method should be called on. For static method invocations, the targetClass property can be configured. For object invocations, that targetObject property can be configured

Returns:

MethodInvoker instance

setRenderingMethodInvoker

public void setRenderingMethodInvoker(org.springframework.util.MethodInvoker renderingMethodInvoker)

Deprecated.

Setter for the method invoker instance

Parameters:

renderingMethodInvoker -

getRenderOutput

public String getRenderOutput()

Deprecated.

Rendering output for the component that will be sent as part of the response (can contain static text and HTML)

Specified by:

getRenderOutput in interface Component

Overrides:

getRenderOutput in class ComponentBase

Returns:

String render output

See Also:

Component.getRenderOutput()