de.hybris.platform.hmc.webchips

Class MenuEntry

java.lang.Object

de.hybris.platform.hmc.webchips.MenuEntry

All Implemented Interfaces:

Serializable

public class MenuEntry
extends Object
implements Serializable

An MenuEntry represents a function this Chip is able to perform. It is used to generate context menues

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MenuEntry(String event) Creates a new MenuEntry (which is enabled).
MenuEntry(String name, String event) Creates a new MenuEntry (which is enabled).
MenuEntry(String name, String event, boolean enabled) Creates a new MenuEntry.
MenuEntry(String name, String event, String value, boolean enabled) Creates a new MenuEntry.
MenuEntry(String name, String event, String value, boolean enabled, String icon) Creates a new MenuEntry.
MenuEntry(String name, String event, String value, boolean enabled, String icon, List menuEntries) Creates a new MenuEntry.

Method Summary

Modifier and Type	Method and Description
static MenuEntry	createHeading(String name) Creates a MenuEntry object which acts as a heading.
MenuEntry	disabled() Returns you a disabled copy, does not modify the original action
MenuEntry	enabled() Gives you an enabled copy, does not modify the original action
String	getConfirmMessage()
String	getEvent() Returns the event of the MenuEntry.
String	getIcon()
List	getMenuEntries()
String	getName() Returns the display name of the MenuEntry.
static MenuEntry	getSplitter() Returns a MenuEntry object which acts as a splitter element.
String	getValue() Returns the value of this MenuEntry.
boolean	isCommand()
boolean	isEnabled() Returns true if this entry is enabled.
boolean	isSplitter()
boolean	isSubMenuBottomAlign()
boolean	isVisible() Returns true if this entry is visible.
void	setCommand(boolean isCommand)
void	setConfirmMessage(String confirmMessage)
void	setEnabled(boolean enabled) Setting enabled to true makes this menu entry active (= it can be clicked on).
void	setEvent(String event)
void	setIcon(String icon)
void	setMenuEntries(List menuEntries)
void	setName(String name) Sets the display name of this entry.
void	setSplitter(boolean isSplitter)
void	setSubMenuBottomAlign(boolean subMenuBottomAlign)
void	setValue(String value)
void	setVisible(boolean visible)

Methods inherited from class java.lang.Object

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

Constructor Detail

MenuEntry

public MenuEntry(String event)

Creates a new MenuEntry (which is enabled). You should override the getName() method, otherwise the displayname will fallback to the event name!!

Parameters:

event - the event of the MenuEntry

Since:

3.00 (beta1)

MenuEntry

public MenuEntry(String name,
                 String event)

Creates a new MenuEntry (which is enabled).

Parameters:

name - the display name of the MenuEntry (must be already localized)

event - the event of the MenuEntry

Since:

2.20

MenuEntry

public MenuEntry(String name,
                 String event,
                 boolean enabled)

Creates a new MenuEntry.

Parameters:

name - the display name of the MenuEntry (must be already localized)

event - the event of the MenuEntry

enabled - if true this menu entry is enabled (= can be clicked on)

Since:

2.20

MenuEntry

public MenuEntry(String name,
                 String event,
                 String value,
                 boolean enabled)

Creates a new MenuEntry.

Parameters:

name - the display name of the MenuEntry (must be already localized)

event - the event of the MenuEntry

value - the value of the MenuEntry

enabled - if true this menu entry is enabled (= can be clicked on)

Since:

2.20

MenuEntry

public MenuEntry(String name,
                 String event,
                 String value,
                 boolean enabled,
                 String icon)

Creates a new MenuEntry.

Parameters:

name - the display name of the MenuEntry (must be already localized)

event - the event of the MenuEntry

value - the value of the MenuEntry

enabled - if true this menu entry is enabled (= can be clicked on)

icon - the url of the image of the MenuEntry

Since:

2.20

MenuEntry

public MenuEntry(String name,
                 String event,
                 String value,
                 boolean enabled,
                 String icon,
                 List menuEntries)

Creates a new MenuEntry.

Parameters:

name - the display name of the MenuEntry (must be already localized)

event - the event of the MenuEntry

value - the value of the MenuEntry

enabled - if true this menu entry is enabled (= can be clicked on)

icon - the url of the image of the MenuEntry

menuEntries - a list with the menu entries

Since:

2.20

Method Detail

getName

public String getName()

Returns the display name of the MenuEntry.

Returns:

the display name of the MenuEntry

setName

public void setName(String name)

Sets the display name of this entry. Must be already localized!

Parameters:

name - the display name of this entry

Since:

2.20

getEvent

public String getEvent()

Returns the event of the MenuEntry.

Returns:

the event of the MenuEntry

Since:

2.20

setEvent

public void setEvent(String event)

Parameters:

event - The event to set.

Since:

2.20

isEnabled

public boolean isEnabled()

Returns true if this entry is enabled.

Returns:

true if this entry is enabled.

Since:

2.20

setEnabled

public void setEnabled(boolean enabled)

Setting enabled to true makes this menu entry active (= it can be clicked on). Setting it to false will deactivate the entry and grey it out.

Parameters:

enabled - using true makes this menu entry active

Since:

2.20

isVisible

public boolean isVisible()

Returns true if this entry is visible.

Returns:

true if this entry is visible.

Since:

2.30

setVisible

public void setVisible(boolean visible)

Parameters:

visible - using true makes this menu entry visible

Since:

2.30

enabled

public MenuEntry enabled()

Gives you an enabled copy, does not modify the original action

Returns:

an enabled copy

Since:

2.20

disabled

public MenuEntry disabled()

Returns you a disabled copy, does not modify the original action

Returns:

a disabled copy

getValue

public String getValue()

Returns the value of this MenuEntry.

Returns:

The value of this MenuEntry.

setValue

public void setValue(String value)

Parameters:

value - The value to set.

Since:

2.20

getIcon

public String getIcon()

Returns:

Returns the imageURL.

Since:

2.20

setIcon

public void setIcon(String icon)

Parameters:

icon - The imageURL to set.

Since:

2.20

getSplitter

public static MenuEntry getSplitter()

Returns a MenuEntry object which acts as a splitter element. Actually it is a horizontal ruler.

Since:

2.20

createHeading

public static MenuEntry createHeading(String name)

Creates a MenuEntry object which acts as a heading. Meaning that it is an entry which is not clickable.

Parameters:

name - the name of the entry (which must be already localized)

Returns:

a MenuEntry object which acts as a heading

Since:

2.20

getMenuEntries

public List getMenuEntries()

Returns:

Returns the menuEntries.

Since:

2.20

setMenuEntries

public void setMenuEntries(List menuEntries)

Parameters:

menuEntries - The menuEntries to set.

Since:

2.20

isSplitter

public boolean isSplitter()

Returns:

Returns the isSplitter.

Since:

2.20

setSplitter

public void setSplitter(boolean isSplitter)

Parameters:

isSplitter - The isSplitter to set.

Since:

2.20

getConfirmMessage

public String getConfirmMessage()

Since:

2.30

setConfirmMessage

public void setConfirmMessage(String confirmMessage)

Since:

2.30

isCommand

public boolean isCommand()

Since:

2.30

setCommand

public void setCommand(boolean isCommand)

Since:

2.30

isSubMenuBottomAlign

public boolean isSubMenuBottomAlign()

Since:

3.00 (beta1)

setSubMenuBottomAlign

public void setSubMenuBottomAlign(boolean subMenuBottomAlign)

Since:

3.00 (beta1)