Libraries.Web.Page.FormAttributeAccepter

The FormAttributeAccepter class is designed as a helper to ease adding and removing attributes from particular WebTag objects belonging to a form. 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 FormAttributeAccepter class.

Example Code

use Libraries.Web.Page.FormAttributeAccepter

class Button is FormAttributeAccepter, 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 onblur attribute. If the onblur attribute is enabled the form element has lost focus.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        Attribute attribute = accept:GetOnBlur()

Returns the OnChange attribute. If the OnChange event occurs when a form elements state, text, or selection is changed.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        Attribute attribute = accept:GetOnChange()

Returns the OnContextMenu attribute. If the OnContextMenu specifies the script to run when a context menu is triggered.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        Attribute attribute = accept:GetOnContextMenu()

Returns the OnFocus attribute. If the OnFocus event occurs when a form element gains focus.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        Attribute attribute = accept:GetOnFocus()

Returns the OnFormChange attribute. If the OnFormChange stores the script to be run when a form change occurs.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        Attribute attribute = accept:GetOnFormChange()

Returns the OnFormInput attribute. If the OnFormInput is triggered, by a form recieving input, the specified script will be run.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        Attribute attribute = accept:GetOnFormInput()

Returns the OnInput attribute. If the OnInput is triggered, by a form element recieving input, the specified script will be run.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        Attribute attribute = accept:GetOnInput()

Returns the OnInvalid attribute. If the OnInvalid is triggered, by a form element recieving invalid input, the specified script will be run.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        Attribute attribute = accept:GetOnInvalid()

Returns the OnSelect attribute. OnSelect is triggered by the selection of an elements text on the form.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        Attribute attribute = accept:GetOnSelect()

Returns the OnSubmit attribute. The OnSubmit is triggered by a submit action on the form.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        Attribute attribute = accept:GetOnSubmit()

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 onblur attribute. The onblur attribute is the script to be triggered when the onblur even occurs. OnBlur is fired the moment an element loses focus.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        accept:SetOnBlur("upperCase()")

Sets the OnChange attribute. The OnChange attribute is the script to be triggered when the OnChange event occurs. OnChange is fired the moment an element content is changed on a form.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        accept:SetOnChange("upperCase()")

Sets the OnContextMenu attribute. The OnContextMenu attribute is the script to be triggered when the OnContextMenu event occurs. OnContextMenu is fired when a context menu is selected.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        accept:SetOnContextMenu("upperCase()")

Sets the OnFocus attribute. The OnFocus attribute is the script to be triggered when the OnFocus event occurs. OnFocus is fired the moment an element gains focus.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        accept:SetOnFocus("upperCase()")

Sets the OnFormChange attribute. The OnFormChange attribute is the script to be triggered when the OnFormChange event occurs. OnFormChange is fired the moment the form is changed.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        accept:SetOnFormChange("upperCase()")

Sets the OnFormInput attribute. The OnFormInput attribute is the script to be triggered when the OnFormInput event occurs. OnFormInput is fired the moment the form is given input.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        accept:SetOnFormInput("upperCase()")

Sets the OnInput attribute. The OnInput attribute is the script to be triggered when the OnInput event occurs. OnInput is fired the moment a form element is given input.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        accept:SetOnInput("upperCase()")

Sets the OnInvalid attribute. The OnInvalid attribute is the script to be triggered when the OnInvalid event occurs. OnInvalid is fired the moment a form element is invalid.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        accept:SetOnInvalid("upperCase()")

Sets the OnSelect attribute. The OnSelect attribute is the script to be triggered when the OnSelect event occurs. OnSelect is fired the moment a form elements text is selected.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        accept:SetOnSelect("upperCase()")

Sets the OnSubmit attribute. The OnSubmit attribute is the script to be triggered when the OnSubmit event occurs. OnSubmit is fired the moment a submit action occurs.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        accept:SetOnSubmit("upperCase()")