org.kuali.rice.krad.uif.view
Class View

java.lang.Object
  extended by org.kuali.rice.krad.uif.component.ConfigurableBase
      extended by org.kuali.rice.krad.uif.component.ComponentBase
          extended by org.kuali.rice.krad.uif.container.ContainerBase
              extended by org.kuali.rice.krad.uif.view.View
All Implemented Interfaces:
Serializable, Component, Configurable, 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 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
View()
           
 
Method Summary
 void addToClientSideState(String componentId, String variableName, Object value)
          Adds a variable name/value pair to the client side state map associated with the given component id
 void assignComponentIds(Component component)
          Assigns an id to the component if one was not configured
 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
 BreadCrumbs getBreadcrumbs()
          Breadcrumb widget used for displaying homeward path and history
 String getBreadcrumbTitleDisplayOption()
          The option to use when appending the view label on the breadcrumb title.
 String getBreadcrumbTitlePropertyName()
          The property name to be used to determine what will be used in the breadcrumb title of this view
 Map<String,Object> getClientSideState()
          Map of key name/value pairs that will be exposed on the client with JavaScript
 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
 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<? extends 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
 NavigationGroup getNavigation()
          NavigationGroup instance for the View
 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.
 int getPreloadPoolSize()
          Specifies the size of the pool that will contain pre-loaded views
 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
 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
 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
 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 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 isPersistFormToSession()
          Indicates whether the form (model) associated with the view should be stored in the user session
 boolean isRenderBreadcrumbsInView()
          Indicates whether the breadcrumbs should be rendered in the view or if they have been rendered in the application header
 boolean isSinglePageView()
          Indicates whether the View only has a single page Group or contains multiple page Group instances.
 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
 void performApplyModel(View view, Object model, Component parent)
          The following updates are done here: Invoke expression evaluation on view theme
 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
 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 setBreadcrumbs(BreadCrumbs breadcrumbs)
           
 void setBreadcrumbTitleDisplayOption(String breadcrumbTitleDisplayOption)
          Setter for the append option
 void setBreadcrumbTitlePropertyName(String breadcrumbTitlePropertyName)
          Setter for the view label property name
 void setClientSideState(Map<String,Object> clientSideState)
          Setter for the client side state map
 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<? extends Group> dialogs)
          Sets the list of dialog groups for this view
 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 setNamespaceCode(String namespaceCode)
          Setter for the view's namespace code
 void setNavigation(NavigationGroup navigation)
          Setter for the View's NavigationGroup
 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 setPersistFormToSession(boolean persistFormToSession)
          Setter for the persist form to session indicator
 void setPreloadPoolSize(int preloadPoolSize)
          Setter for the preloaded view pool size
 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 setRenderBreadcrumbsInView(boolean renderBreadcrumbsInView)
          Setter for the render breadcrumbs in view indicator
 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 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 setTranslateCodesOnReadOnlyDisplay(boolean translateCodesOnReadOnlyDisplay)
          Indicates whether the Name of the Code should be displayed when a property is of type KualiCode
 void setViewHelperServiceClass(Class<? extends ViewHelperService> viewHelperServiceClass)
          Setter for the ViewHelperService class name
 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 setViewTypeName(UifConstants.ViewType viewTypeName)
          Setter for the view's type name
 
Methods inherited from class org.kuali.rice.krad.uif.container.ContainerBase
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
addDataAttribute, addStyleClass, appendToStyle, getAlign, getAllDataAttributesJs, getBaseId, getColSpan, getComplexDataAttributesJs, getComponentModifiers, getComponentSecurity, getComponentSecurityClass, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getDataMetaAttribute, getDataRoleAttribute, getDataTypeAttribute, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getMethodToCallOnRefresh, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, isDisableSessionPersistence, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, isSkipInTabOrder, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAlign, setBaseId, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDataMetaAttribute, setDataRoleAttribute, setDataTypeAttribute, setDisableSessionPersistence, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setForceSessionPersistence, setHidden, setId, setMethodToCallOnRefresh, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setSkipInTabOrder, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setWidth
 
Methods inherited from class org.kuali.rice.krad.uif.component.ConfigurableBase
getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph
 
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
addDataAttribute, addStyleClass, appendToStyle, getAllDataAttributesJs, getBaseId, getColSpan, getComplexDataAttributesJs, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getTemplate, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, isDisableSessionPersistence, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, pushAllToContext, pushObjectToContext, setBaseId, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setForceSessionPersistence, setHidden, setId, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setStyle, setTemplate, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip
 
Methods inherited from interface org.kuali.rice.krad.uif.component.Configurable
getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph
 
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, setOnBlurScript, setOnLoadScript
 

Constructor Detail

View

public View()
Method Detail

performInitialization

public void performInitialization(View view,
                                  Object model)
The following initialization is performed:

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(View, java.lang.Object)

performApplyModel

public void performApplyModel(View view,
                              Object model,
                              Component parent)
The following updates are done here:

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:

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(View, java.lang.Object, org.kuali.rice.krad.uif.component.Component)

assignComponentIds

public void assignComponentIds(Component component)
Assigns an id to the component if one was not configured

