Package org.kuali.rice.krad.datadictionary.uif

Interface UifDictionaryBean

All Superinterfaces:
DictionaryBean, Serializable
All Known Subinterfaces:
CollectionGroup, CollectionLayoutManager, Component, ComponentModifier, Container, ContentElement, Control, DataBinding, DataField, Field, GridLayoutManager, Group, InputField, LayoutManager, PageGroup, SelectControl, StackedLayoutManager, TableLayoutManager, TextControl, Widget
All Known Implementing Classes:
Accordion, AccordionGroup, Action, ActionField, ActionSecurity, ApplicationHeader, AttributeQuery, AttributeSecurity, BindingInfo, BlockUI, BoxLayoutManager, BreadcrumbItem, Breadcrumbs, CheckboxControl, CheckboxGroupControl, CollectionGroupBase, CollectionGroupSecurity, CollectionLayoutManagerBase, ColumnCalculationInfo, ComparableInfo, CompareFieldCreateModifier, ComponentBase, ComponentConvertModifier, ComponentModifierBase, ComponentSecurity, ContainerBase, Content, ContentElementBase, ControlBase, CssGridLabelColumnLayoutManager, CssGridLayoutManager, CssGridLayoutManagerBase, CssGridSizes, DataFieldBase, DataFieldSecurity, DataTable, DatePicker, DialogGroup, Disclosure, Div, DocumentView, FieldBase, FieldGroup, FieldSecurity, FieldValidationMessages, FileControl, FormView, GenericField, GridLayoutManagerBase, GroupBase, GroupControl, GroupLinkField, GroupValidationMessages, Growls, Header, HeadLink, Help, HelpDefinition, HiddenControl, HistoryEntry, Icon, Iframe, IframeView, Image, ImageField, InputFieldBase, Inquiry, InquiryView, Label, LabelSeparateModifier, LayoutManagerBase, LightBox, LightTable, Link, LinkField, LinkGroup, ListLayoutManager, LocationSuggest, LookupInputField, LookupView, MaintenanceDocumentView, Message, MessageField, MessageView, MetaTag, MockView, MultiFileUploadCollection, MultiValueControlBase, NavigationBar, NextPager, NodePrototype, NumberedPager, OptionListControl, PageGroupBase, Pager, PageValidationMessages, ParentLocation, PasswordControl, ProgressBar, ProgressBarField, PropertyReplacer, QuickFinder, RadioGroupControl, RemoteFieldsHolder, RichTable, RoleLinkField, RoutingAttribute, Scrollpane, SearchingAttribute, SelectControlBase, SidebarNavigationGroup, SimpleLayoutManager, Space, SpaceField, Spinner, SpinnerControl, StackedLayoutManagerBase, StepProgressBar, Suggest, SyntaxHighlighter, TabGroup, TableLayoutManagerBase, TabNavigationGroup, Tabs, TextAreaControl, TextControlBase, ToggleMenu, Tooltip, TransactionalDocumentView, Tree, TreeGroup, UifDictionaryBeanBase, UrlInfo, UserControl, UserLinkField, ValidationMessages, View, ViewHeader, ViewSessionPolicy, ViewTheme, WidgetBase, WorkflowAttributeMetadata, WorkflowAttributes
public interface UifDictionaryBean extends DictionaryBean
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 Details

    • getExpressionGraph

      Map<String,String> getExpressionGraph()
      Map of expressions that were configured for the object's graph

      During processing of the UIF configuration, expressions are pulled out and placed into this map for the component graph. A component graph contains the component and all one to one nested components (but not those that are contained in collections, each of these begins another graph). The expressions are placed at the root component level instead of the actual nested component for handling of nested property configuration and overridding

      The expression graph map key gives the property name (possibly nested) the expression was configured on, and the map value gives the expression. During the view lifecycle, see PopulateComponentFromExpressionGraphTask and PopulateReplacersAndModifiersFromExpressionGraphTask, the expressions are moved to the getPropertyExpressions() map for the configurable they should be evaluated on

      Returns:
      Mapinvalid input: '<'String, String> map of expressions contained on the configurable graph

    • setExpressionGraph

      void setExpressionGraph(Map<String,String> expressionGraph)
      Setter for the map of expressions contained on the configurable graph
      Parameters:
      expressionGraph -

    • 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:
      Mapinvalid input: '<'String, String> 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
      Parameters:
      propertyName - property name
      Returns:
      String expression for property or null if expression is not configured
      See Also: