Uses of Interface
org.kuali.rice.krad.uif.component.Component

Packages that use Component

org.kuali.rice.krad.uif.component
org.kuali.rice.krad.uif.container
org.kuali.rice.krad.uif.control
org.kuali.rice.krad.uif.field
org.kuali.rice.krad.uif.layout
org.kuali.rice.krad.uif.modifier
org.kuali.rice.krad.uif.service
org.kuali.rice.krad.uif.service.impl
org.kuali.rice.krad.uif.util
org.kuali.rice.krad.uif.view
org.kuali.rice.krad.uif.widget

Uses of Component in org.kuali.rice.krad.uif.component

Classes in org.kuali.rice.krad.uif.component that implement Component

class

ComponentBase Base implementation of Component which other component implementations should extend

Methods in org.kuali.rice.krad.uif.component that return types with arguments of type Component

List<Component>	ComponentBase.getComponentPrototypes()
List<Component>	Component.getComponentPrototypes() List of components that are maintained by the component as prototypes for creating other component instances
List<Component>	ComponentBase.getComponentsForLifecycle()
List<Component>	Component.getComponentsForLifecycle() List of components that are contained within the component and should be sent through the lifecycle
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

Methods in org.kuali.rice.krad.uif.component with parameters of type Component

void	ComponentBase.performApplyModel(View view, Object model, Component parent) The following updates are done here:
void	Component.performApplyModel(View view, Object model, Component parent) Called after the initialize phase to perform conditional logic based on the model data
void	ComponentBase.performFinalize(View view, Object model, Component parent) The following finalization is done here: If any of the style properties were given, sets the style string on the style property Setup the decorator chain (if component has decorators) for rendering Set the skipInTabOrder flag for nested components
void	Component.performFinalize(View view, Object model, Component parent) The last phase before the view is rendered.

Uses of Component in org.kuali.rice.krad.uif.container

Subinterfaces of Component in org.kuali.rice.krad.uif.container

interface

Container Type of component that contains a collection of other components.

Classes in org.kuali.rice.krad.uif.container that implement Component

class	CollectionGroup 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	Group Container that holds a list of Field or other Group instances
class	LinkGroup Special Group that presents a grouping on links, which can also include nested groupings of links
class	NavigationGroup Special Group that renders a navigation section
class	PageGroup
class	TabGroup A group that presents its child Groups as tabs.
class	TreeGroup Group component that is backed by a Tree data structure and typically rendered as a tree in the user interface

Methods in org.kuali.rice.krad.uif.container that return types with arguments of type Component

List<Component>	CollectionGroup.getComponentPrototypes()
List<Component>	ContainerBase.getComponentPrototypes()
List<Component>	TreeGroup.getComponentPrototypes()
List<Component>	CollectionGroup.getComponentsForLifecycle()
List<Component>	Group.getComponentsForLifecycle()
List<Component>	TabGroup.getComponentsForLifecycle()
List<Component>	ContainerBase.getComponentsForLifecycle()
List<Component>	TreeGroup.getComponentsForLifecycle()
List<? extends Component>	Group.getItems()
abstract List<? extends Component>	ContainerBase.getItems()
List<? extends Component>	Container.getItems() List of Component instances that are held by the container
Set<Class<? extends Component>>	Group.getSupportedComponents()
Set<Class<? extends Component>>	NavigationGroup.getSupportedComponents()
Set<Class<? extends Component>>	TabGroup.getSupportedComponents() Only groups are supported for this group.
Set<Class<? extends Component>>	Container.getSupportedComponents() Set of Component classes that may be placed into the container

Methods in org.kuali.rice.krad.uif.container with parameters of type Component

void	CollectionGroup.performApplyModel(View view, Object model, Component parent) Calls the configured CollectionGroupBuilder to build the necessary components based on the collection data
void	ContainerBase.performApplyModel(View view, Object model, Component parent)
void	TreeGroup.performApplyModel(View view, Object model, Component parent)
void	PageGroup.performFinalize(View view, Object model, Component parent) Perform finalize here adds to its document ready script the setupValidator js function for setting up the validator for this view.
void	ContainerBase.performFinalize(View view, Object model, Component parent) The following finalization is performed: Sets the headerText of the header Group if it is blank Set the messageText of the summary MessageField if it is blank Finalizes LayoutManager

Method parameters in org.kuali.rice.krad.uif.container with type arguments of type Component

