Class MacaoMenuItem

The class MacaoMenuItem is used to create menu items for menus. See MacaoMenu.addMenuItem().

The HTML Structure of a Menu Item

The following structure shows the HTML elements, which are used to display a menu item. In the structure MyMenuMenuItemXXX stands for one of MyMenuMenuItem, MyMenuMenuItemActive or MyMenuMenuItemMouseOver, where MyMenu is the name of the menu object.

<div class="MyMenu" title="Title of the menu">
<table class="MyMenu">
<tr class="MyMenu">
<td class="MyMenu">
	<div class="MyMenuItemXXX" title="Title of the item">
		<img class="MyMenuItemXXX" src="Image source">
		<span class="MyMenuItemXXX">Text of the item</span>
	</div>
</td>
</tr>
</table>
</div>

The next structure shows the HTML elements for a menu item, which contains a placeholder %input% or %password%. The text is split into two parts. Each part is enclosed in a span element. Between this parts is a text or password input field.

<div class="MyMenu" title="Title of the menu">
<table class="MyMenu">
<tr class="MyMenu">
<td class="MyMenu">
	<div class="MyMenuMenuItemXXX" title="Title of the item">
		<img class="MyMenuItemXXX" src="Image source">
		<span class="MyMenuItemXXX">Begin of text</span>
		<input type="text|password">
		<span class="MyMenuItemXXX">End of text</span>
	</div>
</td>
</tr>
</table>
</div>

Use this constructor, to create a new menu item for a menu.

The URLs of the images, which can be provided as parameters, need to be relative to the base path. See MacaoPage.getBasePath().

Parameters

name: Provide a name for the menu item. The name needs to be unique for all items of a menu.
title: Provide the title of the menu item. The menu characteristics control, if the title is displayed as tool tip or as text beside the image (see MacaoMenu.setMenuCharacteristics()). If the title is displayed beside or instead the image, it is enclosed in a span DOM element. You can use the span element to define the style sheet attributes of the text. If the title contains the placeholder %input% or %password%, a text- or password field will be placed in the text. Use the methods getInputValue() and setInputValue() to get or set the content of the input field.
imageDefaultSource: Provide the URL of an image, which is to be displayed, when the menu item is inactive and the mouse is not over the menu item. Set this parameter to null, if the menu item doesn't need to display an image.
imageMouseOverSource: Provide the URL of an image, which is to be displayed, when the mouse is over the menu item and the menu item is not active. Provide null, if you don't need a special image for this case.
imageActiveSource: Provide the URL of an image, which is to be displayed, when the menu item is active. Provide null, if you don't need a special image for this case.
eventType: Provide the name of an event, which is to be sent, when the menu item is clicked or activated or deactivated. Provide null, if the menu item doesn't need to send an event.
eventParams: Provide an array with parameters for the event. Provide null, if the event needs no parameters. If the event is sent because the menu item is activated or deactivated, this set of parameters is ignored. Instead a parameter of type Boolean is sent. The parameter is true, if the item has been activated. It is false, if the item has been deactivated.
recipientName: Provide the name of the object, which is the recipient of the event. Set this parameter to null, if the event is to be sent to the menu, to which the menu item belongs.

Call this method to execute the menu item like the user had clicked it.

Calling this method will execute the menu items event.

Call this method to get the DOM element, which encloses elements of the menu item.

Returns

Returns a Div or a Span element.

Call this method to get the parameters, which are defined for the menu items event.

Returns

Returns an array containing the parameters. Returns null, if there are no parameters defined.

Call this method to get the menu items event.

Returns

Returns the menu items event type. Returns null, if there is no event type defined for this menu item.

Call this method to get the value of the input field.

The menu item has an input field, if the title of the item contains one of the placeholders %input% or %password%.

Returns

Returns the value of the input field. Returns null, if the menu item has no input field.

Call this method to get the menu object, to which the menu item belongs.

Returns

Returns the menu object, to which the menu item belongs. Returns null, if the menu item has not been added to a menu object.

Call this method to get the name of the menu item.

Returns

Returns the name of the menu item.

Call this method to set the name of the object, to which the menu items event is sent.

Returns

Returns the name of the object, to which the menu items event is send. Returns null, if the event is send to the menu, to which the menu item belongs.

Call this method, to get the title of the menu item.

Returns

Returns the title of the menu item.

Call this method to get the visibility of the menu item.

Returns

Returns true, if the menu item is visible. Returns false, if the menu item is hidden.

Call this method to find out, if this menu item is a toggle menu item.

Returns

Returns true, if the menu item is a toggle menu item. Returns false, if the menu item is not a toggle menu item.

Call this method to find out, if this radio or toggle menu item is activated or deactivated.

Returns

Returns true, if the menu item is activated. Returns false, if the menu item is deactivated.

Call this method to find out, if this menu item is a radio menu item.

Returns

Returns true, if the menu item is a radio menu item. Returns false, if the menu item is not a radio menu item.

Call this method to move the menu item to an absolute position on the page.

Parameters

left: Provide the x-coordinate of the left edge of the menu item in pixels relative to the page.
top: Provide the y-coordinate of the top edge of the menu item in pixels relative to the page.

Call this method to set the menu item as toggle menu item or radio menu item.

Parameters

isActivation: Set this parameter to true, if this menu item has to be a toggle item or radio item. Set this parameter to false, if the menu item has not to be activated and deactivated by a mouse click.
isRadio: Set this parameter to true, to define this menu item as radio menu item. When clicking activates a radio menu item, all other radio menu items of the menu are deactivated. Set this parameter to false, if you don't want this item to be a radio item.

Call this method to set the toggle or radio menu item as active or inactive.

Calling this method will execute the menu items event with a Boolean parameter. The parameter is true, when the item is activated and false, when the item is deactivated.

Parameters

active: Provide true, to set the menu item active. Provide false, to set the menu item inactive.

Call this method to define the parameters for the menu items event.

When sending activation events, these parameters are ignored. Instead a Boolean parameter is send, which represents the active state of the menu item.

Parameters

eventParams: Provide an array containing the parameters. Provide null, if the event needs no parameters.

Call this method to set the event type of the menu item.

Parameters

eventType: Provide the event type. Provide null, to deactivate the event.

Call this method to change an image, which is used to display the menu item.

Parameters

imageSource: Provide the URL of the image relative to the base path. See also MacaoPage.getBasePath(). Provide null, to clear the image.
isDefaultImage: Set this parameter to true, if this image is to be displayed, when the menu item is inactive and the mouse is not over the menu item.
isMouseOverImage: Set this parameter to true, if this image is to be displayed, when the mouse is over the menu item and the menu item is not active.
isActiveImage: Set this parameter to true, if this image is to be displayed, when the menu item is active.

Call this method to set the value of the input field.

The menu item has an input field, if the title of the item contains one of the placeholders %input% or %password%.

Parameters

value: Provide the value, which is to be set to the input field.

Call this method to define the recipient of the menu items event.

Parameters

recipientName: Provide the name of the object, to which the menu items event is send. Provide null, if the event is send to the menu object, to which the menu item belongs.

Call this method to set or clear the HTML, which is used to display the text beside the image in a span element.

Parameters

html: Provide the HTML. Provide null, if you want to clear the HTML.

Call this method to change the tool tip of the menu item.

Parameters

title: Provide the new text for the tool tip of the menu item. Provide null, if you want to remove the tool tip from the menu item.

Call this method to show or hide the menu item.

Parameters

visibility: Set this parameter to true, to make the menu item visible. Set this parameter to false, to hide the menu item.