Package org.kuali.rice.krad.uif.container

Class SidebarNavigationGroup

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.container.GroupBase
org.kuali.rice.krad.uif.container.SidebarNavigationGroup
All Implemented Interfaces:
Serializable, Cloneable, Copyable, DictionaryBean, UifDictionaryBean, Component, Ordered, ScriptEventSupport, Container, Group, LifecycleElement, Helpable, org.springframework.core.Ordered
public class SidebarNavigationGroup extends GroupBase
A navigation group which renders a menu with items, that is shown at the side of the page with collapse. functionality

Items of this menu should only be of Header, Action, and ToggleMenu types. Actions and ToggleMenus must have icons to render correctly when using the collapse functionality, but will inherit the defaultItemIconClass if their iconClass properties are not set.

Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Constructor Details

    • SidebarNavigationGroup

      public SidebarNavigationGroup()

  • Method Details

    • performFinalize

      public void performFinalize(Object model, LifecycleElement parent)
      Adds icons and classes to Action and ToggleMenu items which exist in its items for rendering purposes. Sets the section boolean to true if this group has a rendering header with text The following finalization is performed:
      • Sets the headerText of the header Group if it is blank
      • Set the messageText of the summary Message if it is blank
      • Finalizes LayoutManager
      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 GroupBase
      Parameters:
      model - - top level object containing the data
      parent - - parent component

    • isRenderCollapse

      public boolean isRenderCollapse()
      When true, render the collapse icon (an icon that the user can click to close/open the sidebar navigation).
      Returns:
      true if the collapse icon should be rendered, false otherwise

    • setRenderCollapse

      public void setRenderCollapse(boolean renderCollapse)
      See Also:

    • getOpenedToggleIconClass

      public String getOpenedToggleIconClass()
      Icon class to use to render a opened icon for sub menus (the ToggleMenu items) that exist in this navigation menu.
      Returns:
      the opened ToggleMenu icon

    • setOpenedToggleIconClass

      public void setOpenedToggleIconClass(String openedToggleIconClass)
      See Also:

    • getClosedToggleIconClass

      public String getClosedToggleIconClass()
      Icon class to use to render a closed icon for sub menus (the ToggleMenu items) that exist in this navigation menu.
      Returns:
      the closed ToggleMenu icon

    • setClosedToggleIconClass

      public void setClosedToggleIconClass(String closedToggleIconClass)
      See Also:

    • getDefaultItemIconClass

      public String getDefaultItemIconClass()
      The default css class to use for the icons of the items which exist in this navigation menu if they are not set on the items themselves (icons are required by Action and ToggleMenu items in this menu).
      Returns:
      the default icon class

    • setDefaultItemIconClass

      public void setDefaultItemIconClass(String defaultItemIconClass)
      See Also: