JavaScript Documentation -

Class YAHOO.widget.MenuModuleItem

Object
   |
   +--YAHOO.widget.MenuModuleItem

Direct Known Subclasses:: YAHOO.widget.MenuBarItem, YAHOO.widget.MenuItem

class YAHOO.widget.MenuModuleItem

Quick Links: Field Summary | Constructor Summary | Method Summary | Method Details

Field Summary [top]

{YAHOO.util.CustomEvent}	`blurEvent` Fires when a MenuModuleItem instance loses the input focus.
{YAHOO.util.CustomEvent}	`clickEvent` Fires when the user clicks the on a MenuModuleItem instance.
String	`COLLAPSED_SUBMENU_INDICATOR_ALT_TEXT` Constant representing the alt text for the image to be used for the submenu arrow indicator.
String	`CSS_CLASS_NAME` Constant representing the CSS class(es) to be applied to the root HTMLLIElement of the MenuModuleItem.
{YAHOO.util.CustomEvent}	`destroyEvent` Fires when a MenuModuleItem instances's HTMLLIElement is removed from it's parent HTMLUListElement node.
String	`DISABLED_SUBMENU_INDICATOR_ALT_TEXT` Constant representing the alt text for the image to be used for the submenu arrow indicator when a MenuModuleItem instance is disabled.
String	`DISABLED_SUBMENU_INDICATOR_IMAGE_PATH` Constant representing the path to the image to be used for the submenu arrow indicator when a MenuModuleItem instance is disabled.
{HTMLLIElement}	`element` Returns the HTMLLIElement for a MenuModuleItem instance.
String	`EXPANDED_SUBMENU_INDICATOR_ALT_TEXT` Constant representing the alt text for the image to be used for the submenu arrow indicator when the submenu is visible.
{YAHOO.util.CustomEvent}	`focusEvent` Fires when a MenuModuleItem instance receives focus.
Number	`groupIndex` Returns the index of the group to which a MenuModuleItem instance belongs.
string	`imageRoot` The string representing the image root
Number	`index` Returns the ordinal position of a MenuModuleItem instance in a group.
{YAHOO.util.CustomEvent}	`keyDownEvent` Fires when the user presses a key.
{YAHOO.util.CustomEvent}	`keyPressEvent` Fires when the user presses an alphanumeric key.
{YAHOO.util.CustomEvent}	`keyUpEvent` Fires when the user releases a key.
{YAHOO.util.CustomEvent}	`mouseDownEvent` Fires when the user mouses down on a MenuModuleItem instance.
{YAHOO.util.CustomEvent}	`mouseOutEvent` Fires when the mouse has left a MenuModuleItem instance.
{YAHOO.util.CustomEvent}	`mouseOverEvent` Fires when the mouse has entered a MenuModuleItem instance.
{YAHOO.util.CustomEvent}	`mouseUpEvent` Fires when the user releases a mouse button while the mouse is over a MenuModuleItem instance.
{YAHOO.widget.MenuModule}	`parent` Returns the parent object for a MenuModuleItem instance.
String	`SELECTED_SUBMENU_INDICATOR_IMAGE_PATH` Constant representing the path to the image to be used for the submenu arrow indicator when a MenuModuleItem instance has focus.
{HTMLLIElement/HTMLOptGroupElement/HTMLOptionElement}	`srcElement` Returns the HTMLElement (either HTMLLIElement, HTMLOptGroupElement or HTMLOptionElement) used create the MenuModuleItem instance.
String	`SUBMENU_INDICATOR_IMAGE_PATH` Constant representing the path to the image to be used for the submenu arrow indicator.
YAHOO.widget.MenuModuleItem	`SUBMENU_ITEM_TYPE` Constant representing the type of item to instantiate when creating item instances from parsing the child nodes (either HTMLLIElement, HTMLOptGroupElement or HTMLOptionElement) of the submenu's DOM.
YAHOO.widget.MenuModule	`SUBMENU_TYPE` Constant representing the type of menu to instantiate when creating submenu instances from parsing the child nodes (either HTMLSelectElement or HTMLDivElement) of the item's DOM.
{HTMLImageElement}	`subMenuIndicator` Reference to the HTMLImageElement used to create the submenu indicator for a MenuModuleItem instance.
{Object}	`value` Specifies an arbitrary value for a MenuModuleItem instance.

Constructor Summary [top]



						YAHOO.widget.MenuModuleItem

Method Summary [top]

