| Modifier and Type | Method and Description |
|---|---|
void |
ValidationTrace.addBean(Component component)
Adds a UIF Component to the trace
|
static boolean |
Validator.checkExpressions(Component object,
String property)
Checks if a property of a Component is being set by expressions
|
boolean |
Validator.validate(Component object,
boolean failOnWarning)
Validates a UIF Component
|
boolean |
ValidationController.validate(Component object,
org.apache.commons.logging.Log log,
boolean failOnWarning)
Validates a Component with output going to Log4j
|
| 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 |
|---|---|
List<Component> |
LookupView.getCriteriaFields()
List of fields that will be rendered for the lookup criteria.
|
List<Component> |
LookupView.getResultFields()
List of fields that will be rendered for the result collection group, each field will be a column
(assuming table layout is used).
|
| Modifier and Type | Method and Description |
|---|---|
void |
LookupView.setCriteriaFields(List<Component> criteriaFields) |
void |
LookupView.setResultFields(List<Component> resultFields) |
| Modifier and Type | Interface and Description |
|---|---|
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 |
|---|---|
List<Component> |
PropertyReplacer.getNestedComponents()
Returns a list of nested components
|
List<Component> |
ComponentBase.getPropertyReplacerComponents()
Returns list of components that are being held in property replacers configured for this
component
|
List<Component> |
Component.getPropertyReplacerComponents()
List of components that are contained within the List of
PropertyReplacer in component |
| 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 |
|---|---|
protected List<? extends Component> |
CollectionGroupBuilder.getAddLineActionComponents(View view,
Object model,
CollectionGroup collectionGroup)
Creates new
Component instances for the add line |
List<? extends Component> |
CollectionGroupBase.getAddLineActions()
Component fields that should be rendered for the add line.
|
List<? extends Component> |
CollectionGroup.getAddLineActions()
Component fields that should be rendered for the add line.
|
List<? extends Component> |
CollectionGroupBase.getAddLineItems()
List of
Component instances that should be rendered for the
collection add line (if enabled). |
List<? extends Component> |
CollectionGroup.getAddLineItems()
List of
Component instances that should be rendered for the
collection add line (if enabled). |
List<Component> |
TreeGroup.getComponentPrototypes()
Gets all node components prototypes within the tree.
|
List<? extends Component> |
GroupBase.getItems()
List of Component instances that are held by
the container |
abstract List<? extends Component> |
ContainerBase.getItems()
List of Component instances that are held by
the container |
List<? extends Component> |
Container.getItems()
List of Component instances that are held by
the container |
List<? extends Component> |
CollectionGroupBase.getItems()
List of Component instances that are held by
the container |
List<? extends Component> |
CollectionGroupBase.getLineActions()
Action fields that should be rendered for each collection line.
|
List<? extends Component> |
CollectionGroup.getLineActions()
Action fields that should be rendered for each collection line.
|
List<Component> |
TreeGroup.getNodeComponents()
Gets all node components within the tree.
|
Set<Class<? extends Component>> |
TabNavigationGroup.getSupportedComponents()
Set of Component classes that may be placed
into the container |
Set<Class<? extends Component>> |
TabGroup.getSupportedComponents()
Only groups are supported for this group.
|
Set<Class<? extends Component>> |
GroupBase.getSupportedComponents()
Set of Component classes that may be placed
into the container |
Set<Class<? extends Component>> |
Container.getSupportedComponents()
Set of Component classes that may be placed
into the container |
Set<Class<? extends Component>> |
AccordionGroup.getSupportedComponents()
Only groups are supported for this group.
|
protected List<? extends Component> |
CollectionGroupBuilder.initializeLineActions(List<? extends Component> lineActions,
View view,
CollectionGroup collectionGroup,
Object collectionLine,
int lineIndex)
Creates new
Action instances for the line. |
protected List<? extends Component> |
CollectionGroupLineBuilder.initializeLineItems()
Copies either the collections groups items or add line items to a list of components that will be used
for the collection line.
|
| Modifier and Type | Method and Description |
|---|---|
protected Map<String,String> |
LightTable.buildExpressionMap(Component item,
Map<String,String> expressionMap)
Builds the expression map which contains "propertyName@@@id" and the expression.
|
protected String |
LightTable.handleDataFieldInRow(Component item,
Object obj,
String row,
int index,
String originalId)
Special handling of the DataField in the row, replaces necessary content with row specific content
|
protected String |
LightTable.handleInputFieldInRow(Component item,
Object obj,
String row,
int index,
String originalId)
Special handling of the InputField in the row, replaces necessary content with row specific content
|
void |
LightTable.processExpression(String name,
Component item,
Map<String,String> expressionMap,
List<String> toRemove)
Process the expression for the item by putting placeholder values in for String properties and adding markers
for render expressions to the component; adds the original expression to the expressionMap
|
protected void |
GroupBase.setNestedComponentId(Component component,
String newId)
Helper method for setting a new ID for the nested components
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
TreeGroup.addNodeComponents(Node<Group,Message> node,
List<Component> components)
Retrieves the
Component instances from the node for building the nested
components list |
protected void |
CollectionGroupLineBuilder.applyLineFieldAuthorizationAndPresentationLogic(boolean readOnlyLine,
List<Field> lineFields,
List<? extends Component> actionList)
Iterates through the line fields and checks the view field authorization using the view's configured authorizer
and presentation controller.
|
protected List<? extends Component> |
CollectionGroupBuilder.initializeLineActions(List<? extends Component> lineActions,
View view,
CollectionGroup collectionGroup,
Object collectionLine,
int lineIndex)
Creates new
Action instances for the line. |
List<Field> |
CollectionGroupLineBuilder.processAnyRemoteFieldsHolder(CollectionGroup group,
List<? extends Component> items)
Iterates through the given items checking for
RemotableFieldsHolder, if found
the holder is invoked to retrieved the remotable fields and translate to attribute fields. |
void |
CollectionGroupBase.setAddLineActions(List<? extends Component> addLineActions)
Setter for the add line action components fields
|
void |
CollectionGroup.setAddLineActions(List<? extends Component> addLineActions)
Setter for the add line action components fields
|
void |
CollectionGroupBase.setAddLineItems(List<? extends Component> addLineItems)
Setter for the add line field list
|
void |
CollectionGroup.setAddLineItems(List<? extends Component> addLineItems)
Setter for the add line field list
|
void |
GroupBase.setItems(List<? extends Component> items)
Setter for the containers list of components
|
abstract void |
ContainerBase.setItems(List<? extends Component> items)
Setter for the containers list of components
|
void |
Container.setItems(List<? extends Component> items)
Setter for the containers list of components
|
void |
CollectionGroupBase.setLineActions(List<? extends Component> lineActions)
Setter for the line action fields list
|
void |
CollectionGroup.setLineActions(List<? extends Component> lineActions)
Setter for the line action fields list
|
protected void |
CollectionGroupBase.setupLineActionValidationScripts(List<Component> components,
List<Component> actionComponents)
Helper method to set action validation script for every action component provided to validate every
input field component.
|
protected void |
CollectionGroupBase.setupLineActionValidationScripts(List<Component> components,
List<Component> actionComponents)
Helper method to set action validation script for every action component provided to validate every
input field component.
|
| Modifier and Type | Method and Description |
|---|---|
List<? extends Component> |
LineBuilderContext.getLineActions()
List of components to render in the lines action column.
|
| Modifier and Type | Method and Description |
|---|---|
void |
LineBuilderContext.setLineActions(List<? extends Component> lineActions) |
| Constructor and Description |
|---|
LineBuilderContext(int lineIndex,
Object currentLine,
String bindingPath,
boolean bindToForm,
ViewModel model,
CollectionGroup collectionGroup,
List<? extends Component> lineActions)
Constructor.
|
LineBuilderContext(int lineIndex,
Object currentLine,
String bindingPath,
boolean bindToForm,
ViewModel model,
CollectionGroup collectionGroup,
List<? extends Component> lineActions,
List<DialogGroup> lineDialogs)
Constructor.
|
| 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 |
|---|---|
List<Component> |
MultiValueControlBase.getInlineComponents()
Gets the inlineComponents which represent components that can be referenced in an option's value
by index
|
List<Component> |
CheckboxControl.getInlineComponents()
Gets the inlineComponents used by index in the checkboxLabel that has rich message component index tags
|
| Modifier and Type | Method and Description |
|---|---|
void |
MultiValueControlBase.setInlineComponents(List<Component> inlineComponents)
Sets the inlineComponents which represent components that can be referenced in an option's value
by index
|
void |
CheckboxControl.setInlineComponents(List<Component> inlineComponents)
Sets the inlineComponents used by index in the checkboxLabel that has rich message component index tags
|
| 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 |
|---|---|
Component |
BreadcrumbItem.getSiblingBreadcrumbComponent()
Set the breadcrumb component for this breadcrumbs sibling content/navigation.
|
| Modifier and Type | Method and Description |
|---|---|
List<Component> |
Message.getInlineComponents()
The inlineComponents are a list of components in order by index.
|
List<Component> |
Label.getInlineComponents()
Gets the inlineComponents used by index in a Label that has rich message component index tags in its labelText
|
List<Component> |
Header.getInlineComponents()
Gets the inlineComponents used by index in a Header that has rich message component index tags in its headerText
|
List<? extends Component> |
NavigationBar.getItems()
Convenience getter for the navigation group items.
|
List<? extends Component> |
Header.getItems()
List of
Component instances contained in the lower header group |
List<Component> |
ToggleMenu.getMenuItems()
List of components that should be rendered for the toggle menu.
|
List<Component> |
Message.getMessageComponentStructure()
The message component structure is a list of components which represent the components that make up a message
when using rich message functionality.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
ValidationMessages.addNestedGroupKeys(Collection<String> keyList,
Component component)
Adds all group keys of this component (starting from this component itself) by calling getKeys on each of
its nested group's ValidationMessages and adding them to the list.
|
protected void |
PageValidationMessages.addValidationMessageDataAttributes(Component parent)
Overridding to prevent the initial writing of data attributes until the view has been processed and
we collection unmatched messages (through the lifecycle event).
|
protected void |
GroupValidationMessages.addValidationMessageDataAttributes(Component parent)
Adds dataAttributes that are appropriate for group level validationMessages data.
|
void |
ValidationMessages.generateMessages(View view,
Object model,
Component parent)
Generates the messages based on the content in the messageMap
|
void |
PageValidationMessages.generateMessages(View view,
Object model,
Component parent)
Generates the messages based on the content in the messageMap
|
void |
GroupValidationMessages.generateMessages(View view,
Object model,
Component parent)
Generates the messages based on the content in the messageMap
|
void |
FieldValidationMessages.generateMessages(View view,
Object model,
Component parent)
Calls super and add dataAttributes that are appropriate for field level validationMessages
data.
|
protected List<String> |
ValidationMessages.getKeys(Component parent)
Gets all the keys associated to this ValidationMessages.
|
void |
BreadcrumbItem.setSiblingBreadcrumbComponent(Component siblingBreadcrumbComponent)
Set the sibling breadcrumb component
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
GroupValidationMessages.collectIdsFromItems(List<? extends Component> items,
List<String> sectionIds,
List<String> order,
boolean skipSections)
Collects all the ids from the items passed into this method.
|
void |
Message.setInlineComponents(List<Component> inlineComponents)
Set the inlineComponents to be filled in at indexes referenced by [n] in the message
|
void |
Label.setInlineComponents(List<Component> inlineComponents)
Sets the inlineComponents used by index in a Label that has rich message component index tags in its labelText
|
void |
Header.setInlineComponents(List<Component> inlineComponents)
Sets the inlineComponents used by index in a Header that has rich message component index tags in its headerText
|
void |
Header.setItems(List<? extends Component> items)
Setter for the lower group's items
|
void |
NavigationBar.setItems(List<Component> items)
Convenience setter that sets the given items onto the
NavigationBar.getNavigationBarGroup(). |
void |
ToggleMenu.setMenuItems(List<Component> menuItems) |
void |
Message.setMessageComponentStructure(List<Component> messageComponentStructure)
Set the message component structure.
|
| 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 |
|---|---|
List<Component> |
MessageField.getInlineComponents() |
List<? extends Component> |
FieldGroup.getItems()
List of
Component instances contained in the nested group |
List<Component> |
InputFieldBase.getPostInputAddons()
List of components that will be grouped with the input field control to form an input group.
|
List<Component> |
InputField.getPostInputAddons()
List of components that will be grouped with the input field control to form an input group.
|
| Modifier and Type | Method and Description |
|---|---|
void |
InputFieldBase.addPostInputAddon(Component addOn)
Adds a component to the list of post input addon components.
|
void |
InputField.addPostInputAddon(Component addOn)
Adds a component to the list of post input addon components.
|
protected void |
FieldBase.setNestedComponentIdAndSuffix(Component component,
String suffix)
Helper method for suffixing the ids of the fields nested components
|
| Modifier and Type | Method and Description |
|---|---|
void |
MessageField.setInlineComponents(List<Component> inlineComponents) |
void |
FieldGroup.setItems(List<? extends Component> items)
Setter for the field's nested group items
|
void |
InputFieldBase.setPostInputAddons(List<Component> postInputAddons) |
void |
InputField.setPostInputAddons(List<Component> postInputAddons) |
| Modifier and Type | Method and Description |
|---|---|
static void |
FreeMarkerInlineRenderUtils.renderAttrBuild(Component component,
Writer out)
Render common attributes for a KRAD component.
|
static void |
FreeMarkerInlineRenderUtils.renderOpenDiv(Component component,
Writer out)
Render an open div tag for a component.
|
static void |
FreeMarkerInlineRenderUtils.renderScript(String script,
Component component,
String role,
Writer out)
Render a KRAD script component.
|
static void |
FreeMarkerInlineRenderUtils.renderTemplate(freemarker.core.Environment env,
Component component,
String body,
boolean componentUpdate,
boolean includeSrc,
Map<String,freemarker.template.TemplateModel> tmplParms)
Render a KRAD component template inline.
|
static void |
FreeMarkerInlineRenderUtils.renderTooltip(Component component,
Writer out)
Render a KRAD tooltip component.
|
| Modifier and Type | Method and Description |
|---|---|
static void |
FreeMarkerInlineRenderUtils.renderStacked(freemarker.core.Environment env,
List<? extends Component> items,
StackedLayoutManager manager,
CollectionGroup container)
Render a stacked collection inline.
|
| Modifier and Type | Field and Description |
|---|---|
protected List<Component> |
CssGridLayoutManagerBase.cellItems |
| Modifier and Type | Method and Description |
|---|---|
List<Component> |
CssGridLayoutManagerBase.getCellItems()
Get the items which will make up each "cell" divs of this css grid layout, these divs will have appropriate
css class applied to them based on the values stored in cellCssClassAttributes
|
List<Component> |
TableLayoutManagerBase.getColumnCalculationComponents()
Gets a list of column calculation components.
|
List<Component> |
TableLayoutManager.getColumnCalculationComponents()
Gets a list of column calculation components.
|
List<Component> |
TableLayoutManagerBase.getFooterCalculationComponents()
Gets the footer calculation components to be used by the layout.
|
List<Component> |
TableLayoutManager.getFooterCalculationComponents()
Gets the footer calculation components to be used by the layout.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
CssGridLayoutManagerBase.calculateCssClassAndSize(Component item,
List<String> cellCssClasses,
CssGridSizes defaultSizes,
int basicSize)
Determines the css class(es) and based on what settings the item, defaultSizes and basicSize have
|
protected void |
CssGridLabelColumnLayoutManager.calculateCssClassAndSize(Component item,
List<String> cellCssClasses,
CssGridSizes defaultSizes,
int basicSize)
Override is used to calculates total field and label size in addition to calculateCssClassAndSize functionality
|
protected void |
TableLayoutManagerBase.setCellAttributes(Component component)
Moves the width, align, and valign settings of the component to the corresponding cell properties (if not
already configured)
|
protected void |
GridLayoutManagerBase.setCellAttributes(Component component)
Moves the width, align, and valign settings of the component to the corresponding cell properties (if not
already configured)
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
TableLayoutManagerBase.addActionColumn(CollectionGroup collectionGroup,
String idSuffix,
Object currentLine,
int lineIndex,
int rowSpan,
List<? extends Component> actions)
Creates a field group wrapper for the given actions based on
TableLayoutManagerBase.getActionFieldPrototype(). |
protected void |
StackedLayoutManagerBase.determineLineActionPlacement(Group lineGroup,
CollectionGroup collectionGroup,
LineBuilderContext lineBuilderContext,
List<Component> groupFields)
Places actions in the appropriate location for the stacked group line based on placement
flags set on this layout manager
|
protected void |
TableLayoutManagerBase.setFooterCalculationComponents(List<Component> footerCalculationComponents)
Set footer calculation components
|
| Modifier and Type | Method and Description |
|---|---|
Component |
ViewLifecycle.EventRegistration.getEventComponent()
Component instance the event should occur for/on.
|
Component |
ViewLifecyclePhaseBase.getParent()
Retrieves the component that is a parent to the element being processed in the
view three.
|
Component |
ViewLifecyclePhase.getParent()
Retrieves the component that is a parent to the element being processed in the
view three.
|
static Component |
ViewLifecycle.performComponentLifecycle(View view,
Object model,
javax.servlet.http.HttpServletRequest request,
ViewPostMetadata viewPostMetadata,
String componentId)
Performs a lifecycle process to rebuild the component given by the update id.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ViewPostMetadata.addComponentPostData(Component component,
String key,
Object value)
Adds post data for the given component (this is a convenience method for add component post metadata).
|
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.
|
ComponentPostMetadata |
ViewPostMetadata.initializeComponentPostMetadata(Component component)
Initializes a component post metadata instance for the given component.
|
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.
|
static boolean |
ViewLifecycleUtils.isExcluded(Component component)
Determines if a component should be excluded from the current lifecycle.
|
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 |
ViewLifecycle.registerLifecycleCompleteListener(Component eventComponent,
LifecycleEventListener listenerComponent)
Registers the given component as a listener for the lifecycle complete event for the given
event component.
|
void |
ViewLifecycle.EventRegistration.setEventComponent(Component eventComponent)
Sets the component.
|
| Modifier and Type | Class and Description |
|---|---|
class |
MockView
View class for developing UI mocks.
|
| Modifier and Type | Method and Description |
|---|---|
Component |
ComponentConvertModifier.getComponentReplacementPrototype()
Prototype for the component replacement
|
| Modifier and Type | Method and Description |
|---|---|
List<Component> |
ComponentModifierBase.getComponentPrototypes() |
List<Component> |
ComponentModifier.getComponentPrototypes()
List of components that are maintained by the modifier as prototypes for creating other component instances
|
List<Component> |
ComponentConvertModifier.getComponentPrototypes() |
List<Component> |
CompareFieldCreateModifier.getComponentPrototypes() |
Class<? extends Component> |
ComponentConvertModifier.getComponentTypeToReplace()
Type of component that should be replaced with an instance of the
component prototype
|
Set<Class<? extends Component>> |
LabelSeparateModifier.getSupportedComponents()
Set of Component classes that may be sent to
the modifier |
Set<Class<? extends Component>> |
ComponentModifier.getSupportedComponents()
Set of Component classes that may be sent to
the modifier |
Set<Class<? extends Component>> |
ComponentConvertModifier.getSupportedComponents()
Set of Component classes that may be sent to
the modifier |
Set<Class<? extends Component>> |
CompareFieldCreateModifier.getSupportedComponents()
Set of Component classes that may be sent to
the modifier |
| Modifier and Type | Method and Description |
|---|---|
protected void |
ComponentConvertModifier.convertToReplacement(Component component,
int idSuffix)
Reads the component properties and looks for types that match the
configured type to replace.
|
protected void |
ComponentConvertModifier.performConversion(Component component,
String componentProperty,
int idSuffix)
Creates a new instance of the replacement component prototype and sets a
the property value for the given property name and component instance
|
void |
ComponentModifierBase.performInitialization(Object model,
Component component)
Default performInitialization impl (does nothing)
Should be called to initialize the ComponentModifier
|
void |
ComponentModifier.performInitialization(Object model,
Component component)
Should be called to initialize the ComponentModifier
|
void |
CompareFieldCreateModifier.performInitialization(Object model,
Component component)
Default performInitialization impl (does nothing)
Should be called to initialize the ComponentModifier
|
void |
LabelSeparateModifier.performModification(Object model,
Component component)
Iterates through the
Group items and if the label field is
not null and should be rendered, adds it to the new field list
immediately before the Field item the label applies to. |
void |
ComponentModifier.performModification(Object model,
Component component)
Invoked within the configured phase of the component lifecycle.
|
void |
ComponentConvertModifier.performModification(Object model,
Component component)
Invoked within the configured phase of the component lifecycle.
|
void |
CompareFieldCreateModifier.performModification(Object model,
Component component)
Generates the comparison fields
|
protected boolean |
CompareFieldCreateModifier.performValueComparison(Group group,
Component compareItem,
Object model,
String compareValueObjectBindingPath)
For each attribute field in the compare item, retrieves the field value and compares against the value for the
main comparable.
|
void |
ComponentConvertModifier.setComponentReplacementPrototype(Component componentReplacementPrototype)
Setter for the replacement component prototype
|
| Modifier and Type | Method and Description |
|---|---|
void |
ComponentConvertModifier.setComponentTypeToReplace(Class<? extends Component> componentTypeToReplace)
Setter for the component type to replace
|
| Modifier and Type | Method and Description |
|---|---|
void |
ViewHelperService.applyDefaultValues(Component component)
Iterates through the view components picking up data fields and applying an default value
configured
|
| Modifier and Type | Method and Description |
|---|---|
void |
ViewHelperServiceImpl.applyDefaultValues(Component component)
Iterates through the view components picking up data fields and applying an default value
configured
|
| Modifier and Type | Method and Description |
|---|---|
static <T extends Component> |
ComponentUtils.copy(List<T> components)
Copy a list of components
|
static <T extends Component> |
ComponentUtils.copy(T component) |
static <T extends Component> |
ComponentUtils.copy(T component,
String idSuffix) |
static <T extends Component> |
ComponentUtils.copyComponent(T component,
String addBindingPrefix,
String idSuffix) |
static <T extends Component> |
ComponentUtils.copyComponentList(List<T> components,
String idSuffix) |
static <T extends Component> |
ComponentUtils.getNestedContainerComponents(Container container,
Class<T> componentType)
Gets all components of the give type that are within the items list of the container, or within a nested
container or field group.
|
static <T extends Component> |
ComponentUtils.getNestedNonCollectionComponents(Container container,
Class<T> componentType) |
static <T extends Component> |
ComponentUtils.getNestedNonCollectionComponents(List<Component> items,
Class<T> componentType) |
static <T extends Component> |
ComponentUtils.setComponentsPropertyDeep(List<T> components,
String propertyPath,
Object propertyValue)
Traverse a component tree, setting a property on all components for which the property is writable.
|
| Modifier and Type | Method and Description |
|---|---|
static Component |
ComponentUtils.findComponentInList(List<Component> components,
String componentId)
Searches for the component with the given id within the given list of components
|
static Component |
ComponentFactory.getNewComponentInstance(String beanId)
Returns a new
Component instance for the given bean id from the spring factory. |
static Component |
ComponentFactory.getNewInstanceForRefresh(ViewPostMetadata viewPostMetadata,
String id)
Returns a new
Component instance for the given bean id from the spring factory. |
| Modifier and Type | Method and Description |
|---|---|
static List<Component> |
ComponentUtils.getAllNestedComponents(Component component)
Get all nested children of a given component.
|
static List<Component> |
MessageStructureUtils.parseMessage(String messageId,
String messageText,
List<Component> componentList,
View view,
boolean parseComponents)
Parses the message text passed in and returns the resulting rich message component structure.
|
| Modifier and Type | Method and Description |
|---|---|
static boolean |
ComponentUtils.canBeRefreshed(Component component)
Indicates if the given component has configuration that it allows it to be refreshed.
|
static boolean |
ComponentUtils.containsPropertyExpression(Component component,
String propertyName,
boolean collectionMatch)
Determines whether the given component contains an expression for the given property name
|
static List<Component> |
ComponentUtils.getAllNestedComponents(Component component)
Get all nested children of a given component.
|
static void |
ComponentUtils.prefixBindingPath(Component component,
String addBindingPrefix) |
static void |
ComponentUtils.prefixBindingPathNested(Component component,
String addBindingPrefix) |
static void |
ComponentUtils.pushAllToContext(Component component,
Map<String,Object> sourceContext)
pushes object to a component's context so that it is available from
getContext() |
static void |
ContextUtils.pushAllToContextDeep(Component component,
Map<String,Object> sourceContext)
Pushes object to a component's context so that it is available from
getContext() |
static void |
ComponentUtils.pushObjectToContext(Component component,
String contextName,
Object contextValue)
pushes object to a component's context so that it is available from
getContext() |
static void |
ContextUtils.pushObjectToContextDeep(Component component,
String contextName,
Object contextValue)
Pushes object to a component's context so that it is available from
getContext() |
static void |
ComponentUtils.setComponentPropertyDeep(Component component,
String propertyPath,
Object propertyValue)
Traverse a component tree, setting a property on all components for which the property is writable.
|
static void |
ComponentUtils.setComponentPropertyFinal(Component component,
String propertyName,
Object propertyValue)
Sets a property on the given component and removes any expressions for that property so the value is not
overridden
|
static void |
ComponentUtils.updateChildIdsWithSuffixNested(Component component,
String idSuffix) |
static void |
ContextUtils.updateContextForLine(Component component,
CollectionGroup collectionGroup,
Object collectionLine,
int lineIndex,
String lineSuffix)
Update the context map for the given component with the collection context.
|
static void |
ComponentUtils.updateContextForLine(Component component,
CollectionGroup collectionGroup,
Object collectionLine,
int lineIndex,
String lineSuffix)
update the context map for the given component
|
static void |
ComponentUtils.updateIdsWithSuffixNested(Component component,
String idSuffix) |
| Modifier and Type | Method and Description |
|---|---|
static void |
ComponentUtils.clearAndAssignIds(List<? extends Component> components)
Replace all IDs from a component and its children with new generated ID values.
|
static Component |
ComponentUtils.findComponentInList(List<Component> components,
String componentId)
Searches for the component with the given id within the given list of components
|
static <T> List<T> |
ComponentUtils.getComponentsOfType(List<? extends Component> items,
Class<T> componentType) |
static <T extends Component> |
ComponentUtils.getNestedNonCollectionComponents(List<Component> items,
Class<T> componentType) |
static List<Component> |
MessageStructureUtils.parseMessage(String messageId,
String messageText,
List<Component> componentList,
View view,
boolean parseComponents)
Parses the message text passed in and returns the resulting rich message component structure.
|
static void |
ComponentUtils.prefixBindingPath(List<? extends Component> components,
String addBindingPrefix) |
static void |
ComponentUtils.pushAllToContext(List<? extends Component> components,
Map<String,Object> sourceContext)
places a all entries from a map into each context map of a list of components
|
static void |
ContextUtils.pushAllToContextDeep(List<? extends Component> components,
Map<String,Object> sourceContext)
Places a all entries from a map into each context map of a list of components.
|
static void |
ContextUtils.updateContextsForLine(List<? extends Component> components,
CollectionGroup collectionGroup,
Object collectionLine,
int lineIndex,
String lineSuffix)
Update the contexts of the given components.
|
static void |
ComponentUtils.updateContextsForLine(List<? extends Component> components,
CollectionGroup collectionGroup,
Object collectionLine,
int lineIndex,
String lineSuffix)
Update the contexts of the given components.
|
static void |
ComponentUtils.updateIdsWithSuffixNested(List<? extends Component> components,
String idSuffix) |
| 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 |
|---|---|
Component |
ViewIndex.getComponentById(String id)
Retrieves a
Component from the view index by Id |
Component |
ViewModel.getUpdateComponent()
Component instance that been built for a refresh/disclosure request.
|
| Modifier and Type | Method and Description |
|---|---|
List<? extends Component> |
View.getItems()
List of Component instances that are held by
the container |
List<Component> |
View.getPagesForPreprocessing()
Getter for returning the view's items and page for inclusion in the pre-process phase.
|
Set<Class<? extends Component>> |
View.getSupportedComponents()
Set of Component classes that may be placed
into the container |
| Modifier and Type | Method and Description |
|---|---|
protected static String |
DefaultExpressionEvaluator.getLinePathPrefixValue(Component component)
Determines the value for the
UifConstants.LINE_PATH_BIND_ADJUST_PREFIX binding prefix
based on collection group found in the component context |
void |
ViewIndex.indexComponent(Component component)
Adds an entry to the main index for the given component.
|
protected boolean |
ViewAuthorizerBase.isAuthorizedByTemplate(View view,
Component component,
ViewModel model,
String permissionTemplateName,
Person user,
Map<String,String> additionalPermissionDetails,
Map<String,String> additionalRoleQualifications,
boolean checkPermissionExistence)
Performs a permission check for the given template name in the context of the given view and component
|
protected void |
View.setNestedComponentId(Component component,
String newId)
Helper method for setting a new ID for the nested components
|
void |
ViewModel.setUpdateComponent(Component updateComponent) |
| Modifier and Type | Method and Description |
|---|---|
void |
View.setItems(List<? extends Component> items)
Setter for the containers list of components
|
| 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 |
|---|---|
static void |
KRADUtils.syncClientSideStateForComponent(Component component,
Map<String,Object> clientSideState)
Updates the properties of the given component instance with the value found from the
corresponding map of client state (if found)
|
| Modifier and Type | Method and Description |
|---|---|
Component |
UifFormBase.getUpdateComponent() |
| Modifier and Type | Method and Description |
|---|---|
void |
UifFormBase.setUpdateComponent(Component updateComponent) |
Copyright © 2005–2018 The Kuali Foundation. All rights reserved.