Libraries.Web.Page.Menu Documentation

The Menu class represents HTML's (Hypertext Markup Language) menu tag which is used to add a menu of controls to the page. **This is not currently supported in any major browser.** You can find more information about this tag at: The menu attribute.

Example Code


use Libraries.Web.Page.all
class Main
action main
   WebPage page
   Menu menu
   menu:SetLabel("A Menu")
   menu:SetType(menu:listMenuType)
   
   Button button
   button:SetDescription("Quorum")
   button:SetOnClick("alert('Hello, World!')"
   button:SetAutofocus(true)

   menu:Add(button)
   page:AddToBody(menu)
   output page:Generate()
end
end

Inherits from: Libraries.Web.Page.AttributeAccepter, Libraries.Language.Object, Libraries.Web.Page.GlobalAttributeAccepter, Libraries.Web.Page.WebTag

Variables Table

VariablesDescription
text toolbarMenuTypeThis action sets label on the menu.
text listMenuType
text contextMenuType

Actions Documentation

Add(Libraries.Web.Page.Attribute attribute)

This action adds an attribute to this object. If an attribute with the same name as

Parameters

Example


use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute

Attribute attribute
attribute:SetName("src")
attribute:SetValue("http://www.google.com")

AttributeAccepter accept
accept:Add(attribute)

AddAttribute(text name, text value)

This action adds an attribute to this object. This action is a helper action, which essentially does the same thing as the Add(Attribute) action. If an attribute with the same name as

Parameters

  • text name: The name of the attribute functions as a key. For example, in a link, we might have a "src" and an actual address, like google.com. In this case, the name would be equivalent to the src.
  • text value: As an example of link, imagine we have a value of "src" and an actual address, like google.com. In this case, the value would be equivalent to google.com.

Example


use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute

AttributeAccepter accept
accept:AddAttribute("src", "http://www.google.com")

AddClassAttribute(text value)

Adds to the ClassAttribute attribute. Multiple class names can be listed in the passed text, separated by a space.

Parameters

  • text value: The classes to be added to the element

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
accept:AddClassAttribute("myClass")

AddNestedTag(Libraries.Web.Page.WebTag tag)

This action adds a WebTag to the list of WebTags contained within the current WebTag.

Parameters

Example

use Libraries.Web.Page.TableRow
use Libraries.Web.Page.TableData


//TableRow and TableData are both WebTags
TableRow row
TableData cell
cell:SetDescription("name")
row:Add(cell)

AddText(text value)

This action sets the description text for this WebTag.

Parameters

  • text value: The text contained in the WebTag.

Example

use Libraries.Web.Page.TableRow
use Libraries.Web.Page.TableData

//TableRow and TableData are both WebTags
TableRow row
TableData cell
cell:AddDescription("name")
row:Add(cell)

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

Example

use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)

Generate()

This action gets type of the menu.

Return

text: The type of specified menu

Example


use Libraries.Web.Page.Menu
use Libraries.Web.Page.Attribute
Menu menu
Attribute menuType = menu:GetType()

GenerateAttributes()

This action returns a text description of all attributes stored.

Return

text:

Example


use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute

AttributeAccepter accept
accept:AddAttribute("src", "http://www.google.com")
text result = accept:GenerateAttributes()

GenerateNestedTags()

This action generates the HTML output text of all of the nested WebTags.

Return

text: The text including all webtags within this WebTag.

Example

use Libraries.Web.Page.TableRow
use Libraries.Web.Page.TableData

//TableRow and TableData are both WebTags
TableRow row
TableData cell
cell:SetDescription("name")
row:Add(cell)
output row:GenerateNestedTags()

GetAccessKey()

Returns the AccessKey attribute. Specifies a shortcut key for the web element.

Return

Libraries.Web.Page.Attribute: The current AccessKey attribute.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
Attribute attribute = accept:GetAccessKey()

GetAttribute(text name)

This action returns an attribute from this object's Attributes object. If no attribute exists for a given key, this action returns undefined.

Parameters

  • text name

Return

Libraries.Web.Page.Attribute:

Example


use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute

AttributeAccepter accept
//as we have not set any attribute, this would
//return undefined
Attribute attribute = accept:GetAttribute("src")

GetAttributeValue(text name)

This action returns an attribute from this object's Attributes object. If no attribute exists for a given key, this action returns undefined.

Parameters

  • text name: The key value in this case is described in more detail in the documentation for this class's Add actions.

Return

text:

Example


use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute

AttributeAccepter accept
accept:AddAttribute("src", "http://www.google.com")
//This helper action would throw an error if "src" were not set.
text value = accept:GetAttributeValue("src")

GetAttributes()