void	`blur ()` Causes a MenuModuleItem instance to lose focus and fires the onblur event.
string	`browser ()` String representing the browser
void	`configDisabled (<String> p_sType, <Array> p_aArguments, <YAHOO.widget.MenuModuleItem> p_oItem)` Event handler for when the "disabled" configuration property of a MenuModuleItem instance changes.
void	`configEmphasis (<String> p_sType, <Array> p_aArguments, <YAHOO.widget.MenuModuleItem> p_oItem)` Event handler for when the "emphasis" configuration property of a MenuModuleItem instance changes.
void	`configHelpText (<String> p_sType, <Array> p_aArguments, <YAHOO.widget.MenuModuleItem> p_oItem)` Event handler for when the "helptext" configuration property of a MenuModuleItem instance changes.
void	`configSelected (<String> p_sType, <Array> p_aArguments, <YAHOO.widget.MenuModuleItem> p_oItem)` Event handler for when the "selected" configuration property of a MenuModuleItem instance changes.
void	`configStrongEmphasis (<String> p_sType, <Array> p_aArguments, <YAHOO.widget.MenuModuleItem> p_oItem)` Event handler for when the "strongemphasis" configuration property of a MenuModuleItem instance changes.
void	`configSubmenu (<String> p_sType, <Array> p_aArguments, <YAHOO.widget.MenuModuleItem> p_oItem)` Event handler for when the "submenu" configuration property of a MenuModuleItem instance changes.
void	`configText (<String> p_sType, <Array> p_aArguments, <YAHOO.widget.MenuModuleItem> p_oItem)` Event handler for when the "text" configuration property of a MenuModuleItem instance changes.
void	`configURL (<String> p_sType, <Array> p_aArguments, <YAHOO.widget.MenuModuleItem> p_oItem)` Event handler for when the "url" configuration property of a MenuModuleItem instance changes.
void	`destroy ()` Removes a MenuModuleItem instance's HTMLLIElement from it's parent HTMLUListElement node.
void	`focus ()` Causes a MenuModuleItem instance to receive the focus and fires the focus event.
YAHOO.widget.MenuModuleItem	`getNextEnabledSibling ()` Finds the next enabled MenuModuleItem instance in a MenuModule instance
YAHOO.widget.MenuModuleItem	`getPreviousEnabledSibling ()` Finds the previous enabled MenuModuleItem instance in a MenuModule instance
void	`init (<String or HTMLElement> p_oObject, <Object> p_oUserConfig)` The MenuModuleItem class's initialization method.
boolean	`isSecure ()` Boolean representing whether or not the current browsing context is secure (https)

Field Detail [top]

blurEvent



								{YAHOO.util.CustomEvent}

								 

								blurEvent

Fires when a MenuModuleItem instance loses the input focus.

clickEvent



								{YAHOO.util.CustomEvent}

								 

								clickEvent

Fires when the user clicks the on a MenuModuleItem instance. Passes back the DOM Event object as an argument.

COLLAPSED_SUBMENU_INDICATOR_ALT_TEXT



								String

								 

								COLLAPSED_SUBMENU_INDICATOR_ALT_TEXT

Constant representing the alt text for the image to be used for the submenu arrow indicator.

CSS_CLASS_NAME



								String

								 

								CSS_CLASS_NAME

Constant representing the CSS class(es) to be applied to the root HTMLLIElement of the MenuModuleItem.

destroyEvent



								{YAHOO.util.CustomEvent}

								 

								destroyEvent

Fires when a MenuModuleItem instances's HTMLLIElement is removed from it's parent HTMLUListElement node.

DISABLED_SUBMENU_INDICATOR_ALT_TEXT



								String

								 

								DISABLED_SUBMENU_INDICATOR_ALT_TEXT

Constant representing the alt text for the image to be used for the submenu arrow indicator when a MenuModuleItem instance is disabled.

DISABLED_SUBMENU_INDICATOR_IMAGE_PATH



								String

								 

								DISABLED_SUBMENU_INDICATOR_IMAGE_PATH

Constant representing the path to the image to be used for the submenu arrow indicator when a MenuModuleItem instance is disabled.

element



								{HTMLLIElement}

								 

								element

Returns the HTMLLIElement for a MenuModuleItem instance.

EXPANDED_SUBMENU_INDICATOR_ALT_TEXT



								String

								 

								EXPANDED_SUBMENU_INDICATOR_ALT_TEXT

Constant representing the alt text for the image to be used for the submenu arrow indicator when the submenu is visible.

