org.araneaframework.uilib.menu
Class ContextMenuItem

java.lang.Object
  org.araneaframework.uilib.menu.ContextMenuItem

All Implemented Interfaces:

Serializable

public class ContextMenuItem
extends Object
implements Serializable

Represents web application context menu (right-click menu) hierarchy.

Since:

1.1

Author:

Taimo Peelo (taimo@araneaframework.org)

See Also:

ContextMenuWidget, Serialized Form

Nested Class Summary

static class	ContextMenuItem.ContextMenuActionEntry Context menu entry which generates Aranea action when entry is selected.
static class	ContextMenuItem.ContextMenuEntry This class describes the menu entry corresponding to some ContextMenuItem.
static class	ContextMenuItem.ContextMenuEventEntry Context menu entry which generates Aranea event when entry is selected.

Constructor Summary

ContextMenuItem()
Creates a top-level context menu which has no label and does not represent any menu entry.

ContextMenuItem(String label)
Creates a context menu item which has just label.

ContextMenuItem(String label, ContextMenuItem.ContextMenuEntry menuEntry)
Creates context menu with both label and associated menu entry.

Method Summary

ContextMenuItem	addMenuItem(ContextMenuItem item) Adds ContextMenuItem item as submenu of this ContextMenuItem.
String	getLabel() Returns label of this ContextMenuItem.
Map	getSubMenu() Returns submenu of this ContextMenuItem as Map<String, ContextMenuItem>.
protected JsonArray	menuMapToJsonArray(Map map)
JsonObject	toJSON() Returns JSON representation of this context menu hierarchy.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextMenuItem

public ContextMenuItem()

Creates a top-level context menu which has no label and does not represent any menu entry.

ContextMenuItem

public ContextMenuItem(String label)

Creates a context menu item which has just label.

ContextMenuItem

public ContextMenuItem(String label,
                       ContextMenuItem.ContextMenuEntry menuEntry)

Creates context menu with both label and associated menu entry.

Method Detail

addMenuItem

public ContextMenuItem addMenuItem(ContextMenuItem item)

Adds ContextMenuItem item as submenu of this ContextMenuItem.

Returns:

this ContextMenuItem

getLabel

public String getLabel()

Returns label of this ContextMenuItem.

getSubMenu

public Map getSubMenu()

Returns submenu of this ContextMenuItem as Map<String, ContextMenuItem>.

toJSON

public JsonObject toJSON()

Returns JSON representation of this context menu hierarchy.

menuMapToJsonArray

protected JsonArray menuMapToJsonArray(Map map)