View (Rice 2.3.14 API)

java.lang.Object
- org.kuali.rice.krad.datadictionary.DictionaryBeanBase
- - org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase
  - - org.kuali.rice.krad.uif.component.ComponentBase
    - - org.kuali.rice.krad.uif.container.ContainerBase
      - org.kuali.rice.krad.uif.view.View

All Implemented Interfaces:

Serializable, Cloneable, DictionaryBean, UifDictionaryBean, Component, ScriptEventSupport, Container, Helpable, org.springframework.core.Ordered

Direct Known Subclasses:

FormView
```
public class View
extends ContainerBase
```
Root of the component tree which encompasses a set of related GroupContainer instances tied together with a common page layout and navigation.
The View component ties together all the components and configuration of the User Interface for a piece of functionality. In Rice applications the view is typically associated with a Document instance.

The view template lays out the common header, footer, and navigation for the related pages. In addition the view renders the HTML head element bringing in common script files and style sheets, along with optionally rendering a form element for pages that need to post data back to the server.

Configuration of UIF features such as model validation is also done through the View

Author:

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

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected ViewIndex viewIndex
- 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

Fields
Modifier and Type	Field and Description
`protected ViewIndex`	`viewIndex`

Constructor Summary

Constructors
Constructor and Description

View()