protected void	TreeGroup.addNodeComponents(Node<Group,MessageField> node, List<Component> components) Retrieves the Component instances from the node for building the nested components list
void	Group.setItems(List<? extends Component> items) Setter for the Group's 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

Uses of Component in org.kuali.rice.krad.uif.control

Subinterfaces of Component in org.kuali.rice.krad.uif.control

interface

Control Represents an interactive element in the UI (typically an HTML control)

Classes in org.kuali.rice.krad.uif.control that implement Component

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	RadioGroupControl Represents a group of HTML Radio controls.
class	SelectControl Represents a HTML Select control.
class	TextAreaControl Represents a HTML TextArea control.
class	TextControl 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

Methods in org.kuali.rice.krad.uif.control that return types with arguments of type Component

List<Component>

TextControl.getComponentsForLifecycle()

Methods in org.kuali.rice.krad.uif.control with parameters of type Component

void	UserControl.performApplyModel(View view, Object model, Component parent)
void	GroupControl.performApplyModel(View view, Object model, Component parent)
void	TextControl.performFinalize(View view, Object model, Component parent) The following actions are performed: Defaults maxLength, minLength (if not set) to maxLength of parent field
void	TextAreaControl.performFinalize(View view, Object model, Component parent) The following actions are performed: Defaults maxLength, minLength (if not set) to maxLength of parent field

Uses of Component in org.kuali.rice.krad.uif.field

Subinterfaces of Component in org.kuali.rice.krad.uif.field

interface

Field Component that contains one or more user interface elements and can be placed into a Container

Classes in org.kuali.rice.krad.uif.field that implement Component

class	ActionField Field that presents an action that can be taken on the UI such as submitting the form or invoking a script
class	AjaxActionField Action field that performs an Ajax request and will result in updating of the page or a component
class	BlankField Field that produces only a space
class	DataField Field that renders data from the application, such as the value of a data object property
class	ErrorsField Field that displays error, warning, and info messages for the keys that are matched.
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	HeaderField Field that contains a header element and optionally a Group to present along with the header text
class	IframeField Field that encloses an iframe element
class	ImageField Field that encloses an image element
class	InputField Field that encapsulates data input/output captured by an attribute within the application
class	LabelField Contains a label for another Field instance
class	LinkField Field that encloses a link element
class	LookupInputField Custom InputField for search fields within a lookup view
class	MessageField Encapsulates a text message to be displayed
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

Methods in org.kuali.rice.krad.uif.field that return types with arguments of type Component

List<Component>	DataField.getComponentsForLifecycle()
List<Component>	ActionField.getComponentsForLifecycle()
List<Component>	LabelField.getComponentsForLifecycle()
List<Component>	InputField.getComponentsForLifecycle()
List<Component>	FieldGroup.getComponentsForLifecycle()
List<Component>	FieldBase.getComponentsForLifecycle()
List<? extends Component>	FieldGroup.getItems() List of Component instances contained in the nested group

Methods in org.kuali.rice.krad.uif.field with parameters of type Component

