org.kuali.rice.krad.uif.component

Interface Configurable

All Known Subinterfaces:

CollectionLayoutManager, Component, ComponentModifier, Container, Control, Field, LayoutManager, Widget

All Known Implementing Classes:

ActionField, ActionFieldSecurity, AjaxActionField, BindingInfo, BlankField, BoxLayoutManager, BreadCrumbs, CheckboxControl, CheckboxGroupControl, CollectionGroup, CollectionGroupSecurity, ComparableInfo, CompareFieldCreateModifier, ComponentBase, ComponentConvertModifier, ComponentModifierBase, ComponentSecurity, ConfigurableBase, ContainerBase, ControlBase, DataField, DataFieldSecurity, DatePicker, DirectInquiry, Disclosure, DocumentView, ErrorsField, FieldBase, FieldGroup, FieldSecurity, FileControl, FormView, GenericField, GridLayoutManager, Group, GroupControl, Growls, HeaderField, Help, HiddenControl, HistoryEntry, IframeField, ImageField, InputField, Inquiry, InquiryView, LabelField, LabelFieldSeparateModifier, LayoutManagerBase, LightBox, LightBoxLookup, LinkField, LinkGroup, LookupInputField, LookupView, MaintenanceView, MessageField, MultiValueControlBase, NavigationGroup, NodePrototype, PageGroup, PropertyReplacer, QuickFinder, RadioGroupControl, RemoteFieldsHolder, Reorderer, ReorderingGroup, RichTable, SelectControl, Spinner, SpinnerControl, StackedLayoutManager, Suggest, TabGroup, TableLayoutManager, Tabs, TextAreaControl, TextControl, Tree, TreeGroup, UserControl, View, WidgetBase

public interface Configurable

Marks any class that can be configured through the UIF dictionary

Indicates behavior that must be supported by an Class that can be configured through the UIF dictionary, such as property expressions.

Author:

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

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

Method Detail

getPropertyExpressions

Map<String,String> getPropertyExpressions()

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

Returns:

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

setPropertyExpressions

void setPropertyExpressions(Map<String,String> propertyExpressions)

Setter for the Map of property expressions

Parameters:

propertyExpressions -

getPropertyExpression

String getPropertyExpression(String propertyName)

Returns the expression configured for the property with the given name

Returns:

String expression for property or null if expression is not configured

See Also:

getPropertyExpressions()