Constructors
Constructor and Description
`View()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`assignComponentId(Component component)` Assigns an id to the given component
`void`	`assignComponentIds(Component component)` Assigns an id (if not configured) to a component and all its child components
`protected void`	`assignPageIds(View view)` Special handling of assigning ids for the view component to assure each page and all its children gets an id and the page ids are always the same
`void`	`completeValidation(ValidationTrace tracer)` Validates different requirements of component compiling a series of reports detailing information on errors found in the component.
`protected <T> void`	`copyProperties(T component)` Copies the properties over for the copy method
`BooleanMap`	`getActionFlags()` Map of strings that flag what actions can be taken in the UI
`List<String>`	`getAdditionalCssFiles()` Declares additional CSS files that should be included with the `View`.
`List<String>`	`getAdditionalScriptFiles()` Declares additional script files that should be included with the `View`.
`Group`	`getApplicationFooter()` Footer for the application containing the view
`Header`	`getApplicationHeader()` Header for the application containing the view
`ViewAuthorizer`	`getAuthorizer()` Authorizer that should be used for the `View` instance
`BreadcrumbItem`	`getBreadcrumbItem()` The View's breadcrumbItem defines settings for the breadcrumb which appears in the breadcrumb list for this view.
`BreadcrumbOptions`	`getBreadcrumbOptions()` The breadcrumbOptions for this view.
`Breadcrumbs`	`getBreadcrumbs()` Breadcrumb widget used for displaying homeward path and history
`List<Component>`	`getComponentsForLifecycle()` List of components that are contained within the component and should be sent through the lifecycle
`String`	`getComponentTypeName()` The name for the component type
`PageGroup`	`getCurrentPage()` Iterates through the contained page items and returns the Page that matches the set current page id
`String`	`getCurrentPageId()` The id for the page within the view that should be displayed in the UI.
`String`	`getDefaultBindingObjectPath()` For `View` types that work primarily with one nested object of the form (for instance document, or bo) the default binding object path can be set for each of the views `DataBinding` components.
`List<Group>`	`getDialogs()` Provide a list of dialog groups associated with this view
`BooleanMap`	`getEditModes()` Map of edit modes that enabled for the view
`String`	`getEntryPageId()` Specifies what page should be rendered by default.
`Map<String,String>`	`getExpressionVariables()` Map that contains expressions to evaluate and make available as variables for conditional expressions within the view
`Class<?>`	`getFormClass()` Class of the Form that should be used with the `View` instance.
`Growls`	`getGrowls()` Growls widget which sets up global settings for the growls used in this view and its pages
`int`	`getIdSequence()` Current sequence value for id assignment
`List<? extends Group>`	`getItems()` `List` of `Component` instances that are held by the container
`String`	`getNamespaceCode()` Namespace code the view should be associated with
`Group`	`getNavigation()` `NavigationGroup` instance for the `View`
`BlockUI`	`getNavigationBlockUI()`
`String`	`getNextId()` Returns the next unique id available for components within the view instance
`Map<String,Class<?>>`	`getObjectPathToConcreteClassMapping()` Configures the concrete classes that will be used for properties in the form object graph that have an abstract or interface type
`PageGroup`	`getPage()` For single paged views (`isSinglePageView()`, gives the page `Group` the view should render.
`ParentLocation`	`getParentLocation()` The parentLocation defines urls that represent the parent of a View in a conceptial site hierarchy.
`List<BreadcrumbItem>`	`getPathBasedBreadcrumbs()` The pathBasedBreadcrumbs for this View.
`String`	`getPreLoadScript()` Script that is executed at the beginning of page load (before any other script)
`ViewPresentationController`	`getPresentationController()` PresentationController that should be used for the `View` instance
`BlockUI`	`getRefreshBlockUI()`
`ViewSessionPolicy`	`getSessionPolicy()`
`StateMapping`	`getStateMapping()` Gets the stateMapping.
`String`	`getStateObjectBindingPath()` The stateObject's binding path, this will be used along with the StateMapping's statePropertyName to determine what field in the model state information is stored in for this view.
`Set<Class<? extends Component>>`	`getSupportedComponents()` `Set` of `Component` classes that may be placed into the container
`ViewTheme`	`getTheme()` The theme which contains stylesheets for this view
`Group`	`getTopGroup()` TopGroup is an optional group of content that appears above the breadcrumbs and view header
`ViewHelperService`	`getViewHelperService()` Creates the `ViewHelperService` associated with the View
`Class<? extends ViewHelperService>`	`getViewHelperServiceClass()` Class name of the `ViewHelperService` that handles the various phases of the Views lifecycle
`ViewIndex`	`getViewIndex()` Holds field indexes of the `View` instance for retrieval
`String`	`getViewMenuGroupName()` Provides a grouping string for the view to group its menu link (within a portal for instance)
`Link`	`getViewMenuLink()` Provides configuration for displaying a link to the view from an application menu
`String`	`getViewName()` View name provides an identifier for a view within a type.
`Map<String,String>`	`getViewRequestParameters()` Map of parameters from the request that set view options, used to rebuild the view on each post
`String`	`getViewStatus()` Indicates what lifecycle phase the View instance is in
`List<String>`	`getViewTemplates()` List of templates that are used to render the view
`UifConstants.ViewType`	`getViewTypeName()` View type name the view is associated with the view instance
`void`	`index()` Invoked to produce a ViewIndex of the current view's components
`boolean`	`isApplyDirtyCheck()` Indicates whether the form should be validated for dirtyness
`boolean`	`isDisableBrowserCache()` Enables functionality to bust the browsers cache by appending an unique cache key
`boolean`	`isDisableNativeAutocomplete()` Indicates whether the browser autocomplete functionality should be disabled for the entire form (adds autocomplete="off")
`boolean`	`isFinal()` Indicates whether the view has been updated from the model and final updates made
`boolean`	`isGrowlMessagingEnabled()` whether to use growls to show messages - info, warning and error
`boolean`	`isInitialized()` Indicates whether the view has been initialized
`boolean`	`isMergeWithPageItems()` Indicates whether the default sections specified in the page items list should be included for this view.
`boolean`	`isPersistFormToSession()` Indicates whether the form (model) associated with the view should be stored in the user session
`boolean`	`isSinglePageView()` Indicates whether the `View` only has a single page `Group` or contains multiple page `Group` instances.
`boolean`	`isStickyApplicationFooter()` If true, the applicationFooter will become sticky (fixed to bottom of window)
`boolean`	`isStickyApplicationHeader()` Set to true to make the applicationHeader sticky (fixed to top of window)
`boolean`	`isStickyBreadcrumbs()` If true, the breadcrumb widget will be sticky (fixed to top of window)
`boolean`	`isStickyFooter()` If true, the view footer will become sticky (fixed to bottom of window)
`boolean`	`isStickyHeader()` If true, the ViewHeader for this view will be sticky (fixed to top of window)
`boolean`	`isStickyTopGroup()` If true, the top group will be sticky (fixed to top of window)
`boolean`	`isSupportsRequestOverrideOfReadOnlyFields()` Indicates whether the view allows read only fields to be specified on the request URL which will override the view setting
`boolean`	`isTranslateCodesOnReadOnlyDisplay()` Returns whether the current view supports displaying `KualiCode`'s name as additional display value
`boolean`	`isUnifiedHeader()` When true, this view will use a unified header - the page header will be omitted and its title will be used in the ViewHeader supportTitle property (dynamically updated on page change)
`boolean`	`isUseLibraryCssClasses()` True if the libraryCssClasses set on components will be output to their class attribute, false otherwise.
`void`	`performApplyModel(View view, Object model, Component parent)` The following updates are done here: Invoke expression evaluation on view theme Invoke theme to configure defaults
`void`	`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
`void`	`performInitialization(View view, Object model)` The following initialization is performed: If a single paged view, set items in page group and put the page in the items list If `ViewSessionPolicy.enableTimeoutWarning` is enabled add the session timeout dialogs to the views list of dialog groups
`void`	`setActionFlags(BooleanMap actionFlags)` Setter for the action flags Map
`void`	`setAdditionalCssFiles(List<String> additionalCssFiles)` Setter for the List of additional CSS files to included with the `View`
`void`	`setAdditionalScriptFiles(List<String> additionalScriptFiles)` Setter for the List of additional script files to included with the `View`
`void`	`setApplicationFooter(Group applicationFooter)` Setter for the application footer
`void`	`setApplicationHeader(Header applicationHeader)` Setter for the application header
`void`	`setApplyDirtyCheck(boolean applyDirtyCheck)` Setter for dirty validation.
`void`	`setAuthorizer(ViewAuthorizer authorizer)` Setter for the view's authorizer
`void`	`setAuthorizerClass(Class<? extends ViewAuthorizer> authorizerClass)` Setter for the view's authorizer by class
`void`	`setBreadcrumbItem(BreadcrumbItem breadcrumbItem)` Set the breadcrumbItem
`void`	`setBreadcrumbOptions(BreadcrumbOptions breadcrumbOptions)` Set the breadcrumbOptions
`void`	`setBreadcrumbs(Breadcrumbs breadcrumbs)`
`void`	`setCurrentPageId(String currentPageId)` Setter for the page id to display
`void`	`setDefaultBindingObjectPath(String defaultBindingObjectPath)` Setter for the default binding object path to use for the view
`void`	`setDialogs(List<Group> dialogs)` Sets the list of dialog groups for this view
`void`	`setDisableBrowserCache(boolean disableBrowserCache)` Setter to disable browser caching of the view
`void`	`setDisableNativeAutocomplete(boolean disableNativeAutocomplete)` Setter to disable browser autocomplete for the view's form
`void`	`setEditModes(BooleanMap editModes)` Setter for the edit modes Map
`void`	`setEntryPageId(String entryPageId)` Setter for default Page id
`void`	`setExpressionVariables(Map<String,String> expressionVariables)` Setter for the view's map of variable expressions
`void`	`setFormClass(Class<?> formClass)` Setter for the form class
`void`	`setGrowlMessagingEnabled(boolean growlMessagingEnabled)` enable or disable showing of messages using growls
`void`	`setGrowls(Growls growls)`
`void`	`setIdSequence(int idSequence)` Setter for the current id sequence value
`void`	`setItems(List<? extends Component> items)` Setter for the view's `Group` instances
`void`	`setMergeWithPageItems(boolean mergeWithPageItems)` Setter for the include page default sections indicator
`void`	`setNamespaceCode(String namespaceCode)` Setter for the view's namespace code
`void`	`setNavigation(Group navigation)` Setter for the View's `NavigationGroup`
`void`	`setNavigationBlockUI(BlockUI navigationBlockUI)` Set the navigation BlockUI used with single page blocking (such as full page loading/saving)
`void`	`setObjectPathToConcreteClassMapping(Map<String,Class<?>> objectPathToConcreteClassMapping)` Setter for the Map of class implementations keyed by path
`void`	`setPage(PageGroup page)` Setter for the page group for single page views
`void`	`setParentLocation(ParentLocation parentLocation)` Set the parentLocation
`void`	`setPathBasedBreadcrumbs(List<BreadcrumbItem> pathBasedBreadcrumbs)` The pathBasedBreadcrumbs for this View.
`void`	`setPersistFormToSession(boolean persistFormToSession)` Setter for the persist form to session indicator
`void`	`setPreLoadScript(String preLoadScript)` Setter for the pre load script
`void`	`setPresentationController(ViewPresentationController presentationController)` Setter for the view's presentation controller
`void`	`setPresentationControllerClass(Class<? extends ViewPresentationController> presentationControllerClass)` Setter for the view's presentation controller by class
`void`	`setRefreshBlockUI(BlockUI refreshBlockUI)` Set the refresh BlockUI used with single element blocking (such as ajax based element loading/updates)
`void`	`setSessionPolicy(ViewSessionPolicy sessionPolicy)`
`void`	`setSinglePageView(boolean singlePageView)` Setter for the single page indicator
`void`	`setStateMapping(StateMapping stateMapping)` Set the stateMapping
`void`	`setStateObjectBindingPath(String stateObjectBindingPath)` The stateObject's binding path, this will be used along with the StateMapping's statePropertyName to determine what field in the model state information is stored in for this view.
`void`	`setStickyApplicationFooter(boolean stickyApplicationFooter)` Set to true to make the application footer sticky
`void`	`setStickyApplicationHeader(boolean stickyApplicationHeader)` Set to true to make the applicationHeader sticky
`void`	`setStickyBreadcrumbs(boolean stickyBreadcrumbs)` Set to true to make the breadcrumbs sticky
`void`	`setStickyFooter(boolean stickyFooter)` Set to true to make the view footer sticky
`void`	`setStickyHeader(boolean stickyHeader)` Set to true to make the ViewHeader sticky
`void`	`setStickyTopGroup(boolean stickyTopGroup)` Set to true to make the top group sticky (fixed to top of window)
`void`	`setSupportsRequestOverrideOfReadOnlyFields(boolean supportsRequestOverrideOfReadOnlyFields)` Setter for the the read only field override indicator
`void`	`setTheme(ViewTheme theme)` Setter for The theme which contains stylesheets for this view
`void`	`setTopGroup(Group topGroup)` Set the topGroup component which appears the breadcrumbs and view header
`void`	`setTranslateCodesOnReadOnlyDisplay(boolean translateCodesOnReadOnlyDisplay)` Indicates whether the Name of the Code should be displayed when a property is of type `KualiCode`
`void`	`setUnifiedHeader(boolean unifiedHeader)` Set to true, to use unified header functionality
`void`	`setUseLibraryCssClasses(boolean useLibraryCssClasses)` Set useLibraryCssClasses
`void`	`setViewHelperService(ViewHelperService viewHelperService)` Setter for the `ViewHelperService`
`void`	`setViewHelperServiceClass(Class<? extends ViewHelperService> viewHelperServiceClass)` Setter for the `ViewHelperService` class name Also initializes the viewHelperService
`void`	`setViewMenuGroupName(String viewMenuGroupName)` Setter for the views menu grouping
`void`	`setViewMenuLink(Link viewMenuLink)` Setter for the views link field
`void`	`setViewName(String viewName)` Setter for the view's name
`void`	`setViewRequestParameters(Map<String,String> viewRequestParameters)` Setter for the view's request parameters map
`void`	`setViewStatus(String viewStatus)` Setter for the view status
`void`	`setViewTemplates(List<String> viewTemplates)` Setter for the the list of template names that should be included to render the view
`void`	`setViewTypeName(UifConstants.ViewType viewTypeName)` Setter for the view's type name
`protected void`	`sortItems(View view, Object model)` Override sort method to prevent sorting in the case of a single page view, since the items will get pushed into the configured page and sorted through the page

