Uses of Interface
org.kuali.rice.krad.uif.util.LifecycleElement

Packages that use LifecycleElement
  • Uses of LifecycleElement in org.kuali.rice.krad.lookup

    Modifier and Type
    Class
    Description
    class 
    Custom InputField for criteria fields within a lookup view that adds criteria specific options.
    class 
    View type for lookups.
    Methods in org.kuali.rice.krad.lookup with parameters of type LifecycleElement
    Modifier and Type
    Method
    Description
    void
    LookupView.performApplyModel(Object model, LifecycleElement parent)
    Reads the convenience render flags and sets the corresponding component property, processing the criteria fields for any adjustments, and invokes the lookup authorizer to determine whether maintenance links should be shown.
    void
    LookupInputField.performFinalize(Object model, LifecycleElement parent)
    The following actions are performed: Add all option if enabled and control is multi-value The following finalization is performed: Set the labelForComponentId to this component id Set the label text on the label field from the field's label property Set the render property on the label's required message field if this field is marked as required 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
    LookupView.performFinalize(Object model, LifecycleElement parent)
    Forces session persistence on the criteria fields so the search criteria can be validated on post.
  • Uses of LifecycleElement in org.kuali.rice.krad.maintenance

    Methods in org.kuali.rice.krad.maintenance with parameters of type LifecycleElement
    Modifier and Type
    Method
    Description
    void
    MaintainableImpl.performCustomApplyModel(LifecycleElement element, Object model)
    Hook for service overrides to perform custom apply model logic on the component.
    void
    MaintainableImpl.performCustomFinalize(LifecycleElement element, Object model, LifecycleElement parent)
    For the copy action, clears out primary key values, applies defaults to previously cleared fields, and replaces any new fields that the current user is unauthorized for with default values in the old record.
  • Uses of LifecycleElement in org.kuali.rice.krad.uif.component

    Modifier and Type
    Interface
    Description
    interface 
    Component defines basic properties and methods that all rendering element implement
    interface 
    Components that bind to a model (hold model data) should implement this interface.
    Modifier and Type
    Class
    Description
    class 
    Base implementation of Component which other component implementations should extend.
    Methods in org.kuali.rice.krad.uif.component with parameters of type LifecycleElement
    Modifier and Type
    Method
    Description
    void
    ComponentBase.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
    ComponentBase.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
  • Uses of LifecycleElement in org.kuali.rice.krad.uif.container

    Modifier and Type
    Interface
    Description
    interface 
    Interface representing an editable collection within a view.
    interface 
    Type of component that contains a collection of other components.
    interface 
    Common interface for group components.
    interface 
    Interface for top-level page components, to be used as items in a multi-page view.
    Modifier and Type
    Class
    Description
    class 
    Accordion group class used to stack groups by there header titles in an accordion layout.
    class 
    Group that holds a collection of objects and configuration for presenting the collection in the UI.
    class 
    Base Container implementation which container implementations can extend
    class 
    Special type of group that presents the content in a modal dialog.
    class 
    Container that holds a list of Field or other Group instances
    class 
    LightTable is a light-weight collection table implementation that supports a subset of features, Current known supported features are: DataField InputField with TextControl, CheckboxControl, or single SelectControl MessageField LinkField ActionField ImageField most RichTable options FieldGroup containing only Actions, Image, Messages, or Links SpringEL for String properties on supported components only SpringEL specifically for the render property Other features are not guaranteed to work, but may work at your own risk.
    class 
    Special Group that presents a grouping on links, which can also include nested groupings of links
    class 
    A PageGroup represents a page of a View.
    class 
    A navigation group which renders a menu with items, that is shown at the side of the page with collapse.
    class 
    A group that presents its child Groups as tabs.
    class 
    Special Group that renders a tab navigation section
    class 
    Group component that is backed by a Tree data structure and typically rendered as a tree in the user interface
    Methods in org.kuali.rice.krad.uif.container with parameters of type LifecycleElement
    Modifier and Type
    Method
    Description
    void
    CollectionGroupBase.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
    ContainerBase.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
    DialogGroup.performApplyModel(Object model, LifecycleElement parent)
    The following actions are performed in this phase: For each configured key value response, create an action component and add to the footer items. 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
    TreeGroup.performApplyModel(Object model, LifecycleElement parent)
     
    void
    AccordionGroup.performFinalize(Object model, LifecycleElement parent)
    Sets the section boolean to true if this group has a rendering header with text The following finalization is performed: Sets the headerText of the header Group if it is blank Set the messageText of the summary Message if it is blank Finalizes LayoutManager 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
    CollectionGroupBase.performFinalize(Object model, LifecycleElement parent)
    Sets the section boolean to true if this group has a rendering header with text The following finalization is performed: Sets the headerText of the header Group if it is blank Set the messageText of the summary Message if it is blank Finalizes LayoutManager 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
    ContainerBase.performFinalize(Object model, LifecycleElement parent)
    The following finalization is performed: Sets the headerText of the header Group if it is blank Set the messageText of the summary Message if it is blank Finalizes LayoutManager 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
    DialogGroup.performFinalize(Object model, LifecycleElement parent)
    The following actions are performed in this phase: Add data attributes for any configured event handlers Sets the section boolean to true if this group has a rendering header with text The following finalization is performed: Sets the headerText of the header Group if it is blank Set the messageText of the summary Message if it is blank Finalizes LayoutManager 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
    GroupBase.performFinalize(Object model, LifecycleElement parent)
    Sets the section boolean to true if this group has a rendering header with text The following finalization is performed: Sets the headerText of the header Group if it is blank Set the messageText of the summary Message if it is blank Finalizes LayoutManager 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
    LightTable.performFinalize(Object model, LifecycleElement parent)
    performFinalize override corrects the binding path for the DataFields and turns off rendering on some components
    void
    PageGroupBase.performFinalize(Object model, LifecycleElement parent)
    Sets the section boolean to true if this group has a rendering header with text The following finalization is performed: Sets the headerText of the header Group if it is blank Set the messageText of the summary Message if it is blank Finalizes LayoutManager 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
    SidebarNavigationGroup.performFinalize(Object model, LifecycleElement parent)
    Adds icons and classes to Action and ToggleMenu items which exist in its items for rendering purposes.
    void
    TabGroup.performFinalize(Object model, LifecycleElement parent)
    Sets the section boolean to true if this group has a rendering header with text The following finalization is performed: Sets the headerText of the header Group if it is blank Set the messageText of the summary Message if it is blank Finalizes LayoutManager 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
    Method parameters in org.kuali.rice.krad.uif.container with type arguments of type LifecycleElement
    Modifier and Type
    Method
    Description
    protected Map<String,String>
    LightTable.addChildExpressions(Collection<? extends LifecycleElement> components, Map<String,String> expressionMap)
    Add expressions to the expression map for nested components of specific types
  • Uses of LifecycleElement in org.kuali.rice.krad.uif.control

    Modifier and Type
    Interface
    Description
    interface 
    Represents an interactive element in the UI (typically an HTML control)
    interface 
    Control interface for a select box.
    interface 
    Interface representing a text input control component.
    Modifier and Type
    Class
    Description
    class 
    Represents a HTML Checkbox control.
    class 
    Represents a group of HTML checkbox controls.
    class 
    Base class for all Control implementations.
    class 
    Represents a HTML File control, generally rendered as an input control with type 'file'.
    class 
    Represents a group control, which is a special control to handle the input of a KIM Group by group name
    class 
    Represents a HTML Hidden control, generally rendered as an input control of type 'hidden'.
    class 
    Base class for controls that accept/display multiple values
    class 
    OptionListControl is used for listing out options from an option finder or options list.
    class 
    Represents a HTML password text control, rendered as a input field of type 'password'.
    class 
    Represents a group of HTML Radio controls.
    class 
    Represents a HTML Select control.
    class 
    Text control that as decorated with a spinner widget (allowing the control value to be modified using the spinner)
    class 
    Represents a HTML TextArea control.
    class 
    Represents a HTML Text control, generally rendered as a input field of type 'text'.
    class 
    Represents a user control, which is a special control to handle the input of a Person.
    Methods in org.kuali.rice.krad.uif.control with parameters of type LifecycleElement
    Modifier and Type
    Method
    Description
    void
    CheckboxControl.performApplyModel(Object model, LifecycleElement parent)
    Sets up rich message content for the label, if any exists Sets the disabledExpression, if any, evaluates it and sets the disabled property
    void
    ControlBase.performApplyModel(Object model, LifecycleElement parent)
    Sets the disabledExpression, if any, evaluates it and sets the disabled property
    void
    GroupControl.performApplyModel(Object model, LifecycleElement parent)
     
    void
    MultiValueControlBase.performApplyModel(Object model, LifecycleElement parent)
    Process rich message content that may be in the options, by creating and initializing the richOptions Sets the disabledExpression, if any, evaluates it and sets the disabled property
    void
    UserControl.performApplyModel(Object model, LifecycleElement parent)
    Sets the disabledExpression, if any, evaluates it and sets the disabled property
    void
    ControlBase.performFinalize(Object model, LifecycleElement parent)
    Parses the disabled expressions, if any, to equivalent javascript and evaluates the disable/enable when changed property names.
    void
    MultiValueControlBase.performFinalize(Object model, LifecycleElement parent)
    Adds appropriate parent data to inputs internal to the controls that may be in rich content of options Parses the disabled expressions, if any, to equivalent javascript and evaluates the disable/enable when changed property names.
    void
    PasswordControl.performFinalize(Object model, LifecycleElement parent)
    The following actions are performed: Defaults maxLength, minLength (if not set) to maxLength of parent field Parses the disabled expressions, if any, to equivalent javascript and evaluates the disable/enable when changed property names.
    void
    TextAreaControl.performFinalize(Object model, LifecycleElement parent)
    The following actions are performed: Defaults maxLength, minLength (if not set) to maxLength of parent field Parses the disabled expressions, if any, to equivalent javascript and evaluates the disable/enable when changed property names.
    void
    TextControlBase.performFinalize(Object model, LifecycleElement parent)
    The following actions are performed: Defaults maxLength, minLength (if not set) to maxLength of parent field Parses the disabled expressions, if any, to equivalent javascript and evaluates the disable/enable when changed property names.
  • Uses of LifecycleElement in org.kuali.rice.krad.uif.element

    Modifier and Type
    Interface
    Description
    interface 
    Interface for content element components.
    Modifier and Type
    Class
    Description
    class 
    Field that presents an action that can be taken on the UI such as submitting the form or invoking a script.
    class 
    Component that renders a standard application header including a logo, navigation, and toolbar.
    class 
    BreadcrumbItem represents a single item in the breadcrumb list that is generated by the breadcrumbs widget.
    class 
    General component that allows custom HTML to be inserted into the view.
    class 
    Base component class for content elements.
    class 
    Content element that renders a table using the RichTable widget configured with an Ajax (or Javascript) data source
    class 
    Outputs an empty div for placeholder purposes, including any basic component options set on it through bean properties or by the framework (id, css, data attributes, etc.)
    class 
    Content element that renders a header element and optionally a Group to present along with the header text
    class 
    Renders a link tag in the head of the html document.
    class 
    Element that presents an Icon.
    class 
    Content element that encloses an iframe
    class 
    Content element that renders a HTML <IMG> tag
    class 
    Content element that renders a label
    class 
    Content element that renders a link
    class 
    Encapsulates a text message to be displayed
    class 
    Renders a meta tag in the head of the html document.
    class 
    A content element that will display the collection configured with a file upload button.
    class 
    Component that renders a navigation bar, including a branding and navigation group.
    class 
    The NextPager widget is used to display previous and next links.
    class 
    The NumberedPager widget is used to display a list of links horizontally in a page selection user interface.
    class 
    Pager widgets are used to page a set of information which has multiple pages.
    class 
    Element which shows a visual progress bar based on percentageValue passed in or segmentPercentages passed in
    class 
    Content element that renders a non-breaking space HTML &nbsp; tag
    class 
    Element which shows a visual progress bar alongside a set of steps, to be used by wizard or multi-step processes, which reflects the current progress based on value of currentStep.
    class 
    Renders a toggle menu (aka sub menu, dropdown menu) of items.
    class 
    The ViewHeader component represents the header for the view.
    Methods in org.kuali.rice.krad.uif.element with parameters of type LifecycleElement
    Modifier and Type
    Method
    Description
    protected void
    Action.buildActionData(View view, Object model, LifecycleElement parent)
    Builds the data attributes that will be read client side to determine how to handle the action and the additional data that should be submitted with the action
    void
    Action.performApplyModel(Object model, LifecycleElement parent)
    Sets the disabledExpression, if any, evaluates it and sets the disabled property.
    void
    BreadcrumbItem.performApplyModel(Object model, LifecycleElement parent)
    The following updates are done here: Evaluate expressions on url object 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
    Header.performApplyModel(Object model, LifecycleElement parent)
    Sets up rich message content for the label, if any exists 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
    Performs the following steps Set the caption header text on the caption header Set the cutline text on the cutline message 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
    Sets up rich message content for the label, if any exists 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
    The following updates are done here: Initialize the nested lightBox widget if open in lightbox is true 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
    Message.performApplyModel(Object model, LifecycleElement parent)
    Message perform apply model parses message text for rich text functionality if the messageText contains [ or ] special characters 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
    ToggleMenu.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
    Action.performFinalize(Object model, LifecycleElement parent)
    The following finalization is performed: Add methodToCall action parameter if set and setup event code for setting action parameters Invoke method to build the data attributes and submit data for the action Compose the final onclick script for the action Parses the disabled expressions, if any, to equivalent javascript and evaluates the disable/enable when changed property names 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
    Header.performFinalize(Object model, LifecycleElement parent)
    The following finalization is performed: Set render on header group to false if no items are configured 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
    Label.performFinalize(Object model, LifecycleElement parent)
    The following finalization is performed: If label text is blank, set render to false for field Set the requiredIndicator Set the label text on the label field from the field's label property Set the render property on the label's required message field if this field is marked as required If the label is hidden then add CSS class to render off screen for accessibility 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
    Special handling for lightbox links to add and onclick data attribute to be handled by a global handler
    void
    Message.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
    MultiFileUploadCollection.performFinalize(Object model, LifecycleElement parent)
    This finalize method adds template options to the templateOptions property based on settings in the parameters of this class 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
    NumberedPager.performFinalize(Object model, LifecycleElement parent)
    performFinalize calculates the pagesStart and pagesEnd properties (using numberOfPages, currentPage, and maxNumberedLinksShown - these must be set) which determines pages shown by the widget
    void
    Pager.performFinalize(Object model, LifecycleElement parent)
    performFinalize calculates the pagesStart and pagesEnd properties (using numberOfPages, currentPage, and maxNumberedLinksShown - these must be set) which determines pages shown by the widget
    void
    ProgressBar.performFinalize(Object model, LifecycleElement parent)
    Sets the appropriate classes and bar widths based on values in percentComplete or segmentPercentages 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
    StepProgressBar.performFinalize(Object model, LifecycleElement parent)
    Populates the stepLabelClasses, accessibilityText, segmentSizes, and segmentClasses lists based on the settings of this StepProgressBar.
    void
    ViewHeader.performFinalize(Object model, LifecycleElement parent)
    Sets the supportTitleMessage if one has not been set and unified header is being used, based on the value of page title The following finalization is performed: Set render on header group to false if no items are configured 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
    PageValidationMessages.processEvent(ViewLifecycle.LifecycleEvent lifecycleEvent, View view, Object model, LifecycleElement eventElement)
    Check for message keys that are not matched anywhere on the page, these unmatched messages must still be displayed at the page level.
  • Uses of LifecycleElement in org.kuali.rice.krad.uif.field

    Modifier and Type
    Interface
    Description
    interface 
    Component interface for data fields.
    interface 
    Component that contains one or more user interface elements and can be placed into a Container
    interface 
    TODO mark don't forget to fill this in.
    Modifier and Type
    Class
    Description
    class 
    Field that encloses an @{link org.kuali.rice.krad.uif.element.Action} element
    class 
    Field that renders data from the application, such as the value of a data object property
    class 
    Base class for Field implementations
    class 
    Field that contains a nested Group.
    class 
    Field whose output is produced by invoking a method or template and has no properties (generic)
    class 
    Field that encloses a link to a group element.
    class 
    Field that wraps an image content element.
    class 
    Field that encapsulates data input/output captured by an attribute within the application
    class 
    Field that encloses a link element.
    class 
    Field wrapper for a Message.
    class 
    Field wrapper for the ProgressBar element
    class 
    A placeholder in the configuration for a Container list of items that will be invoked to retrieve a list of RemotableAttributeField instances which will then be inserted into the containers list at the position of the holder
    class 
    Field that encloses a link to a role element.
    class 
    Field that produces only a space
    class 
    Field that encloses a link to a person element.
    Methods in org.kuali.rice.krad.uif.field with parameters of type LifecycleElement
    Modifier and Type
    Method
    Description
    void
    DataFieldBase.performApplyModel(Object model, LifecycleElement parent)
    The following finalization is performed: Make sure that a label is defined for any data fields.
    void
    FieldBase.performApplyModel(Object model, LifecycleElement parent)
    The following finalization is performed: Make sure that a label is defined for any data fields.
    void
    InputFieldBase.performApplyModel(Object model, LifecycleElement parent)
    The following finalization is performed: Make sure that a label is defined for any data fields.
    void
    ActionField.performFinalize(Object model, LifecycleElement parent)
    PerformFinalize override - calls super, corrects the field's Label for attribute to point to this field's content.
    void
    DataFieldBase.performFinalize(Object model, LifecycleElement parent)
    The following finalization is performed: Set the labelForComponentId to this component id Set the label text on the label field from the field's label property Set the render property on the label's required message field if this field is marked as required 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
    FieldBase.performFinalize(Object model, LifecycleElement parent)
    The following finalization is performed: Set the labelForComponentId to this component id Set the label text on the label field from the field's label property Set the render property on the label's required message field if this field is marked as required 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
    FieldGroup.performFinalize(Object model, LifecycleElement parent)
     
    void
    GroupLinkField.performFinalize(Object model, LifecycleElement parent)
    PerformFinalize override - calls super, corrects the field's Label for attribute to point to this field's content/
    void
    ImageField.performFinalize(Object model, LifecycleElement parent)
    PerformFinalize override - calls super, corrects the field's Label for attribute to point to this field's content
    void
    InputFieldBase.performFinalize(Object model, LifecycleElement parent)
    The following finalization is performed: Set the labelForComponentId to this component id Set the label text on the label field from the field's label property Set the render property on the label's required message field if this field is marked as required 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
    LinkField.performFinalize(Object model, LifecycleElement parent)
    PerformFinalize override - calls super, corrects the field's Label for attribute to point to this field's content
    void
    MessageField.performFinalize(Object model, LifecycleElement parent)
    PerformFinalize override - calls super, corrects the field's Label for attribute to point to this field's content
    void
    ProgressBarField.performFinalize(Object model, LifecycleElement parent)
    PerformFinalize override - calls super, corrects the field's Label for attribute to point to this field's content
    void
    RoleLinkField.performFinalize(Object model, LifecycleElement parent)
    PerformFinalize override - calls super, corrects the field's Label for attribute to point to this field's content.
    void
    UserLinkField.performFinalize(Object model, LifecycleElement parent)
    PerformFinalize override - calls super, corrects the field's Label for attribute to point to this field's content
  • Uses of LifecycleElement in org.kuali.rice.krad.uif.layout

    Modifier and Type
    Interface
    Description
    interface 
    Layout manager implementations that work with a collection (such as a table layout) should implement this interface for building the collection component instances.
    interface 
    Layout manager interface for grid layouts.
    interface 
    Manages the rendering of Component instances within a Container
    interface 
    Layout manager interface for stacked collections.
    interface 
    Layout manager that works with CollectionGroup components and renders the collection as a Table.
    Modifier and Type
    Class
    Description
    class 
    Layout manager that organizes components in a single row (horizontal) or column (vertical)
    class 
    A Css Grid Layout which only takes fields as its content and separates out the field's labels into separate columns
    class 
    Css Grid Layout manager is a layout manager which creates div "rows" and "cells" to replicate a table look by using div elements for its items.
    class 
    Css Grid Layout managers are a layout managers which creates div "rows" and "cells" to replicate a table look by using div elements for its items.
    class 
    Layout manager that organizes its components in a table based grid
    class 
    Base class for all layout managers
    class 
    List layout manager is a layout manager for group types to output their items as either ordered or unordered lists.
    class 
    Layout manager that just renders the items one after another (no wrapping occurs).
    class 
    Layout manager that works with CollectionGroup containers and renders the collection lines in a vertical row
    class 
    Implementation of table layout manager.
    Methods in org.kuali.rice.krad.uif.layout with parameters of type LifecycleElement
    Modifier and Type
    Method
    Description
    void
    LayoutManagerBase.performApplyModel(Object model, LifecycleElement component)
    Called after the initialize phase to perform conditional logic based on the model data
    void
    ListLayoutManager.performApplyModel(Object model, LifecycleElement component)
    Iterates through the groups items and sets the rendered in list boolean.
    void
    StackedLayoutManagerBase.performApplyModel(Object model, LifecycleElement component)
    Called after the initialize phase to perform conditional logic based on the model data
    void
    TableLayoutManagerBase.performApplyModel(Object model, LifecycleElement parent)
    Takes expressions that may be set in the columnCalculation objects and populates them correctly into those component's propertyExpressions.
    void
    BoxLayoutManager.performFinalize(Object model, LifecycleElement container)
    Sets the item span style The last phase before the view is rendered
    void
    CssGridLabelColumnLayoutManager.performFinalize(Object model, LifecycleElement component)
    CssGridLabelColumnLayoutManager's performFinalize method calculates and separates the items into rows The last phase before the view is rendered
    void
    CssGridLayoutManager.performFinalize(Object model, LifecycleElement component)
    CssGridLayoutManager's performFinalize method calculates and separates the items into rows based on their colSpan settings and the defaultItemSize setting The last phase before the view is rendered
    void
    GridLayoutManagerBase.performFinalize(Object model, LifecycleElement parent)
    The following finalization is performed: If suppressLineWrapping is true, sets the number of columns to the container's items list size Adjust the cell attributes for the container items The last phase before the view is rendered
    void
    LayoutManagerBase.performFinalize(Object model, LifecycleElement component)
    The last phase before the view is rendered
    void
    StackedLayoutManagerBase.performFinalize(Object model, LifecycleElement element)
    The last phase before the view is rendered
    void
    TableLayoutManagerBase.performFinalize(Object model, LifecycleElement parent)
    The last phase before the view is rendered
  • Uses of LifecycleElement in org.kuali.rice.krad.uif.layout.collections

    Modifier and Type
    Class
    Description
    class 
    Base class for collection layout managers.
  • Uses of LifecycleElement in org.kuali.rice.krad.uif.lifecycle

    Methods in org.kuali.rice.krad.uif.lifecycle with type parameters of type LifecycleElement
    Modifier and Type
    Method
    Description
    static <T extends LifecycleElement>
    List<T>
    ViewLifecycleUtils.getElementsOfTypeDeep(Collection<? extends LifecycleElement> items, Class<T> elementType)
    Return the lifecycle elements of the specified type from the given list
    static <T extends LifecycleElement>
    List<T>
    ViewLifecycleUtils.getElementsOfTypeDeep(LifecycleElement element, Class<T> elementType)
    Returns the lifecycle elements of the specified type from the given list.
    static <T extends LifecycleElement>
    List<T>
    ViewLifecycleUtils.getElementsOfTypeShallow(LifecycleElement element, Class<T> elementType)
    Returns elements of the given type that are direct children of the given element including itself, or a child of a non-component child of the given element.
    static <T extends LifecycleElement>
    List<T>
    ViewLifecycleUtils.getNestedElementsOfTypeShallow(LifecycleElement element, Class<T> elementType)
    Get nested elements of the type specified one layer deep; this defers from getElementsOfTypeShallow because it does NOT include itself as a match if it also matches the type being requested.
    Modifier and Type
    Method
    Description
    LifecycleElementState.getElement()
    Gets the element this lifecycle phase is responsible for processing.
    ViewLifecyclePhaseBase.getElement()
    Gets the element this lifecycle phase is responsible for processing.
    Methods in org.kuali.rice.krad.uif.lifecycle that return types with arguments of type LifecycleElement
    Modifier and Type
    Method
    Description
    ViewLifecycleUtils.getElementsForLifecycle(LifecycleElement element)
    Gets sub-elements for lifecycle processing.
    ViewLifecycleUtils.getElementsForLifecycle(LifecycleElement element, String viewPhase)
    Gets subcomponents for lifecycle processing.
    Methods in org.kuali.rice.krad.uif.lifecycle with parameters of type LifecycleElement
    Modifier and Type
    Method
    Description
    ViewLifecyclePhaseBuilder.buildPhase(String viewPhase, LifecycleElement element, Component parent, String parentPath, List<String> refreshPaths)
    Creates a lifecycle phase instance for a specific component in the current lifecycle.
    ViewLifecyclePhaseBuilderBase.buildPhase(String viewPhase, LifecycleElement element, Component parent, String parentPath, List<String> refreshPaths)
    Creates a lifecycle phase instance for a specific component in the current lifecycle.
    protected static void
    LifecycleRefreshPathBuilder.buildRefreshPathMappings(LifecycleElement lifecycleElement, ComponentPostMetadata componentPostMetadata)
    Builds the refresh paths for the given lifecycle element and sets onto the post metadata for storage.
    ViewLifecycleUtils.getElementsForLifecycle(LifecycleElement element)
    Gets sub-elements for lifecycle processing.
    ViewLifecycleUtils.getElementsForLifecycle(LifecycleElement element, String viewPhase)
    Gets subcomponents for lifecycle processing.
    static <T extends LifecycleElement>
    List<T>
    ViewLifecycleUtils.getElementsOfTypeDeep(LifecycleElement element, Class<T> elementType)
    Returns the lifecycle elements of the specified type from the given list.
    static <T extends LifecycleElement>
    List<T>
    ViewLifecycleUtils.getElementsOfTypeShallow(LifecycleElement element, Class<T> elementType)
    Returns elements of the given type that are direct children of the given element including itself, or a child of a non-component child of the given element.
    static Set<String>
    ViewLifecycleUtils.getLifecycleRestrictedProperties(LifecycleElement element, String viewPhase)
    Gets property names of all bean properties on the lifecycle element restricted for the indicated view phase.
    static <T extends LifecycleElement>
    List<T>
    ViewLifecycleUtils.getNestedElementsOfTypeShallow(LifecycleElement element, Class<T> elementType)
    Get nested elements of the type specified one layer deep; this defers from getElementsOfTypeShallow because it does NOT include itself as a match if it also matches the type being requested.
    static String
    ViewLifecycleUtils.getNextLifecyclePhase(LifecycleElement element)
    Gets the next lifecycle phase to be executed on the provided element.
    PreProcessElementPhase.initializeSuccessor(LifecycleElement nestedElement, String nestedPath, Component nestedParent)
    Initializes a successor of this phase for a given nested element.
    RenderComponentPhase.initializeSuccessor(LifecycleElement nestedElement, String nestedPath, Component parent)
    Initializes a successor of this phase for a given nested element.
    ViewLifecyclePhaseBase.initializeSuccessor(LifecycleElement nestedElement, String nestedPath, Component nestedParent)
    Initializes a successor of this phase for a given nested element.
    void
    ViewLifecycle.invokeEventListeners(ViewLifecycle.LifecycleEvent event, View view, Object model, LifecycleElement eventElement)
    Invoked when an event occurs to invoke registered listeners.
    void
    ViewLifecyclePhase.prepare(LifecycleElement element, Component parent, String parentPath, List<String> refreshPaths)
    Prepares a phase for use after being recycled (state cleared).
    void
    ViewLifecyclePhaseBase.prepare(LifecycleElement element, Component parent, String parentPath, List<String> refreshPaths)
    Prepares a phase for use after being recycled (state cleared).
    void
    LifecycleEventListener.processEvent(ViewLifecycle.LifecycleEvent lifecycleEvent, View view, Object model, LifecycleElement eventElement)
    Invoked on a component listener when an event occurs for the given event component.
    protected static void
    LifecycleRefreshPathBuilder.processLifecycleElement(LifecycleElement element)
    Determines whether the given lifecycle element is capable of being refreshed, and if so invokes LifecycleRefreshPathBuilder.buildRefreshPathMappings(org.kuali.rice.krad.uif.util.LifecycleElement, org.kuali.rice.krad.uif.lifecycle.ComponentPostMetadata) to build the refresh paths.
    protected static void
    LifecycleRefreshPathBuilder.storePhasePathMapping(LifecycleElement lifecycleElement, ComponentPostMetadata componentPostMetadata)
    Store phase path mapping for component if there are any paths different from the final path.
    boolean
    ApplyModelComponentPhase.visit(LifecycleElement element)
    Visit a lifecycle element.
    Method parameters in org.kuali.rice.krad.uif.lifecycle with type arguments of type LifecycleElement
    Modifier and Type
    Method
    Description
    static <T extends LifecycleElement>
    List<T>
    ViewLifecycleUtils.getElementsOfTypeDeep(Collection<? extends LifecycleElement> items, Class<T> elementType)
    Return the lifecycle elements of the specified type from the given list
  • Uses of LifecycleElement in org.kuali.rice.krad.uif.lifecycle.initialize

    Modifier and Type
    Method
    Description
    static String
    AssignIdsTask.generateId(LifecycleElement element, View view)
    Generate a new ID for a lifecycle element at the current phase.
  • Uses of LifecycleElement in org.kuali.rice.krad.uif.lifecycle.model

    Modifier and Type
    Method
    Description
    EvaluateExpressionsTask.adjustIdIfNecessary(LifecycleElement element)
    Checks against the visited ids to see if the id is duplicate, if so it is adjusted to make an unique id by appending an unique identifier
  • Uses of LifecycleElement in org.kuali.rice.krad.uif.mock

    Modifier and Type
    Class
    Description
    class 
    View class for developing UI mocks.
    Methods in org.kuali.rice.krad.uif.mock with parameters of type LifecycleElement
    Modifier and Type
    Method
    Description
    void
    MockView.performFinalize(Object model, LifecycleElement parent)
    Creates sample data for read only data fields and defaults actions to call the refresh method.
  • Uses of LifecycleElement in org.kuali.rice.krad.uif.service

    Methods in org.kuali.rice.krad.uif.service with parameters of type LifecycleElement
    Modifier and Type
    Method
    Description
    void
    ViewHelperService.performCustomApplyModel(LifecycleElement component, Object model)
    Hook for service overrides to perform custom apply model logic on the component
    void
    ViewHelperService.performCustomFinalize(LifecycleElement component, Object model, LifecycleElement parent)
    Hook for service overrides to perform custom component finalization
    void
    ViewHelperService.performCustomInitialization(LifecycleElement component)
    Hook for service overrides to perform custom initialization on the component
    void
    ViewHelperService.setElementContext(LifecycleElement element, LifecycleElement parent)
    Invoked to set up the context for an element.
  • Uses of LifecycleElement in org.kuali.rice.krad.uif.service.impl

    Methods in org.kuali.rice.krad.uif.service.impl with parameters of type LifecycleElement
    Modifier and Type
    Method
    Description
    void
    ViewHelperServiceImpl.performCustomApplyModel(LifecycleElement element, Object model)
    Hook for service overrides to perform custom apply model logic on the component
    void
    ViewHelperServiceImpl.performCustomFinalize(LifecycleElement element, Object model, LifecycleElement parent)
    Hook for service overrides to perform custom component finalization
    void
    ViewHelperServiceImpl.performCustomInitialization(LifecycleElement element)
    Hook for service overrides to perform custom initialization on the component
    void
    ViewHelperServiceImpl.setElementContext(LifecycleElement element, LifecycleElement parent)
    Invoked to set up the context for an element.
  • Uses of LifecycleElement in org.kuali.rice.krad.uif.util

    Methods in org.kuali.rice.krad.uif.util with parameters of type LifecycleElement
    Modifier and Type
    Method
    Description
    static void
    ComponentUtils.cleanContextDeap(LifecycleElement lifecycleElement)
    Sets the context of the given lifecycle element to null, then using reflection recursively finds any lifecycle element children and sets their context to null.
    static void
    ContextUtils.cleanContextDeep(LifecycleElement lifecycleElement)
    Sets the context of the given lifecycle element to null, then using reflection recursively finds any lifecycle element children and sets their context to null.
    static int
    ComponentUtils.generateId(LifecycleElement element, int seed)
    Generate a hash code unique within the current view for a single lifecycle element.
    void
    LifecycleElement.performApplyModel(Object model, LifecycleElement parent)
    Deprecated.
    Special processing within this method should be replaced by ViewLifecycleTask and initialized by
    invalid reference
    #initializePendingTasks(ViewLifecyclePhase, Queue)
    .
    void
    LifecycleElement.performFinalize(Object model, LifecycleElement parent)
    Deprecated.
    Special processing within this method should be replaced by ViewLifecycleTask and initialized by
    invalid reference
    #initializePendingTasks(ViewLifecyclePhase, Queue)
    .
    static void
    ComponentUtils.updateIdWithSuffix(LifecycleElement element, String idSuffix)
    add a suffix to the id
    Method parameters in org.kuali.rice.krad.uif.util with type arguments of type LifecycleElement
    Modifier and Type
    Method
    Description
    static void
    ComponentUtils.pushObjectToContext(Collection<? extends LifecycleElement> elements, String contextName, Object contextValue)
    places a key, value pair in each context map of a list of components
    static void
    ContextUtils.pushObjectToContextDeep(Collection<? extends LifecycleElement> elements, String contextName, Object contextValue)
    places a key, value pair in each context map of a list of components
    Constructors in org.kuali.rice.krad.uif.util with parameters of type LifecycleElement
    Modifier
    Constructor
    Description
     
    Create a new list instance.
     
    LifecycleAwareList(LifecycleElement lifecycleElement, List<T> delegate)
    Create a new list instance, based on another list.
     
    Create a new map instance for use with a lifecycle element.
     
    LifecycleAwareMap(LifecycleElement lifecycleElement, Map<K,V> delegate)
    Create a new list instance, based on another list.
  • Uses of LifecycleElement in org.kuali.rice.krad.uif.view

    Modifier and Type
    Class
    Description
    class 
    View type for KRAD documents.
    class 
    Provides configuration for View instances that render an HTML form.
    class 
    IframeView is a View component that shows another website's content in an iframe.
    class 
    Type of View that provides a read-only display of a record of data (object instance)
    class 
    View type for Maintenance documents
    class 
    View that presents a message to the user (for example an application error message)
    class 
    View type for Transactional documents.
    class 
    Root of the component tree which encompasses a set of related GroupContainer instances tied together with a common page layout and navigation.
    Modifier and Type
    Method
    Description
    Gets a lifecycle element instance by the given path (relative to the view).
    Methods in org.kuali.rice.krad.uif.view that return types with arguments of type LifecycleElement
    Modifier and Type
    Method
    Description
    Gets the Map of lifecycle elements that are indexed by their path relative to the view.
    Methods in org.kuali.rice.krad.uif.view with parameters of type LifecycleElement
    Modifier and Type
    Method
    Description
    void
    IframeView.performApplyModel(Object model, LifecycleElement parent)
    Evaluates expressions that may appear in location properties and sets the source of iframe automatically The following updates are done here: Invoke expression evaluation on view theme Invoke theme to configure defaults
    void
    The following updates are done here: Invoke expression evaluation on view theme Invoke theme to configure defaults
    void
    FormView.performFinalize(Object model, LifecycleElement parent)
    The following is performed: Adds to its document ready script the setupValidator js function for setting up the validator for this view The following is performed: Adds to its document ready script the setupValidator js function for setting up the validator for this view The following finalization is performed: Sets the headerText of the header Group if it is blank Set the messageText of the summary Message if it is blank Finalizes LayoutManager 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
    TransactionalDocumentView.performFinalize(Object model, LifecycleElement parent)
    The following is performed: Adds to its document ready script the setupValidator js function for setting up the validator for this view The following is performed: Adds to its document ready script the setupValidator js function for setting up the validator for this view The following finalization is performed: Sets the headerText of the header Group if it is blank Set the messageText of the summary Message if it is blank Finalizes LayoutManager 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
    The following is performed: Adds to its document ready script the setupValidator js function for setting up the validator for this view The following finalization is performed: Sets the headerText of the header Group if it is blank Set the messageText of the summary Message if it is blank Finalizes LayoutManager 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
  • Uses of LifecycleElement in org.kuali.rice.krad.uif.widget

    Modifier and Type
    Interface
    Description
    interface 
    Components that provide a user interface function (besides the basic form handing) should implement the widget interface
    Modifier and Type
    Class
    Description
    class 
    Accordion widget class used to create an accordion based layout.
    class 
    BlockUI element is used within the view element for managing element/page blocking attributes
    class 
    The breadcrumb widget contains various settings for setting up Breadcrumb/History support on the view
    class 
    Used for rendering a calendar in the UI that can be used to selected dates for field values
    class 
    Decorates a group with collapse/expand functionality
    class 
    Growls sets up settings for growls global to the current view and its pages
    class 
    Widget that renders help on a component
    class 
    Widget for rendering an Inquiry link or DirectInquiry action field
    class 
    Used for rendering a lightbox in the UI to display action links in dialog popups.
    class 
    LocationSuggest widget for providing suggestions that represent locations.
    class 
    Widget for navigating to a lookup from a field (called a quickfinder).
    class 
    Decorates a HTML Table client side with various tools
    class 
    Decorates a group with scroll functionality.
    class 
    Widget that decorates a control transforming into a spinner
    class 
    Widget that provides dynamic select options to the user as they are entering the value (also known as auto-complete).
    class 
    Widget that renders text syntax highlighted
    class 
    Widget used for configuring tab options, use componentOptions for most options.
    class 
    Widget that renders a Tooltip on a component.
    class 
    Widget component for rendering a Tree
    class 
    Base class for Widgets
    Methods in org.kuali.rice.krad.uif.widget with parameters of type LifecycleElement
    Modifier and Type
    Method
    Description
    protected void
    Build the external help
    protected void
    Build the tooltip help
    void
    Disclosure.performApplyModel(Object model, LifecycleElement parent)
    Sets forceSessionPersistence when using the ajax retrieval option 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
    Suggest.performApplyModel(Object model, LifecycleElement parent)
    The following updates are done here: Invoke expression evaluation on the suggestQuery 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
    Finalize the help widget for usage
    void
    Inquiry.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
    LocationSuggest.performFinalize(Object model, LifecycleElement parent)
    Process the objectIdPropertyName, if set The following actions are performed: Adjusts the query field mappings on the query based on the binding configuration of the field TODO: determine query if render is true and query is not set 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
    QuickFinder.performFinalize(Object model, LifecycleElement parent)
    The following finalization is performed: Sets up the quickfinder based on whether the parent is an input field or collection group Adds action parameters to the quickfinder action based on the quickfinder configuration Adds callback parameters to post data if present 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
    RichTable.performFinalize(Object model, LifecycleElement parent)
    The following initialization is performed: Initializes component options for empty table message
    void
    Scrollpane.performFinalize(Object model, LifecycleElement parent)
     
    void
    Suggest.performFinalize(Object model, LifecycleElement parent)
    The following actions are performed: Adjusts the query field mappings on the query based on the binding configuration of the field TODO: determine query if render is true and query is not set 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
    The following is performed: If the active tab id is configured, set the active plugin option
    void
    QuickFinder.processEvent(ViewLifecycle.LifecycleEvent lifecycleEvent, View view, Object model, LifecycleElement eventComponent)
    Adds post context data for the quickfinder so when the lookup return occurs the focus and jump point of the quickfinder action can be retrieved.
    protected void
    QuickFinder.setupQuickfinderAction(View view, Object model, LifecycleElement parent)
    Adjusts the id for the quickfinder action, and then adds action parameters for passing along the quickfinder configuration to the lookup view.