org.broadleafcommerce.menu.domain

Class MenuItemImpl

java.lang.Object

org.broadleafcommerce.menu.domain.MenuItemImpl

All Implemented Interfaces:

Serializable, org.broadleafcommerce.common.copy.MultiTenantCloneable<MenuItem>, org.broadleafcommerce.common.extensibility.jpa.copy.ProfileEntity, MenuItem

@Entity
public class MenuItemImpl
extends Object
implements MenuItem, org.broadleafcommerce.common.extensibility.jpa.copy.ProfileEntity

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MenuItemImpl.Presentation

Field Summary

Fields

Modifier and Type	Field and Description
protected String	actionUrl
protected String	altText
protected String	customHtml
protected Long	id
protected org.broadleafcommerce.common.media.domain.Media	image
protected String	label
protected Menu	linkedMenu
protected org.broadleafcommerce.cms.page.domain.Page	linkedPage
protected Menu	parentMenu
protected BigDecimal	sequence
protected String	type

Constructor Summary

Constructors

Constructor and Description
MenuItemImpl()

Method Summary

Modifier and Type	Method and Description
<G extends MenuItem> org.broadleafcommerce.common.copy.CreateResponse<G>	createOrRetrieveCopyInstance(org.broadleafcommerce.common.copy.MultiTenantCopyContext context)
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 MenuItem.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 image) 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 linkedMenu) 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 parentMenu) Sets the Menu to which this menuItem belongs
void	setSequence(BigDecimal sequence) Sets the order of this MenuItem in the MenuItem.getParentMenu()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

id

protected Long id

label

protected String label

type

protected String type

sequence

protected BigDecimal sequence

parentMenu

protected Menu parentMenu

actionUrl

protected String actionUrl

image

protected org.broadleafcommerce.common.media.domain.Media image

altText

protected String altText

linkedMenu

protected Menu linkedMenu

linkedPage

protected org.broadleafcommerce.cms.page.domain.Page linkedPage

customHtml

protected String customHtml

Constructor Detail

MenuItemImpl

public MenuItemImpl()

Method Detail

getId

public Long getId()

Description copied from interface: MenuItem

Id of this menuItem

Specified by:

getId in interface MenuItem

Returns:

setId

public void setId(Long id)

Description copied from interface: MenuItem

Sets the id of this menuItem.

Specified by:

setId in interface MenuItem

getMenuItemType

public MenuItemType getMenuItemType()

Description copied from interface: MenuItem

Returns the MenuItemType

Specified by:

getMenuItemType in interface MenuItem

Returns:

setMenuItemType

public void setMenuItemType(MenuItemType menuItemType)

Description copied from interface: MenuItem

Sets the MenuItemType

Specified by:

setMenuItemType in interface MenuItem

getLabel

public String getLabel()

Description copied from interface: MenuItem

Returns the label for this menu item

Specified by:

getLabel in interface MenuItem

Returns:

See Also:

to get the label based on MenuItemType

setLabel

public void setLabel(String label)

Description copied from interface: MenuItem

Sets the value for this menu item to display on a site.

Specified by:

setLabel in interface MenuItem

getActionUrl

public String getActionUrl()

Description copied from interface: MenuItem

Returns the URL (if applicable) that should be targeted when this menu is clicked.

Specified by:

getActionUrl in interface MenuItem

Returns:

setActionUrl

public void setActionUrl(String actionUrl)

Description copied from interface: MenuItem

Sets the URL to go to if this menu is clicked.

Specified by:

setActionUrl in interface MenuItem

getImage

public org.broadleafcommerce.common.media.domain.Media getImage()

Description copied from interface: MenuItem

For items of type MenuItemType.LINK, gets any Media associated with this Menu Item

Specified by:

getImage in interface MenuItem

Returns:

setImage

public void setImage(org.broadleafcommerce.common.media.domain.Media image)

Description copied from interface: MenuItem