Returns a list of all attributes on the system.

Return

Libraries.Web.Page.Attributes: The attributes class contains all of the attributes that have been set for this object.

Example



use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attributes

AttributeAccepter accept
Attributes attributes = accept:GetAttributes()

GetClassAttribute()

Returns the ClassAttribute attribute.

Return

Libraries.Web.Page.Attribute: The current ClassAttribute attribute.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
Attribute attribute = accept:GetClassAttribute()

GetContentEditable()

Returns the ContentEditable attribute.

Return

Libraries.Web.Page.Attribute: The current ContentEditable attribute.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
Attribute attribute = accept:GetContentEditable()

GetContextMenu()

Returns the ContextMenu attribute.

Return

Libraries.Web.Page.Attribute: The current ContextMenu attribute.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
Attribute attribute = accept:GetContextMenu()

GetDraggable()

Returns the Draggable attribute.

Return

Libraries.Web.Page.Attribute: The current Draggable attribute.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
Attribute attribute = accept:GetDraggable()

GetDropZone()

Returns the DropZone attribute.

Return

Libraries.Web.Page.Attribute: The current DropZone attribute.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
Attribute attribute = accept:GetDropZone()

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

GetHidden()

Returns the Hidden attribute.

Return

Libraries.Web.Page.Attribute: The current Hidden attribute.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
Attribute attribute = accept:GetHidden()

GetIdentifier()

Returns the Identifier attribute.

Return

Libraries.Web.Page.Attribute: The current Identifier attribute.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
Attribute attribute = accept:GetIdentifier()

GetIterator()

This action returns an iterator of all attributes stored in this object.

Return

Libraries.Containers.Iterator:

Example


use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute
use Libraries.Containers.Iterator

AttributeAccepter accept
accept:AddAttribute("src", "http://www.google.com")

//output out all of the attributes
Iterator<Attribute> it =  accept:GetIterator()
repeat while it:HasNext()
    Attribute at = it:Next()
    output at:Generate()
end

GetLabel()

This action gets label of the menu.

Return

Libraries.Web.Page.Attribute: The label of specified menu

Example


use Libraries.Web.Page.Menu
use Libraries.Web.Page.Attribute
Menu menu
Attribute menuLabel = menu:GetLabel()

GetLanguage()

Returns the Language attribute.

Return

Libraries.Web.Page.Attribute: The current Language attribute.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
Attribute attribute = accept:GetLanguage()

GetNumberOfAttributes()

This action returns the number of attributes that are currently stored in this object.

Return

integer:

Example


use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute

AttributeAccepter accept
accept:AddAttribute("src", "http://www.google.com")
integer num = accept:GetNumberOfAttributes()

GetNumberOfNestedTags()

This action gets the number of nested tags within the current WebTag.

Return

integer: The number of nested tags.

Example

use Libraries.Web.Page.TableRow
use Libraries.Web.Page.TableData

//TableRow and TableData are both WebTags
TableRow row
TableData cell
cell:SetDescription("name")
row:Add(cell)
integer numTags = row:GetSize()

GetSpellcheck()

Returns the Spellcheck attribute.

Return

Libraries.Web.Page.Attribute: The current Spellcheck attribute.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
Attribute attribute = accept:GetSpellcheck()

GetStyle()

Returns the Style attribute.

Return

Libraries.Web.Page.Attribute: The current Style attribute.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
Attribute attribute = accept:GetStyle()

GetTabIndex()

Returns the TabIndex attribute.

Return

Libraries.Web.Page.Attribute: The current TabIndex attribute.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
Attribute attribute = accept:GetTabIndex()

GetTag(integer index)

This action gets the number of nested tags within the current WebTag.

Parameters

  • integer index

Return

Libraries.Web.Page.WebTag: The number of nested tags.

Example

use Libraries.Web.Page.TableRow
use Libraries.Web.Page.TableData

//TableRow and TableData are both WebTags
TableRow row
TableData cell
cell:SetDescription("name")
row:Add(cell)
WebTag tag = row:GetTag(0)

GetTextDirection()

Returns the TextDirection attribute.

Return

Libraries.Web.Page.Attribute: The current TextDirection attribute.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
Attribute attribute = accept:GetTextDirection()

GetTitle()

Returns the Title attribute.

Return

Libraries.Web.Page.Attribute: The current Title attribute.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
Attribute attribute = accept:GetTitle()

GetType()

This action gets type of the menu.

Return

Libraries.Web.Page.Attribute: The type of specified menu

Example


use Libraries.Web.Page.Menu
use Libraries.Web.Page.Attribute
Menu menu
Attribute menuType = menu:GetType()

HasAttribute(text name)