Methods inherited from class org.kuali.rice.krad.uif.container.ContainerBase
getComponentPrototypes, getDefaultItemPosition, getFooter, getHeader, getHeaderText, getHelp, getHelpTitle, getInstructionalMessage, getInstructionalText, getLayoutManager, getValidationMessages, setDefaultItemPosition, setFooter, setHeader, setHeaderText, setHelp, setInstructionalMessage, setInstructionalText, setLayoutManager, setRenderFooter, setRenderHeader, setTooltipOfComponent, setValidationMessages

Methods inherited from class org.kuali.rice.krad.uif.component.ComponentBase
addCellCssClass, addDataAttribute, addDataAttributeIfNonEmpty, addStyleClass, appendToStyle, copy, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getBaseId, getCellCssClasses, getCellStyle, getCellStyleClassesAsString, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getComponentSecurityClass, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getEventHandlerScript, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getLibraryCssClasses, getMethodToCallOnRefresh, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, isSkipInTabOrder, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setBaseId, setCellCssClasses, setCellStyle, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setForceSessionPersistence, setHidden, setId, setLibraryCssClasses, setMethodToCallOnRefresh, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRowSpan, setSelfRendered, setSkipInTabOrder, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setWidth

Methods inherited from class org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase
getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph

Methods inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase
getComponentCode, setComponentCode

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
addCellCssClass, addDataAttribute, addStyleClass, appendToStyle, copy, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getBaseId, getCellCssClasses, getCellStyle, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getEventHandlerScript, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getLibraryCssClasses, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, pushAllToContext, pushObjectToContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setBaseId, setCellCssClasses, setCellStyle, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setForceSessionPersistence, setHidden, setId, setLibraryCssClasses, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRowSpan, setSelfRendered, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setWidth

Methods inherited from interface org.kuali.rice.krad.datadictionary.uif.UifDictionaryBean
getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph

Methods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean
getComponentCode

- Field Detail
  - viewIndex
```
protected ViewIndex viewIndex
```
- Constructor Detail
  - View
```
public View()
```
- Method Detail
  - performInitialization
```
public void performInitialization(View view,
                                  Object model)
```
    The following initialization is performed:
    - If a single paged view, set items in page group and put the page in the items list
    - If ViewSessionPolicy.enableTimeoutWarning is enabled add the session timeout dialogs to the views list of dialog groups
    Specified by:
    
    performInitialization in interface Component
    
    Overrides:
    
    performInitialization in class ContainerBase
    
    Parameters:
    
    view - - view instance in which the component belongs
    
    model - - object instance containing the view data
    
    See Also:
    
    ContainerBase.performInitialization(org.kuali.rice.krad.uif.view.View, Object)
  - performApplyModel
```
public void performApplyModel(View view,
                              Object model,
                              Component parent)
```
    The following updates are done here:
    - Invoke expression evaluation on view theme
    - Invoke theme to configure defaults
    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)
  - performFinalize
```
public void 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
    Specified by:
    
    performFinalize in interface Component
    
    Overrides:
    
    performFinalize in class ContainerBase
    
    Parameters:
    
    view - - view instance that should be finalized for rendering
    
    model - - top level object containing the data
    
    parent - - parent component
    
    See Also:
    
    ContainerBase.performFinalize(org.kuali.rice.krad.uif.view.View, Object, org.kuali.rice.krad.uif.component.Component)
  - assignComponentIds
```
public void assignComponentIds(Component component)
```
    Assigns an id (if not configured) to a component and all its child components
    
    Parameters:
    
    component - component instance to assign id to
  - assignPageIds
```
protected void assignPageIds(View view)
```
    Special handling of assigning ids for the view component to assure each page and all its children gets an id and the page ids are always the same
    First the pages are assigned ids sequentially so they always get the same ids regardless of what page is being displayed. Also, since the view doesn't include pages that are not being displayed (or are not the current page) in its tree (components for lifecycle) we need to loop through them explicity and assign ids
    
    Parameters:
    
    view - view instance containing the pages
  - assignComponentId
```
protected void assignComponentId(Component component)
```
    Assigns an id to the given component
    
    Parameters:
    
    component - component to assign id to
  - 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 ContainerBase
    
    Returns:
    
    List child components
    
    See Also:
    
    ComponentBase.getComponentsForLifecycle()
  - getSupportedComponents
```
public Set<Class<? extends Component>> getSupportedComponents()
```
    Description copied from interface: Container
    
    Set of Component classes that may be placed into the container
    If an empty or null list is returned, it is assumed the container supports all components. The returned set will be used by dictionary validators and allows renders to make assumptions about the contained components
    
    Returns:
    
    Set component classes
    
    See Also:
    
    Container.getSupportedComponents()
  - getComponentTypeName
```
public String getComponentTypeName()
```
    Description copied from interface: Component
    
    The name for the component type
    This is used within the rendering layer to pass the component instance into the template. The component instance is exported under the name given by this method.
    
    Returns:
    
    String type name
    
    See Also:
    
    Component.getComponentTypeName()
  - getCurrentPage
```
public PageGroup getCurrentPage()
```
    Iterates through the contained page items and returns the Page that matches the set current page id
    
    Returns:
    
    Page instance
  - sortItems
```
protected void sortItems(View view,
                         Object model)
