Libraries.Web.Page.EventAttributeAccepter Documentation
The EventAttributeAccepter is a helper class which is a subclass of all accepters classes. This includesAttributeAccepter, MouseAttributeAccepter, WindowAttributeAccepter, FormAttributeAccepter,MediaAttributeAccepter, and KeyboardAttributeAccepter.
Inherits from: Libraries.Web.Page.AttributeAccepter, Libraries.Web.Page.KeyboardAttributeAccepter, Libraries.Web.Page.FormAttributeAccepter, Libraries.Web.Page.WindowAttributeAccepter, Libraries.Web.Page.MediaAttributeAccepter, Libraries.Language.Object, Libraries.Web.Page.MouseAttributeAccepter
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
- Libraries.Web.Page.Attribute: The attribute that will be stored.
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
- Libraries.Language.Object: The object to compare to.
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
- Libraries.Language.Object: The to be compared.
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
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
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()
GetOnAHasChange()
Returns the OnAHasChange attribute. If a window change event occurs on a specified element a script is fired based on this attribute.
Return
Libraries.Web.Page.Attribute: The current OnAHasChange attribute.
Example
use Libraries.Web.Page.WindowAttributeAccepter
use Libraries.Web.Page.Attribute
WindowAttributeAccepter accept
Attribute attribute = accept:GetOnAHasChange()
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()
GetOnAfterPrint()
Returns the OnAfterPrint attribute. After a output event occurs on a specified element a script is fired based on this attribute.
Return
Libraries.Web.Page.Attribute: The current OnAfterPrint attribute.
Example
use Libraries.Web.Page.WindowAttributeAccepter
use Libraries.Web.Page.Attribute
WindowAttributeAccepter accept
Attribute attribute = accept:GetOnAfterPrint()
GetOnBeforePrint()
Returns the OnBeforePrint attribute. Before a output event occurs on a specified element a script is fired based on this attribute.
Return
Libraries.Web.Page.Attribute: The current OnBeforePrint attribute.
Example
use Libraries.Web.Page.WindowAttributeAccepter
use Libraries.Web.Page.Attribute
WindowAttributeAccepter accept
Attribute attribute = accept:GetOnBeforePrint()
GetOnBlur()
Returns the onblur attribute. If the onblur attribute is enabled the form element has lost focus.
Return
Libraries.Web.Page.Attribute: The current onblur attribute.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
Attribute attribute = accept:GetOnBlur()
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()
GetOnChange()
Returns the OnChange attribute. If the OnChange event occurs when a form elements state, text, or selection is changed.
Return
Libraries.Web.Page.Attribute: The current OnChange event attribute.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
Attribute attribute = accept:GetOnChange()
GetOnClick()
Returns the OnClick attribute. If a on click event occurs on a specified element a script is fired based on this attribute.
Return
Libraries.Web.Page.Attribute: The current OnClick attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
Attribute attribute = accept:GetOnClick()
GetOnContextMenu()
Returns the OnContextMenu attribute. If the OnContextMenu specifies the script to run when a context menu is triggered.
Return
Libraries.Web.Page.Attribute: The current OnContextMenu attribute.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
Attribute attribute = accept:GetOnContextMenu()
GetOnDoubleClick()
Returns the OnDoubleClick attribute. If a on double click event occurs on a specified element a script is fired based on this attribute.
Return
Libraries.Web.Page.Attribute: The current OnDoubleClick attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
Attribute attribute = accept:GetOnDoubleClick()
GetOnDrag()
Returns the OnDrag attribute. If a on drag event occurs on a specified element a script is fired based on this attribute.
Return
Libraries.Web.Page.Attribute: The current OnDrag attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
Attribute attribute = accept:GetOnDrag()
GetOnDragEnd()
Returns the OnDragEnd attribute. If a on drag end event occurs on a specified element a script is fired based on this attribute.
Return
Libraries.Web.Page.Attribute: The current OnDragEnd attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
Attribute attribute = accept:GetOnDragEnd()
GetOnDragEnter()
Returns the OnDragEnter attribute. If a on drag into area event occurs on a specified element a script is fired based on this attribute.
Return
Libraries.Web.Page.Attribute: The current OnDragEnter attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
Attribute attribute = accept:GetOnDragEnter()
GetOnDragLeave()
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.
Return
Libraries.Web.Page.Attribute: The current OnDragLeave attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
Attribute attribute = accept:GetOnDragLeave()
GetOnDragOver()
Returns the OnDragOver attribute. If a on drag over event occurs on a specified element a script is fired based on this attribute.
Return
Libraries.Web.Page.Attribute: The current OnDragOver attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
Attribute attribute = accept:GetOnDragOver()
GetOnDragStart()
Returns the OnDragStart attribute. If a on drag start event occurs on a specified element a script is fired based on this attribute.
Return
Libraries.Web.Page.Attribute: The current OnDragStart attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
Attribute attribute = accept:GetOnDragStart()
GetOnDrop()
Returns the OnDrop attribute. If a on drop item event occurs on a specified element a script is fired based on this attribute.
Return
Libraries.Web.Page.Attribute: The current OnDrop attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
Attribute attribute = accept:GetOnDrop()
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()
GetOnError()
Returns the OnError attribute. When an error event occurs on a specified element a script is fired based on this attribute.
Return
Libraries.Web.Page.Attribute: The current OnError attribute.
Example
use Libraries.Web.Page.WindowAttributeAccepter
use Libraries.Web.Page.Attribute
WindowAttributeAccepter accept
Attribute attribute = accept:GetOnError()
GetOnFocus()
Returns the OnFocus attribute. If the OnFocus event occurs when a form element gains focus.
Return
Libraries.Web.Page.Attribute: The current OnFocus event attribute.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
Attribute attribute = accept:GetOnFocus()
GetOnFormChange()
Returns the OnFormChange attribute. If the OnFormChange stores the script to be run when a form change occurs.
Return
Libraries.Web.Page.Attribute: The current OnFormChange script attribute.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
Attribute attribute = accept:GetOnFormChange()
GetOnFormInput()
Returns the OnFormInput attribute. If the OnFormInput is triggered, by a form recieving input, the specified script will be run.
Return
Libraries.Web.Page.Attribute: The current OnFormInput event attribute.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
Attribute attribute = accept:GetOnFormInput()
GetOnInput()
Returns the OnInput attribute. If the OnInput is triggered, by a form element recieving input, the specified script will be run.
Return
Libraries.Web.Page.Attribute: The current OnInput event attribute.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
Attribute attribute = accept:GetOnInput()
GetOnInvalid()
Returns the OnInvalid attribute. If the OnInvalid is