Package 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, Ordered, 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:

  • Constructor Details

    • ViewHeader

      public ViewHeader()

  • Method Details

    • 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 -