Libraries.Web.Page.Area Documentation

The Area class represents HTML's (Hypertext Markup Language) area tag which is used to make clickable areas on an ImageMap class. You can find more information about this tag at: The area attribute.

Example Code


use Libraries.Web.Page.all
class Main
action main
   WebPage page
   
   Image image
   image:SetAddress("http://images.free-extras.com/pics/s/smile-1613.jpg")
   image:SetWidth("150")
   image:SetHeight("150")
   image:SetAlternate("Smile")
   image:SetUseMap("#smilemap")

   ImageMap imageMap
   imageMap:SetName("smilemap")

   Area area
   area:SetShape("rect")
   area:SetCoordinates("0,0,100,100")
   area:SetAddress("http://www.darpa.mil/uploadedImages/Content/NewsEvents/Releases/2012/Upward_Falling_Image.jpg")

   imageMap:Add(area)

   page:AddToBody(image)
   page:AddToBody(imageMap)
   output page:Generate()
end
end

Inherits from: Libraries.Web.Page.AttributeAccepter, Libraries.Language.Object, Libraries.Web.Page.GlobalAttributeAccepter, Libraries.Web.Page.WebTag, Libraries.Web.Page.FlowContent

Variables Table

VariablesDescription
text relationshipPrefetch
text relationshipNoReferrer
text relationshipAuthor
text relationshipBookmark
text relationshipNoFollow
text relationshipRelationship
text relationshipLicense
text targetSameWindow
text relationshipTagThis action gets the coordinates attribute of the area. The coordinates is used together with the shape attribute to specify the size, shape, and placement of an area.
text relationshipSearch
text targetParentFrame
text targetSameFrame
text relationshipPrev
text targetNewTab
text relationshipHelp
text relationshipNext

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

AddClassAttribute(text value)

Adds to the ClassAttribute attribute. Multiple class names can be listed in the passed text, separated by a space.

Parameters

  • text value: The classes to be added to the element

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
accept:AddClassAttribute("myClass")

AddNestedTag(Libraries.Web.Page.WebTag tag)

This action adds a WebTag to the list of WebTags contained within the current WebTag.

Parameters

Example

use Libraries.Web.Page.TableRow
use Libraries.Web.Page.TableData


//TableRow and TableData are both WebTags
TableRow row
TableData cell
cell:SetDescription("name")
row:Add(cell)

AddText(text value)

This action sets the description text for this WebTag.

Parameters

  • text value: The text contained in the WebTag.

Example

use Libraries.Web.Page.TableRow
use Libraries.Web.Page.TableData

//TableRow and TableData are both WebTags
TableRow row
TableData cell
cell:AddDescription("name")
row:Add(cell)

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)

Generate()

This action sets the relationship attribute of the area. The relationship tag specifies the type of relationship between the area and the current page. These relationships include: alternate, author, help, bookmark, help, license, next, nofollow, noreferrer, prefetch, prev, search, tag

Return

text:

Example


use Libraries.Web.Page.Area

Area area
area:SetRelationship(area:relationshipNext)

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

GenerateNestedTags()

This action generates the HTML output text of all of the nested WebTags.

Return

text: The text including all webtags within this WebTag.

Example

use Libraries.Web.Page.TableRow
use Libraries.Web.Page.TableData

//TableRow and TableData are both WebTags
TableRow row
TableData cell
cell:SetDescription("name")
row:Add(cell)
output row:GenerateNestedTags()

GetAccessKey()

Returns the AccessKey attribute. Specifies a shortcut key for the web element.

Return

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

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
Attribute attribute = accept:GetAccessKey()

GetAddress()

This action gets the address attribute of the area. The address is the location of the linked webpage or document.

Return

Libraries.Web.Page.Attribute: The address of the link.

Example


use Libraries.Web.Page.Area
use Libraries.Web.Page.Attribute

Area area
Attribute address = area:GetAddress()
if address not= undefined
    text href = address:GetValue()
end

GetAlternativeText()

This action gets the alterinative text attribute of the area.

Return

Libraries.Web.Page.Attribute: The alternitive text for the area.

