Class MenuItem

Deprecated. The UI service was deprecated on December 11, 2014. To create user interfaces, use the HTML service instead.

An entry in a MenuBar.

Menu items can either fire an event handler when they are clicked, or open a cascading sub-menu.

Internally, UiApp widgets are built on top of the Google Web Toolkit, and it can sometimes be helpful to look at the GWT documentation directly. You can find the MenuItem documentation here.

Deprecated methods

Method	Return type	Brief description
`addStyleDependentName(styleName)`	`MenuItem`	Sets the dependent style name of this `MenuItem`.
`addStyleName(styleName)`	`MenuItem`	Adds a style name to this `MenuItem`.
`getId()`	`String`	Returns the id that has been assigned to this object.
`getTag()`	`String`	Gets the text tag of this `MenuItem`.
`getType()`	`String`	Gets the type of this object.
`setCommand(handler)`	`MenuItem`	Sets the handler to execute when the menu is clicked.
`setHTML(html)`	`MenuItem`	Sets the HTML content of this `MenuItem`.
`setHeight(height)`	`MenuItem`	Sets the height of this `MenuItem`.
`setId(id)`	`MenuItem`	Sets the id of this `MenuItem`.
`setPixelSize(width, height)`	`MenuItem`	Sets the size of this `MenuItem` in pixels.
`setSize(width, height)`	`MenuItem`	Sets the size of this `MenuItem`.
`setStyleAttribute(attribute, value)`	`MenuItem`	Sets one of this `MenuItem`'s style attributes to a new value.
`setStyleAttributes(attributes)`	`MenuItem`	Sets this `MenuItem`'s style attributes.
`setStyleName(styleName)`	`MenuItem`	Sets the style name of this `MenuItem`.
`setStylePrimaryName(styleName)`	`MenuItem`	Sets the primary style name of this `MenuItem`.
`setSubMenu(subMenu)`	`MenuItem`	Sets the sub-menu to show when the menu is clicked.
`setTag(tag)`	`MenuItem`	Sets the text tag of this `MenuItem`.
`setText(text)`	`MenuItem`	Set the display text of this `MenuItem`.
`setTitle(title)`	`MenuItem`	Sets the hover title of this `MenuItem`.
`setVisible(visible)`	`MenuItem`	Sets whether this `MenuItem` is visible.
`setWidth(width)`	`MenuItem`	Sets the width of this `MenuItem`.

Deprecated methods

`addStyleDependentName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the dependent style name of this MenuItem.

This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.

Parameters

Name	Type	Description
`styleName`	`String`	the new style name.

Return

MenuItem — the MenuItem itself, useful for chaining.

`addStyleName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Adds a style name to this MenuItem.

This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.

Parameters

Name	Type	Description
`styleName`	`String`	the new style name.

Return

MenuItem — the MenuItem itself, useful for chaining.

`getId()`

Deprecated. This function is deprecated and should not be used in new scripts.

Returns the id that has been assigned to this object.

This can be used in conjunction with app.getElementById() to retrieve a reference to this object.

Return

String — the id that has been assigned to this object

`getTag()`

Deprecated. This function is deprecated and should not be used in new scripts.

Gets the text tag of this MenuItem.

Return

String — the text tag.

`getType()`

Deprecated. This function is deprecated and should not be used in new scripts.

Gets the type of this object.

Return

String — the object type

`setCommand(handler)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the handler to execute when the menu is clicked.

Parameters

Name	Type	Description
`handler`	`Handler`	the ClientHandler or ServerHandler to execute when the menu is clicked.

Return

MenuItem — the MenuItem itself, useful for chaining.

`setHTML(html)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the HTML content of this MenuItem.

Parameters

Name	Type	Description
`html`	`String`	the new HTML

Return

MenuItem — the MenuItem itself, useful for chaining.

`setHeight(height)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the height of this MenuItem.

Parameters

Name	Type	Description
`height`	`String`	the new height in any CSS unit such as "10px" or "50%".

Return

MenuItem — the MenuItem itself, useful for chaining.

`setId(id)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the id of this MenuItem.

Parameters

Name	Type	Description
`id`	`String`	the new id, which can be used to retrieve the `MenuItem` from app.getElementById(id).

Return

MenuItem — the MenuItem itself, useful for chaining.

`setPixelSize(width, height)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the size of this MenuItem in pixels.

Parameters

Name	Type	Description
`width`	`Integer`	the new width in pixels.
`height`	`Integer`	the new height in pixels.

Return

MenuItem — the MenuItem itself, useful for chaining.

`setSize(width, height)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the size of this MenuItem.

Parameters

Name	Type	Description
`width`	`String`	the new width in any CSS unit such as "10px" or "50%".
`height`	`String`	the new height in any CSS unit such as "10px" or "50%".

