org.kuali.rice.krad.uif.element
Class ViewHeader

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.element.ContentElementBase
                  org.kuali.rice.krad.uif.element.Header
                      org.kuali.rice.krad.uif.element.ViewHeader

All Implemented Interfaces:

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

public class ViewHeader
extends Header

The ViewHeader component represents the header for the view

This header has support for a "Unified" header in which both the page title and view title appear in its content. An "area title" and "metadata" can also be set to provide context.

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

ViewHeader()

Method Summary

protected <T> void	copyProperties(T component) Copies the properties over for the copy method
Message	getAreaTitleMessage() Message object backing areaTitleText
String	getAreaTitleText() Represents the area in which this view and page exist (conceptially in the site); this title appears above the view title.
List<Component>	getComponentsForLifecycle() List of components that are contained within the component and should be sent through the lifecycle
Message	getMetadataMessage() The metadataMessage represents any relevant metadata about the view (last saved, etc).
String	getMetadataText() The metadataText represents any relevant metadata about the view (last saved, etc).
Message	getSupportTitleMessage() The supportTitleMessage represents the sub-area of this view that supports what the page is displaying, this is the Message component
String	getSupportTitleText() The supportTitleText represents the sub-area of this view that explains what the page is displaying; this is the text used in supportTitleMessage
boolean	isSticky() If true, this ViewHeader will be sticky (fixed to top of window, stays at top during scrolling)
void	performFinalize(View view, Object model, Component parent) Sets the supportTitleMessage if one has not been set and unified header is being used, based on the value of page title
void	setAreaTitleMessage(Message areaTitleMessage) Set the areaTitleMessage object
void	setAreaTitleText(String areaTitle) Set the areaTitle
void	setMetadataMessage(Message metadataMessage) Set the metadataMessage
void	setMetadataText(String metadataText) Set the metadataText
void	setSticky(boolean sticky) Set to true to make this ViewHeader sticky
void	setSupportTitleMessage(Message supportTitleMessage) Set the supportTitleMessage
void	setSupportTitleText(String supportTitle) Set the supportTitleText

Methods inherited from class org.kuali.rice.krad.uif.element.Header

completeValidation, getHeaderLevel, getHeaderStyleClassesAsString, getHeaderTagCssClasses, getHeaderTagStyle, getHeaderText, getInlineComponents, getItems, getLowerGroup, getRichHeaderMessage, getRightGroup, getUpperGroup, performApplyModel, setHeaderLevel, setHeaderTagCssClasses, setHeaderTagStyle, setHeaderText, setInlineComponents, setItems, setLowerGroup, setRichHeaderMessage, setRightGroup, setUpperGroup

Methods inherited from class org.kuali.rice.krad.uif.element.ContentElementBase

getComponentTypeName

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, getComponentPrototypes, 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, performInitialization, 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, getNamespaceCode, setComponentCode, setNamespaceCode

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, getComponentPrototypes, 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, performInitialization, 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, getNamespaceCode

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, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript

Constructor Detail

ViewHeader

public ViewHeader()

Method Detail

performFinalize

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

Sets the supportTitleMessage if one has not been set and unified header is being used, based on the value of page title

Specified by:

performFinalize in interface Component

Overrides:

performFinalize in class Header

Parameters:

view - - view instance that should be finalized for rendering

model - - top level object containing the data

parent - - parent component

See Also:

Component.performFinalize(org.kuali.rice.krad.uif.view.View, Object, org.kuali.rice.krad.uif.component.Component)

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 Header

Returns:

List child components

See Also:

ComponentBase.getComponentsForLifecycle()

getAreaTitleText

public String getAreaTitleText()

Represents the area in which this view and page exist (conceptially in the site); this title appears above the view title.

Returns:

the areaTitle text

setAreaTitleText

public void setAreaTitleText(String areaTitle)

Set the areaTitle

Parameters:

areaTitle -

getAreaTitleMessage

public Message getAreaTitleMessage()

Message object backing areaTitleText

Returns:

the areaTitle Message object

setAreaTitleMessage

public void setAreaTitleMessage(Message areaTitleMessage)

Set the areaTitleMessage object

Parameters:

areaTitleMessage -

getSupportTitleText

public String getSupportTitleText()

The supportTitleText represents the sub-area of this view that explains what the page is displaying; this is the text used in supportTitleMessage

This title appears below the view title and will be automatically set to the page title if not set.

Returns:

the supportTitle text

setSupportTitleText

public void setSupportTitleText(String supportTitle)

Set the supportTitleText

Parameters:

supportTitle -

getSupportTitleMessage

public Message getSupportTitleMessage()

The supportTitleMessage represents the sub-area of this view that supports what the page is displaying, this is the Message component

This title appears below the view title and will be automatically set to the page title if not messageText is not set.

Returns:

the supportTitle Message object

setSupportTitleMessage

public void setSupportTitleMessage(Message supportTitleMessage)

Set the supportTitleMessage

Parameters:

supportTitleMessage -

getMetadataText

public String getMetadataText()

The metadataText represents any relevant metadata about the view (last saved, etc). This message will appear in the bottom right of the ViewHeader container.

Returns:

the metadataText string

setMetadataText

public void setMetadataText(String metadataText)

Set the metadataText

Parameters:

metadataText -

getMetadataMessage

public Message getMetadataMessage()

The metadataMessage represents any relevant metadata about the view (last saved, etc). This message will appear in the bottom right of the ViewHeader container.

Returns:

the metadataMessage object

setMetadataMessage

public void setMetadataMessage(Message metadataMessage)

Set the metadataMessage

Parameters:

metadataMessage -

isSticky

public boolean isSticky()

If true, this ViewHeader will be sticky (fixed to top of window, stays at top during scrolling)

Returns:

true if sticky, false otherwise

setSticky

public void setSticky(boolean sticky)

Set to true to make this ViewHeader sticky

Parameters:

sticky -

copyProperties

protected <T> void copyProperties(T component)

Description copied from class: ComponentBase

Copies the properties over for the copy method

Overrides:

copyProperties in class Header

Parameters:

component - base bean

See Also:

ComponentBase.copy()