Example


use Libraries.Web.Page.Area
use Libraries.Web.Page.Attribute

Area area
Attribute altText = area:GetAlternativeText()
if altText not= undefined
    text alt = altText:GetValue()
end

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

GetClassAttribute()

Returns the ClassAttribute attribute.

Return

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

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
Attribute attribute = accept:GetClassAttribute()

GetContentEditable()

Returns the ContentEditable attribute.

Return

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

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
Attribute attribute = accept:GetContentEditable()

GetContextMenu()

Returns the ContextMenu attribute.

Return

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

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
Attribute attribute = accept:GetContextMenu()

GetCoordinates()

This action gets the coordinates attribute of the area. The coordinates is used together with the shape attribute to specify the size, shape, and placement of an area.

Return

Libraries.Web.Page.Attribute: The coordinates of specified area

Example


use Libraries.Web.Page.Area
use Libraries.Web.Page.Attribute

Area area
Attribute coor = area:GetCoordinates()
if coor not= undefined
    text coordinates = coor:GetValue()
end

GetDraggable()

Returns the Draggable attribute.

Return

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

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
Attribute attribute = accept:GetDraggable()

GetDropZone()

Returns the DropZone attribute.

Return

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

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
Attribute attribute = accept:GetDropZone()

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

GetHidden()

Returns the Hidden attribute.

Return

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

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
Attribute attribute = accept:GetHidden()

GetIdentifier()

Returns the Identifier attribute.

Return

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

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
Attribute attribute = accept:GetIdentifier()

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

GetLanguage()

Returns the Language attribute.

Return

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

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
Attribute attribute = accept:GetLanguage()

GetLanguageCode()

This action gets the language code attribute of the area. The language code is the two letter code corresponding to a language. See the Libraries.Web.LanguageCode class.

Return

Libraries.Web.Page.Attribute: The two letter language code.

Example


use Libraries.Web.Page.Area
use Libraries.Web.Page.Attribute

Area area
Attribute code = area:GetLanguageCode()
if code not= undefined
    text languageCode = code:GetValue()
end

GetMedia()

This action gets the media attribute of the area. The media tag specifies the type of media the area will be displayed on (e.g. handheld).

Return

Libraries.Web.Page.Attribute: The type of media the page will be displayed on (braille, handheld, aural, print, screen, etc.)

Example


use Libraries.Web.Page.Area
use Libraries.Web.Page.Attribute

Area area
Attribute media = area:GetMedia()
if media not= undefined
    text mediaType = media:GetValue()
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()

GetNumberOfNestedTags()

This action gets the number of nested tags within the current WebTag.

Return

integer: The number of nested tags.

Example

use Libraries.Web.Page.TableRow
use Libraries.Web.Page.TableData

//TableRow and TableData are both WebTags
TableRow row
TableData cell
cell:SetDescription("name")
row:Add(cell)
integer numTags = row:GetSize()

GetRelationship()

This action gets the relationship attribute of the area. The relationship tag specifies the type of relationship between the area and the current page.

Return

Libraries.Web.Page.Attribute: The type of relationship between the current page and area.

Example


use Libraries.Web.Page.Area
use Libraries.Web.Page.Attribute

Area area
Attribute relationship = area:GetRelationship()
if relationship not= undefined
    text rel = relationship:GetValue()
end

GetShape()

This action gets the shape attribute of the area. The shape tag specifies the type of shape the area should be.

Return

Libraries.Web.Page.Attribute: The type of shape the area should be.

Example


use Libraries.Web.Page.Area
use Libraries.Web.Page.Attribute

Area area
Attribute shapeType = area:GetShape()
if shapeType not= undefined
    text shape = shapeType:GetValue()
end

GetSpellcheck()

Returns the Spellcheck attribute.

Return

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

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
Attribute attribute = accept:GetSpellcheck()

GetStyle()

Returns the Style attribute.

Return

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

Example



use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute

GlobalAttributeAccepter accept
Attribute attribute = accept:GetStyle()

GetTabIndex()

Returns the TabIndex attribute.

Return

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

Example

<