Libraries.Web.Page.MediaAttributeAccepter

The MediaAttributeAccepter 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 MediaAttributeAccepter class.

Example Code

use Libraries.Web.Page.MediaAttributeAccepter

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        Attribute attribute = accept:GetOnAbort()

Returns the OnCanPlay attribute. If a can play event (a file has buffered enough to play) occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        Attribute attribute = accept:GetOnCanPlay()

Returns the OnCanPlayThrough attribute. If a play all the way through (the file can play without pausing for buffering) event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        Attribute attribute = accept:GetOnCanPlayThrough()

Returns the OnDurationChange attribute. If the durration of a a media file changes, this event will occur on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        Attribute attribute = accept:GetOnDurationChange()

Returns the OnEmptied attribute. If the file becomes unavailable this event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        Attribute attribute = accept:GetOnEmptied()

Returns the OnEnded attribute. If the media file reaches the end event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        Attribute attribute = accept:GetOnEnded()

Returns the OnLoadStart attribute. If a load event is about to start on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        Attribute attribute = accept:GetOnLoadStart()

Returns the OnLoadedData attribute. If a media loaded event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        Attribute attribute = accept:GetOnLoadedData()

Returns the OnLoadedMetaData attribute. If the meta data is loaded event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        Attribute attribute = accept:GetOnLoadedMetaData()

Returns the OnMediaError attribute. If a load error event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        Attribute attribute = accept:GetOnMediaError()

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        Attribute attribute = accept:GetOnPause()

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        Attribute attribute = accept:GetOnPlay()

Returns the OnPlaying attribute. If a play event is currently firing on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        Attribute attribute = accept:GetOnPlaying()

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        Attribute attribute = accept:GetOnProgress()

Returns the OnRateChange attribute. If a on play rate change event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        Attribute attribute = accept:GetOnRateChange()

Returns the OnReadyStateChange attribute. If the ready state event changes on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        Attribute attribute = accept:GetOnReadyStateChange()

Returns the OnSeeked attribute. If a seek event has occured on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        Attribute attribute = accept:GetOnSeeked()

Returns the OnSeeking attribute. If a seek event is currently occuring on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        Attribute attribute = accept:GetOnSeeking()

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        Attribute attribute = accept:GetOnStalled()

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        Attribute attribute = accept:GetOnSuspend()

Returns the OnTimeUpdate attribute. If the playing position changes on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        Attribute attribute = accept:GetOnTimeUpdate()

Returns the OnVolumeChange attribute. If a volume change event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        Attribute attribute = accept:GetOnVolumeChange()

Returns the OnWaiting attribute. If a pause event occurs and it is expected to continue on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        Attribute attribute = accept:GetOnWaiting()

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 OnAbort attribute script when the OnAbort event is triggered.

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        accept:SetOnAbort("doSomething()")

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        accept:SetOnCanPlay("doSomething()")

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        accept:SetOnCanPlayThrough("doSomething()")

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        accept:SetOnDurationChange("doSomething()")

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        accept:SetOnEmptied("doSomething()")

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        accept:SetOnEnded("doSomething()")

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        accept:SetOnLoadStart("doSomething()")

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        accept:SetOnLoadedData("doSomething()")

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        accept:SetOnLoadedMetaData("doSomething()")

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        accept:SetOnMediaError("doSomething()")

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        accept:SetOnPause("doSomething()")

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        accept:SetOnPlay("doSomething()")

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        accept:SetOnPlaying("doSomething()")

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        accept:SetOnProgress("doSomething()")

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        accept:SetOnRateChange("doSomething()")

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        accept:SetOnReadyStateChange("doSomething()")

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        accept:SetOnSeeked("doSomething()")

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        accept:SetOnSeeking("doSomething()")

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        accept:SetOnStalled("doSomething()")

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        accept:SetOnSuspend("doSomething()")

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        accept:SetOnTimeUpdate("doSomething()")

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        accept:SetOnVolumeChange("doSomething()")

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

Example Code

use Libraries.Web.Page.MediaAttributeAccepter
        use Libraries.Web.Page.Attribute

        MediaAttributeAccepter accept
        accept:SetOnWaiting("doSomething()")