```
    Override sort method to prevent sorting in the case of a single page view, since the items will get pushed into the configured page and sorted through the page
    
    Overrides:
    
    sortItems in class ContainerBase
    
    Parameters:
    
    view - view instance containing the container
    
    model - model object containing the view data
  - getNamespaceCode
```
public String getNamespaceCode()
```
    Namespace code the view should be associated with
    The namespace code is used within the framework in such places as permission checks and parameter retrieval
    
    Specified by:
    
    getNamespaceCode in interface DictionaryBean
    
    Overrides:
    
    getNamespaceCode in class DictionaryBeanBase
    
    Returns:
    
    namespace code
    
    See Also:
    
    DictionaryBean.getNamespaceCode()
  - setNamespaceCode
```
public void setNamespaceCode(String namespaceCode)
```
    Setter for the view's namespace code
    
    Overrides:
    
    setNamespaceCode in class DictionaryBeanBase
    
    Parameters:
    
    namespaceCode -
  - getViewName
```
public String getViewName()
```
    View name provides an identifier for a view within a type. That is if a set of View instances have the same values for the properties that are used to retrieve them by their type, the name can be given to further qualify the view that should be retrieved.
    A view type like the LookupView might have several views for the same object class, but one that is the 'default' lookup and another that is the 'advanced' lookup. Therefore the name on the first could be set to 'default', and likewise the name for the second 'advanced'.
    
    Returns:
    
    name of view
  - setViewName
```
public void setViewName(String viewName)
```
    Setter for the view's name
    
    Parameters:
    
    viewName -
  - isUnifiedHeader
```
public boolean isUnifiedHeader()
```
    When true, this view will use a unified header - the page header will be omitted and its title will be used in the ViewHeader supportTitle property (dynamically updated on page change)
    
    Returns:
    
    true if using a unified header
  - setUnifiedHeader
```
public void setUnifiedHeader(boolean unifiedHeader)
```
    Set to true, to use unified header functionality
    
    Parameters:
    
    unifiedHeader -
  - getTopGroup
```
public Group getTopGroup()
```
    TopGroup is an optional group of content that appears above the breadcrumbs and view header
    
    Returns:
    
    the topGroup component
  - setTopGroup
```
public void setTopGroup(Group topGroup)
```
    Set the topGroup component which appears the breadcrumbs and view header
    
    Parameters:
    
    topGroup -
  - getApplicationHeader
```
public Header getApplicationHeader()
```
    Header for the application containing the view
    When deploying outside a portal, the application header and footer property can be configured to display a consistent header/footer across all views. Here application logos, menus, login controls and so on can be rendered.
    
    Returns:
    
    application header
  - setApplicationHeader
```
public void setApplicationHeader(Header applicationHeader)
```
    Setter for the application header
    
    Parameters:
    
    applicationHeader -
  - getApplicationFooter
```
public Group getApplicationFooter()
```
    Footer for the application containing the view
    When deploying outside a portal, the application header and footer property can be configured to display a consistent header/footer across all views. Here such things as application links, copyrights and so on can be rendered.
    
    Returns:
    
    application footer
  - setApplicationFooter
```
public void setApplicationFooter(Group applicationFooter)
```
    Setter for the application footer
    
    Parameters:
    
    applicationFooter -
  - isStickyTopGroup
```
public boolean isStickyTopGroup()
```
    If true, the top group will be sticky (fixed to top of window)
    
    Returns:
    
    true if the top group is sticky, false otherwise
  - setStickyTopGroup
```
public void setStickyTopGroup(boolean stickyTopGroup)
```
    Set to true to make the top group sticky (fixed to top of window)
    
    Parameters:
    
    stickyTopGroup -
  - isStickyBreadcrumbs
```
public boolean isStickyBreadcrumbs()
```
    If true, the breadcrumb widget will be sticky (fixed to top of window)
    
    Returns:
    
    true if breadcrumbs are sticky, false otherwise
  - setStickyBreadcrumbs
```
public void setStickyBreadcrumbs(boolean stickyBreadcrumbs)
```
    Set to true to make the breadcrumbs sticky
    
    Parameters:
    
    stickyBreadcrumbs -
  - isStickyHeader
```
public boolean isStickyHeader()
```
    If true, the ViewHeader for this view will be sticky (fixed to top of window)
    
    Returns:
    
    true if the header is sticky, false otherwise
  - setStickyHeader
```
public void setStickyHeader(boolean stickyHeader)
```
    Set to true to make the ViewHeader sticky
    
    Parameters:
    
    stickyHeader -
  - isStickyApplicationHeader
```
public boolean isStickyApplicationHeader()
```
    Set to true to make the applicationHeader sticky (fixed to top of window)
    
    Returns:
    
    true if applicationHeader is sticky, false otherwise
  - setStickyApplicationHeader
```
public void setStickyApplicationHeader(boolean stickyApplicationHeader)
```
    Set to true to make the applicationHeader sticky
    
    Parameters:
    
    stickyApplicationHeader -
  - isStickyFooter
```
public boolean isStickyFooter()
```
    If true, the view footer will become sticky (fixed to bottom of window)
    
    Returns:
    
    ture if the view footer is sticky, false otherwise
  - setStickyFooter
```
public void setStickyFooter(boolean stickyFooter)
```
    Set to true to make the view footer sticky
    
    Parameters:
    
    stickyFooter -
  - isStickyApplicationFooter
```
public boolean isStickyApplicationFooter()
```
    If true, the applicationFooter will become sticky (fixed to bottom of window)
    
    Returns:
    
    true if the application footer is sticky, false otherwise
  - setStickyApplicationFooter
```
public void setStickyApplicationFooter(boolean stickyApplicationFooter)
```
    Set to true to make the application footer sticky
    
    Parameters:
    
    stickyApplicationFooter -
  - getIdSequence
```
public int getIdSequence()
```
    Current sequence value for id assignment
    
    Returns:
    
    id sequence
  - setIdSequence
```
public void setIdSequence(int idSequence)
```
    Setter for the current id sequence value
    
    Parameters:
    
    idSequence -
  - getNextId
```
public String getNextId()
```
    Returns the next unique id available for components within the view instance
    
    Returns:
    
    next id available
  - getEntryPageId
```
public String getEntryPageId()
```
    Specifies what page should be rendered by default. This is the page that will be rendered when the View is first rendered or when the current page is not set
    
    Returns:
    
    id of the page to render by default
  - setEntryPageId
```
public void setEntryPageId(String entryPageId)
```
    Setter for default Page id
    
    Parameters:
    
    entryPageId -
  - getCurrentPageId
```
public String getCurrentPageId()
```
    The id for the page within the view that should be displayed in the UI. Other pages of the view will not be rendered
    If current page id is not set, it is set to the configured entry page or first item in list id
    
    Returns:
    
    id of the page that should be displayed
  - setCurrentPageId
```
public void setCurrentPageId(String currentPageId)
```
    Setter for the page id to display
    
    Parameters:
    
    currentPageId -
  - getNavigation
```
public Group getNavigation()
```
    NavigationGroup instance for the View
    Provides configuration necessary to render the navigation. This includes navigation items in addition to configuration for the navigation renderer.
    
    Returns:
    
    NavigationGroup
  - setNavigation
```
public void setNavigation(Group navigation)
```
    Setter for the View's NavigationGroup
    
    Parameters:
    
    navigation -
  - getFormClass
```
public Class<?> getFormClass()
```
    Class of the Form that should be used with the View instance. The form is the top level object for all the view's data and is used to present and accept data in the user interface. All form classes should extend UifFormBase
    
    Returns:
    
    class for the view's form
    
    See Also:
    
    UifFormBase
  - setFormClass
```
public void setFormClass(Class<?> formClass)
```
    Setter for the form class
    
    Parameters:
    
    formClass -
  - getDefaultBindingObjectPath
```
public String getDefaultBindingObjectPath()
```
    For View types that work primarily with one nested object of the form (for instance document, or bo) the default binding object path can be set for each of the views DataBinding components. If the component does not set its own binding object path it will inherit the default
    
    Returns:
    
    binding path to the object from the form
  - setDefaultBindingObjectPath
```
public void setDefaultBindingObjectPath(String defaultBindingObjectPath)
```
    Setter for the default binding object path to use for the view
    
    Parameters:
    
    defaultBindingObjectPath -
  - getObjectPathToConcreteClassMapping
```
public Map<String,Class<?>> getObjectPathToConcreteClassMapping()
```
    Configures the concrete classes that will be used for properties in the form object graph that have an abstract or interface type
    For properties that have an abstract or interface type, it is not possible to perform operations like getting/settings property values and getting information from the dictionary. When these properties are encountered in the object graph, this Map will be consulted to determine the concrete type to use.
    
    e.g. Suppose we have a property document.accountingLine.accountNumber and the accountingLine property on the document instance has an interface type 'AccountingLine'. We can then put an entry into this map with key 'document.accountingLine', and value 'org.kuali.rice.sampleapp.TravelAccountingLine'. When getting the property type or an entry from the dictionary for accountNumber, the TravelAccountingLine class will be used.
    
    Returns:
    
    Map of class implementations keyed by path
  - setObjectPathToConcreteClassMapping
```
public void setObjectPathToConcreteClassMapping(Map<String,Class<?>> objectPathToConcreteClassMapping)
```
    Setter for the Map of class implementations keyed by path
    
    Parameters:
    
    objectPathToConcreteClassMapping -
  - getAdditionalScriptFiles
```
public List<String> getAdditionalScriptFiles()
```
    Declares additional script files that should be included with the View. These files are brought into the HTML page along with common script files configured for the Rice application. Each entry contain the path to the CSS file, either a relative path, path from web root, or full URI
    e.g. '/krad/scripts/myScript.js', '../scripts/myScript.js', 'http://my.edu/web/myScript.js'
    
    Returns:
    
    script file locations
  - setAdditionalScriptFiles
```
public void setAdditionalScriptFiles(List<String> additionalScriptFiles)
```
    Setter for the List of additional script files to included with the View
    
    Parameters:
    
    additionalScriptFiles -
  - getAdditionalCssFiles
```
public List<String> getAdditionalCssFiles()
```
    Declares additional CSS files that should be included with the View. These files are brought into the HTML page along with common CSS files configured for the Rice application. Each entry should contain the path to the CSS file, either a relative path, path from web root, or full URI
    e.g. '/krad/css/stacked-view.css', '../css/stacked-view.css', 'http://my.edu/web/stacked-view.css'
    
    Returns:
    
    CSS file locations
  - setAdditionalCssFiles
```
public void setAdditionalCssFiles(List<String> additionalCssFiles)
```
    Setter for the List of additional CSS files to included with the View
    
    Parameters:
    
    additionalCssFiles -
  - isUseLibraryCssClasses
```
public boolean isUseLibraryCssClasses()
```
    True if the libraryCssClasses set on components will be output to their class attribute, false otherwise.
    
    Returns:
    
    true if using libraryCssClasses on components
  - setUseLibraryCssClasses
```
public void setUseLibraryCssClasses(boolean useLibraryCssClasses)
```
    Set useLibraryCssClasses
    
    Parameters:
    
    useLibraryCssClasses -
  - getViewTemplates
```
public List<String> getViewTemplates()
```
    List of templates that are used to render the view
    This list will be populated by unique template names as the components of the view are being processed. Additional templates can be added in the view configuration if desired. At the beginning of the the view rendering, each template in the list will then be included or processed by the template language
    
    Note the user of this depends on the template language being used for rendering. Some languages might require including the template for each component instance (for example JSP templates). While others might simply include markup that is then available for rendering each component instance (for example FreeMarker which has a macro for each component that the template defines)
    
    Returns:
    
    list of template names that should be included for rendering the view
  - setViewTemplates
```
public void setViewTemplates(List<String> viewTemplates)
```
    Setter for the the list of template names that should be included to render the view
    
    Parameters:
    
    viewTemplates -
  - getViewTypeName
```
public UifConstants.ViewType getViewTypeName()
```
    View type name the view is associated with the view instance
    Views that share common features and functionality can be grouped by the view type. Usually view types extend the View class to provide additional configuration and to set defaults. View types can also implement the ViewTypeService to add special indexing and retrieval of views.
    
    Returns:
    
    view type name for the view
  - setViewTypeName
```
public void setViewTypeName(UifConstants.ViewType viewTypeName)
```
    Setter for the view's type name
    
    Parameters:
    
    viewTypeName -
  - getViewHelperServiceClass
```
public Class<? extends ViewHelperService> getViewHelperServiceClass()
```
    Class name of the ViewHelperService that handles the various phases of the Views lifecycle
    
    Returns:
    
    Class for the spring bean
    
    See Also:
    
    ViewHelperService
  - setViewHelperServiceClass
```
public void setViewHelperServiceClass(Class<? extends ViewHelperService> viewHelperServiceClass)
```
    Setter for the ViewHelperService class name Also initializes the viewHelperService
    
    Parameters:
    
    viewHelperServiceClass -
  - getViewHelperService
```
public ViewHelperService getViewHelperService()
```
    Creates the ViewHelperService associated with the View
    
    Returns:
    
    ViewHelperService instance
  - setViewHelperService
```
public void setViewHelperService(ViewHelperService viewHelperService)
```
    Setter for the ViewHelperService
    
    Parameters:
    
    viewHelperService -
  - index
```
public void index()
```
    Invoked to produce a ViewIndex of the current view's components
  - getViewIndex
```
public ViewIndex getViewIndex()
```
    Holds field indexes of the View instance for retrieval
    
    Returns:
    
    ViewIndex instance
  - getViewRequestParameters
```
public Map<String,String> getViewRequestParameters()
```
    Map of parameters from the request that set view options, used to rebuild the view on each post
    Views can be configured by parameters. These might impact which parts of the view are rendered or how the view behaves. Generally these would get passed in when a new view is requested (by request parameters). These will be used to initially populate the view properties. In addition, on a post the view will be rebuilt and properties reset again by the allow request parameters.
    
    Example parameter would be for MaintenaceView whether a New, Edit, or Copy was requested (maintenance mode)
    
    Returns:
  - setViewRequestParameters
```
public void setViewRequestParameters(Map<String,String> viewRequestParameters)
```
    Setter for the view's request parameters map
    
    Parameters:
    
    viewRequestParameters -
  - isPersistFormToSession
```
public boolean isPersistFormToSession()
```
    Indicates whether the form (model) associated with the view should be stored in the user session
    The form class (or model) is used to hold the data that backs the view along with the built view object. Storing the form instance in session allows many things:
    - Data does not need to be rebuilt for each server request (for example a collection)
    - Data that does not need to go to the user can remain on the form, reducing the size of the response and improving security
    - Data can be keep around in a 'pre-save' state. When requested by the user changes can then be persisted to the database
    - Certain information about the view that was rendered, such as input fields, collection paths, and refresh components can be kept on the form to support UI interaction
    Setting this flag to false will prevent the form from being kept in session and as a result will limit what can be done by the framework. In almost all cases this is not recommended.
    
    Note all forms will be cleared when the user session expires (based on the rice configuration). In addition, the framework enables clear points on certain actions to remove the form when it is no longer needed
    Returns:
    
    true if the form should be stored in the user session, false if only request based
  - setPersistFormToSession
```
public void setPersistFormToSession(boolean persistFormToSession)
```
    Setter for the persist form to session indicator
    
    Parameters:
    
    persistFormToSession -
  - getSessionPolicy
```
public ViewSessionPolicy getSessionPolicy()
```
  - setSessionPolicy
```
public void setSessionPolicy(ViewSessionPolicy sessionPolicy)
```
  - getPresentationController
```
public ViewPresentationController getPresentationController()
```
    PresentationController that should be used for the View instance
    The presentation controller is consulted to determine component (group, field) state such as required, read-only, and hidden. The presentation controller does not take into account user permissions. The presentation controller can also output action flags and edit modes that will be set onto the view instance and can be referred to by conditional expressions
    
    Returns:
    
    PresentationController
  - setPresentationController
```
public void setPresentationController(ViewPresentationController presentationController)
```
    Setter for the view's presentation controller
    
    Parameters:
    
    presentationController -
  - setPresentationControllerClass
```
public void setPresentationControllerClass(Class<? extends ViewPresentationController> presentationControllerClass)
```
    Setter for the view's presentation controller by class
    
    Parameters:
    
    presentationControllerClass -
  - getAuthorizer
```
public ViewAuthorizer getAuthorizer()
```
    Authorizer that should be used for the View instance
    The authorizer class is consulted to determine component (group, field) state such as required, read-only, and hidden based on the users permissions. It typically communicates with the Kuali Identity Management system to determine roles and permissions. It is used with the presentation controller and dictionary conditional logic to determine the final component state. The authorizer can also output action flags and edit modes that will be set onto the view instance and can be referred to by conditional expressions
    
    Returns:
    
    Authorizer
  - setAuthorizer
```
public void setAuthorizer(ViewAuthorizer authorizer)
```
    Setter for the view's authorizer
    
    Parameters:
    
    authorizer -
  - setAuthorizerClass
```
public void setAuthorizerClass(Class<? extends ViewAuthorizer> authorizerClass)
```
    Setter for the view's authorizer by class
    
    Parameters:
    
    authorizerClass -
  - getActionFlags
```
public BooleanMap getActionFlags()
```
    Map of strings that flag what actions can be taken in the UI
    These can be used in conditional expressions in the dictionary or by other UI logic
    
    Returns:
    
    action flags
  - setActionFlags
```
public void setActionFlags(BooleanMap actionFlags)
```
    Setter for the action flags Map
    
    Parameters:
    
    actionFlags -
  - getEditModes
```
public BooleanMap getEditModes()
```
    Map of edit modes that enabled for the view
    These can be used in conditional expressions in the dictionary or by other UI logic
    
    Returns:
    
    edit modes
  - setEditModes
```
public void setEditModes(BooleanMap editModes)
```
    Setter for the edit modes Map
    
    Parameters:
    
    editModes -
  - getExpressionVariables
```
public Map<String,String> getExpressionVariables()
```
    Map that contains expressions to evaluate and make available as variables for conditional expressions within the view
    Each Map entry contains one expression variables, where the map key gives the name for the variable, and the map value gives the variable expression. The variables expressions will be evaluated before conditional logic is run and made available as variables for other conditional expressions. Variable expressions can be based on the model and any object contained in the view's context
    
    Returns:
    
    variable expressions
  - setExpressionVariables
```
public void setExpressionVariables(Map<String,String> expressionVariables)
```
    Setter for the view's map of variable expressions
    
    Parameters:
    
    expressionVariables -
  - isSinglePageView
```
public boolean isSinglePageView()
```
    Indicates whether the View only has a single page Group or contains multiple page Group instances. In the case of a single page it is assumed the group's items list contains the section groups for the page, and the page itself is given by the page property (getPage(). This is for convenience of configuration and also can drive other configuration like styling.
    
    Returns:
    
    true if the view only contains one page group, false if it contains multple pages
  - setSinglePageView
```
public void setSinglePageView(boolean singlePageView)
```
    Setter for the single page indicator
    
    Parameters:
    
    singlePageView -
  - isMergeWithPageItems
```
public boolean isMergeWithPageItems()
```
    Indicates whether the default sections specified in the page items list should be included for this view. This only applies to single paged views.
    
    Returns:
    
    true if the view should contain the default sections specified in the page
  - setMergeWithPageItems
```
public void setMergeWithPageItems(boolean mergeWithPageItems)
```
    Setter for the include page default sections indicator
    
    Parameters:
    
    mergeWithPageItems -
  - getPage
```
public PageGroup getPage()
```
    For single paged views (isSinglePageView(), gives the page Group the view should render. The actual items for the page is taken from the group's items list (getItems(), and set onto the give page group. This is for convenience of configuration.
    
    Returns:
    
    page group for single page views
  - setPage
```
public void setPage(PageGroup page)
```
    Setter for the page group for single page views
    
    Parameters:
    
    page -
  - getItems
```
public List<? extends Group> getItems()
```
    Description copied from interface: Container
    
    List of Component instances that are held by the container
    Contained components are rendered within the section template by calling the associated LayoutManager.
    
    Specified by:
    
    getItems in interface Container
    
    Specified by:
    
    getItems in class ContainerBase
    
    Returns:
    
    List component instances
    
    See Also:
    
    ContainerBase.getItems()
  - setItems
```
public void setItems(List<? extends Component> items)
```
    Setter for the view's Group instances
    
    Specified by:
    
    setItems in interface Container
    
    Specified by:
    
    setItems in class ContainerBase
    
    Parameters:
    
    items -
  - getDialogs
```
public List<Group> getDialogs()
```
    Provide a list of dialog groups associated with this view
    
    Returns:
    
    List of dialog Groups
  - setDialogs
```
public void setDialogs(List<Group> dialogs)
```
    Sets the list of dialog groups for this view
    
    Parameters:
    
    dialogs - List of dialog groups
  - getViewMenuLink
```
public Link getViewMenuLink()
```
    Provides configuration for displaying a link to the view from an application menu
    
    Returns:
    
    view link field
  - setViewMenuLink
```
public void setViewMenuLink(Link viewMenuLink)
```
    Setter for the views link field
    
    Parameters:
    
    viewMenuLink -
  - getViewMenuGroupName
```
public String getViewMenuGroupName()
```
    Provides a grouping string for the view to group its menu link (within a portal for instance)
    
    Returns:
    
    menu grouping
  - setViewMenuGroupName
```
public void setViewMenuGroupName(String viewMenuGroupName)
```
    Setter for the views menu grouping
    
    Parameters:
    
    viewMenuGroupName -
  - getViewStatus
```
public String getViewStatus()
```
    Indicates what lifecycle phase the View instance is in
    The view lifecycle begins with the CREATED status. In this status a new instance of the view has been retrieved from the dictionary, but no further processing has been done. After the initialize phase has been run the status changes to INITIALIZED. After the model has been applied and the view is ready for render the status changes to FINAL
    
    Returns:
    
    view status
    
    See Also:
    
    UifConstants.ViewStatus
  - setViewStatus
```
public void setViewStatus(String viewStatus)
```
    Setter for the view status
    
    Parameters:
    
    viewStatus -
  - isInitialized
```
public boolean isInitialized()
```
    Indicates whether the view has been initialized
    
    Returns:
    
    true if the view has been initialized, false if not
  - isFinal
```
public boolean isFinal()
```
    Indicates whether the view has been updated from the model and final updates made
    
    Returns:
    
    true if the view has been updated, false if not
  - getBreadcrumbs
```
public Breadcrumbs getBreadcrumbs()
```
    Breadcrumb widget used for displaying homeward path and history
    
    Returns:
    
    the breadcrumbs
  - setBreadcrumbs
```
public void setBreadcrumbs(Breadcrumbs breadcrumbs)
```
    Parameters:
    
    breadcrumbs - the breadcrumbs to set
  - getBreadcrumbOptions
```
public BreadcrumbOptions getBreadcrumbOptions()
```
    The breadcrumbOptions for this view.
    Render options set at the view level are always ignored (only apply to page level BreadcrumbOptions). BreadcrumbOptions for homewardPathBreadcrumbs, preViewBreadcrumbs, prePageBreadcrumbs, and breadcrumbOverrides are inherited by child pages unless they override them themselves.
    
    Returns:
    
    the BreadcrumbOptions for this view
  - setBreadcrumbOptions
```
public void setBreadcrumbOptions(BreadcrumbOptions breadcrumbOptions)
```
    Set the breadcrumbOptions
    
    Parameters:
    
    breadcrumbOptions -
  - getBreadcrumbItem
```
public BreadcrumbItem getBreadcrumbItem()
```
    The View's breadcrumbItem defines settings for the breadcrumb which appears in the breadcrumb list for this view.
    
    Returns:
    
    the breadcrumbItem
  - setBreadcrumbItem
```
public void setBreadcrumbItem(BreadcrumbItem breadcrumbItem)
```
    Set the breadcrumbItem
    
    Parameters:
    
    breadcrumbItem -
  - getParentLocation
```
public ParentLocation getParentLocation()
```
    The parentLocation defines urls that represent the parent of a View in a conceptial site hierarchy.
    By defining a parent with these urls defined, a breadcrumb chain can be generated and displayed automatically before this View's breadcrumbItem(s). To chain multiple views, the urls must be defining viewId and controllerMapping settings instead of setting an href directly (this will end the chain). If labels are not set on parentLocations, the labels will attempt to be derived from parent views/pages breadcrumbItem and headerText - if these contain expressions which cannot be evaluated in the current context an exception will be thrown.
    
    Returns:
    
    the parentLocation
  - setParentLocation
```
public void setParentLocation(ParentLocation parentLocation)
```
    Set the parentLocation
    
    Parameters:
    
    parentLocation -
  - getPathBasedBreadcrumbs
```
public List<BreadcrumbItem> getPathBasedBreadcrumbs()
```
    The pathBasedBreadcrumbs for this View. These can only be set by the framework.
    
    Returns:
    
    the path based breadcrumbs
  - setPathBasedBreadcrumbs
```
public void setPathBasedBreadcrumbs(List<BreadcrumbItem> pathBasedBreadcrumbs)
```
    The pathBasedBreadcrumbs for this View. This has been added for copyProperties().
    
    Parameters:
    
    pathBasedBreadcrumbs -
  - getGrowls
```
public Growls getGrowls()
```
    Growls widget which sets up global settings for the growls used in this view and its pages
    
    Returns:
    
    the growls
  - setGrowls
```
public void setGrowls(Growls growls)
```
    Parameters:
    
    growls - the growls to set
  - setRefreshBlockUI
```
public void setRefreshBlockUI(BlockUI refreshBlockUI)
```
    Set the refresh BlockUI used with single element blocking (such as ajax based element loading/updates)
    
    Parameters:
    
    refreshBlockUI -
  - getRefreshBlockUI
```
public BlockUI getRefreshBlockUI()
```
    Returns:
    
    returns the refresh block object
  - setNavigationBlockUI
```
public void setNavigationBlockUI(BlockUI navigationBlockUI)
```
    Set the navigation BlockUI used with single page blocking (such as full page loading/saving)
    
    Parameters:
    
    navigationBlockUI -
  - getNavigationBlockUI
```
public BlockUI getNavigationBlockUI()
```
    Returns:
    
    returns the navigation block object
  - isGrowlMessagingEnabled
```
public boolean isGrowlMessagingEnabled()
```
    whether to use growls to show messages - info, warning and error
    Growls use the messages contained in the message map. If enabled, info messages in their entirety will be displayed in growls, for warning and error messages a growl message will notify the user that these messages exist on the page.
    
    If this setting is disabled, it is recommended that infoMessage display be enabled for the page ValidationMessages bean in order to display relevant information to the user. Note: the growl scripts are built out in the PageGroup class.
    
    Returns:
    
    the growlMessagingEnabled
  - setGrowlMessagingEnabled
```
public void setGrowlMessagingEnabled(boolean growlMessagingEnabled)
```
    enable or disable showing of messages using growls
    
    Parameters:
    
    growlMessagingEnabled - the growlMessagingEnabled to set
  - isApplyDirtyCheck
```
public boolean isApplyDirtyCheck()
```
    Indicates whether the form should be validated for dirtyness
    For FormView, it's necessary to validate when the user tries to navigate out of the form. If set, all the InputFields will be validated on refresh, navigate, cancel or close Action or on form unload and if dirty, displays a message and user can decide whether to continue with the action or stay on the form. For lookup and inquiry, it's not needed to validate.
    
    Returns:
    
    true if dirty validation is set
  - setApplyDirtyCheck
```
public void setApplyDirtyCheck(boolean applyDirtyCheck)
```
    Setter for dirty validation.
  - setTranslateCodesOnReadOnlyDisplay
```
public void setTranslateCodesOnReadOnlyDisplay(boolean translateCodesOnReadOnlyDisplay)
```
    Indicates whether the Name of the Code should be displayed when a property is of type KualiCode
    
    Parameters:
    
    translateCodesOnReadOnlyDisplay - indicates whether KualiCode's name should be included.
  - isTranslateCodesOnReadOnlyDisplay
```
public boolean isTranslateCodesOnReadOnlyDisplay()
```
    Returns whether the current view supports displaying KualiCode's name as additional display value
    
    Returns:
    
    true if the current view supports
  - isSupportsRequestOverrideOfReadOnlyFields
```
public boolean isSupportsRequestOverrideOfReadOnlyFields()
```
    Indicates whether the view allows read only fields to be specified on the request URL which will override the view setting
    If enabled, the readOnlyFields request parameter can be sent to indicate fields that should be set read only
    
    Returns:
    
    true if read only request overrides are allowed, false if not
  - setSupportsRequestOverrideOfReadOnlyFields
```
public void setSupportsRequestOverrideOfReadOnlyFields(boolean supportsRequestOverrideOfReadOnlyFields)
```
    Setter for the the read only field override indicator
    
    Parameters:
    
    supportsRequestOverrideOfReadOnlyFields -
  - isDisableNativeAutocomplete
```
public boolean isDisableNativeAutocomplete()
```
    Indicates whether the browser autocomplete functionality should be disabled for the entire form (adds autocomplete="off")
    The browser's native autocomplete functionality can cause issues with security fields and also fields with the UIF suggest widget enabled
    
    Returns:
    
    true if the native autocomplete should be turned off for the form, false if not
  - setDisableNativeAutocomplete
```
public void setDisableNativeAutocomplete(boolean disableNativeAutocomplete)
```
    Setter to disable browser autocomplete for the view's form
    
    Parameters:
    
    disableNativeAutocomplete -
  - isDisableBrowserCache
```
public boolean isDisableBrowserCache()
```
    Enables functionality to bust the browsers cache by appending an unique cache key
    Since response headers are unreliable for preventing caching in all browsers, the framework uses a technique for updating the URL to include an unique cache key. If the HTML 5 History API is supported a parameter can be added to the URL which causes the browser to not find the cached page when the user goes back. If not the framework falls back to using a hash key and resubmitting using script to pull the latest
    
    Returns:
    
    true if cache for the view should be disabled, false if not
  - setDisableBrowserCache
```
public void setDisableBrowserCache(boolean disableBrowserCache)
```
    Setter to disable browser caching of the view
    
    Parameters:
    
    disableBrowserCache -
  - getPreLoadScript
```
public String getPreLoadScript()
```
    Script that is executed at the beginning of page load (before any other script)
    Many used to set server variables client side
    
    Returns:
    
    pre load script
  - setPreLoadScript
```
public void setPreLoadScript(String preLoadScript)
```
    Setter for the pre load script
    
    Parameters:
    
    preLoadScript -
  - getTheme
```
public ViewTheme getTheme()
```
    The theme which contains stylesheets for this view
    
    Returns:
    
    ViewTheme
  - setTheme
```
public void setTheme(ViewTheme theme)
```
    Setter for The theme which contains stylesheets for this view
  - getStateObjectBindingPath
```
public String getStateObjectBindingPath()
```
    The stateObject's binding path, this will be used along with the StateMapping's statePropertyName to determine what field in the model state information is stored in for this view. Used during View validation.
    
    Returns:
    
    stateObjectBindingPath path to the object storing state information
  - setStateObjectBindingPath
```
public void setStateObjectBindingPath(String stateObjectBindingPath)
```
    The stateObject's binding path, this will be used along with the StateMapping's statePropertyName to determine what field in the model state information is stored in for this view. Used during View validation.
    
    Parameters:
    
    stateObjectBindingPath -
  - getStateMapping
```
public StateMapping getStateMapping()
```
    Gets the stateMapping.
    The state mapping object is used to determine the state information for a view, it must include an ordered list of states, and where to find the state information for the view. A stateMapping must be set for state based validation to occur. When stateMapping information is not included, the view's model is considered stateless and all constraints will apply regardless of their state information or replacements (ie, they will function as they did in version 2.1).
    
    Returns:
    
    information needed for state based validation, if null no state based validation functionality will exist and configured constraints will apply regardless of state
    
    Since:
    
    2.2
  - setStateMapping
```
public void setStateMapping(StateMapping stateMapping)
```
    Set the stateMapping
    
    Parameters:
    
    stateMapping -
  - copyProperties
```
protected <T> void copyProperties(T component)
```
    Description copied from class: ComponentBase
    
    Copies the properties over for the copy method
    
    Overrides:
    
    copyProperties in class ContainerBase
    
    Parameters:
    
    component - base bean
    
    See Also:
    
    ComponentBase.copy()
  - completeValidation
```
public void completeValidation(ValidationTrace tracer)
```
    Description copied from interface: Component
    
    Validates different requirements of component compiling a series of reports detailing information on errors found in the component. Used by the RiceDictionaryValidator.
    
    Specified by:
    
    completeValidation in interface Component
    
    Overrides:
    
    completeValidation in class ContainerBase
    
    Parameters:
    
    tracer - Record of component's location
    
    See Also:
    
    Component.completeValidation(org.kuali.rice.krad.datadictionary.validator.ValidationTrace)

Class View

Field Summary

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

Fields inherited from interface org.springframework.core.Ordered

Constructor Summary

Method Summary

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

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

Methods inherited from class org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase

Methods inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.krad.datadictionary.uif.UifDictionaryBean

Methods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean

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

Field Detail

viewIndex

Constructor Detail

View

Method Detail

performInitialization

performApplyModel

performFinalize

assignComponentIds

assignPageIds

assignComponentId

getComponentsForLifecycle

getSupportedComponents

getComponentTypeName

getCurrentPage

sortItems

getNamespaceCode

setNamespaceCode

getViewName

setViewName

isUnifiedHeader

setUnifiedHeader

getTopGroup

setTopGroup

getApplicationHeader

setApplicationHeader

getApplicationFooter

setApplicationFooter

isStickyTopGroup

setStickyTopGroup

isStickyBreadcrumbs

setStickyBreadcrumbs

isStickyHeader

setStickyHeader

isStickyApplicationHeader

setStickyApplicationHeader

isStickyFooter

setStickyFooter

isStickyApplicationFooter

setStickyApplicationFooter

getIdSequence

setIdSequence

getNextId

getEntryPageId

setEntryPageId

getCurrentPageId

setCurrentPageId

getNavigation

setNavigation

getFormClass

setFormClass

getDefaultBindingObjectPath

setDefaultBindingObjectPath

getObjectPathToConcreteClassMapping

setObjectPathToConcreteClassMapping

getAdditionalScriptFiles

setAdditionalScriptFiles

getAdditionalCssFiles

setAdditionalCssFiles

isUseLibraryCssClasses

setUseLibraryCssClasses

getViewTemplates

setViewTemplates

getViewTypeName

setViewTypeName