org.kuali.rice.krad.uif.util

Class ViewCleaner

java.lang.Object

org.kuali.rice.krad.uif.util.ViewCleaner

public class ViewCleaner
extends Object

Utility class for trimming component instances for storage

Invoked to trim the view instance before storing on the form as the post view. Certain information is keep around to support post methods that need to operate on the previous view configuration. Examples include component refresh and collection add/delete line.

Author:

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

Constructor Summary

Constructors

Constructor and Description
ViewCleaner()

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	cleanCollectionGroup(CollectionGroup collectionGroup, ViewIndex viewIndex) Cleans a collection group instance removing the items and collection prototypes (note add line fields are keep around to support the add line action)
static void	cleanComponent(Component component, ViewIndex viewIndex) Cleans a component instance removing properties not needed for posting
protected static void	cleanContainer(Container container, ViewIndex viewIndex) General purpose method to clean any container, removes all nested components except the items list
protected static void	cleanDataField(DataField dataField) Cleans an data field instance
protected static void	cleanInputField(InputField inputField) Cleans an input field instance removing the control and inherited component properties
protected static void	cleanTableLayoutManager(TableLayoutManager tableLayoutManager) Cleans a table layout manager instance removing unneeded prototypes
static void	cleanView(View view) Cleans a view instance removing all pages except the current page and then invoking the view index to perform cleaning on contained components

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewCleaner

public ViewCleaner()

Method Detail

cleanView

public static void cleanView(View view)

Cleans a view instance removing all pages except the current page and then invoking the view index to perform cleaning on contained components

Parameters:

view - view instance to clean

cleanComponent

public static void cleanComponent(Component component,
                  ViewIndex viewIndex)

Cleans a component instance removing properties not needed for posting

Parameters:

component - instance to clean

cleanContainer

protected static void cleanContainer(Container container,
                  ViewIndex viewIndex)

General purpose method to clean any container, removes all nested components except the items list

Parameters:

container - container instance to clean

cleanCollectionGroup

protected static void cleanCollectionGroup(CollectionGroup collectionGroup,
                        ViewIndex viewIndex)

Cleans a collection group instance removing the items and collection prototypes (note add line fields are keep around to support the add line action)

Parameters:

collectionGroup - collection group instance to clean

cleanTableLayoutManager

protected static void cleanTableLayoutManager(TableLayoutManager tableLayoutManager)

Cleans a table layout manager instance removing unneeded prototypes

Parameters:

tableLayoutManager - table layout instance to clean

cleanDataField

protected static void cleanDataField(DataField dataField)

Cleans an data field instance

Parameters:

dataField - data field instance to clean

cleanInputField

protected static void cleanInputField(InputField inputField)

Cleans an input field instance removing the control and inherited component properties

Parameters:

inputField - input field instance to clean