org.kuali.rice.krad.uif.component

Class ConfigurableBase

java.lang.Object

org.kuali.rice.krad.uif.component.ConfigurableBase

All Implemented Interfaces:

Configurable

Direct Known Subclasses:

BindingInfo, ComparableInfo, ComponentBase, ComponentModifierBase, ComponentSecurity, HistoryEntry, LayoutManagerBase, NodePrototype, PropertyReplacer

public abstract class ConfigurableBase
extends Object
implements Configurable

Implementation of Configurable that contains a Map for holding property expressions

Should be extended by other UIF classes (such as Component or LayoutManager) to provide property expression support

Author:

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

Constructor Summary

Constructors

Constructor and Description
ConfigurableBase()

Method Summary

Modifier and Type	Method and Description
String	getPropertyExpression(String propertyName) Returns the expression configured for the property with the given name
Map<String,String>	getPropertyExpressions() Map of expressions that should be evaluated to conditionally set a property on the component
void	setPropertyExpressions(Map<String,String> propertyExpressions) Setter for the Map of property expressions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigurableBase

public ConfigurableBase()

Method Detail

getPropertyExpressions

public Map<String,String> getPropertyExpressions()

Description copied from interface: Configurable

Map of expressions that should be evaluated to conditionally set a property on the component

When configuring a component property through XML an expression can be given using the @{} placeholder. During the loading of the XML any such expressions are captured and placed into this Map, with the property they apply to set as the Map key. The expressions are then evaluated during the apply model phase and the result is set as the property value.

Note after the expression is picked up, the property configuration is removed. Thus the property in the component will only have its default object value until the expression is evaluated

Specified by:

getPropertyExpressions in interface Configurable

Returns:

Map map of expressions where key is property name and value is expression to evaluate

See Also:

getPropertyExpressions()

setPropertyExpressions

public void setPropertyExpressions(Map<String,String> propertyExpressions)

Description copied from interface: Configurable

Setter for the Map of property expressions

Specified by:

setPropertyExpressions in interface Configurable

See Also:

setPropertyExpressions(java.util.Map<java.lang.String, java.lang.String>)

getPropertyExpression

public String getPropertyExpression(String propertyName)

Description copied from interface: Configurable

Returns the expression configured for the property with the given name

Specified by:

getPropertyExpression in interface Configurable

Returns:

String expression for property or null if expression is not configured

See Also:

getPropertyExpression(java.lang.String)