focusEvent



								{YAHOO.util.CustomEvent}

								 

								focusEvent

Fires when a MenuModuleItem instance receives focus.

groupIndex



								Number

								 

								groupIndex

Returns the index of the group to which a MenuModuleItem instance belongs.

index



								Number

								 

								index

Returns the ordinal position of a MenuModuleItem instance in a group.

keyDownEvent



								{YAHOO.util.CustomEvent}

								 

								keyDownEvent

Fires when the user presses a key. Passes back the DOM Event object as an argument.

keyPressEvent



								{YAHOO.util.CustomEvent}

								 

								keyPressEvent

Fires when the user presses an alphanumeric key. Passes back the DOM Event object as an argument.

keyUpEvent



								{YAHOO.util.CustomEvent}

								 

								keyUpEvent

Fires when the user releases a key. Passes back the DOM Event object as an argument.

mouseDownEvent



								{YAHOO.util.CustomEvent}

								 

								mouseDownEvent

Fires when the user mouses down on a MenuModuleItem instance. Passes back the DOM Event object as an argument.

mouseOutEvent



								{YAHOO.util.CustomEvent}

								 

								mouseOutEvent

Fires when the mouse has left a MenuModuleItem instance. Passes back the DOM Event object as an argument.

mouseOverEvent



								{YAHOO.util.CustomEvent}

								 

								mouseOverEvent

Fires when the mouse has entered a MenuModuleItem instance. Passes back the DOM Event object as an argument.

mouseUpEvent



								{YAHOO.util.CustomEvent}

								 

								mouseUpEvent

Fires when the user releases a mouse button while the mouse is over a MenuModuleItem instance. Passes back the DOM Event object as an argument.

parent



								{YAHOO.widget.MenuModule}

								 

								parent

Returns the parent object for a MenuModuleItem instance.

SELECTED_SUBMENU_INDICATOR_IMAGE_PATH



								String

								 

								SELECTED_SUBMENU_INDICATOR_IMAGE_PATH

Constant representing the path to the image to be used for the submenu arrow indicator when a MenuModuleItem instance has focus.

srcElement



								{HTMLLIElement/HTMLOptGroupElement/HTMLOptionElement}

								 

								srcElement

Returns the HTMLElement (either HTMLLIElement, HTMLOptGroupElement or HTMLOptionElement) used create the MenuModuleItem instance.

SUBMENU_INDICATOR_IMAGE_PATH



								String

								 

								SUBMENU_INDICATOR_IMAGE_PATH

Constant representing the path to the image to be used for the submenu arrow indicator.

SUBMENU_ITEM_TYPE



								YAHOO.widget.MenuModuleItem

								 

								SUBMENU_ITEM_TYPE

Constant representing the type of item to instantiate when creating item instances from parsing the child nodes (either HTMLLIElement, HTMLOptGroupElement or HTMLOptionElement) of the submenu's DOM. The default is YAHOO.widget.MenuModuleItem.

SUBMENU_TYPE



								YAHOO.widget.MenuModule

								 

								SUBMENU_TYPE

Constant representing the type of menu to instantiate when creating submenu instances from parsing the child nodes (either HTMLSelectElement or HTMLDivElement) of the item's DOM. The default is YAHOO.widget.MenuModule.

subMenuIndicator



								{HTMLImageElement}

								 

								subMenuIndicator

Reference to the HTMLImageElement used to create the submenu indicator for a MenuModuleItem instance.

value



								{Object}

								 

								value

Specifies an arbitrary value for a MenuModuleItem instance.

Constructor Detail [top]

YAHOO.widget.MenuModuleItem



							YAHOO.widget.MenuModuleItem

							()

Parameters:: p_oObject - String or HTMLElement (either HTMLLIElement, HTMLOptGroupElement or HTMLOptionElement) of the source HTMLElement node.; p_oUserConfig - The configuration object literal containing the configuration for a MenuModuleItem instance. See the configuration class documentation for more details.

Method Detail [top]

blur



								void 

								blur

								()

Causes a MenuModuleItem instance to lose focus and fires the onblur event.

browser



								string 

								browser

								()

String representing the browser

configDisabled



								void 

								configDisabled

								(<String> p_sType, <Array> p_aArguments, <YAHOO.widget.MenuModuleItem> p_oItem)

Event handler for when the "disabled" configuration property of a MenuModuleItem instance changes.

