org.kuali.rice.krad.uif.container
Class TreeGroup

java.lang.Object
  org.kuali.rice.krad.uif.component.ConfigurableBase
      org.kuali.rice.krad.uif.component.ComponentBase
          org.kuali.rice.krad.uif.container.ContainerBase
              org.kuali.rice.krad.uif.container.Group
                  org.kuali.rice.krad.uif.container.TreeGroup

All Implemented Interfaces:

Serializable, Component, Configurable, DataBinding, ScriptEventSupport, Container, org.springframework.core.Ordered

public class TreeGroup
extends Group
implements DataBinding

Group component that is backed by a Tree data structure and typically rendered as a tree in the user interface

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.kuali.rice.krad.uif.component.Ordered

INITIAL_ORDER_VALUE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

TreeGroup()

Method Summary

protected void	addNodeComponents(Node<Group,MessageField> node, List<Component> components) Retrieves the Component instances from the node for building the nested components list
protected void	buildTreeGroups(View view, Object model) Builds the components that will be rendered as part of the tree group
protected Node<Group,MessageField>	buildTreeNode(Node<Object,String> nodeData, String bindingPrefix, String parentNode)
BindingInfo	getBindingInfo() Returns the BindingInfo instance that is configured for the component
List<Component>	getComponentPrototypes() List of components that are maintained by the component as prototypes for creating other component instances
List<Component>	getComponentsForLifecycle() List of components that are contained within the component and should be sent through the lifecycle
NodePrototype	getDefaultNodePrototype()
Map<Class<?>,NodePrototype>	getNodePrototypeMap()
String	getPropertyName() Name of the property (relative to the parent object) the component binds to
Tree	getTree()
Tree<Group,MessageField>	getTreeGroups()
protected void	initializeNodePrototypeComponents(View view, Object model)
void	performApplyModel(View view, Object model, Component 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
void	performInitialization(View view, Object model) The following actions are performed: Set fieldBindModelPath to the collection model path (since the fields have to belong to the same model as the collection) Set defaults for binding Calls view helper service to initialize prototypes
void	setBindingInfo(BindingInfo bindingInfo) Setter for the binding info instance
void	setDefaultNodePrototype(NodePrototype defaultNodePrototype)
void	setNodePrototypeMap(Map<Class<?>,NodePrototype> nodePrototypeMap)
void	setPropertyName(String propertyName)
void	setTree(Tree tree)
void	setTreeGroups(Tree<Group,MessageField> treeGroups)

Methods inherited from class org.kuali.rice.krad.uif.container.Group

getComponentTypeName, getDisclosure, getFieldBindByNamePrefix, getFieldBindingObjectPath, getItems, getSupportedComponents, setDisclosure, setFieldBindByNamePrefix, setFieldBindingObjectPath, setItems

Methods inherited from class org.kuali.rice.krad.uif.container.ContainerBase

getAdditionalMessageKeys, getAllInputFields, getErrorsField, getFooter, getHeader, getHelp, getInputFields, getInstructionalMessageField, getInstructionalText, getItemOrderingSequence, getLayoutManager, isFieldContainer, performFinalize, setAdditionalMessageKeys, setErrorsField, setFieldContainer, setFooter, setHeader, setHelp, setInstructionalMessageField, setInstructionalText, setItemOrderingSequence, setLayoutManager, setRenderFooter, setRenderHeader

Methods inherited from class org.kuali.rice.krad.uif.component.ComponentBase

addStyleClass, appendToStyle, getAlign, getColSpan, getComponentModifiers, getComponentOptions, getComponentOptionsJSString, getComponentSecurity, getComponentSecurityClass, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getEventCode, getFactoryId, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshDiscloseMethodToCall, getRefreshWhenChanged, getRefreshWhenChangedControlNames, getRenderOutput, getRequired, getRowSpan, getStyle, getStyleClasses, getStyleClassesAsString, getSupportsOnBlur, getSupportsOnChange, getSupportsOnClick, getSupportsOnClose, getSupportsOnDblClick, getSupportsOnDocumentReady, getSupportsOnFocus, getSupportsOnKeyDown, getSupportsOnKeyPress, getSupportsOnKeyUp, getSupportsOnLoad, getSupportsOnMouseDown, getSupportsOnMouseMove, getSupportsOnMouseOut, getSupportsOnMouseOver, getSupportsOnMouseUp, getSupportsOnSubmit, getSupportsOnUnload, getTemplate, getTitle, getValign, getWidth, isHidden, isPersistInSession, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, isSkipInTabOrder, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAlign, setColSpan, setComponentModifiers, setComponentOptions, setComponentOptionsJSString, setComponentSecurity, setConditionalRefresh, setContext, setFactoryId, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setHidden, setId, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setPersistInSession, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefresh, setRefreshDiscloseMethodToCall, setRefreshedByAction, setRefreshWhenChanged, setRender, setRenderOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setSkipInTabOrder, setStyle, setStyleClasses, setTemplate, setTitle, setValign, setWidth

Methods inherited from class org.kuali.rice.krad.uif.component.ConfigurableBase

getPropertyExpression, getPropertyExpressions, setPropertyExpressions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.kuali.rice.krad.uif.component.Component

addStyleClass, appendToStyle, getColSpan, getComponentModifiers, getComponentOptions, getComponentOptionsJSString, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getFactoryId, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshWhenChanged, getRefreshWhenChangedControlNames, getRenderOutput, getRequired, getRowSpan, getStyle, getStyleClasses, getTemplate, getTitle, isHidden, isPersistInSession, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, pushAllToContext, pushObjectToContext, setColSpan, setComponentModifiers, setComponentOptions, setComponentOptionsJSString, setComponentSecurity, setConditionalRefresh, setContext, setFactoryId, setHidden, setId, setOrder, setPersistInSession, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefresh, setRefreshedByAction, setRefreshWhenChanged, setRender, setRenderOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setStyle, setStyleClasses, setTemplate, setTitle

Methods inherited from interface org.kuali.rice.krad.uif.component.Configurable

getPropertyExpression, getPropertyExpressions, setPropertyExpressions

Methods inherited from interface org.kuali.rice.krad.uif.component.ScriptEventSupport

getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getSupportsOnBlur, getSupportsOnChange, getSupportsOnClick, getSupportsOnClose, getSupportsOnDblClick, getSupportsOnDocumentReady, getSupportsOnFocus, getSupportsOnKeyDown, getSupportsOnKeyPress, getSupportsOnKeyUp, getSupportsOnLoad, getSupportsOnMouseDown, getSupportsOnMouseMove, getSupportsOnMouseOut, getSupportsOnMouseOver, getSupportsOnMouseUp, getSupportsOnSubmit, getSupportsOnUnload, setOnBlurScript, setOnDocumentReadyScript, setOnLoadScript

Constructor Detail

TreeGroup

public TreeGroup()

Method Detail

performInitialization

public void performInitialization(View view,
                                  Object model)

The following actions are performed:

• Set fieldBindModelPath to the collection model path (since the fields have to belong to the same model as the collection)
• Set defaults for binding
• Calls view helper service to initialize prototypes

Specified by:

performInitialization in interface Component

Overrides:

performInitialization in class Group

Parameters:

view - - view instance in which the component belongs

model - - object instance containing the view data

See Also:

ComponentBase.performInitialization(org.kuali.rice.krad.uif.view.View, java.lang.Object)

initializeNodePrototypeComponents

protected void initializeNodePrototypeComponents(View view,
                                                 Object model)

performApplyModel

public void performApplyModel(View view,
                              Object model,
                              Component parent)

Description copied from class: ComponentBase

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

Specified by:

performApplyModel in interface Component

Overrides:

performApplyModel in class ContainerBase

Parameters:

view - - view instance to which the component belongs

model - - Top level object containing the data (could be the form or a top level business object, dto)

See Also:

ComponentBase.performApplyModel(org.kuali.rice.krad.uif.view.View, java.lang.Object, org.kuali.rice.krad.uif.component.Component)

buildTreeGroups

protected void buildTreeGroups(View view,
                               Object model)

Builds the components that will be rendered as part of the tree group

The component tree group mirrors the tree data structure on the model. For each node of the data structure, a corresponding MessageField will be created for the node label, and a Group component for the node data. These are placed into a new node for the component tree. After the tree is built it is set as a property on the tree group to be read by the renderer

Parameters:

view - - view instance the tree group belongs to

model - - object containing the view data from which the tree data will be retrieved

buildTreeNode

protected Node<Group,MessageField> buildTreeNode(Node<Object,String> nodeData,
                                                 String bindingPrefix,
                                                 String parentNode)

getComponentsForLifecycle

public List<Component> getComponentsForLifecycle()

Description copied from interface: Component

List of components that are contained within the component and should be sent through the lifecycle

Used by ViewHelperService for the various lifecycle callbacks

Specified by:

getComponentsForLifecycle in interface Component

Overrides:

getComponentsForLifecycle in class Group

Returns:

List child components

See Also:

Component.getComponentsForLifecycle()

getComponentPrototypes

public List<Component> getComponentPrototypes()

Description copied from interface: Component

List of components that are maintained by the component as prototypes for creating other component instances

Prototypes are held for configuring how a component should be created during the lifecycle. An example of this are the fields in a collection group that are created for each collection record. They only participate in the initialize phase.

Specified by:

getComponentPrototypes in interface Component

Overrides:

getComponentPrototypes in class ContainerBase

Returns:

List child component prototypes

See Also:

Component.getComponentPrototypes()

addNodeComponents

protected void addNodeComponents(Node<Group,MessageField> node,
                                 List<Component> components)

Retrieves the Component instances from the node for building the nested components list

Parameters:

node - - node to pull components from

components - - list to add components to

getPropertyName

public String getPropertyName()

Description copied from interface: DataBinding

Name of the property (relative to the parent object) the component binds to

Specified by:

getPropertyName in interface DataBinding

Returns:

String property name

setPropertyName

public void setPropertyName(String propertyName)

getBindingInfo

public BindingInfo getBindingInfo()

Description copied from interface: DataBinding

Returns the BindingInfo instance that is configured for the component

Specified by:

getBindingInfo in interface DataBinding

Returns:

BindingInfo

See Also:

BindingInfo

setBindingInfo

public void setBindingInfo(BindingInfo bindingInfo)

Description copied from interface: DataBinding

Setter for the binding info instance

Specified by:

setBindingInfo in interface DataBinding

getDefaultNodePrototype

public NodePrototype getDefaultNodePrototype()

Returns:

the defaultNodePrototype

setDefaultNodePrototype

public void setDefaultNodePrototype(NodePrototype defaultNodePrototype)

Parameters:

defaultNodePrototype - the defaultNodePrototype to set

getNodePrototypeMap

public Map<Class<?>,NodePrototype> getNodePrototypeMap()

Returns:

the nodePrototypeMap

setNodePrototypeMap

public void setNodePrototypeMap(Map<Class<?>,NodePrototype> nodePrototypeMap)

Parameters:

nodePrototypeMap - the nodePrototypeMap to set

getTreeGroups

public Tree<Group,MessageField> getTreeGroups()

setTreeGroups

public void setTreeGroups(Tree<Group,MessageField> treeGroups)

getTree

public Tree getTree()

setTree

public void setTree(Tree tree)