org.kuali.rice.krad.uif.component
Class ComponentBase

java.lang.Object
  org.kuali.rice.krad.uif.component.ConfigurableBase
      org.kuali.rice.krad.uif.component.ComponentBase

All Implemented Interfaces:

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

Direct Known Subclasses:

ContainerBase, ControlBase, FieldBase, WidgetBase

public abstract class ComponentBase
extends ConfigurableBase
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 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

ComponentBase()

Method Summary

void	addStyleClass(String styleClass) Adds a single style to the list of styles on this component
void	appendToStyle(String styleRules) TODO: javadoc
String	getAlign() Horizontal alignment of the component within its container
String	getBaseId() The original generated id.
int	getColSpan() Number of places the component should take up horizontally in the container
List<ComponentModifier>	getComponentModifiers() ComponentModifier instances that should be invoked to initialize the component
Map<String,String>	getComponentOptions() Options that are passed through to the Component renderer.
String	getComponentOptionsJSString() Builds a string from the underlying Map of component options that will export that options as a JavaScript Map for use in js and jQuery plugins
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.
Map<String,Object>	getContext() Context map for the component
String	getEventCode()
List<Object>	getFinalizeMethodAdditionalArguments() 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() 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 component
List<Component>	getNestedComponents() List of components that are contained within the component
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	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() Can be used to order a component within a List of other components, lower numbers are placed higher up in the list, while higher numbers are placed lower in the list
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() List of components that are contained within the List of PropertyReplacer in component
List<PropertyReplacer>	getPropertyReplacers() List of PropertyReplacer instances that will be evaluated during the view lifecycle to conditionally set properties on the Component based on expression evaluations
String	getRefreshWhenChanged() Specifies a property by name that when it value changes will automatically perform a refresh on this component.
List<String>	getRefreshWhenChangedControlNames() Control names which will refresh this component when they are changed, added internally
String	getRenderOutput() 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
int	getRowSpan() Number of places the component should take up vertically in the container
String	getStyle() CSS style string to be applied to the component
List<String>	getStyleClasses() CSS style class(s) to be applied to the component
String	getStyleClassesAsString() Builds the HTML class attribute string by combining the styleClasses list with a space delimiter
boolean	getSupportsOnBlur() Indicates whether the component supports the onBlur event
boolean	getSupportsOnChange() Indicates whether the component supports the onChange event
boolean	getSupportsOnClick() Indicates whether the component supports the onClick event
boolean	getSupportsOnClose() Indicates whether the component supports the onClose event
boolean	getSupportsOnDblClick() Indicates whether the component supports the onDblClick event
boolean	getSupportsOnDocumentReady() Indicates whether the component supports the document ready event
boolean	getSupportsOnFocus() Indicates whether the component supports the onFocus event
boolean	getSupportsOnKeyDown() Indicates whether the component supports the onKeyDown event
boolean	getSupportsOnKeyPress() Indicates whether the component supports the onKeyPress event
boolean	getSupportsOnKeyUp() Indicates whether the component supports the onKeyUp event
boolean	getSupportsOnLoad() Indicates whether the component supports the onLoad event
boolean	getSupportsOnMouseDown() Indicates whether the component supports the onMouseDown event
boolean	getSupportsOnMouseMove() Indicates whether the component supports the onMouseMove event
boolean	getSupportsOnMouseOut() Indicates whether the component supports the onMouseOut event
boolean	getSupportsOnMouseOver() Indicates whether the component supports the onMouseOver event
boolean	getSupportsOnMouseUp() Indicates whether the component supports the onMouseUp event
boolean	getSupportsOnSubmit() Indicates whether the component supports the onSubmit event
boolean	getSupportsOnUnload() Indicates whether the component supports the onUnload event
String	getTemplate() The path to the JSP file that should be called to render the component
String	getTitle() A title for the component.
String	getValign() Vertical alignment of the component within its container
String	getWidth() Width the component should take up in the container
boolean	isHidden() Indicates whether the component should be hidden in the UI
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	isReadOnly() Indicates whether the component can be edited
boolean	isRefresh() Result of the conditionalRefresh expression, true if satisfied, otherwise false.
boolean	isRender() Indicates whether the component should be rendered in the UI
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.
void	performApplyModel(View view, Object model, Component parent) The following updates are done here:
void	performFinalize(View view, Object model, Component parent) The following finalization is done here: If any of the style properties were given, sets the style string on the style property Setup the decorator chain (if component has decorators) for rendering Set the skipInTabOrder flag for nested components
void	performInitialization(View view) The following initialization is performed: progressiveRender and conditionalRefresh variables are processed if set.
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	setAlign(String align) Sets the components horizontal alignment
void	setBaseId(String baseId)
void	setColSpan(int colSpan) Setter for the components column span
void	setComponentModifiers(List<ComponentModifier> componentModifiers) Setter for the components List of ComponentModifier instances
void	setComponentOptions(Map<String,String> componentOptions) Setter for the widget's options
void	setComponentOptionsJSString(String componentOptionsJSString) Setter for the widget's options
void	setConditionalRefresh(String conditionalRefresh)
void	setContext(Map<String,Object> context) Setter for the context Map
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	setHidden(boolean hidden) Setter for the hidden indicator
void	setId(String id) Sets the unique id (within a given tree) for the component
void	setOnBlurScript(String onBlurScript) Setter for the components onBlur script
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	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) Setter for the components onLoad script
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	setProgressiveRender(String progressiveRender)
void	setProgressiveRenderAndRefresh(boolean progressiveRenderAndRefresh)
void	setProgressiveRenderViaAJAX(boolean progressiveRenderViaAJAX)
void	setPropertyReplacers(List<PropertyReplacer> propertyReplacers) Setter for the components property substitutions
void	setReadOnly(boolean readOnly) Setter for the read only indicator
void	setRefresh(boolean refresh)
void	setRefreshWhenChanged(String refreshWhenChanged)
void	setRender(boolean render) Setter for the components render indicator
void	setRenderOutput(String renderOutput) Setter for the component's render output
void	setRequired(Boolean required) Setter for the required indicator
void	setRowSpan(int rowSpan) Setter for the component row span
void	setSelfRendered(boolean selfRendered) Setter for the self render indicator
void	setSkipInTabOrder(boolean skipInTabOrder)
void	setStyle(String style) Setter for the components style
void	setStyleClasses(List<String> styleClasses) Setter for the components style classes
void	setTemplate(String template) Setter for the components template
void	setTitle(String title) Setter for the components title
void	setValign(String valign) Setter for the component's vertical align
void	setWidth(String width) Setter for the components width

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

