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, Copyable, DictionaryBean, UifDictionaryBean, Component, ScriptEventSupport, ContentElement, LifecycleElement, 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 class org.kuali.rice.krad.uif.component.ComponentBase

templateOptions

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

componentCode, namespaceCode

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

Constructors

Constructor and Description
ViewHeader()

Method Summary

Methods

Modifier and Type	Method and Description
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.
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(Object model, LifecycleElement parent) Sets the supportTitleMessage if one has not been set and unified header is being used, based on the value of page title The following finalization is performed: Set render on header group to false if no items are configured The following finalization is done here: progressiveRender and conditionalRefresh variables are processed if set If any of the style properties were given, sets the style string on the style property Set the skipInTabOrder flag for nested components The last phase before the view is rendered
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, getAdditionalTemplates, getHeaderLevel, getHeaderStyleClassesAsString, getHeaderTagCssClasses, getHeaderTagStyle, getHeaderText, getInlineComponents, getItems, getLowerGroup, getRichHeaderMessage, getRightGroup, getUpperGroup, isHeaderTagOnly, performApplyModel, setHeaderLevel, setHeaderTagCssClasses, setHeaderTagOnly, setHeaderTagStyle, setHeaderText, setInlineComponents, setItems, setLowerGroup, setRichHeaderMessage, setRightGroup, setUpperGroup

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

afterEvaluateExpression, getComponentTypeName

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

addAriaAttribute, addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, appendToStyle, checkMutable, clone, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getAriaAttributes, getAriaAttributesAsString, getCanCopyOnReadOnly, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContainerIdSuffix, getContext, getCssClasses, getCssGridSizes, getDataAttributes, getEventHandlerScript, getExcludeIf, getExcludeUnless, getFieldsToSendOnRefresh, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getLibraryCssClasses, getMethodToCallOnRefresh, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnInputScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getPhasePathMapping, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getReadOnly, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRole, getRowSpan, getScriptDataAttributes, getScriptDataAttributesJs, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getViewPath, getViewStatus, getWidth, getWrapperCssClasses, getWrapperCssClassesAsString, getWrapperStyle, initializeComponentSecurity, isDisableSessionPersistence, isDisclosedByAction, isEditAuthz, isFinal, isForceSessionPersistence, isHidden, isInitialized, isModelApplied, isMutable, isOmitFromFormPost, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isRefreshedByAction, isRender, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, isSkipInTabOrder, isViewAuthz, notifyCompleted, performInitialization, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setAriaAttributes, setCanCopyOnReadOnly, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContainerIdSuffix, setContext, setCssClasses, setCssGridSizes, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setEditAuthz, setExcludeIf, setExcludeUnless, setFieldsToSendOnRefresh, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setForceSessionPersistence, setHidden, setId, setLibraryCssClasses, setMethodToCallOnRefresh, setOmitFromFormPost, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnInputScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setPhasePathMapping, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRole, setRowSpan, setScriptDataAttributes, setSelfRendered, setSkipInTabOrder, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setViewAuthz, setViewPath, setViewStatus, setWidth, setWrapperCssClasses, setWrapperStyle, skipLifecycle

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

getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions

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

copy, dataDictionaryPostProcessing, getComponentCode, getNamespaceCode, setComponentCode, setNamespaceCode

Methods inherited from class java.lang.Object

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

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

addAriaAttribute, addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, appendToStyle, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getAriaAttributes, getAriaAttributesAsString, getCanCopyOnReadOnly, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getCssGridSizes, getDataAttributes, getEventHandlerScript, getExcludeIf, getExcludeUnless, getFieldsToSendOnRefresh, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getLibraryCssClasses, getMethodToCallOnRefresh, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getReadOnly, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRole, getRowSpan, getScriptDataAttributes, getScriptDataAttributesJs, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, getWrapperCssClasses, getWrapperStyle, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isOmitFromFormPost, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isRefreshedByAction, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setAriaAttributes, setCanCopyOnReadOnly, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setCssGridSizes, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setFieldsToSendOnRefresh, setForceSessionPersistence, setHidden, setLibraryCssClasses, setOmitFromFormPost, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRole, setRowSpan, setScriptDataAttributes, setSelfRendered, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setViewStatus, setWidth, setWrapperCssClasses, setWrapperStyle

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

getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions

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

dataDictionaryPostProcessing, getComponentCode, getNamespaceCode

Methods inherited from interface org.kuali.rice.krad.uif.util.LifecycleElement

checkMutable, getContainerIdSuffix, getId, getPhasePathMapping, getViewPath, getViewStatus, isFinal, isInitialized, isModelApplied, isMutable, isRender, notifyCompleted, performInitialization, pushAllToContext, pushObjectToContext, setContainerIdSuffix, setId, setPhasePathMapping, setRender, setViewPath, skipLifecycle

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

clone

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

getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnInputScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnInputScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript

Constructor Detail

ViewHeader

public ViewHeader()

Method Detail

performFinalize

public void performFinalize(Object model,
                   LifecycleElement parent)

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

• Set render on header group to false if no items are configured

The following finalization is done here:

• progressiveRender and conditionalRefresh variables are processed if set
• If any of the style properties were given, sets the style string on the style property
• Set the skipInTabOrder flag for nested components

The last phase before the view is rendered

Here final preparations can be made based on the updated view state.

Specified by:

performFinalize in interface LifecycleElement

Overrides:

performFinalize in class Header

Parameters:

model - - top level object containing the data

parent - - parent component

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 -