Package com.broadleafcommerce.adminnavigation.domain

Class PropertyDrivenNavMenuItem

java.lang.Object
com.broadleafcommerce.adminnavigation.domain.PropertyDrivenNavMenuItem
All Implemented Interfaces:
Serializable
public class PropertyDrivenNavMenuItem extends Object implements Serializable
Represents a menu item defined by properties. The main difference is that this domain allows submenu items to be defined rather than a purely flat list.
Since:
Admin Navigation 3.0.0, Release Train 3.0.0
See Also:

  • Constructor Details

    • PropertyDrivenNavMenuItem

      public PropertyDrivenNavMenuItem()

  • Method Details

    • getId

      public String getId()
      The context ID of the menu item.

    • getParentMenuItemId

      public String getParentMenuItemId()
      The context ID of the menu item this menu item should be under.

      This is optional, as menu items don't have to be under another menu item. If this value is not set, this menu item will be a top level menu-item.

      If this value is set, then this menu item will appear directly under the specified menu item, however deep that parent menu item is in the overall navigation tree.

    • getLabel

      public String getLabel()
      The user-visible label for this menu item.

      This can be a key into a message bundle for internationalization.

      See Also:

    • getUrl

      public String getUrl()
      The url that is visited when the menu item is clicked.

    • getDisplayOrder

      public Long getDisplayOrder()
      The order in which this item should be displayed relative to its siblings in the navigation tree.

    • getIcon

      public String getIcon()
      The font class to apply to the label of the menu item when it is displayed.

      This field is optional.

      See Also:

    • getScopes

      public List<String> getScopes()
      The security scopes required to view this menu item.

    • getScopeMatchType

      public String getScopeMatchType()
      Controls whether all or any scopes must match. Default is "ANY".

    • getPredicates

      public List<NavigationPredicate> getPredicates()
      The list of predicates to evaluate for this menu item.

    • getPredicateMatchType

      public String getPredicateMatchType()
      Controls whether all or any predicates must match. Default is "ALL".

    • getSubmenu

      public List<PropertyDrivenNavMenuItem> getSubmenu()
      The submenu items for this menu item.

    • setId

      public void setId(String id)
      The context ID of the menu item.

    • setParentMenuItemId

      public void setParentMenuItemId(String parentMenuItemId)
      The context ID of the menu item this menu item should be under.

      This is optional, as menu items don't have to be under another menu item. If this value is not set, this menu item will be a top level menu-item.

      If this value is set, then this menu item will appear directly under the specified menu item, however deep that parent menu item is in the overall navigation tree.

    • setLabel

      public void setLabel(String label)
      The user-visible label for this menu item.

      This can be a key into a message bundle for internationalization.

      See Also:

    • setUrl

      public void setUrl(String url)
      The url that is visited when the menu item is clicked.

    • setDisplayOrder

      public void setDisplayOrder(Long displayOrder)
      The order in which this item should be displayed relative to its siblings in the navigation tree.

    • setIcon

      public void setIcon(String icon)
      The font class to apply to the label of the menu item when it is displayed.

      This field is optional.

      See Also:

    • setScopes

      public void setScopes(List<String> scopes)
      The security scopes required to view this menu item.

    • setScopeMatchType

      public void setScopeMatchType(String scopeMatchType)
      Controls whether all or any scopes must match. Default is "ANY".

    • setPredicates

      public void setPredicates(List<NavigationPredicate> predicates)
      The list of predicates to evaluate for this menu item.

    • setPredicateMatchType

      public void setPredicateMatchType(String predicateMatchType)
      Controls whether all or any predicates must match. Default is "ALL".

    • setSubmenu

      public void setSubmenu(List<PropertyDrivenNavMenuItem> submenu)
      The submenu items for this menu item.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object