| Modifier and Type | Class and Description |
|---|---|
class |
LookupInputField
Custom
InputField for criteria fields within a lookup view that adds criteria specific options. |
class |
LookupView
View type for lookups.
|
| Modifier and Type | Method and 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 |
LookupView.performFinalize(Object model,
LifecycleElement parent)
Forces session persistence on the criteria fields so the search criteria can be validated on post.
|
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
|
| Modifier and Type | Method and 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.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
Component
Component defines basic properties and methods that all rendering element implement
|
interface |
DataBinding
Components that bind to a model (hold model data) should implement this interface.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ComponentBase
Base implementation of Component which other component implementations should extend.
|
| Modifier and Type | Method and 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
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
CollectionGroup
Interface representing an editable collection within a view.
|
interface |
Container
Type of component that contains a collection of other components.
|
interface |
Group
Common interface for group components.
|
interface |
PageGroup
Interface for top-level page components, to be used as items in a multi-page view.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AccordionGroup
Accordion group class used to stack groups by there header titles in an accordion layout.
|
class |
CollectionGroupBase
Group that holds a collection of objects and configuration for presenting the
collection in the UI.
|
class |
ContainerBase
Base
Container implementation which container implementations
can extend |
class |
DialogGroup
Special type of group that presents the content in a modal dialog.
|
class |
GroupBase
Container that holds a list of
Field or other Group
instances |
class |
LightTable
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 |
LinkGroup
Special
Group that presents a grouping on links, which can
also include nested groupings of links |
class |
PageGroupBase
A PageGroup represents a page of a View.
|
class |
SidebarNavigationGroup
A navigation group which renders a menu with items, that is shown at the side of the page with collapse.
|
class |
TabGroup
A group that presents its child Groups as tabs.
|
class |
TabNavigationGroup
Special
Group that renders a tab navigation section |
class |
TreeGroup
Group component that is backed by a
Tree data structure and typically
rendered as a tree in the user interface |
| Modifier and Type | Method and Description |
|---|---|
void |
TreeGroup.performApplyModel(Object model,
LifecycleElement parent) |
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 |
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 |
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 |
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
|
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 |
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 |
LightTable.performFinalize(Object model,
LifecycleElement parent)
performFinalize override corrects the binding path for the DataFields and turns off rendering on some components
|
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 |
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 |
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 |
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 |
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
|
| Modifier and Type | Method and 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
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
Control
Represents an interactive element in the UI (typically an HTML control)
|
interface |
SelectControl
Control interface for a select box.
|
interface |
TextControl
Interface representing a text input control component.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CheckboxControl
Represents a HTML Checkbox control.
|
class |
CheckboxGroupControl
Represents a group of HTML checkbox controls.
|
class |
ControlBase
Base class for all
Control implementations. |
class |
FileControl
Represents a HTML File control, generally rendered as an input control with
type 'file'.
|
class |
GroupControl
Represents a group control, which is a special control to handle
the input of a KIM Group by group name
|
class |
HiddenControl
Represents a HTML Hidden control, generally rendered as an input control of
type 'hidden'.
|
class |
MultiValueControlBase
Base class for controls that accept/display multiple values
|
class |
OptionListControl
OptionListControl is used for listing out options from an option finder or options list.
|
class |
PasswordControl
Represents a HTML password text control, rendered as a input field of type
'password'.
|
class |
RadioGroupControl
Represents a group of HTML Radio controls.
|
class |
SelectControlBase
Represents a HTML Select control.
|
class |
SpinnerControl
Text control that as decorated with a spinner widget (allowing the control value to be modified using the
spinner)
|
class |
TextAreaControl
Represents a HTML TextArea control.
|
class |
TextControlBase
Represents a HTML Text control, generally rendered as a input field of type
'text'.
|
class |
UserControl
Represents a user control, which is a special control to handle the input of a Person.
|
| Modifier and Type | Method and Description |
|---|---|
void |
UserControl.performApplyModel(Object model,
LifecycleElement parent)
Sets the disabledExpression, if any, evaluates it and sets the disabled property
|
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 |
GroupControl.performApplyModel(Object model,
LifecycleElement parent) |
void |
ControlBase.performApplyModel(Object model,
LifecycleElement parent)
Sets the disabledExpression, if any, evaluates it and sets the disabled property
|
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 |
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.
|
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 |
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 |
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 |
ControlBase.performFinalize(Object model,
LifecycleElement parent)
Parses the disabled expressions, if any, to equivalent javascript and evaluates the disable/enable when
changed property names.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
ContentElement
Interface for content element components.
|
| Modifier and Type | Class and Description |
|---|---|
class |
Action
Field that presents an action that can be taken on the UI such as submitting the form or invoking a script.
|
class |
ApplicationHeader
Component that renders a standard application header including a logo, navigation, and toolbar.
|
class |
BreadcrumbItem
BreadcrumbItem represents a single item in the breadcrumb list that is generated by the breadcrumbs widget.
|
class |
Content
General component that allows custom HTML to be inserted into the view.
|
class |
ContentElementBase
Base component class for content elements.
|
class |
DataTable
Content element that renders a table using the
RichTable widget configured with an Ajax (or Javascript)
data source |
class |
Div
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 |
Header
Content element that renders a header element and optionally a
Group to
present along with the header text |
class |
HeadLink
Renders a link tag in the head of the html document.
|
class |
Icon
Element that presents an Icon.
|
class |
Iframe
Content element that encloses an iframe
|
class |
Image
Content element that renders a HTML
<IMG> tag |
class |
Label
Content element that renders a label
|
class |
Link
Content element that renders a link
|
class |
Message
Encapsulates a text message to be displayed
|
class |
MetaTag
Renders a meta tag in the head of the html document.
|
class |
MultiFileUploadCollection
A content element that will display the collection configured with a file upload button.
|
class |
NavigationBar
Component that renders a navigation bar, including a branding and navigation group.
|
class |
NextPager
The NextPager widget is used to display previous and next links.
|
class |
NumberedPager
The NumberedPager widget is used to display a list of links horizontally in a page selection user interface.
|
class |
Pager
Pager widgets are used to page a set of information which has multiple pages.
|
class |
ProgressBar
Element which shows a visual progress bar based on percentageValue passed in or segmentPercentages passed in
|
class |
Space
Content element that renders a non-breaking space HTML
tag |
class |
StepProgressBar
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 |
ToggleMenu
Renders a toggle menu (aka sub menu, dropdown menu) of items.
|
class |
ViewHeader
The ViewHeader component represents the header for the view.
|
| Modifier and Type | Method and 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 |
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 |
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 |
Link.performApplyModel(Object model,
LifecycleElement parent)
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 |
Label.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 |
Image.performApplyModel(Object model,
LifecycleElement parent)
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 |
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 |
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 |
Action.performApplyModel(Object model,
LifecycleElement parent)
Sets the disabledExpression, if any, evaluates it and sets the disabled property.
|
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 |
StepProgressBar.performFinalize(Object model,
LifecycleElement parent)
Populates the stepLabelClasses, accessibilityText, segmentSizes, and segmentClasses lists based on the settings
of this StepProgressBar.
|
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 |
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 |
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 |
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 |
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 |
Link.performFinalize(Object model,
LifecycleElement parent)
Special handling for lightbox links to add and onclick data attribute to be handled by a global handler
|
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 |
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 |
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 |
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.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
DataField
Component interface for data fields.
|
interface |
Field
Component that contains one or more user interface elements and can be placed
into a
Container |
interface |
InputField
TODO mark don't forget to fill this in.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ActionField
Field that encloses an @{link org.kuali.rice.krad.uif.element.Action} element
|
class |
DataFieldBase
Field that renders data from the application, such as the value of a data object property
|
class |
FieldBase
Base class for
Field implementations |
class |
FieldGroup
Field that contains a nested
Group. |
class |
GenericField
Field whose output is produced by invoking a method or template and has no
properties (generic)
|
class |
GroupLinkField
Field that encloses a link to a group element.
|
class |
ImageField
Field that wraps an image content element.
|
class |
InputFieldBase
Field that encapsulates data input/output captured by an attribute within the
application
|
class |
LinkField
Field that encloses a link element.
|
class |
MessageField
Field wrapper for a Message.
|
class |
ProgressBarField
Field wrapper for the ProgressBar element
|
class |
RemoteFieldsHolder
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 |
RoleLinkField
Field that encloses a link to a role element.
|
class |
SpaceField
Field that produces only a space
|
class |
UserLinkField
Field that encloses a link to a person element.
|
| Modifier and Type | Method and Description |
|---|---|
void |
InputFieldBase.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 |
DataFieldBase.performApplyModel(Object model,
LifecycleElement parent)
The following finalization is performed:
Make sure that a label is defined for any data fields.
|
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
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
FieldGroup.performFinalize(Object model,
LifecycleElement parent) |
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 |
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 |
ActionField.performFinalize(Object model,
LifecycleElement parent)
PerformFinalize override - calls super, corrects the field's Label for attribute to point to this field's
content.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
CollectionLayoutManager
Layout manager implementations that work with a collection (such as a table layout) should implement
this interface for building the collection component instances.
|
interface |
GridLayoutManager
Layout manager interface for grid layouts.
|
interface |
LayoutManager
Manages the rendering of
Component instances within a
Container |
interface |
StackedLayoutManager
Layout manager interface for stacked collections.
|
interface |
TableLayoutManager
Layout manager that works with
CollectionGroup components and renders the collection as a
Table. |
| Modifier and Type | Class and Description |
|---|---|
class |
BoxLayoutManager
Layout manager that organizes components in a single row (horizontal) or
column (vertical)
|
class |
CssGridLabelColumnLayoutManager
A Css Grid Layout which only takes fields as its content and separates out the field's labels into
separate columns
|
class |
CssGridLayoutManager
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 |
CssGridLayoutManagerBase
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 |
GridLayoutManagerBase
Layout manager that organizes its components in a table based grid
|
class |
LayoutManagerBase
Base class for all layout managers
|
class |
ListLayoutManager
List layout manager is a layout manager for group types to output their items as either ordered or
unordered lists.
|
class |
SimpleLayoutManager
Layout manager that just renders the items one after another (no wrapping occurs).
|
class |
StackedLayoutManagerBase
Layout manager that works with
CollectionGroup containers and
renders the collection lines in a vertical row |
class |
TableLayoutManagerBase
Implementation of table layout manager.
|
| Modifier and Type | Method and Description |
|---|---|
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 |
StackedLayoutManagerBase.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 |
LayoutManagerBase.performApplyModel(Object model,
LifecycleElement component)
Called after the initialize phase to perform conditional logic based on the model data
|
void |
TableLayoutManagerBase.performFinalize(Object model,
LifecycleElement parent)
The last phase before the view is rendered
|
void |
StackedLayoutManagerBase.performFinalize(Object model,
LifecycleElement element)
The last phase before the view is rendered
|
void |
LayoutManagerBase.performFinalize(Object model,
LifecycleElement component)
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 |
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 |
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 |
BoxLayoutManager.performFinalize(Object model,
LifecycleElement container)
Sets the item span style
The last phase before the view is rendered
|
| Modifier and Type | Class and Description |
|---|---|
class |
CollectionLayoutManagerBase
Base class for collection layout managers.
|
| Modifier and Type | Method and Description |
|---|---|
static <T extends LifecycleElement> |
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> |
ViewLifecycleUtils.getElementsOfTypeDeep(LifecycleElement element,
Class<T> elementType)
Returns the lifecycle elements of the specified type from the given list.
|
static <T extends LifecycleElement> |
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> |
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 and Description |
|---|---|
LifecycleElement |
ViewLifecyclePhaseBase.getElement()
Gets the element this lifecycle phase is responsible for processing.
|
LifecycleElement |
LifecycleElementState.getElement()
Gets the element this lifecycle phase is responsible for processing.
|
| Modifier and Type | Method and Description |
|---|---|
static Map<String,LifecycleElement> |
ViewLifecycleUtils.getElementsForLifecycle(LifecycleElement element)
Gets sub-elements for lifecycle processing.
|
static Map<String,LifecycleElement> |
ViewLifecycleUtils.getElementsForLifecycle(LifecycleElement element,
String viewPhase)
Gets subcomponents for lifecycle processing.
|
| Modifier and Type | Method and Description |
|---|---|
ViewLifecyclePhase |
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.
|
ViewLifecyclePhase |
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.
|
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.
|
static Map<String,LifecycleElement> |
ViewLifecycleUtils.getElementsForLifecycle(LifecycleElement element)
Gets sub-elements for lifecycle processing.
|
static Map<String,LifecycleElement> |
ViewLifecycleUtils.getElementsForLifecycle(LifecycleElement element,
String viewPhase)
Gets subcomponents for lifecycle processing.
|
static <T extends LifecycleElement> |
ViewLifecycleUtils.getElementsOfTypeDeep(LifecycleElement element,
Class<T> elementType)
Returns the lifecycle elements of the specified type from the given list.
|
static <T extends LifecycleElement> |
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> |
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.
|
protected ViewLifecyclePhase |
ViewLifecyclePhaseBase.initializeSuccessor(LifecycleElement nestedElement,
String nestedPath,
Component nestedParent)
Initializes a successor of this phase for a given nested element.
|
protected ViewLifecyclePhase |
RenderComponentPhase.initializeSuccessor(LifecycleElement nestedElement,
String nestedPath,
Component parent)
Initializes a successor of this phase for a given nested element.
|
protected ViewLifecyclePhase |
PreProcessElementPhase.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 |
ViewLifecyclePhaseBase.prepare(LifecycleElement element,
Component parent,
String parentPath,
List<String> refreshPaths)
Prepares a phase for use after being recycled (state cleared).
|
void |
ViewLifecyclePhase.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.
|
| Modifier and Type | Method and Description |
|---|---|
static <T extends LifecycleElement> |
ViewLifecycleUtils.getElementsOfTypeDeep(Collection<? extends LifecycleElement> items,
Class<T> elementType)
Return the lifecycle elements of the specified type from the given list
|
| Modifier and Type | Method and Description |
|---|---|
static String |
AssignIdsTask.generateId(LifecycleElement element,
View view)
Generate a new ID for a lifecycle element at the current phase.
|
| Modifier and Type | Method and Description |
|---|---|
String |
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
|
| Modifier and Type | Class and Description |
|---|---|
class |
MockView
View class for developing UI mocks.
|
| Modifier and Type | Method and Description |
|---|---|
void |
MockView.performFinalize(Object model,
LifecycleElement parent)
Creates sample data for read only data fields and defaults actions to call the refresh method.
|
| Modifier and Type | Method and 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.
|
| Modifier and Type | Method and 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.
|
| Modifier and Type | Method and 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
#initializePendingTasks(ViewLifecyclePhase, Queue). |
void |
LifecycleElement.performFinalize(Object model,
LifecycleElement parent)
Deprecated.
Special processing within this method should be replaced by
ViewLifecycleTask and initialized by
#initializePendingTasks(ViewLifecyclePhase, Queue). |
static void |
ComponentUtils.updateIdWithSuffix(LifecycleElement element,
String idSuffix)
add a suffix to the id
|
| Modifier and Type | Method and 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
|
| Constructor and Description |
|---|
LifecycleAwareList(LifecycleElement lifecycleElement)
Create a new list instance.
|
LifecycleAwareList(LifecycleElement lifecycleElement,
List<T> delegate)
Create a new list instance, based on another list.
|
LifecycleAwareMap(LifecycleElement lifecycleElement)
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.
|
| Modifier and Type | Class and Description |
|---|---|
class |
DocumentView
View type for KRAD documents.
|
class |
FormView
Provides configuration for
View instances that render an HTML form. |
class |
IframeView
IframeView is a View component that shows another website's content in an iframe.
|
class |
InquiryView
Type of
View that provides a read-only display of a record of
data (object instance) |
class |
MaintenanceDocumentView
View type for Maintenance documents
|
class |
MessageView
View that presents a message to the user (for example an application error message)
|
class |
TransactionalDocumentView
View type for Transactional documents.
|
class |
View
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 and Description |
|---|---|
LifecycleElement |
ViewIndex.getLifecycleElementByPath(String path)
Gets a lifecycle element instance by the given path (relative to the view).
|
| Modifier and Type | Method and Description |
|---|---|
Map<String,LifecycleElement> |
ViewIndex.getLifecycleElementsByPath()
Gets the Map of lifecycle elements that are indexed by their path relative to the view.
|
| Modifier and Type | Method and Description |
|---|---|
void |
View.performApplyModel(Object model,
LifecycleElement parent)
The following updates are done here:
Invoke expression evaluation on view theme
Invoke theme to configure defaults
|
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 |
View.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 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 |
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
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
Widget
Components that provide a user interface function (besides the basic form
handing) should implement the widget interface
|
| Modifier and Type | Class and Description |
|---|---|
class |
Accordion
Accordion widget class used to create an accordion based layout.
|
class |
BlockUI
BlockUI element is used within the view element for managing element/page blocking attributes
|
class |
Breadcrumbs
The breadcrumb widget contains various settings for setting up
Breadcrumb/History support on the view
|
class |
DatePicker
Used for rendering a calendar in the UI that can be used to selected dates
for field values
|
class |
Disclosure
Decorates a group with collapse/expand functionality
|
class |
Growls
Growls sets up settings for growls global to the current view and its pages
|
class |
Help
Widget that renders help on a component
|
class |
Inquiry
Widget for rendering an Inquiry link or DirectInquiry action field
|
class |
LightBox
Used for rendering a lightbox in the UI to display action links in dialog popups.
|
class |
LocationSuggest
LocationSuggest widget for providing suggestions that represent locations.
|
class |
QuickFinder
Widget for navigating to a lookup from a field (called a quickfinder).
|
class |
RichTable
Decorates a HTML Table client side with various tools
|
class |
Scrollpane
Decorates a group with scroll functionality.
|
class |
Spinner
Widget that decorates a control transforming into a spinner
|
class |
Suggest
Widget that provides dynamic select options to the user as they are entering the value (also known
as auto-complete).
|
class |
SyntaxHighlighter
Widget that renders text syntax highlighted
|
class |
Tabs
Widget used for configuring tab options, use componentOptions for most options.
|
class |
Tooltip
Widget that renders a Tooltip on a component.
|
class |
Tree
Widget component for rendering a Tree
|
class |
WidgetBase
Base class for Widgets
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
Help.buildExternalHelp(LifecycleElement parent)
Build the external help
|
protected void |
Help.buildTooltipHelp(LifecycleElement parent)
Build the tooltip help
|
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 |
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 |
Tabs.performFinalize(Object model,
LifecycleElement parent)
The following is performed:
If the active tab id is configured, set the active plugin option
|
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 |
Scrollpane.performFinalize(Object model,
LifecycleElement parent) |
void |
RichTable.performFinalize(Object model,
LifecycleElement parent)
The following initialization is performed:
Initializes component options for empty table message
|
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 |
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 |
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 |
Help.performFinalize(Object model,
LifecycleElement parent)
Finalize the help widget for usage
|
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.
|
Copyright © 2005–2018 The Kuali Foundation. All rights reserved.