Parameters:: p_sType - The name of the event that was fired.; p_aArguments - Collection of arguments sent when the event was fired.; p_oItem - The MenuModuleItem instance that fired the event.

configEmphasis



								void 

								configEmphasis

								(<String> p_sType, <Array> p_aArguments, <YAHOO.widget.MenuModuleItem> p_oItem)

Event handler for when the "emphasis" configuration property of a MenuModuleItem instance changes.

Parameters:: p_sType - The name of the event that was fired.; p_aArguments - Collection of arguments sent when the event was fired.; p_oItem - The MenuModuleItem instance that fired the event.

configHelpText



								void 

								configHelpText

								(<String> p_sType, <Array> p_aArguments, <YAHOO.widget.MenuModuleItem> p_oItem)

Event handler for when the "helptext" configuration property of a MenuModuleItem instance changes.

Parameters:: p_sType - The name of the event that was fired.; p_aArguments - Collection of arguments sent when the event was fired.; p_oItem - The MenuModuleItem instance that fired the event.

configSelected



								void 

								configSelected

								(<String> p_sType, <Array> p_aArguments, <YAHOO.widget.MenuModuleItem> p_oItem)

Event handler for when the "selected" configuration property of a MenuModuleItem instance changes.

Parameters:: p_sType - The name of the event that was fired.; p_aArguments - Collection of arguments sent when the event was fired.; p_oItem - The MenuModuleItem instance that fired the event.

configStrongEmphasis



								void 

								configStrongEmphasis

								(<String> p_sType, <Array> p_aArguments, <YAHOO.widget.MenuModuleItem> p_oItem)

Event handler for when the "strongemphasis" configuration property of a MenuModuleItem instance changes.

Parameters:: p_sType - The name of the event that was fired.; p_aArguments - Collection of arguments sent when the event was fired.; p_oItem - The MenuModuleItem instance that fired the event.

configSubmenu



								void 

								configSubmenu

								(<String> p_sType, <Array> p_aArguments, <YAHOO.widget.MenuModuleItem> p_oItem)

Event handler for when the "submenu" configuration property of a MenuModuleItem instance changes.

Parameters:: p_sType - The name of the event that was fired.; p_aArguments - Collection of arguments sent when the event was fired.; p_oItem - The MenuModuleItem instance that fired the event.

configText



								void 

								configText

								(<String> p_sType, <Array> p_aArguments, <YAHOO.widget.MenuModuleItem> p_oItem)

Event handler for when the "text" configuration property of a MenuModuleItem instance changes.

Parameters:: p_sType - The name of the event that was fired.; p_aArguments - Collection of arguments sent when the event was fired.; p_oItem - The MenuModuleItem instance that fired the event.

configURL



								void 

								configURL

								(<String> p_sType, <Array> p_aArguments, <YAHOO.widget.MenuModuleItem> p_oItem)

Event handler for when the "url" configuration property of a MenuModuleItem instance changes.

Parameters:: p_sType - The name of the event that was fired.; p_aArguments - Collection of arguments sent when the event was fired.; p_oItem - The MenuModuleItem instance that fired the event.

destroy



								void 

								destroy

								()

Removes a MenuModuleItem instance's HTMLLIElement from it's parent HTMLUListElement node.

focus



								void 

								focus

								()

Causes a MenuModuleItem instance to receive the focus and fires the focus event.

getNextEnabledSibling



								YAHOO.widget.MenuModuleItem 

								getNextEnabledSibling

								()

Finds the next enabled MenuModuleItem instance in a MenuModule instance

Returns:: Returns a MenuModuleItem instance.

getPreviousEnabledSibling



								YAHOO.widget.MenuModuleItem 

								getPreviousEnabledSibling

								()

Finds the previous enabled MenuModuleItem instance in a MenuModule instance

Returns:: Returns a MenuModuleItem instance.

init



								void 

								init

								(<String or HTMLElement> p_oObject, <Object> p_oUserConfig)

The MenuModuleItem class's initialization method. This method is automatically called by the constructor, and sets up all DOM references for pre-existing markup, and creates required markup if it is not already present.

Parameters:: p_oObject - String or HTMLElement (either HTMLLIElement, HTMLOptGroupElement or HTMLOptionElement) of the source HTMLElement node.; p_oUserConfig - The configuration object literal containing the configuration for a MenuModuleItem instance. See the configuration class documentation for more details.

isSecure



								boolean 

								isSecure

								()

Boolean representing whether or not the current browsing context is secure (https)