Libraries.Web.Page.MediaAttributeAccepter Documentation

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

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

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

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)

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

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

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

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

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

GetOnAbort()

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

Return

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

Example



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

MediaAttributeAccepter accept
Attribute attribute = accept:GetOnAbort()

GetOnCanPlay()

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.

Return

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

Example



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

MediaAttributeAccepter accept
Attribute attribute = accept:GetOnCanPlay()

GetOnCanPlayThrough()

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.

Return

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

Example



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

MediaAttributeAccepter accept
Attribute attribute = accept:GetOnCanPlayThrough()

GetOnDurationChange()

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.

Return

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

Example



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

MediaAttributeAccepter accept
Attribute attribute = accept:GetOnDurationChange()

GetOnEmptied()

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

Return

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

Example



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

MediaAttributeAccepter accept
Attribute attribute = accept:GetOnEmptied()

GetOnEnded()

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.

Return

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

Example



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

MediaAttributeAccepter accept
Attribute attribute = accept:GetOnEnded()

GetOnLoadStart()

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

Return

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

Example



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

MediaAttributeAccepter accept
Attribute attribute = accept:GetOnLoadStart()

GetOnLoadedData()

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

Return

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

Example



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

MediaAttributeAccepter accept
Attribute attribute = accept:GetOnLoadedData()

GetOnLoadedMetaData()

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

Return

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

Example



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

MediaAttributeAccepter accept
Attribute attribute = accept:GetOnLoadedMetaData()

GetOnMediaError()

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

Return

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

Example



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

MediaAttributeAccepter accept
Attribute attribute = accept:GetOnMediaError()

GetOnPause()

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

Return

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

Example



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

MediaAttributeAccepter accept
Attribute attribute = accept:GetOnPause()

GetOnPlay()

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

Return

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

Example



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

MediaAttributeAccepter accept
Attribute attribute = accept:GetOnPlay()

GetOnPlaying()

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

Return

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

Example



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

MediaAttributeAccepter accept
Attribute attribute = accept:GetOnPlaying()

GetOnProgress()

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

Return

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

Example



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

MediaAttributeAccepter accept
Attribute attribute = accept:GetOnProgress()

GetOnRateChange()

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

Return

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

Example



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

MediaAttributeAccepter accept
Attribute attribute = accept:GetOnRateChange()

GetOnReadyStateChange()

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

Return

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

Example



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

MediaAttributeAccepter accept
Attribute attribute = accept:GetOnReadyStateChange()

GetOnSeeked()

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

Return

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

Example



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

MediaAttributeAccepter accept
Attribute attribute = accept:GetOnSeeked()

GetOnSeeking()

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

Return

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

Example



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

MediaAttributeAccepter accept
Attribute attribute = accept:GetOnSeeking()

GetOnStalled()

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

Return

Libraries.Web.Page.Attribute: The current OnAbort OnStalled.

Example



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

MediaAttributeAccepter accept
Attribute attribute = accept:GetOnStalled()

GetOnSuspend()

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

Return

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

Example



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

MediaAttributeAccepter accept
Attribute attribute = accept:GetOnSuspend()

GetOnTimeUpdate()

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

Return

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

Example



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

MediaAttributeAccepter accept
Attribute attribute = accept:GetOnTimeUpdate()

GetOnVolumeChange()

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

Return

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

Example



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

MediaAttributeAccepter accept
Attribute attribute = accept:GetOnVolumeChange()

GetOnWaiting()

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.

Return

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

Example



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

MediaAttributeAccepter accept
Attribute attribute = accept:GetOnWaiting()

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

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

SetOnAbort(text value)

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

Parameters

  • text value: The current OnAbort attribute.

Example



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

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

SetOnCanPlay(text value)

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

Parameters

  • text value: The current OnCanPlay attribute.