For items of type MenuItemType.LINK, sets an Image for this Menu Item

Specified by:

setImage in interface MenuItem

getSequence

public BigDecimal getSequence()

Description copied from interface: MenuItem

Returns the order of this MenuItem in the MenuItem.getParentMenu()

Specified by:

getSequence in interface MenuItem

Returns:

setSequence

public void setSequence(BigDecimal sequence)

Description copied from interface: MenuItem

Sets the order of this MenuItem in the MenuItem.getParentMenu()

Specified by:

setSequence in interface MenuItem

getParentMenu

public Menu getParentMenu()

Description copied from interface: MenuItem

Returns the Menu to which this menuItem belongs

Specified by:

getParentMenu in interface MenuItem

Returns:

setParentMenu

public void setParentMenu(Menu parentMenu)

Description copied from interface: MenuItem

Sets the Menu to which this menuItem belongs

Specified by:

setParentMenu in interface MenuItem

getLinkedMenu

public Menu getLinkedMenu()

Description copied from interface: MenuItem

The menu represented by this MenuItem. (Allows for nested menus).

Specified by:

getLinkedMenu in interface MenuItem

Returns:

setLinkedMenu

public void setLinkedMenu(Menu linkedMenu)

Description copied from interface: MenuItem

Sets the linked menu.

Specified by:

setLinkedMenu in interface MenuItem

getAltText

public String getAltText()

Description copied from interface: MenuItem

For items of type MenuItemType.LINK, gets the alt text for the associated image.

Specified by:

getAltText in interface MenuItem

Returns:

setAltText

public void setAltText(String altText)

Description copied from interface: MenuItem

For items of type MenuItemType.LINK, stores the alt text for the associated image.

Specified by:

setAltText in interface MenuItem

getLinkedPage

public org.broadleafcommerce.cms.page.domain.Page getLinkedPage()

Description copied from interface: MenuItem

For items of type MenuItemType.PAGE, returns the associated page.

Specified by:

getLinkedPage in interface MenuItem

Returns:

setLinkedPage

public void setLinkedPage(org.broadleafcommerce.cms.page.domain.Page linkedPage)

Description copied from interface: MenuItem

For items of type MenuItemType.PAGE, sets the associated page.

Specified by:

setLinkedPage in interface MenuItem

getCustomHtml

public String getCustomHtml()

Description copied from interface: MenuItem

For items of type MenuItemType.CUSTOM, returns the associated custom HTML.

Specified by:

getCustomHtml in interface MenuItem

Returns:

setCustomHtml

public void setCustomHtml(String customHtml)

Description copied from interface: MenuItem

For items of type MenuItemType.CUSTOM, sets the associated custom HTML.

Specified by:

setCustomHtml in interface MenuItem

getDerivedUrl

public String getDerivedUrl()

Description copied from interface: MenuItem

Convenience method that returns an anchor URL based on the configured MenuItemType. Will return getActionUrl() unless type is MenuItemType.PAGE, MenuItemType.PRODUCT, or MenuItemType.CATEGORY and will use corresponding linked URL.

Specified by:

getDerivedUrl in interface MenuItem

Returns:

getDerivedLabel

public String getDerivedLabel()

Description copied from interface: MenuItem

Convenience method that will always return the configured Label if specified. If it is not specified and of type MenuItemType.PRODUCT, or MenuItemType.CATEGORY, or MenuItemType.SUBMENU, it will return the corresponding linked name.

Specified by:

getDerivedLabel in interface MenuItem

createOrRetrieveCopyInstance

public <G extends MenuItem> org.broadleafcommerce.common.copy.CreateResponse<G> createOrRetrieveCopyInstance(org.broadleafcommerce.common.copy.MultiTenantCopyContext context)
                                                                                                      throws CloneNotSupportedException

Specified by:

createOrRetrieveCopyInstance in interface org.broadleafcommerce.common.copy.MultiTenantCloneable<MenuItem>

Throws:

CloneNotSupportedException