public interface MenuItem extends Serializable, org.broadleafcommerce.common.copy.MultiTenantCloneable<MenuItem>
| Modifier and Type | Method and Description |
|---|---|
String |
getActionUrl()
Returns the URL (if applicable) that should be targeted when this menu is clicked.
|
String |
getAltText()
For items of type
MenuItemType.LINK, gets the alt text for the associated image. |
String |
getCustomHtml()
For items of type
MenuItemType.CUSTOM, returns the associated custom HTML. |
String |
getDerivedLabel()
Convenience method that will always return the configured Label if specified.
|
String |
getDerivedUrl()
Convenience method that returns an anchor URL based on the configured MenuItemType.
|
Long |
getId()
Id of this menuItem
|
org.broadleafcommerce.common.media.domain.Media |
getImage()
For items of type
MenuItemType.LINK, gets any Media associated with this Menu Item |
String |
getLabel()
Returns the label for this menu item
|
Menu |
getLinkedMenu()
The menu represented by this MenuItem.
|
org.broadleafcommerce.cms.page.domain.Page |
getLinkedPage()
For items of type
MenuItemType.PAGE, returns the associated page. |
MenuItemType |
getMenuItemType()
Returns the
MenuItemType |
Menu |
getParentMenu()
Returns the
Menu to which this menuItem belongs |
BigDecimal |
getSequence()
Returns the order of this MenuItem in the
getParentMenu() |
void |
setActionUrl(String actionUrl)
Sets the URL to go to if this menu is clicked.
|
void |
setAltText(String altText)
For items of type
MenuItemType.LINK, stores the alt text for the associated image. |
void |
setCustomHtml(String customHtml)
For items of type
MenuItemType.CUSTOM, sets the associated custom HTML. |
void |
setId(Long id)
Sets the id of this menuItem.
|
void |
setImage(org.broadleafcommerce.common.media.domain.Media media)
For items of type
MenuItemType.LINK, sets an Image for this Menu Item |
void |
setLabel(String label)
Sets the value for this menu item to display on a site.
|
void |
setLinkedMenu(Menu menu)
Sets the linked menu.
|
void |
setLinkedPage(org.broadleafcommerce.cms.page.domain.Page linkedPage)
For items of type
MenuItemType.PAGE, sets the associated page. |
void |
setMenuItemType(MenuItemType menuItemType)
Sets the
MenuItemType |
void |
setParentMenu(Menu menu)
Sets the
Menu to which this menuItem belongs |
void |
setSequence(BigDecimal sequence)
Sets the order of this MenuItem in the
getParentMenu() |
Long getId()
void setId(Long id)
id - String getLabel()
to get the label based on MenuItemTypevoid setLabel(String label)
label - MenuItemType getMenuItemType()
MenuItemTypevoid setMenuItemType(MenuItemType menuItemType)
MenuItemTypemenuItemType - String getActionUrl()
void setActionUrl(String actionUrl)
actionUrl - org.broadleafcommerce.common.media.domain.Media getImage()
MenuItemType.LINK, gets any Media associated with this Menu Itemvoid setImage(org.broadleafcommerce.common.media.domain.Media media)
MenuItemType.LINK, sets an Image for this Menu ItemimageUrl - void setParentMenu(Menu menu)
Menu to which this menuItem belongsmenu - Menu getLinkedMenu()
void setLinkedMenu(Menu menu)
menu - void setSequence(BigDecimal sequence)
getParentMenu()sequence - BigDecimal getSequence()
getParentMenu()String getAltText()
MenuItemType.LINK, gets the alt text for the associated image.void setAltText(String altText)
MenuItemType.LINK, stores the alt text for the associated image.org.broadleafcommerce.cms.page.domain.Page getLinkedPage()
MenuItemType.PAGE, returns the associated page.void setLinkedPage(org.broadleafcommerce.cms.page.domain.Page linkedPage)
MenuItemType.PAGE, sets the associated page.String getCustomHtml()
MenuItemType.CUSTOM, returns the associated custom HTML.void setCustomHtml(String customHtml)
MenuItemType.CUSTOM, sets the associated custom HTML.String getDerivedUrl()
MenuItemType.PAGE,
MenuItemType.PRODUCT, or MenuItemType.CATEGORY and will use corresponding linked URL.String getDerivedLabel()
MenuItemType.PRODUCT, or MenuItemType.CATEGORY,
or MenuItemType.SUBMENU, it will return the corresponding linked name.Copyright © 2015. All rights reserved.