This action returns whether or not an attribute exists for the key passed in as a parameter.

Parameters

  • text name: The key value in this case is described in more detail in the documentation for this class's Add actions.

Return

boolean:

Example


use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute

AttributeAccepter accept
accept:AddAttribute("src", "http://www.google.com")
//This helper action would throw an error if "src" were not set.
boolean exists = accept:HasAttribute("src")

Remove(Libraries.Web.Page.WebTag tag)

This action removes the first instance of a webtag found in the list of sub-WebTags.

Parameters

Example

use Libraries.Web.Page.TableRow
use Libraries.Web.Page.TableData

//TableRow and TableData are both WebTags
TableRow row
TableData cell
cell:SetDescription("name")
row:Add(cell)
row:Remove(cell)

RemoveAttribute(text name)

This action removes an attribute with a particular key. If that attribute does not exist, then this action returns undefined.

Parameters

  • text name: The name of the attribute that should be removed.

Return

Libraries.Web.Page.Attribute:

Example


use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute

AttributeAccepter accept
accept:AddAttribute("src", "http://www.google.com")
//This helper action would throw an error if "src" were not set.
accept:RemoveAttribute("src")

SetAccessKey(text value)

Sets the AccessKey attribute. Specifies a shortcut key for the web element.

Parameters

  • text value: The current AccessKey.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
accept:SetAccessKey("z")

SetClassAttribute(text value)

Sets the ClassAttribute attribute. Specifies a class name for the element.

Parameters

  • text value: The current ClassAttribute.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
accept:SetClassAttribute("myClass")

SetContentEditable(text value)

Sets the ContentEditable attribute. Specifies wether content in an element is editable.

Parameters

  • text value: The current ContentEditable.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
accept:SetContentEditable("true")

SetContextMenu(text value)

Sets the ContextMenu attribute. Specifies a context menu that contains the element.

Parameters

  • text value: The current ContextMenu.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
accept:SetContextMenu("parentmenu")

SetDraggable(boolean value)

Sets the Draggable attribute. Specifies wether an element is draggable or not.

Parameters

  • boolean value: The current Draggable.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
accept:SetDraggable(true)

SetDropZone(text value)

Sets the DropZone attribute. This element specifies what happens when an element is dropped on a web page. The three valid values are copy, move, and link.

Parameters

  • text value: The current DropZone.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
accept:SetDropZone("move")

SetHidden(boolean value)

Sets the AccessKey attribute. Specifies wether an element is hidden or not.

Parameters

  • boolean value: To true to hide element and false to make it visible.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
accept:SetHidden(false)

SetIdentifier(text value)

Sets the Identifier attribute. Specifies a unique name for the element.

Parameters

  • text value: The current Identifier.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
accept:SetIdentifier("myElement")

SetLabel(text value)

This action sets label on the menu.

Parameters

  • text value

Example


use Libraries.Web.Page.Menu
Menu menu
menu:SetLabel("aLabel")

SetLanguage(text value)

Creates and sets an attribute for language. As these codes are esoteric in the standard on the web (HTML), we recommend using the LanguageCode class to help.

Parameters

  • text value

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.LanguageCode
use Libraries.Web.Page.Link

LanguageCode code
//use any WebItem, in this case a link
Link link
link:SetLanguage(code:english)

SetSpellcheck(boolean value)

Sets the Spellcheck attribute. Specifies wether spellcheck is on or off.

Parameters

  • boolean value: The current Spellcheck.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
accept:SetSpellcheck(true)

SetStyle(text value)

Sets the Style attribute. Specifies inline css formatting for an element.

Parameters

  • text value: The current Style.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
accept:SetStyle("color:orange")

SetTabIndex(text value)

Sets the TabIndex attribute. Specifies a tab order for elements.

Parameters

  • text value: The current TabIndex.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
accept:SetTabIndex("0")

SetTextDirection(text value)

Sets the TextDirection attribute. Specifies a direction for the text to be written. For example, "ltr" is left-to-right.

Parameters

  • text value: The current TextDirection.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
accept:SetTextDirection("rtl")

SetTitle(text value)

Sets the Title attribute. Specifies title information for the web element.

Parameters

  • text value: The current Title.

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
accept:SetTitle("MyTitle")

SetType(text value)

This action sets type of the menu.

Parameters

  • text value

Example


use Libraries.Web.Page.Menu
Menu menu
menu:SetType(menu:toolbarMenuType)

ToText()

This action generates text for a particular web page. It is a helper action for Generate()

Return

text: This returns text in hypertext markup language (HTML) representing the tag.

Example

use Libraries.Web.Page.WebPage

WebPage page
text result = page:ToText()
//output out the web page
output result