protected List<String>	ErrorsField.getKeys(Component parent) Gets all the keys associated to this ErrorsField.
void	DataField.performApplyModel(View view, Object model, Component parent) The following updates are done here: If readOnlyHidden set to true, set field to readonly and add to hidden property names
void	DataField.performFinalize(View view, Object model, Component parent) The following actions are performed: Set the ids for the various attribute components Sets up the client side validation for constraints on this field.
void	ActionField.performFinalize(View view, Object model, Component parent) The following finalization is performed: Add methodToCall action parameter if set and setup event code for setting action parameters
void	ImageField.performFinalize(View view, Object model, Component parent)
void	LabelField.performFinalize(View view, Object model, Component parent) The following finalization is performed: If label text is blank, set render to false for field
void	ErrorsField.performFinalize(View view, Object model, Component parent) PerformFinalize will generate the messages and counts used by the errorsField based on the keys that were matched from the MessageMap for this ErrorsField.
void	InputField.performFinalize(View view, Object model, Component parent) The following actions are performed: Set the ids for the various attribute components Sets up the client side validation for constraints on this field.
void	AjaxActionField.performFinalize(View view, Object model, Component parent) The following finalization is performed: Add methodToCall action parameter if set and setup event code for setting action parameters
void	FieldBase.performFinalize(View view, Object model, Component 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 If label placement is right, set render colon to false

Method parameters in org.kuali.rice.krad.uif.field with type arguments of type Component

void	FieldGroup.setItems(List<? extends Component> items) Setter for the field's nested group items

Uses of Component in org.kuali.rice.krad.uif.layout

Methods in org.kuali.rice.krad.uif.layout that return types with arguments of type Component

List<Component>	LayoutManagerBase.getComponentPrototypes()
List<Component>	TableLayoutManager.getComponentPrototypes()
List<Component>	LayoutManager.getComponentPrototypes() List of components that are maintained by the layout manager as prototypes for creating other component instances
List<Component>	StackedLayoutManager.getComponentPrototypes()
List<Component>	LayoutManagerBase.getComponentsForLifecycle()
List<Component>	TableLayoutManager.getComponentsForLifecycle()
List<Component>	LayoutManager.getComponentsForLifecycle() List of components that are contained within the layout manager that should be sent through the lifecycle
List<Component>	StackedLayoutManager.getComponentsForLifecycle()

Uses of Component in org.kuali.rice.krad.uif.modifier

Methods in org.kuali.rice.krad.uif.modifier that return Component

Component

ComponentConvertModifier.getComponentReplacementPrototype() Prototype for the component replacement

Methods in org.kuali.rice.krad.uif.modifier that return types with arguments of type Component

List<Component>	CompareFieldCreateModifier.getComponentPrototypes()
List<Component>	ComponentConvertModifier.getComponentPrototypes()
List<Component>	ComponentModifier.getComponentPrototypes() List of components that are maintained by the modifier as prototypes for creating other component instances
List<Component>	ComponentModifierBase.getComponentPrototypes()
Class<? extends Component>	ComponentConvertModifier.getComponentTypeToReplace() Type of component that should be replaced with an instance of the component prototype
Set<Class<? extends Component>>	CompareFieldCreateModifier.getSupportedComponents()
Set<Class<? extends Component>>	ComponentConvertModifier.getSupportedComponents()
Set<Class<? extends Component>>	ComponentModifier.getSupportedComponents() Set of Component classes that may be sent to the modifier
Set<Class<? extends Component>>	LabelFieldSeparateModifier.getSupportedComponents()

Methods in org.kuali.rice.krad.uif.modifier with parameters of type Component

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	CompareFieldCreateModifier.performInitialization(View view, Object model, Component component) Calls ViewHelperService to initialize the header field prototype
void	ComponentModifier.performInitialization(View view, Object model, Component component) Should be called to initialize the ComponentModifier
void	ComponentModifierBase.performInitialization(View view, Object model, Component component) Default performInitialization impl (does nothing)
void	CompareFieldCreateModifier.performModification(View view, Object model, Component component) Generates the comparison fields
void	ComponentConvertModifier.performModification(View view, Object model, Component component)
void	ComponentModifier.performModification(View view, Object model, Component component) Invoked within the configured phase of the component lifecycle.
void	LabelFieldSeparateModifier.performModification(View view, 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.
protected void	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

Method parameters in org.kuali.rice.krad.uif.modifier with type arguments of type Component

void	ComponentConvertModifier.setComponentTypeToReplace(Class<? extends Component> componentTypeToReplace) Setter for the component type to replace

Uses of Component in org.kuali.rice.krad.uif.service

Methods in org.kuali.rice.krad.uif.service with parameters of type Component

void	ViewHelperService.performComponentInitialization(View view, Object model, Component component) Performs the Initialization phase for the given Component
void	ViewHelperService.performComponentLifecycle(View view, Object model, Component component, String origId) Performs the complete component lifecycle on the component passed in for use during a refresh process

Uses of Component in org.kuali.rice.krad.uif.service.impl

Methods in org.kuali.rice.krad.uif.service.impl with parameters of type Component

protected void	ViewHelperServiceImpl.addClientSideStateForComponent(Component component, Map<String,Object> clientSideState) Reflects the class for the given component to find any fields that are annotated with ClientSideState and adds the corresponding property name/value pair to the client side state map
protected Map<String,Object>	ViewHelperServiceImpl.getCommonContext(View view, Component component) Gets global objects for the context map and pushes them to the context for the component
protected void	ViewHelperServiceImpl.invokeMethodFinalizer(View view, Component component, Object model) Invokes the finalize method for the component (if configured) and sets the render output for the component to the returned method string (if method is not a void type)
protected void	ViewHelperServiceImpl.performComponentApplyModel(View view, Component component, Object model) Applies the model data to a component of the View instance
protected void	ViewHelperServiceImpl.performComponentFinalize(View view, Component component, Object model, Component parent, Map<String,Object> clientSideState) Update state of the given component and does final preparation for rendering
void	ViewHelperServiceImpl.performComponentInitialization(View view, Object model, Component component) Performs initialization of a component by these steps: If component id not set, assigns to next available int for view For InputField instances, set defaults from the data dictionary. Invoke the initialize method on the component.
void	ViewHelperServiceImpl.performComponentLifecycle(View view, Object model, Component component, String origId) Performs the complete component lifecycle on the component passed in, in this order: performComponentInitialization, performComponentApplyModel, and performComponentFinalize.
protected void	ViewHelperServiceImpl.performCustomApplyModel(View view, Component component, Object model) Hook for service overrides to perform custom apply model logic on the component
protected void	ViewHelperServiceImpl.performCustomFinalize(View view, Component component, Object model, Component parent) Hook for service overrides to perform custom component finalization
protected void	ViewHelperServiceImpl.performCustomInitialization(View view, Component component) Hook for service overrides to perform custom initialization on the component
protected void	ViewHelperServiceImpl.runComponentModifiers(View view, Component component, Object model, String runPhase) Runs any configured ComponentModifiers for the given component that match the given run phase and who run condition evaluation succeeds
protected void	ViewHelperServiceImpl.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)

Uses of Component in org.kuali.rice.krad.uif.util

Methods in org.kuali.rice.krad.uif.util with type parameters of type Component

static <T extends Component> T	ComponentUtils.copy(T component)
static <T extends Component> T	ComponentUtils.copy(T component, String idSuffix)
static <T extends Component> T	ComponentUtils.copyComponent(T component, String addBindingPrefix, String idSuffix)
static <T extends Component> List<T>	ComponentUtils.copyComponentList(List<T> components, String idSuffix)
static <T extends Component> List<T>	ComponentUtils.getComponentsOfType(List<? extends Component> items, Class<T> componentType)
static <T extends Component> List<T>	ComponentUtils.getComponentsOfTypeDeep(Component component, Class<T> componentType)
static <T extends Component> List<T>	ComponentUtils.getComponentsOfTypeDeep(List<? extends Component> items, Class<T> componentType)

Methods in org.kuali.rice.krad.uif.util that return Component

static Component	ComponentFactory.getNewComponentInstance(String beanId) Returns a new Component instance for the given bean id from the spring factory
static Component	ComponentFactory.getNewInstanceForRefresh(View view, String id) Gets a fresh copy of the component by the id passed in which used to look up the component in the view index, then retrieve a new instance with initial state configured using the factory id

Methods in org.kuali.rice.krad.uif.util that return types with arguments of type Component

static List<Component>

ComponentUtils.getAllNestedComponents(Component component)

Methods in org.kuali.rice.krad.uif.util with parameters of type Component

static List<Component>	ComponentUtils.getAllNestedComponents(Component component)
static org.springframework.web.servlet.ModelAndView	UifWebUtils.getComponentModelAndView(Component component, Object model)
static <T extends Component> List<T>	ComponentUtils.getComponentsOfTypeDeep(Component component, Class<T> componentType)
static String	ComponentUtils.getLinePathValue(Component component)
static void	ComponentUtils.prefixBindingPathNested(Component component, String addBindingPrefix)
static void	ComponentUtils.pushObjectToContext(Component component, String contextName, Object contextValue)
static void	ComponentUtils.setComponentPropertyDeep(Component component, String propertyPath, Object propertyValue)
static void	ComponentUtils.updateContextForLine(Component component, Object collectionLine, int lineIndex)
static void	ComponentUtils.updateIdsWithSuffix(Component component, String idSuffix)
static void	ComponentUtils.updateIdsWithSuffixNested(Component component, String idSuffix)

Method parameters in org.kuali.rice.krad.uif.util with type arguments of type Component

static List<String>	ComponentUtils.getComponentPropertyNames(Class<? extends Component> componentClass)
static <T extends Component> List<T>	ComponentUtils.getComponentsOfType(List<? extends Component> items, Class<T> componentType)
static <T extends Component> List<T>	ComponentUtils.getComponentsOfTypeDeep(List<? extends Component> items, Class<T> componentType)
static void	ComponentUtils.pushObjectToContext(List<? extends Component> components, String contextName, Object contextValue)
static void	ComponentUtils.setComponentsPropertyDeep(List<? extends Component> components, String propertyPath, Object propertyValue)
static void	ComponentUtils.updateContextsForLine(List<? extends Component> components, Object collectionLine, int lineIndex)
static void	ComponentUtils.updateIdsWithSuffixNested(List<? extends Component> components, String idSuffix)

Uses of Component in org.kuali.rice.krad.uif.view

Classes in org.kuali.rice.krad.uif.view that implement Component

class	DocumentView View type for KRAD documents
class	FormView Provides configuration for View instances that render an HTML form
class	InquiryView Type of View that provides a read-only display of a record of data (object instance)
class	LookupView View type for Maintenance documents
class	MaintenanceView View type for Maintenance 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.

Methods in org.kuali.rice.krad.uif.view that return Component

Component

ViewIndex.getComponentById(String id) Retrieves a Component from the view index by Id

Methods in org.kuali.rice.krad.uif.view that return types with arguments of type Component

List<Component>	View.getComponentPrototypes()
List<Component>	LookupView.getComponentPrototypes()
List<Component>	View.getComponentsForLifecycle()
List<Component>	LookupView.getCriteriaFields()
Map<String,Component>	ViewIndex.getInitialComponentStates() Preserves initial state of components needed for doing component refreshes
List<Component>	LookupView.getResultFields()
Set<Class<? extends Component>>	View.getSupportedComponents()

Methods in org.kuali.rice.krad.uif.view with parameters of type Component

void	ViewIndex.addInitialComponentState(Component component) Adds a copy of the given component instance to the map of initial component states keyed by the component factory id
void	View.assignComponentIds(Component component) Assigns an id to the component if one was not configured
void	ViewIndex.indexComponent(Component component) Adds an entry to the main index for the given component.
void	LookupView.performApplyModel(View view, Object model, Component parent)
void	View.performFinalize(View view, Object model, Component parent) The following is performed: Adds to its document ready script the setupValidator js function for setting up the validator for this view

Method parameters in org.kuali.rice.krad.uif.view with type arguments of type Component

void	LookupView.setCriteriaFields(List<Component> criteriaFields)
void	ViewIndex.setInitialComponentStates(Map<String,Component> initialComponentStates) Setter for the map holding initial component states
void	View.setItems(List<? extends Component> items) Setter for the view's Group instances
void	LookupView.setResultFields(List<Component> resultFields)

Uses of Component in org.kuali.rice.krad.uif.widget

Subinterfaces of Component in org.kuali.rice.krad.uif.widget

interface

Widget Components that provide a user interface function (besides the basic form handing) should implement the widget interface

Classes in org.kuali.rice.krad.uif.widget that implement Component

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	DirectInquiry Widget for rendering an Direct Inquiry link icon next to a input field
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 Some basic options of the plugin are exposed through this class, however additional options can be passed through setComponentOptions as usual.
class	Help This is a description of what this class does - jkneal don't forget to fill this in.
class	Inquiry Widget for rendering an Inquiry link on a field's value
class	LightBox Used for rendering a lightbox in the UI to display action links in dialog popups
class	LightBoxLookup Used for rendering a lightbox in the UI to display the result of a submit in a light box.
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	Suggest Widget that provides dynamic select options to the user as they are entering the value (also known as auto-complete)
class	Tabs Widget used for configuring tab options, use componentOptions for most options.
class	Tree Widget component for rendering a Tree
class	WidgetBase Base class for Widgets

Methods in org.kuali.rice.krad.uif.widget that return types with arguments of type Component

List<Component>	QuickFinder.getComponentsForLifecycle()
List<Component>	Inquiry.getComponentsForLifecycle()
List<Component>	DirectInquiry.getComponentsForLifecycle()

Methods in org.kuali.rice.krad.uif.widget with parameters of type Component

void	BreadCrumbs.performApplyModel(View view, Object model, Component parent) The following updates are done here: Evaluate expression on howeward path list
void	QuickFinder.performFinalize(View view, Object model, Component parent) The following finalization is performed: Sets defaults on collectionLookup such as collectionName, and the class if not set
void	Inquiry.performFinalize(View view, Object model, Component parent)
void	RichTable.performFinalize(View view, Object model, Component component) The following initialization is performed: Initializes component options for empty table message
void	Suggest.performFinalize(View view, Object model, Component 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
void	DirectInquiry.performFinalize(View view, Object model, Component parent)