Package org.kuali.rice.krad.uif.element

Class NavigationBar

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.NavigationBar
All Implemented Interfaces:
Serializable, Cloneable, Copyable, DictionaryBean, UifDictionaryBean, Component, Ordered, ScriptEventSupport, ContentElement, LifecycleElement, org.springframework.core.Ordered
public class NavigationBar extends ContentElementBase
Component that renders a navigation bar, including a branding and navigation group.
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Constructor Details

    • NavigationBar

      public NavigationBar()

  • Method Details

    • getBrandText

      public String getBrandText()
      Header text to use for the application branding.

      Note either the branding text, or the getBrandImage() should be set, but not both

      Returns:
      String text to use for branding

    • setBrandText

      public void setBrandText(String brandText)
      See Also:

    • getBrandImage

      public Image getBrandImage()
      Image component instance to use for the application branding.

      Note either the branding image, or the getBrandText() should be set, but not both

      Returns:
      Image component to use for branding

    • setBrandImage

      public void setBrandImage(Image brandImage)
      See Also:

    • getBrandUrl

      public String getBrandUrl()
      String of URL set in rendering the navigation component.
      Returns:
      String of the URL

    • setBrandUrl

      public void setBrandUrl(String brandUrl)
      See Also:

    • getNavigationBarGroup

      public Group getNavigationBarGroup()
      Group instance that holds the navigation items (such as links) for the navigation bar.
      Returns:
      Group instance for navigation

    • setNavigationBarGroup

      public void setNavigationBarGroup(Group navigationBarGroup)
      See Also:

    • getItems

      public List<? extends Component> getItems()
      Convenience getter for the navigation group items.
      Returns:
      list of components for the navigation bar group

    • setItems

      public void setItems(List<Component> items)
      Convenience setter that sets the given items onto the getNavigationBarGroup().
      Parameters:
      items - list of items for the navigation group