ComponentBase (Rice 2.5.11 API)

java.lang.Object
- org.kuali.rice.krad.datadictionary.DictionaryBeanBase
- - org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase
  - - org.kuali.rice.krad.uif.component.ComponentBase

All Implemented Interfaces:

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

Direct Known Subclasses:

ContainerBase, ContentElementBase, FieldBase, RemoteFieldsHolder, WidgetBase
```
public abstract class ComponentBase
extends UifDictionaryBeanBase
implements Component
```
Base implementation of Component which other component implementations should extend.
Provides base component properties such as id and template. Also provides default implementation for the ScriptEventSupport and Ordered interfaces. By default no script events except the onDocumentReady are supported.

Author:

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

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected Map<String,String> 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

Fields
Modifier and Type	Field and Description
`protected Map<String,String>`	`templateOptions`

Constructor Summary

Constructors
Constructor and Description

ComponentBase()

Constructors
Constructor and Description
`ComponentBase()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAriaAttribute(String key, String value)` Add an aria attribute to the ariaAttributes list
`void`	`addDataAttribute(String key, String value)` Add a data attribute to the dataAttributes map
`void`	`addScriptDataAttribute(String key, String value)` Add a script data attribute to the scriptDataAttributes map
`void`	`addStyleClass(String styleClass)` Adds a single style to the list of styles on this component
`void`	`addWrapperCssClass(String cssClass)` Add a cell css class to the cell classes list
`void`	`afterEvaluateExpression()` No-op implementation.
`void`	`appendToStyle(String styleRules)` Appends to the inline style set on a component
`void`	`checkMutable(boolean legalDuringInitialization)` Check for mutability on the element before modifying state.
`ComponentBase`	`clone()` Override `Object.clone()` to assign the public modifier.
`void`	`completeValidation(ValidationTrace tracer)` Validates different requirements of component compiling a series of reports detailing information on errors found in the component.
`List<String>`	`getAdditionalComponentsToRefresh()` Returns a list of componentIds which will be also be refreshed when this component is refreshed
`String`	`getAdditionalComponentsToRefreshJs()` Returns a string for representing the list of additional components to be refreshed as a JavaScript value
`List<String>`	`getAdditionalCssClasses()` Convenience property for adding css class names to the end of the list of cssClasses that may already exist on this Component (this is to avoid explicitly having to set list merge in the bean definition)
`List<String>`	`getAdditionalTemplates()` Gets additional templates that will be required during the rendering of this component.
`String`	`getAlign()` Horizontal alignment of the component within its container
`Map<String,String>`	`getAriaAttributes()` The aria attributes of this component and their values (without "aria-", this is automatically appended during rendering)
`String`	`getAriaAttributesAsString()` Get the aria attributes as a String that can be used during template output
`Boolean`	`getCanCopyOnReadOnly()` Indicates whether the component should be cleared on copy
`String`	`getCellWidth()` Width setting for the cell containing the component (only applies within table based layouts)
`int`	`getColSpan()` Number of places the component should take up horizontally in the container; when using a CssGridLayoutManager this is converted to the appropriate medium size.
`List<ComponentModifier>`	`getComponentModifiers()` `ComponentModifier` instances that should be invoked to initialize the component
`ComponentSecurity`	`getComponentSecurity()` Security object that indicates what authorization (permissions) exist for the component
`String`	`getConditionalRefresh()` When set if the condition is satisfied, the component will be refreshed.
`String`	`getConditionalRefreshConditionJs()` The condition to refresh this component converted to a js expression, set internally cannot be set.
`List<String>`	`getConditionalRefreshControlNames()` Control names used to control conditional refresh, set internally cannot be set.
`String`	`getContainerIdSuffix()` A string suffix that should get applied to the id for all child components of the given element.
`Map<String,Object>`	`getContext()` Context map for the component
`List<String>`	`getCssClasses()` CSS style class(s) to be applied to the component
`CssGridSizes`	`getCssGridSizes()` CssGridSizes represent the size (width) the content's div "cell" will take up in the "row" at each screen size (extra small, small, medium, large) when using a group backed by a CssGridLayoutManager.
`Map<String,String>`	`getDataAttributes()` The DataAttributes that will be written to the html element for this component as data-
`String`	`getEventHandlerScript()` String containing JavaScript code for registering event handlers for this component (blur, focus, click, etc.)
`String`	`getExcludeIf()` Names a model property path, which if set and resolves to true, indicates that this component should be excluded from the lifecycle at the initialize phase.
`String`	`getExcludeUnless()` Names a model property path, which if set and resolves to null or false, indicates that this component should be excluded from the lifecycle at the initialize phase.
`List<String>`	`getFieldsToSendOnRefresh()` Limits the field data to send on a refresh methodToCall server call to the names/group id/field id specified in this list.
`List<Object>`	`getFinalizeMethodAdditionalArguments()` The List of Object instances that should be passed as arguments to the finalize method
`MethodInvokerConfig`	`getFinalizeMethodInvoker()` `MethodInvokerConfig` instance for the method that should be invoked for finalizing the component configuration
`String`	`getFinalizeMethodToCall()` The name of the method that should be invoked for finalizing the component configuration (full method name, without parameters or return type)
`String`	`getId()` The unique id (within a given tree) for the element.
`List<String>`	`getLibraryCssClasses()` Additional css classes that come before css classes listed in the cssClasses property
`String`	`getMethodToCallOnRefresh()` Name of a method on the controller that should be invoked as part of the component refresh and disclosure process
`String`	`getOnBlurScript()` Script that should be executed when the component's onBlur event is fired
`String`	`getOnChangeScript()` Script that should be executed when the component's onChange event is fired
`String`	`getOnClickScript()` Script that should be executed when the component's onClick event is fired
`String`	`getOnCloseScript()` Script that should be executed when the component's onClose event is fired
`String`	`getOnDblClickScript()` Script that should be executed when the component's onDblClick event is fired
`String`	`getOnDocumentReadyScript()` Script to be run when the document ready event is triggered
`String`	`getOnFocusScript()` Script that should be executed when the component's onFocus event is fired
`String`	`getOnInputScript()` Script that should be executed when the component's onInput event is fired
`String`	`getOnKeyDownScript()` Script that should be executed when the component's onKeyDown event is fired
`String`	`getOnKeyPressScript()` Script that should be executed when the component's onKeyPress event is fired
`String`	`getOnKeyUpScript()` Script that should be executed when the component's onKeyUp event is fired
`String`	`getOnLoadScript()` Script that should be executed when the component's onLoad event is fired
`String`	`getOnMouseDownScript()` Script that should be executed when the component's onMouseDown event is fired
`String`	`getOnMouseMoveScript()` Script that should be executed when the component's onMouseMove event is fired
`String`	`getOnMouseOutScript()` Script that should be executed when the component's onMouseOut event is fired
`String`	`getOnMouseOverScript()` Script that should be executed when the component's onMouseOver event is fired
`String`	`getOnMouseUpScript()` Script that should be executed when the component's onMouseUp event is fired
`String`	`getOnSubmitScript()` Script that should be executed when the component's onSubmit event is fired
`String`	`getOnUnloadScript()` Script that should be executed when the component's onUnload event is fired
`int`	`getOrder()` Order of a component within a List of other components
`Map<String,String>`	`getPhasePathMapping()` Map of paths for this component that will be used to process a refresh (if necessary).
`String`	`getPostRenderContent()` Raw html or string content to render after this component renders
`String`	`getPreRenderContent()` Raw html or string content to render before this component renders
`String`	`getProgressiveDisclosureConditionJs()` The condition to show this component progressively converted to a js expression, set internally cannot be set.
`List<String>`	`getProgressiveDisclosureControlNames()` Control names used to control progressive disclosure, set internally cannot be set.
`String`	`getProgressiveRender()` When set if the condition is satisfied, the component will be displayed.
`List<Component>`	`getPropertyReplacerComponents()` Returns list of components that are being held in property replacers configured for this component
`List<PropertyReplacer>`	`getPropertyReplacers()` gets a list of `PropertyReplacer` instances
`Boolean`	`getReadOnly()` Indicates whether the component can be edited
`int`	`getRefreshTimer()` Time in seconds that the component will be automatically refreshed
`List<String>`	`getRefreshWhenChangedPropertyNames()` Specifies a property by name that when its value changes will automatically perform a refresh on this component
`String`	`getRenderedHtmlOutput()` Rendering output for the component that will be sent as part of the response (can contain static text and HTML)
`Boolean`	`getRequired()` Indicates whether the component is required
`String`	`getRole()` The role attribute of this component, use to define aria roles
`int`	`getRowSpan()` Number of places the component should take up vertically in the container
`Map<String,String>`	`getScriptDataAttributes()` The DataAttributes that will be written to the html as a script call to data for this component (these cannot be used for jQuery selection directly)
`String`	`getScriptDataAttributesJs()` Returns a js string that can be used to right js data attributes to for the component
`String`	`getSimpleDataAttributes()` The string that can be put into a the tag of a component to add data attributes inline
`String`	`getStyle()` CSS style string to be applied to the component
`String`	`getStyleClassesAsString()` Builds the HTML class attribute string by combining the styleClasses list with a space delimiter
`String`	`getTemplate()` The path to the JSP file that should be called to render the component
`String`	`getTemplateName()` The name for which the template can be invoked by
`Map<String,String>`	`getTemplateOptions()` The options that are passed through to the Component renderer
`String`	`getTemplateOptionsJSString()` Builds a string from the underlying `Map` of template options that will export that options as a JavaScript Map for use in js and jQuery plugins
`String`	`getTitle()` The component title
`Tooltip`	`getToolTip()` The Tooltip widget that renders a tooltip with additional information about the element on specified trigger event
`String`	`getValign()` Vertical alignment of the component within its container
`String`	`getViewPath()` Gets a property for referring to this component from the view, relative to the view, as assigned by the current or most recent lifecycle.
`String`	`getViewStatus()` Indicates what lifecycle phase the component instance is in
`String`	`getWidth()` Width the component should take up in the container
`List<String>`	`getWrapperCssClasses()` The cellCssClasses property defines the classes that will be placed on the corresponding td (or th) elements relating to this component when used in a table backed layout.
`String`	`getWrapperCssClassesAsString()` Builds the HTML class attribute string by combining the cellStyleClasses list with a space delimiter.
`String`	`getWrapperStyle()` CSS style string to be applied to the cell containing the component (only applies within table based layouts)
`protected void`	`initializeComponentSecurity()` Initializes (if necessary) the component security instance for the component type
`boolean`	`isDisableSessionPersistence()` Disables the storage of the component in session (when the framework determines it needs to be due to a refresh condition)
`boolean`	`isDisclosedByAction()` If true if this component is disclosed by an action in js, a placeholder will be put in this components place if render is also false.
`Boolean`	`isEditAuthz()`
`boolean`	`isFinal()` Indicates whether the component has been updated from the model and final updates made.
`boolean`	`isForceSessionPersistence()` Indicates whether the component should be stored with the session view regardless of configuration
`boolean`	`isHidden()` Indicates whether the component should be hidden in the UI
`boolean`	`isInitialized()` Indicates whether the component has been initialized.
`boolean`	`isModelApplied()` Indicates whether the component has been updated from the model.
`boolean`	`isMutable(boolean legalDuringInitialization)` Determine if this lifecycle element is mutable.
`boolean`	`isOmitFromFormPost()` Whether to omit fields from form post unless they are explicitly specified by the `Action.fieldsToSend` property.
`boolean`	`isProgressiveRenderAndRefresh()` If true, when the progressiveRender condition is satisfied, the component will always be retrieved from the server and shown(as opposed to being stored on the client, but hidden, after the first retrieval as is the case with the progressiveRenderViaAJAX option).
`boolean`	`isProgressiveRenderViaAJAX()` When progressiveRenderViaAJAX is true, this component will be retrieved from the server when it first satisfies its progressive render condition.
`boolean`	`isRefreshedByAction()` Indicates the component can be refreshed by an action
`boolean`	`isRender()` Indicates whether the component should be rendered in the UI
`boolean`	`isRendered()` Indicates whether the component has been fully rendered.
`boolean`	`isResetDataOnRefresh()` Indicates whether data contained within the component should be reset (set to default) when the component is refreshed
`boolean`	`isRetrieveViaAjax()` When true, this component will render as a placeholder component instead of rendering normally because the content will be later retrieved through manually ajax retrieval calls in the js
`boolean`	`isSelfRendered()` Indicates whether the component contains its own render output (through the renderOutput property)
`boolean`	`isSkipInTabOrder()` Flag indicating that this component and its nested components must be skipped when keyboard tabbing.
`Boolean`	`isViewAuthz()`
`void`	`notifyCompleted(ViewLifecyclePhase phase)` Receive notification that a lifecycle phase, and all successor phases, have been completed on this component.
`void`	`performApplyModel(Object model, LifecycleElement parent)` The following updates are done here: Evaluate the progressive render condition (if set) and combine with the current render status to set the render status Called after the initialize phase to perform conditional logic based on the model data
`void`	`performFinalize(Object model, LifecycleElement parent)` 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`	`performInitialization(Object model)` The following updates are done here: Invoke performInitialize on component modifiers Initializes the component
`void`	`pushAllToContext(Map<String,Object> objects)` Places each entry of the given Map into the context for the component
`void`	`pushObjectToContext(String objectName, Object object)` Places the given object into the context Map for the component with the given name
`protected void`	`pushToPropertyReplacerContext(String objectName, Object object)`
`void`	`setAdditionalComponentsToRefresh(List<String> additionalComponentsToRefresh)` Setter for alsoRefreshComponents
`void`	`setAdditionalCssClasses(List<String> additionalCssClasses)` Set the additionalCssClasses
`void`	`setAlign(String align)` Sets the components horizontal alignment
`void`	`setAriaAttributes(Map<String,String> ariaAttributes)`
`void`	`setCanCopyOnReadOnly(Boolean canCopyOnReadOnly)` Setter for the canCopyOnReadOnly indicator
`void`	`setCellWidth(String cellWidth)` Setter for the containing cell width
`void`	`setColSpan(int colSpan)` Setter for the components column span
`void`	`setComponentModifiers(List<ComponentModifier> componentModifiers)` Setter for the components List of `ComponentModifier` instances
`void`	`setComponentSecurity(ComponentSecurity componentSecurity)` Setter for the components security object
`void`	`setConditionalRefresh(String conditionalRefresh)` Set the conditional refresh condition
`void`	`setContainerIdSuffix(String containerIdSuffix)`
`void`	`setContext(Map<String,Object> context)` Setter for the context Map
`void`	`setCssClasses(List<String> cssClasses)` Setter for the components style classes
`void`	`setCssGridSizes(CssGridSizes cssGridSizes)`
`void`	`setDataAttributes(Map<String,String> dataAttributes)` Setter for data attributes to include for the component
`void`	`setDisableSessionPersistence(boolean disableSessionPersistence)` Setter for disabling storage of the component in session
`void`	`setDisclosedByAction(boolean disclosedByAction)` Set if this component is disclosed by some outside action
`void`	`setEditAuthz(Boolean editAuthz)` Setter for `isEditAuthz()`
`void`	`setExcludeIf(String excludeIf)`
`void`	`setExcludeUnless(String excludeUnless)`
`void`	`setFieldsToSendOnRefresh(List<String> fieldsToSendOnRefresh)`
`void`	`setFinalizeMethodAdditionalArguments(List<Object> finalizeMethodAdditionalArguments)` Setter for the finalize additional arguments list
`void`	`setFinalizeMethodInvoker(MethodInvokerConfig finalizeMethodInvoker)` Setter for the method invoker instance
`void`	`setFinalizeMethodToCall(String finalizeMethodToCall)` Setter for the finalize method
`void`	`setForceSessionPersistence(boolean forceSessionPersistence)` Setter for the indicator to force persistence of the component in session
`void`	`setHidden(boolean hidden)` Setter for the hidden indicator
`void`	`setId(String id)` Setter for the unique id (within a given tree) for the component
`void`	`setLibraryCssClasses(List<String> libraryCssClasses)` Set the libraryCssClasses
`void`	`setMethodToCallOnRefresh(String methodToCallOnRefresh)` Setter for the controller method to call for a refresh or disclosure action on this component
`void`	`setOmitFromFormPost(boolean omitFromFormPost)`
`void`	`setOnBlurScript(String onBlurScript)` Script that should be executed when the component's onBlur event is fired
`void`	`setOnChangeScript(String onChangeScript)` Setter for the components onChange script
`void`	`setOnClickScript(String onClickScript)` Setter for the components onClick script
`void`	`setOnCloseScript(String onCloseScript)` Setter for the components onClose script
`void`	`setOnDblClickScript(String onDblClickScript)` Setter for the components onDblClick script
`void`	`setOnDocumentReadyScript(String onDocumentReadyScript)` Setter for the components onDocumentReady script
`void`	`setOnFocusScript(String onFocusScript)` Setter for the components onFocus script
`void`	`setOnInputScript(String onInputScript)` Setter for the components onInput script
`void`	`setOnKeyDownScript(String onKeyDownScript)` Setter for the components onKeyDown script
`void`	`setOnKeyPressScript(String onKeyPressScript)` Setter for the components onKeyPress script
`void`	`setOnKeyUpScript(String onKeyUpScript)` Setter for the components onKeyUp script
`void`	`setOnLoadScript(String onLoadScript)` Script that should be executed when the component's onLoad event is fired
`void`	`setOnMouseDownScript(String onMouseDownScript)` Setter for the components onMouseDown script
`void`	`setOnMouseMoveScript(String onMouseMoveScript)` Setter for the components onMouseMove script
`void`	`setOnMouseOutScript(String onMouseOutScript)` Setter for the components onMouseOut script
`void`	`setOnMouseOverScript(String onMouseOverScript)` Setter for the components onMouseOver script
`void`	`setOnMouseUpScript(String onMouseUpScript)` Setter for the components onMouseUp script
`void`	`setOnSubmitScript(String onSubmitScript)` Setter for the components onSubmit script
`void`	`setOnUnloadScript(String onUnloadScript)` Setter for the components onUnload script
`void`	`setOrder(int order)` Setter for the component's order
`void`	`setPhasePathMapping(Map<String,String> phasePathMapping)`
`void`	`setPostRenderContent(String postRenderContent)` Set the postRenderContent
`void`	`setPreRenderContent(String preRenderContent)` Set the preRenderContent
`void`	`setProgressiveRender(String progressiveRender)` Setter for progressiveRender Spring EL expression
`void`	`setProgressiveRenderAndRefresh(boolean progressiveRenderAndRefresh)` Set the progressive render and refresh option.
`void`	`setProgressiveRenderViaAJAX(boolean progressiveRenderViaAJAX)` Setter for the progressiveRenderViaAJAX flag
`void`	`setPropertyReplacers(List<PropertyReplacer> propertyReplacers)` Setter for the components property substitutions
`void`	`setReadOnly(Boolean readOnly)` Setter for the read only indicator
`void`	`setRefreshedByAction(boolean refreshedByAction)` Setter for the refreshed by action indicator
`void`	`setRefreshTimer(int refreshTimer)` Setter for refreshTimer
`void`	`setRefreshWhenChangedPropertyNames(List<String> refreshWhenChangedPropertyNames)` Setter for the list of property names that trigger a refresh
`void`	`setRender(boolean render)` Setter for the components render indicator
`void`	`setRenderedHtmlOutput(String renderedHtmlOutput)` Setter for the component's render output
`void`	`setRequired(Boolean required)` Setter for the required indicator
`void`	`setResetDataOnRefresh(boolean resetDataOnRefresh)` Setter for the reset data on refresh indicator
`void`	`setRetrieveViaAjax(boolean retrieveViaAjax)` When true, this component will render as a placeholder component instead of rendering normally because the content will be later retrieved through manually ajax retrieval calls in the js
`void`	`setRole(String role)`
`void`	`setRowSpan(int rowSpan)` Setter for the component row span
`void`	`setScriptDataAttributes(Map<String,String> scriptDataAttributes)` Setter for script data attributes to include for the component
`void`	`setSelfRendered(boolean selfRendered)` Setter for the self render indicator
`void`	`setSkipInTabOrder(boolean skipInTabOrder)`
`void`	`setStyle(String style)` Setter for the components style
`void`	`setTemplate(String template)` Setter for the components template
`void`	`setTemplateName(String templateName)` Setter for the name of the template (a name which can be used to invoke)
`void`	`setTemplateOptions(Map<String,String> templateOptions)` Setter for the template's options
`void`	`setTemplateOptionsJSString(String templateOptionsJSString)` Setter for the template's options
`void`	`setTitle(String title)` Setter for the component's title
`void`	`setToolTip(Tooltip toolTip)` Setter for the component tooltip widget instance
`void`	`setValign(String valign)` Setter for the component's vertical align
`void`	`setViewAuthz(Boolean viewAuthz)` Setter for `isViewAuthz()`
`void`	`setViewPath(String viewPath)` Setter for `LifecycleElement.getViewPath()`.
`void`	`setViewStatus(String status)` Setter for the view status
`void`	`setWidth(String width)` Setter for the components width
`void`	`setWrapperCssClasses(List<String> wrapperCssClasses)` Set the cellCssClasses property which defines the classes that will be placed on the corresponding td (or th) relating to this component when used in a table backed layout.
`void`	`setWrapperStyle(String wrapperStyle)` Setter for the cell style attribute
`boolean`	`skipLifecycle()` Return true if the lifecycle should be skipped for this component.

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
getComponentTypeName

Methods inherited from interface org.kuali.rice.krad.datadictionary.uif.UifDictionaryBean
getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions

Methods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean
dataDictionaryPostProcessing, getComponentCode, getNamespaceCode

- Field Detail
  - templateOptions
```
protected Map<String,String> templateOptions
```
- Constructor Detail
  - ComponentBase
```
public ComponentBase()
```
- Method Detail
  - skipLifecycle
```
public boolean skipLifecycle()
```
    Return true if the lifecycle should be skipped for this component.
    Skipping the lifecycle means do not invoke the performInitialize, performApplyModel, and performFinalize methods of this component and its children. This means that content built by those lifecycle tasks will not be processed or applied. Skipping the lifecycle on a component helps initial load/setup performance by only performing the full lifecycle when the component is requested on subsequent requests (ajax retrievals).
    
    Specified by:
    
    skipLifecycle in interface LifecycleElement
    
    Returns:
    
    true if lifecycle should be skipped for this component
  - checkMutable
```
public void checkMutable(boolean legalDuringInitialization)
```
    Description copied from interface: LifecycleElement
    
    Check for mutability on the element before modifying state.
    
    Specified by:
    
    checkMutable in interface LifecycleElement
    
    Parameters:
    
    legalDuringInitialization - True if the operation is legal during view initialization, false if the operation is only allowed during the component lifecycle.
    
    See Also:
    
    LifecycleElement.checkMutable(boolean)
  - isMutable
```
public boolean isMutable(boolean legalDuringInitialization)
```
    Description copied from interface: LifecycleElement
    
    Determine if this lifecycle element is mutable.
    Most lifecycle element are immutable, and all are immutable expect during initialization and the during the view lifecycle. Those that have been copied within the view lifecycle, however, may be modified during the same lifecycle.
    
    Specified by:
    
    isMutable in interface LifecycleElement
    
    Parameters:
    
    legalDuringInitialization - true if the current operation may be called before the lifecycle element has been cached, for example while being initialized as part of a Spring context.
    
    Returns:
    
    True if the component is mutable.
    
    See Also:
    
    LifecycleElement.isMutable(boolean)
  - getViewStatus
```
public String getViewStatus()
```
    Indicates what lifecycle phase the component instance is in
    The view lifecycle begins with the CREATED status. In this status a new instance of the view has been retrieved from the dictionary, but no further processing has been done. After the initialize phase has been run the status changes to INITIALIZED. After the model has been applied and the view is ready for render the status changes to FINAL
    
    Specified by:
    
    getViewStatus in interface LifecycleElement
    
    Returns:
    
    view status
    
    See Also:
    
    UifConstants.ViewStatus
  - setViewStatus
```
public void setViewStatus(String status)
```
    Setter for the view status
    
    Specified by:
    
    setViewStatus in interface Component
    
    Specified by:
    
    setViewStatus in interface LifecycleElement
    
    Parameters:
    
    status - view status
    
    See Also:
    
    LifecycleElement.getViewStatus()
  - notifyCompleted
```
public void notifyCompleted(ViewLifecyclePhase phase)
```
    Receive notification that a lifecycle phase, and all successor phases, have been completed on this component.
    
    Specified by:
    
    notifyCompleted in interface LifecycleElement
    
    Parameters:
    
    phase - The completed view lifecycle phase
  - isInitialized
```
public boolean isInitialized()
```
    Indicates whether the component has been initialized.
    
    Specified by:
    
    isInitialized in interface LifecycleElement
    
    Returns:
    
    True if the component has been initialized, false if not.
  - isModelApplied
```
public boolean isModelApplied()
```
    Indicates whether the component has been updated from the model.
    
    Specified by:
    
    isModelApplied in interface LifecycleElement
    
    Returns:
    
    True if the component has been updated, false if not.
  - isFinal
```
public boolean isFinal()
```
    Indicates whether the component has been updated from the model and final updates made.
    
    Specified by:
    
    isFinal in interface LifecycleElement
    
    Returns:
    
    True if the component has been updated, false if not.
  - isRendered
```
public boolean isRendered()
```
    Indicates whether the component has been fully rendered.
    
    Specified by:
    
    isRendered in interface Component
    
    Returns:
    
    True if the component has fully rendered, false if not.
  - performInitialization
```
public void performInitialization(Object model)
```
    The following updates are done here:
    - Invoke performInitialize on component modifiers
    Initializes the component
    Where components can set defaults and setup other necessary state. The initialize method should only be called once per component lifecycle and is invoked within the initialize phase of the view lifecylce.
    Specified by:
    
    performInitialization in interface LifecycleElement
    
    Parameters:
    
    model - - object instance containing the view data
    
    See Also:
    
    ComponentDefaultInitializeTask
  - performApplyModel
```
public void performApplyModel(Object model,
                              LifecycleElement parent)
```
    The following updates are done here:
    - Evaluate the progressive render condition (if set) and combine with the current render status to set the render status
    Called after the initialize phase to perform conditional logic based on the model data
    Where components can perform conditional logic such as dynamically generating new fields or setting field state based on the given data
    Specified by:
    
    performApplyModel in interface LifecycleElement
    
    Parameters:
    
    model - - Top level object containing the data (could be the form or a top level business object, dto)
    
    parent - parent lifecycle element
  - afterEvaluateExpression
```
public void afterEvaluateExpression()
```
    No-op implementation. Override for custom behavior in subclasses. Invoked by the view lifecycle after expressions are evaluated at the apply model phase.
    In general, this method is preferred to LifecycleElement.performApplyModel(Object, LifecycleElement) for populating model data via code, since it is called before client-side state is synchronize.
    
    Specified by:
    
    afterEvaluateExpression in interface Component
  - performFinalize
```
public void performFinalize(Object model,
                            LifecycleElement parent)
```
    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
    Here final preparations can be made based on the updated view state.
    Specified by:
    
    performFinalize in interface LifecycleElement
    
    Parameters:
    
    model - - top level object containing the data
    
    parent - - parent component
  - getPropertyReplacerComponents
```
@ViewLifecycleRestriction
public List<Component> getPropertyReplacerComponents()
```
    Returns list of components that are being held in property replacers configured for this component
    
    Specified by:
    
    getPropertyReplacerComponents in interface Component
    
    Returns:
    
    List
  - getId
```
public String getId()
```
    The unique id (within a given tree) for the element.
    The id is used to identify an element instance within the tree, and will be used by renderers to set the HTML element id. This gives a way to find various elements for scripting. If the id is not given, a default will be generated by the framework.
    
    Specified by:
    
    getId in interface LifecycleElement
    
    Returns:
    
    A unique ID for this lifecycle element.
  - setId
```
public void setId(String id)
```
    Setter for the unique id (within a given tree) for the component
    
    Specified by:
    
    setId in interface LifecycleElement
    
    Parameters:
    
    id - - string to set as the component id
  - getContainerIdSuffix
```
public String getContainerIdSuffix()
```
    A string suffix that should get applied to the id for all child components of the given element.
    This is mainly used within the framework to keep ids unique. For instance, for components generated for collection lines, all the components within those should get a line suffix. The framework will set this property to be '_line0', '_line1', etc. Then when the apply model phase is run on the child components their ids will be updated with this suffix.
    
    Specified by:
    
    getContainerIdSuffix in interface LifecycleElement
    
    Returns:
    
    String id suffix for child components
    
    See Also:
    
    SuffixIdFromContainerTask
  - setContainerIdSuffix
```
public void setContainerIdSuffix(String containerIdSuffix)
```
    Specified by:
    
    setContainerIdSuffix in interface LifecycleElement
    
    See Also:
    
    LifecycleElement.getContainerIdSuffix()
  - getViewPath
```
public String getViewPath()
```
    Gets a property for referring to this component from the view, relative to the view, as assigned by the current or most recent lifecycle.
    
    Specified by:
    
    getViewPath in interface LifecycleElement
    
    Returns:
    
    property path
  - setViewPath
```
public void setViewPath(String viewPath)
```
    Setter for LifecycleElement.getViewPath().
    
    Specified by:
    
    setViewPath in interface LifecycleElement
    
    Parameters:
    
    viewPath - The property path.
  - getPhasePathMapping
```
public Map<String,String> getPhasePathMapping()
```
    Map of paths for this component that will be used to process a refresh (if necessary).
    
    Specified by:
    
    getPhasePathMapping in interface LifecycleElement
    
    Returns:
    
    map of refresh paths, key represents the lifecycle phase and the value is the path for the component at that phase
  - setPhasePathMapping
```
public void setPhasePathMapping(Map<String,String> phasePathMapping)
```
    Specified by:
    
    setPhasePathMapping in interface LifecycleElement
    
    See Also:
    
    LifecycleElement.getPhasePathMapping()
  - getTemplate
```
public String getTemplate()
```
    The path to the JSP file that should be called to render the component
    The path should be relative to the web root. An attribute will be available to the component to use under the name given by the method getComponentTypeName. Based on the component type, additional attributes could be available for use. See the component documentation for more information on such attributes.
    
    e.g. '/krad/WEB-INF/jsp/tiles/component.jsp'
    
    Specified by:
    
    getTemplate in interface Component
    
    Returns:
    
    String representing the template path
  - setTemplate
```
public void setTemplate(String template)
```
    Setter for the components template
    
    Specified by:
    
    setTemplate in interface Component
  - getAdditionalTemplates
```
public List<String> getAdditionalTemplates()
```
    Gets additional templates that will be required during the rendering of this component.
    If a parent or sibling component is referred to by this component's template, include that component's template here to ensure that it has been compiled already during bottom-up inline rendering.
    
    Specified by:
    
    getAdditionalTemplates in interface Component
    
    Returns:
    
    additional templates required during rendering
  - getTemplateName
```
public String getTemplateName()
```
    The name for which the template can be invoked by
    Whether the template name is needed depends on the underlying rendering engine being used. In the example of Freemarker, the template points to the actual source file, which then loads a macro. From then on the macro is simply invoked to execute the template
    
    e.g. 'uif_text'
    
    Specified by:
    
    getTemplateName in interface Component
    
    Returns:
    
    template name
  - setTemplateName
```
public void setTemplateName(String templateName)
```
    Setter for the name of the template (a name which can be used to invoke)
    
    Specified by:
    
    setTemplateName in interface Component
  - getTitle
```
public String getTitle()
```
    The component title
    Depending on the component can be used in various ways. For example with a Container component the title is used to set the header text. For components like controls other other components that render an HTML element it is used to set the HTML title attribute.
    
    Specified by:
    
    getTitle in interface Component
    
    Returns:
    
    String title for component
  - setTitle
```
public void setTitle(String title)
```
    Setter for the component's title
    
    Specified by:
    
    setTitle in interface Component
  - isHidden
```
public boolean isHidden()
```
    Indicates whether the component should be hidden in the UI
    How the hidden data is maintained depends on the views persistence mode. If the mode is request, the corresponding data will be rendered to the UI but not visible. If the mode is session, the data will not be rendered to the UI but maintained server side.
    
    For a Container component, the hidden setting will apply to all contained components (making a section hidden makes all fields within the section hidden)
    
    Specified by:
    
    isHidden in interface Component
    
    Returns:
    
    boolean true if the component should be hidden, false if it should be visible
  - setHidden
```
public void setHidden(boolean hidden)
```
    Setter for the hidden indicator
    
    Specified by:
    
    setHidden in interface Component
  - getReadOnly
```
public Boolean getReadOnly()
```
    Indicates whether the component can be edited
    When readOnly the controls and widgets of Field components will not be rendered. If the Field has an underlying value it will be displayed readOnly to the user.
    
    For a Container component, the readOnly setting will apply to all contained components (making a section readOnly makes all fields within the section readOnly).
    
    Specified by:
    
    getReadOnly in interface Component
    
    Returns:
    
    boolean true if the component should be readOnly, false if is allows editing
  - setReadOnly
```
public void setReadOnly(Boolean readOnly)
```
    Setter for the read only indicator
    
    Specified by:
    
    setReadOnly in interface Component
  - getCanCopyOnReadOnly
```
public Boolean getCanCopyOnReadOnly()
```
    Indicates whether the component should be cleared on copy
    By default this property is false. ReadOnly components are cleared on a copy operation. If set this prevents the component from being cleared.
    
    Specified by:
    
    getCanCopyOnReadOnly in interface Component
    
    Returns:
  - setCanCopyOnReadOnly
```
public void setCanCopyOnReadOnly(Boolean canCopyOnReadOnly)
```
    Setter for the canCopyOnReadOnly indicator
    
    Specified by:
    
    setCanCopyOnReadOnly in interface Component
  - getRequired
```
public Boolean getRequired()
```
    Indicates whether the component is required
    At the general component level required means there is some action the user needs to take within the component. For example, within a section it might mean the fields within the section should be completed. At a field level, it means the field should be completed. This provides the ability for the renderers to indicate the required action.
    
    Specified by:
    
    getRequired in interface Component
    
    Returns:
    
    boolean true if the component is required, false if it is not required
  - setRequired
```
public void setRequired(Boolean required)
```
    Setter for the required indicator
    
    Specified by:
    
    setRequired in interface Component
  - isRender
```
public boolean isRender()
```
    Indicates whether the component should be rendered in the UI
    If set to false, the corresponding component template will not be invoked (therefore nothing will be rendered to the UI).
    
    Specified by:
    
    isRender in interface LifecycleElement
    
    Returns:
    
    boolean true if the component should be rendered, false if it should not be
  - setRender
```
public void setRender(boolean render)
```
    Setter for the components render indicator
    
    Specified by:
    
    setRender in interface LifecycleElement
  - isRetrieveViaAjax
```
public boolean isRetrieveViaAjax()
```
    When true, this component will render as a placeholder component instead of rendering normally because the content will be later retrieved through manually ajax retrieval calls in the js
    This flag does not imply any automation, there must be a js call invoked for the content to be retrieved by the server, but this does mark it with a placeholder component which KRAD js uses during these calls. This placeholder component is used for ajax retrievals. In particular, this flag is useful for use in combination with the showLightboxComponent js function which will automatically retrieve the real content of a component through ajax if a placeholder component is detected. This allows for the full content to only be retrieved when the lightbox is first opened. When this flag is set to true, the forceSessionPersistence flag is set to true AUTOMATICALLY because it is implied that this component will be retrieved by an ajax call in the future. This may also be useful for direct custom calls to retrieveComponent function, as well, which also relies on the placeholder being present.
    
    Specified by:
    
    isRetrieveViaAjax in interface Component
    
    Returns:
    
    true if this component is being rendered as a placeholder for use in replacement during and ajax call, false otherwise
  - setRetrieveViaAjax
```
public void setRetrieveViaAjax(boolean retrieveViaAjax)
```
    When true, this component will render as a placeholder component instead of rendering normally because the content will be later retrieved through manually ajax retrieval calls in the js
    
    Specified by:
    
    setRetrieveViaAjax in interface Component
  - getColSpan
```
public int getColSpan()
```
    Number of places the component should take up horizontally in the container; when using a CssGridLayoutManager this is converted to the appropriate medium size.
    All components belong to a Container and are placed using a LayoutManager. This property specifies how many places horizontally the component should take up within the container. This is only applicable for table based layout managers. Default is 1
    TODO: this should not be on component interface since it only applies if the layout manager supports it, need some sort of layoutOptions map for field level options that depend on the manager
    
    Specified by:
    
    getColSpan in interface Component
    
    Returns:
    
    int number of columns to span
  - setColSpan
```
public void setColSpan(int colSpan)
```
    Setter for the components column span
    
    Specified by:
    
    setColSpan in interface Component
  - getRowSpan
```
public int getRowSpan()
```
    Number of places the component should take up vertically in the container
    All components belong to a Container and are placed using a LayoutManager. This property specifies how many places vertically the component should take up within the container. This is only applicable for table based layout managers. Default is 1
    TODO: this should not be on component interface since it only applies if the layout manager supports it, need some sort of layoutOptions map for field level options that depend on the manager
    
    Specified by:
    
    getRowSpan in interface Component
    
    Returns:
    
    int number of rows to span
  - setRowSpan
```
public void setRowSpan(int rowSpan)
```
    Setter for the component row span
    
    Specified by:
    
    setRowSpan in interface Component
  - getWrapperCssClasses
```
public List<String> getWrapperCssClasses()
```
    The cellCssClasses property defines the classes that will be placed on the corresponding td (or th) elements relating to this component when used in a table backed layout. This property has no effect on other layouts.
    
    Specified by:
    
    getWrapperCssClasses in interface Component
    
    Returns:
    
    the css classes to apply to the wrapping td (or th) element for this component
  - setWrapperCssClasses
```
public void setWrapperCssClasses(List<String> wrapperCssClasses)
```
    Set the cellCssClasses property which defines the classes that will be placed on the corresponding td (or th) relating to this component when used in a table backed layout. This property has no effect on other layouts.
    
    Specified by:
    
    setWrapperCssClasses in interface Component
  - addWrapperCssClass
```
public void addWrapperCssClass(String cssClass)
```
    Add a cell css class to the cell classes list
    
    Specified by:
    
    addWrapperCssClass in interface Component
    
    Parameters:
    
    cssClass - the name of the class to add
  - getWrapperCssClassesAsString
```
public String getWrapperCssClassesAsString()
```
    Builds the HTML class attribute string by combining the cellStyleClasses list with a space delimiter.
    
    Returns:
    
    class attribute string
  - getWrapperStyle
```
public String getWrapperStyle()
```
    CSS style string to be applied to the cell containing the component (only applies within table based layouts)
    e.g. 'align: right;'
    
    Specified by:
    
    getWrapperStyle in interface Component
    
    Returns:
    
    String css style string
  - setWrapperStyle
```
public void setWrapperStyle(String wrapperStyle)
```
    Setter for the cell style attribute
    
    Specified by:
    
    setWrapperStyle in interface Component
  - getCellWidth
```
public String getCellWidth()
```
    Width setting for the cell containing the component (only applies within table based layouts)
    
    Specified by:
    
    getCellWidth in interface Component
    
    Returns:
    
    String width ('25%', '155px')
  - setCellWidth
```
public void setCellWidth(String cellWidth)
```
    Setter for the containing cell width
    
    Specified by:
    
    setCellWidth in interface Component
  - getCssGridSizes
```
public CssGridSizes getCssGridSizes()
```
    CssGridSizes represent the size (width) the content's div "cell" will take up in the "row" at each screen size (extra small, small, medium, large) when using a group backed by a CssGridLayoutManager.
    This object is NOT used by other layouts. For specifics of how css grids work, refer to the krad guide and bootstrap css grid documentation.
    
    Specified by:
    
    getCssGridSizes in interface Component
    
    Returns:
  - setCssGridSizes
```
public void setCssGridSizes(CssGridSizes cssGridSizes)
```
    Specified by:
    
    setCssGridSizes in interface Component
    
    See Also:
    
    Component.getCssGridSizes()
  - getAlign
```
public String getAlign()
```
    Horizontal alignment of the component within its container
    All components belong to a Container and are placed using a LayoutManager. This property specifies how the component should be aligned horizontally within the container. During the finalize phase the CSS text-align style will be created for the align setting.
    
    Specified by:
    
    getAlign in interface Component
    
    Returns:
    
    String horizontal align
    
    See Also:
    
    CssConstants.TextAligns
  - setAlign
```
public void setAlign(String align)
```
    Sets the components horizontal alignment
    
    Specified by:
    
    setAlign in interface Component
  - getValign
```
public String getValign()
```
    Vertical alignment of the component within its container
    All components belong to a Container and are placed using a LayoutManager. This property specifies how the component should be aligned vertically within the container. During the finalize phase the CSS vertical-align style will be created for the valign setting.
    
    Specified by:
    
    getValign in interface Component
    
    Returns:
    
    String vertical align
    
    See Also:
    
    CssConstants.VerticalAligns
  - setValign
```
public void setValign(String valign)
```
    Setter for the component's vertical align
    
    Specified by:
    
    setValign in interface Component
  - getWidth
```
public String getWidth()
```
    Width the component should take up in the container
    All components belong to a Container and are placed using a LayoutManager. This property specifies a width the component should take up in the Container. This is not applicable for all layout managers. During the finalize phase the CSS width style will be created for the width setting.
    
    e.g. '30%', '55px'
    
    Specified by:
    
    getWidth in interface Component
    
    Returns:
    
    String width string
  - setWidth
```
public void setWidth(String width)
```
    Setter for the components width
    
    Specified by:
    
    setWidth in interface Component
  - getStyle
```
public String getStyle()
```
    CSS style string to be applied to the component
    Any style override or additions can be specified with this attribute. This is used by the renderer to set the style attribute on the corresponding element.
    
    e.g. 'color: #000000;text-decoration: underline;'
    
    Specified by:
    
    getStyle in interface Component
    
    Returns:
    
    String css style string
  - setStyle
```
public void setStyle(String style)
```
    Setter for the components style
    
    Specified by:
    
    setStyle in interface Component
  - getLibraryCssClasses
```
public List<String> getLibraryCssClasses()
```
    Additional css classes that come before css classes listed in the cssClasses property
    These are used by the framework for styling with a library (for example, bootstrap), and should normally not be overridden.
    
    Specified by:
    
    getLibraryCssClasses in interface Component
    
    Returns:
    
    the library cssClasses
  - setLibraryCssClasses
```
public void setLibraryCssClasses(List<String> libraryCssClasses)
```
    Set the libraryCssClasses
    
    Specified by:
    
    setLibraryCssClasses in interface Component
  - getCssClasses
```
public List<String> getCssClasses()
```
    CSS style class(s) to be applied to the component
    Declares style classes for the component. Multiple classes are specified with a space delimiter. This is used by the renderer to set the class attribute on the corresponding element. The class(s) declared must be available in the common style sheets or the style sheets specified for the view
    
    Specified by:
    
    getCssClasses in interface Component
    
    Returns:
    
    List css style classes to appear on the 'class' attribute
  - setCssClasses
```
public void setCssClasses(List<String> cssClasses)
```
    Setter for the components style classes
    
    Specified by:
    
    setCssClasses in interface Component
  - getAdditionalCssClasses
```
public List<String> getAdditionalCssClasses()
```
    Convenience property for adding css class names to the end of the list of cssClasses that may already exist on this Component (this is to avoid explicitly having to set list merge in the bean definition)
    
    Specified by:
    
    getAdditionalCssClasses in interface Component
    
    Returns:
    
    the additionalCssClasses
  - setAdditionalCssClasses
```
public void setAdditionalCssClasses(List<String> additionalCssClasses)
```
    Set the additionalCssClasses
    
    Specified by:
    
    setAdditionalCssClasses in interface Component
  - getStyleClassesAsString
```
public String getStyleClassesAsString()
```
    Builds the HTML class attribute string by combining the styleClasses list with a space delimiter
    
    Specified by:
    
    getStyleClassesAsString in interface Component
    
    Returns:
    
    class attribute string
  - addStyleClass
```
public void addStyleClass(String styleClass)
```
    Adds a single style to the list of styles on this component
    
    Specified by:
    
    addStyleClass in interface Component
  - appendToStyle
```
public void appendToStyle(String styleRules)
```
    Appends to the inline style set on a component
    
    Specified by:
    
    appendToStyle in interface Component
  - getFinalizeMethodToCall
```
public String getFinalizeMethodToCall()
```
    The name of the method that should be invoked for finalizing the component configuration (full method name, without parameters or return type)
    Note the method can also be set with the finalizeMethodInvoker targetMethod property. If the method is on the configured ViewHelperService, only this property needs to be configured
    
    The model backing the view will be passed as the first argument method and then the Component instance as the second argument. If any additional method arguments are declared with the finalizeMethodAdditionalArguments, they will then be passed in the order declared in the list
    
    If the component is selfRendered, the finalize method can return a string which will be set as the component's renderOutput. The selfRendered indicator will also be set to true on the component.
    
    Specified by:
    
    getFinalizeMethodToCall in interface Component
    
    Returns:
    
    String method name
  - setFinalizeMethodToCall
```
public void setFinalizeMethodToCall(String finalizeMethodToCall)
```
    Setter for the finalize method
  - getFinalizeMethodAdditionalArguments
```
public List<Object> getFinalizeMethodAdditionalArguments()
```
    The List of Object instances that should be passed as arguments to the finalize method
    These arguments are passed to the finalize method after the standard model and component arguments. They are passed in the order declared in the list
    Specified by:
    
    getFinalizeMethodAdditionalArguments in interface Component
    
    Returns:
    List

Class ComponentBase

Field Summary

Fields inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

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

Fields inherited from interface org.springframework.core.Ordered

Constructor Summary

Method Summary

Methods inherited from class org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase

Methods inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

Methods inherited from class java.lang.Object

Methods inherited from interface org.kuali.rice.krad.uif.component.Component

Methods inherited from interface org.kuali.rice.krad.datadictionary.uif.UifDictionaryBean

Methods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean

Field Detail

templateOptions

Constructor Detail

ComponentBase

Method Detail

skipLifecycle

checkMutable

isMutable

getViewStatus

setViewStatus

notifyCompleted

isInitialized

isModelApplied

isFinal

isRendered

performInitialization

performApplyModel

afterEvaluateExpression

performFinalize

getPropertyReplacerComponents

getId

setId

getContainerIdSuffix

setContainerIdSuffix

getViewPath

setViewPath

getPhasePathMapping

setPhasePathMapping

getTemplate

setTemplate

getAdditionalTemplates

getTemplateName

setTemplateName

getTitle

setTitle

isHidden

setHidden

getReadOnly

setReadOnly

getCanCopyOnReadOnly

setCanCopyOnReadOnly

getRequired

setRequired

isRender

setRender

isRetrieveViaAjax

setRetrieveViaAjax

getColSpan

setColSpan

getRowSpan

setRowSpan

getWrapperCssClasses

setWrapperCssClasses

addWrapperCssClass

getWrapperCssClassesAsString

getWrapperStyle

setWrapperStyle

getCellWidth

setCellWidth

getCssGridSizes

setCssGridSizes

getAlign

setAlign

getValign

setValign

getWidth

setWidth