getComponentTypeName

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

getPropertyExpression, getPropertyExpressions, setPropertyExpressions

Constructor Detail

ComponentBase

public ComponentBase()

Method Detail

performInitialization

public void performInitialization(View view)

The following initialization is performed: progressiveRender and conditionalRefresh variables are processed if set.

Specified by:

performInitialization in interface Component

Parameters:

view - - view instance in which the component belongs

See Also:

performInitialization(org.kuali.rice.krad.uif.view.View)

performApplyModel

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

The following updates are done here:

Specified by:

performApplyModel in interface Component

Parameters:

view - - view instance to which the component belongs

model - - Top level object containing the data (could be the form or a top level business object, dto)

performFinalize

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

The following finalization is done here:

• If any of the style properties were given, sets the style string on the style property
• Setup the decorator chain (if component has decorators) for rendering
• Set the skipInTabOrder flag for nested components

Specified by:

performFinalize in interface Component

Parameters:

view - - view instance that should be finalized for rendering

model - - top level object containing the data

parent - - parent component

See Also:

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

getNestedComponents

public List<Component> getNestedComponents()

Description copied from interface: Component

List of components that are contained within the component

Used by ViewHelperService for the various lifecycle callbacks

Specified by:

getNestedComponents in interface Component

Returns:

List child components

See Also:

Component.getNestedComponents()

getPropertyReplacerComponents

public List<Component> getPropertyReplacerComponents()

Description copied from interface: Component

List of components that are contained within the List of PropertyReplacer in component

Used to get all the nested components in the property replacer's

Specified by:

getPropertyReplacerComponents in interface Component

Returns:

List PropertyReplacer child components

getId

public String getId()

Description copied from interface: Component

The unique id (within a given tree) for the component

The id 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 Component

Returns:

String id

See Also:

Component.getId()

setId

public void setId(String id)

Description copied from interface: Component

Sets the unique id (within a given tree) for the component

Specified by:

setId in interface Component

Parameters:

id - - string to set as the component id

See Also:

Component.setId(java.lang.String)

getTemplate

public String getTemplate()

Description copied from interface: Component

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

See Also:

Component.getTemplate()

setTemplate

public void setTemplate(String template)

Description copied from interface: Component

Setter for the components template

Specified by:

setTemplate in interface Component

See Also:

Component.setTemplate(java.lang.String)

getTitle

public String getTitle()

Description copied from interface: Component

A title for the component. 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

See Also:

