Libraries.Web.Page.MouseAttributeAccepter

The MouseAttributeAccepter class is designed as a helper to ease adding and removing mouse event attributes from particular WebTag objects. While there is no harm in creating an object of this type, it is used most commonly by sub-classes that need to use attributes. The example for this class shows how to subclass the MouseAttributeAccepter class.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter

class audio is MouseAttributeAccepter, WebGenerator
    action Generate returns text
        text result = "<button " 
        Attributes attributes = parent:WebTag:GetAttributes()
        attributeText = attributes:Generate()
        result = result + attributeText + ">"
        result = result + me:GenerateNestedTags()
        result = result + "</button>"
        return result
    end
end

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

Example Code

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)

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

Example Code

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

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

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.

Example Code

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

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

Example Code

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

This action returns a text description of all attributes stored.

Example Code

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

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

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

Example Code

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")

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

Example Code

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")

Returns a list of all attributes on the system.

Example Code

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

        AttributeAccepter accept
        Attributes attributes = accept:GetAttributes()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

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

Example Code

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

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

Example Code

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

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

Returns the OnClick attribute. If a on click event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnClick()

Returns the OnDoubleClick attribute. If a on double click event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnDoubleClick()

Returns the OnDrag attribute. If a on drag event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnDrag()

Returns the OnDragEnd attribute. If a on drag end event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnDragEnd()

Returns the OnDragEnter attribute. If a on drag into area event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnDragEnter()

Returns the OnDragLeave attribute. If a on drag out of area event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnDragLeave()

Returns the OnDragOver attribute. If a on drag over event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnDragOver()

Returns the OnDragStart attribute. If a on drag start event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnDragStart()

Returns the OnDrop attribute. If a on drop item event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnDrop()

Returns the OnMouseDown attribute. If a on mouse button down event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnMouseDown()

Returns the OnMouseMove attribute. If a on mouse move event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnMouseMove()

Returns the OnMouseOut attribute. If a on mouse out of area event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnMouseOut()

Returns the OnMouseOver attribute. If a on mouse over event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnMouseOver()

Returns the OnMouseUp attribute. If a on mouse button up event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnMouseUp()

Returns the OnMouseWheel attribute. If a mouse wheel scroll event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnMouseWheel()

Returns the OnScroll attribute. If a on scroll event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnScroll()

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

Example Code

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")

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

Example Code

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")

Sets the OnClick attribute script when the OnClick event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnClick("doSomething()")

Sets the OnDoubleClick attribute script when the OnDoubleClick event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnDoubleClick("doSomething()")

Sets the OnDrag attribute script when the OnDrag event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnDrag("doSomething()")

Sets the OnDragEnd attribute script when the OnDragEnd event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnDragEnd("doSomething()")

Sets the OnDragEnter attribute script when the OnDragEnter event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnDragEnter("doSomething()")

Sets the OnDragLeave attribute script when the OnDragLeave event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnDragLeave("doSomething()")

Sets the OnDragOver attribute script when the OnDragOver event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnDragOver("doSomething()")

Sets the OnDragStart attribute script when the OnDragStart event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnDragStart("doSomething()")

Sets the OnDrop attribute script when the OnDrop event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnDrop("doSomething()")

Sets the OnMouseDown attribute script when the OnMouseDown event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnMouseDown("doSomething()")

Sets the OnMouseMove attribute script when the OnMouseMove event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnMouseMove("doSomething()")

Sets the OnMouseOut attribute script when the OnMouseOut event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnMouseOut("doSomething()")

Sets the OnMouseOver attribute script when the OnMouseOver event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnMouseOver("doSomething()")

Sets the OnMouseUp attribute script when the OnMouseUp event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnMouseUp("doSomething()")

Sets the OnMouseWheel attribute script when the OnMouseWheel event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnMouseWheel("doSomething()")

Sets the OnScroll attribute script when the OnScroll event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnScroll("doSomething()")