Libraries.Web.Page.KeyboardAttributeAccepter

The KeyboardAttributeAccepter class is designed as a helper to ease adding and removing keyboard 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 KeyboardAttributeAccepter class.

Example Code

use Libraries.Web.Page.KeyboardAttributeAccepter

class Input is KeyboardAttributeAccepter, WebGenerator
    action Generate returns text
        text result = "<input " 
        Attributes attributes = parent:WebTag:GetAttributes()
        attributeText = attributes:Generate()
        result = result + attributeText + ">"
        result = result + me:GenerateNestedTags()
        result = result + "</input>"
        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 OnKeyDown attribute. If a key down event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.KeyboardAttributeAccepter
        use Libraries.Web.Page.Attribute

        KeyboardAttributeAccepter accept
        Attribute attribute = accept:GetOnKeyDown()

Returns the OnKeyPress attribute. If a key press event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.KeyboardAttributeAccepter
        use Libraries.Web.Page.Attribute

        KeyboardAttributeAccepter accept
        Attribute attribute = accept:GetOnKeyPress()

Returns the OnKeyUp attribute. If a key up event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.KeyboardAttributeAccepter
        use Libraries.Web.Page.Attribute

        KeyboardAttributeAccepter accept
        Attribute attribute = accept:GetOnKeyUp()

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 OnKeyDown attribute. If a key down event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.KeyboardAttributeAccepter
        use Libraries.Web.Page.Attribute

        KeyboardAttributeAccepter accept
        accept:SetOnKeyDown("doSomething()")

Sets the OnKeyPress attribute. If a key press event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.KeyboardAttributeAccepter
        use Libraries.Web.Page.Attribute

        KeyboardAttributeAccepter accept
        accept:SetOnKeyPress("doSomething()")

Sets the OnKeyUp attribute. If a key up event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.KeyboardAttributeAccepter
        use Libraries.Web.Page.Attribute

        KeyboardAttributeAccepter accept
        accept:SetOnKeyUp("doSomething()")