Component.getTitle()

setTitle

public void setTitle(String title)

Description copied from interface: Component

Setter for the components title

Specified by:

setTitle in interface Component

See Also:

Component.setTitle(java.lang.String)

isHidden

public boolean isHidden()

Description copied from interface: Component

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

See Also:

Component.isHidden()

setHidden

public void setHidden(boolean hidden)

Description copied from interface: Component

Setter for the hidden indicator

Specified by:

setHidden in interface Component

See Also:

Component.setHidden(boolean)

isReadOnly

public boolean isReadOnly()

Description copied from interface: Component

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:

isReadOnly in interface Component

Returns:

boolean true if the component should be readOnly, false if is allows editing

See Also:

Component.isReadOnly()

setReadOnly

public void setReadOnly(boolean readOnly)

Description copied from interface: Component

Setter for the read only indicator

Specified by:

setReadOnly in interface Component

See Also:

Component.setReadOnly(boolean)

getRequired

public Boolean getRequired()

Description copied from interface: Component

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

See Also:

Component.getRequired()

setRequired

public void setRequired(Boolean required)

Description copied from interface: Component

Setter for the required indicator

Specified by:

setRequired in interface Component

See Also:

Component.setRequired(java.lang.Boolean)

isRender

public boolean isRender()

Description copied from interface: Component

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 Component

Returns:

boolean true if the component should be rendered, false if it should not be

See Also:

Component.isRender()

setRender

public void setRender(boolean render)

Description copied from interface: Component

Setter for the components render indicator

Specified by:

setRender in interface Component

See Also:

Component.setRender(boolean)

getColSpan

public int getColSpan()

Description copied from interface: Component

Number of places the component should take up horizontally in the container

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

See Also:

Component.getColSpan()

setColSpan

public void setColSpan(int colSpan)

Description copied from interface: Component

Setter for the components column span

Specified by:

setColSpan in interface Component

See Also:

Component.setColSpan(int)

getRowSpan

public int getRowSpan()

Description copied from interface: Component

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

See Also:

Component.getRowSpan()

setRowSpan

public void setRowSpan(int rowSpan)

Description copied from interface: Component

Setter for the component row span

Specified by:

setRowSpan in interface Component

See Also:

Component.setRowSpan(int)

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.

Returns:

String horizontal align

See Also:

CssConstants.TextAligns

setAlign

public void setAlign(String align)

Sets the components horizontal alignment

Parameters:

align -

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.

Returns:

String vertical align

See Also:

CssConstants.VerticalAligns

setValign

public void setValign(String valign)

Setter for the component's vertical align

Parameters:

valign -

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'

Returns:

String width string

setWidth

public void setWidth(String width)

Setter for the components width

Parameters:

width -

getStyle

public String getStyle()

Description copied from interface: Component

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

See Also:

Component.getStyle()

setStyle

public void setStyle(String style)

Description copied from interface: Component

Setter for the components style

Specified by:

setStyle in interface Component

See Also:

Component.setStyle(java.lang.String)

getStyleClasses

public List<String> getStyleClasses()

Description copied from interface: Component

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

e.g. 'header left'

Specified by:

getStyleClasses in interface Component

Returns:

List css style classes to apply

See Also:

Component.getStyleClasses()

setStyleClasses

public void setStyleClasses(List<String> styleClasses)

Description copied from interface: Component

Setter for the components style classes

Specified by:

setStyleClasses in interface Component

See Also:

Component.setStyleClasses(java.util.List)

getStyleClassesAsString

public String getStyleClassesAsString()

Builds the HTML class attribute string by combining the styleClasses list with a space delimiter

Returns:

String class attribute string

addStyleClass

public void addStyleClass(String styleClass)

Description copied from interface: Component

Adds a single style to the list of styles on this component

Specified by:

addStyleClass in interface Component

See Also:

Component.addStyleClass(java.lang.String)

appendToStyle

public void appendToStyle(String styleRules)

Description copied from interface: Component

TODO: javadoc

Specified by:

appendToStyle in interface Component

See Also:

Component.appendToStyle(java.lang.String)

getFinalizeMethodToCall

public String getFinalizeMethodToCall()

Description copied from interface: Component

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

See Also:

Component.getFinalizeMethodToCall()

setFinalizeMethodToCall

public void setFinalizeMethodToCall(String finalizeMethodToCall)

Setter for the finalize method

Parameters:

finalizeMethodToCall -

getFinalizeMethodAdditionalArguments

public List<Object> getFinalizeMethodAdditionalArguments()

Description copied from interface: Component

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