Return

MenuItem — the MenuItem itself, useful for chaining.

`setStyleAttribute(attribute, value)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets one of this MenuItem's style attributes to a new value. Valid attributes are listed here; the values for each attribute are the same as those available in CSS style sheets.

 

 // Change the widget's background to black and text color to green.
 widget.setStyleAttribute("background", "black")
     .setStyleAttribute("color", "green");

Parameters

Name	Type	Description
`attribute`	`String`	the CSS attribute, in camel-case ("fontSize", not "font-size"), as listed here
`value`	`String`	the CSS value

Return

MenuItem — the MenuItem itself, useful for chaining.

`setStyleAttributes(attributes)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets this MenuItem's style attributes. This is a convenience method that is equivalent to calling setStyleAttribute with every key/value pair in the attributes object. Valid attributes are listed here; the values for each attribute are the same as those available in CSS style sheets.

 

 // Change the widget's background to black and text color to green.
 widget.setStyleAttributes({background: "black", color: "green"});

Parameters

Name	Type	Description
`attributes`	`Object`	an object of key/value pairs for the CSS attributes and values to set; valid attributes are listed here

Return

MenuItem — the MenuItem itself, useful for chaining.

`setStyleName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the style name of this MenuItem.

This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.

Parameters

Name	Type	Description
`styleName`	`String`	the new style name.

Return

MenuItem — the MenuItem itself, useful for chaining.

`setStylePrimaryName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the primary style name of this MenuItem.

This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.

Parameters

Name	Type	Description
`styleName`	`String`	the new style name.

Return

MenuItem — the MenuItem itself, useful for chaining.

`setSubMenu(subMenu)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the sub-menu to show when the menu is clicked.

Parameters

Name	Type	Description
`subMenu`	`MenuBar`	the sub-menu to show when the menu is clicked.

Return

MenuItem — the MenuItem itself, useful for chaining.

`setTag(tag)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the text tag of this MenuItem.

Parameters

Name	Type	Description
`tag`	`String`	the new text tag, which can be anything you wish to store with the widget.

Return

MenuItem — the MenuItem itself, useful for chaining.

`setText(text)`

Deprecated. This function is deprecated and should not be used in new scripts.

Set the display text of this MenuItem.

Parameters

Name	Type	Description
`text`	`String`	the new text.

Return

MenuItem — the MenuItem itself, useful for chaining.

`setTitle(title)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the hover title of this MenuItem.

Not all browsers will show this.

Parameters

Name	Type	Description
`title`	`String`	the hover title.

Return

MenuItem — the MenuItem itself, useful for chaining.

`setVisible(visible)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets whether this MenuItem is visible.

Parameters

Name	Type	Description
`visible`	`Boolean`	whether this `MenuItem` should be visible or not.

Return

MenuItem — the MenuItem itself, useful for chaining.

`setWidth(width)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the width of this MenuItem.

Parameters

Name	Type	Description
`width`	`String`	the new width in any CSS unit such as "10px" or "50%".

Return

MenuItem — the MenuItem itself, useful for chaining.

Class MenuItem

Deprecated methods

Deprecated methods

addStyleDependentName(styleName)

Parameters

Return

addStyleName(styleName)

Parameters

Return

getId()

Return

getTag()

Return

getType()

Return

setCommand(handler)

Parameters

Return

setHTML(html)

Parameters

Return

setHeight(height)

Parameters

Return

setId(id)

Parameters

Return

setPixelSize(width, height)

Parameters

Return

setSize(width, height)

Parameters

Return

setStyleAttribute(attribute, value)

Parameters

Return

setStyleAttributes(attributes)

Parameters

Return

setStyleName(styleName)

Parameters

Return

setStylePrimaryName(styleName)

Parameters

Return

setSubMenu(subMenu)

Parameters

Return

setTag(tag)

Parameters

Return

setText(text)

Parameters

Return

setTitle(title)

Parameters

Return

setVisible(visible)

Parameters

Return

setWidth(width)

Parameters

Return

Send feedback about...

`addStyleDependentName(styleName)`

`addStyleName(styleName)`

`getId()`

`getTag()`

`getType()`

`setCommand(handler)`

`setHTML(html)`

`setHeight(height)`

`setId(id)`

`setPixelSize(width, height)`

`setSize(width, height)`

`setStyleAttribute(attribute, value)`

`setStyleAttributes(attributes)`

`setStyleName(styleName)`

`setStylePrimaryName(styleName)`

`setSubMenu(subMenu)`

`setTag(tag)`

`setText(text)`

`setTitle(title)`

`setVisible(visible)`

`setWidth(width)`