Parameters:
component - - component instance 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()

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()

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

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

Returns:
String namespace code

setNamespaceCode

public void setNamespaceCode(String namespaceCode)
Setter for the view's namespace code

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:
String name of view

setViewName

public void setViewName(String viewName)
Setter for the view's name

Parameters:
viewName -

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:
HeaderField 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:
Group application footer

setApplicationFooter

public void setApplicationFooter(Group applicationFooter)
Setter for the application footer

Parameters:
applicationFooter -

getIdSequence

public int getIdSequence()
Current sequence value for id assignment

Returns:
int 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:
String 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:
String 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:
String 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 NavigationGroup 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(NavigationGroup 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 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:
String 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:
List 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:
List 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 -

getPreloadPoolSize

public int getPreloadPoolSize()
Specifies the size of the pool that will contain pre-loaded views

The spring loading of some views can take a few seconds which hurts performance. The framework supports pre-loading of view instances so they are available right away when a request is made. This property configures how many view instances will be pre-loaded. A value of 0 (the default) means no view instances will be pre-loaded

Returns:
int number of view instances to pre-load

setPreloadPoolSize

public void setPreloadPoolSize(int preloadPoolSize)
Setter for the preloaded view pool size

Parameters:
preloadPoolSize -

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:
String 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

Parameters:
viewHelperServiceClass -

getViewHelperService

public ViewHelperService getViewHelperService()
Creates the ViewHelperService associated with the View

Returns:
ViewHelperService instance

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:

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:
boolean 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 -

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:
BooleanMap 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:
BooleanMap 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:
Map 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:
boolean 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 -

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:
Group 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<? extends Group> getDialogs()
Provide a list of dialog groups associated with this view

Returns:
List of dialog Groups

setDialogs

public void setDialogs(List<? extends 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:
Link 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:
String 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:
String 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:
boolean 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:
boolean 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

isRenderBreadcrumbsInView

public boolean isRenderBreadcrumbsInView()
Indicates whether the breadcrumbs should be rendered in the view or if they have been rendered in the application header

For layout purposes it is sometimes necessary to render the breadcrumbs in the application header. This flag indicates that is being done (by setting to false) and therefore should not be rendered in the view template.

Returns:
boolean true if breadcrumbs should be rendered in the view, false if not (are rendered in the application header)

setRenderBreadcrumbsInView

public void setRenderBreadcrumbsInView(boolean renderBreadcrumbsInView)
Setter for the render breadcrumbs in view indicator

Parameters:
renderBreadcrumbsInView -

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

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

getBreadcrumbTitlePropertyName

public String getBreadcrumbTitlePropertyName()
The property name to be used to determine what will be used in the breadcrumb title of this view

The title can be determined from a combination of this and viewLabelFieldbindingInfo: If only viewLabelFieldPropertyName is set, the title we be determined against the defaultBindingObjectPath. If only viewLabelFieldbindingInfo is set it must provide information about what object(bindToForm or explicit) and path to use. If both viewLabelFieldbindingInfo and viewLabelFieldPropertyName are set, the bindingInfo will be used with a the viewLabelFieldPropertyName as its bindingPath. If neither are set, the default title attribute from the dataObject's metadata (determined by the defaultBindingObjectPath's object) will be used.

Returns:
String property name whose value should be displayed in view label

setBreadcrumbTitlePropertyName

public void setBreadcrumbTitlePropertyName(String breadcrumbTitlePropertyName)
Setter for the view label property name

Parameters:
breadcrumbTitlePropertyName - the viewLabelFieldPropertyName to set

getBreadcrumbTitleDisplayOption

public String getBreadcrumbTitleDisplayOption()
The option to use when appending the view label on the breadcrumb title. Available options: 'dash', 'parenthesis', and 'replace'(don't append - simply replace the title). MUST be set for the viewLabelField to be used in the breadcrumb, if not set no appendage will be added.

Returns:
the appendOption

setBreadcrumbTitleDisplayOption

public void setBreadcrumbTitleDisplayOption(String breadcrumbTitleDisplayOption)
Setter for the append option

Parameters:
breadcrumbTitleDisplayOption - the appendOption to set

getClientSideState

public Map<String,Object> getClientSideState()
Map of key name/value pairs that will be exposed on the client with JavaScript

Any state contained in the Map will be in addition to general state added by the ViewHelperService and also state generated from the component properties annotated with ClientSideState. If this map does contain a key that is the same as the generated state, it will override the generated, with the exception of keys that refer to component ids and have a nested map as value, which will be merged

Returns:
Map contains key name/value pairs to expose on client

setClientSideState

public void setClientSideState(Map<String,Object> clientSideState)
Setter for the client side state map

Parameters:
clientSideState -

addToClientSideState

public void addToClientSideState(String componentId,
                                 String variableName,
                                 Object value)
Adds a variable name/value pair to the client side state map associated with the given component id

Parameters:
componentId - - id of the component the state is associated with
variableName - - name to expose the state as
value - - initial value for the variable on the client

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:
boolean 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 -

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:
String 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:

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:
StateMapping 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 -


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.