Class: LinkMenuItem

Cadcorp.UI.LinkMenuItem

new LinkMenuItem(config)

A menu item that contains a link
Parameters:
Name Type Description
config Object Configuration for this object. The config supplied directly extends the control

Extends

Members

childMenuVisible

Properties:
Name Type Description
childMenuVisible boolean True if the child menu is visible, otherwise false
Inherited From:

dialogId

Properties:
Name Type Description
dialogId string | null The id of a dialog to show when this menu item is clicked
Inherited From:

events

Properties:
Name Type Description
events Cadcorp.Util.Events The events object
Inherited From:

footerid

Properties:
Name Type Description
footerid string | null The id of the footer element
Inherited From:

hasDropDown

Properties:
Name Type Description
hasDropDown boolean True if this menu has a sub menu, otherwise false
Inherited From:

id

Properties:
Name Type Description
id string The unique id of this menu item
Inherited From:

itemArray

Properties:
Name Type Description
itemArray Array.<Cadcorp.UI.MenuItem> Array of sub menu items
Inherited From:

mapId

Properties:
Name Type Description
mapId string | null The id of a map object
Inherited From:
Properties:
Name Type Description
menu Object The menu this menu item belongs to
Inherited From:

parentMenuItem

Properties:
Name Type Description
parentMenuItem Object The jQuery object for the element that is displayed in the parent menu when this menu item is selected
Inherited From:

text

Properties:
Name Type Description
text string The text to display in this menu item
Inherited From:

Methods

destroy()

Destroys this menu item
Inherited From:

(protected) dialogClosed(eventArgs, ui)

Event handler for dialog closed event
Deactivates the menu when the dialog is closed
Parameters:
Name Type Description
eventArgs Object jQuery event object
ui Object jQuery ui object
Inherited From:

getUI() → {Object}

Gets the UI for this menu item
Inherited From:
Returns:
A jQuery object that contains this menu item
Type
Object

hideChildItems()

Hides all the sub items of this menu item
Inherited From:
Event handler for mouse click event
This function is expected to be overridden in child classes so they can do their own thing when clicked
Parameters:
Name Type Description
eventArgs Object jQuery event object
Inherited From:
Event handler for menu deactivated event
This function is expected to be overridden in child classes so they can do their own thing when deactivated
Parameters:
Name Type Description
eventArgs Object jQuery event object
Inherited From:

set_tree(tree)

Sets the text representation of the location of this menu item in the menu hierarchy
Parameters:
Name Type Description
tree string The text location of the parent of this menu item
Inherited From:

Events

clicked

Click event
Type:
  • Object
Properties:
Name Type Description
object Cadcorp.UI.MenuItem The sender of the event
Inherited From: