Libraries.Web.Page.WebTable Documentation

The WebTable class represents HTML's (Hypertext Markup Language) table tag which is a class that builds a table. This table contains any number of rows that have been added to the table.

Example Code

use Libraries.Compute.Matrix
use Libraries.Web.Page.WebTable

class Main
    action main
        Matrix matrix
        matrix:Fill(3, 3, 1.0)

        WebTable table
        table:Add(matrix)

        output table:Generate()
   end
end

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

Summary

Actions Summary Table

ActionsDescription
Add(Libraries.Compute.Matrix matrix)This action creates a WebTable object from a two dimensional matrix created with the Matrix class.
Add(Libraries.Web.Page.Attribute attribute)This action adds an attribute to this object.
Add(Libraries.Web.Page.TableRow content)This action places an TableRow object inside of a WebTable object.
Add(Libraries.Web.Page.TableCaption content)This action places an TableCaption object inside of a WebTable object.
Add(Libraries.Web.Page.TableFooter content)This action places an TableFooter object inside of a WebTable object.
Add(Libraries.Web.Page.TableHeader content)This action places an TableHeader object inside of a WebTable object.
Add(Libraries.Web.Page.ColumnGroup content)This action places an ColumnGroup object inside of a WebTable object.
Add(Libraries.Web.Page.TableBody content)This action places an TableBody object inside of a WebTable object.
AddAttribute(text name, text value)This action adds an attribute to this object.
AddClassAttribute(text value)Adds to the ClassAttribute attribute.
AddText(text value)This action sets the description text for this WebTag.
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns a CompareResult.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
Generate()
GenerateAttributes()This action returns a text description of all attributes stored.
GenerateNestedTags()This action generates the HTML output text of all of the nested WebTags.
GetAccessKey()Returns the AccessKey attribute.
GetAttribute(text name)This action returns an attribute from this object's Attributes object.
GetAttributeValue(text name)This action returns an attribute from this object's Attributes object.
GetAttributes()Returns a list of all attributes on the system.
GetBorder()This action gets the border attribute of the web table and returns true if there is a border around the cells and false if it does not.
GetClassAttribute()Returns the ClassAttribute attribute.
GetContentEditable()Returns the ContentEditable attribute.
GetContextMenu()Returns the ContextMenu attribute.
GetDraggable()Returns the Draggable attribute.
GetDropZone()Returns the DropZone attribute.
GetHashCode()This action gets the hash code for an object.
GetHidden()Returns the Hidden attribute.
GetIdentifier()Returns the Identifier attribute.
GetIterator()This action returns an iterator of all attributes stored in this object.
GetLanguage()Returns the Language attribute.
GetNumberOfAttributes()This action returns the number of attributes that are currently stored in this object.
GetNumberOfNestedTags()This action gets the number of nested tags within the current WebTag.
GetSpellcheck()Returns the Spellcheck attribute.
GetStyle()Returns the Style attribute.
GetTabIndex()Returns the TabIndex attribute.
GetTextDirection()Returns the TextDirection attribute.
GetTitle()Returns the Title attribute.
HasAttribute(text name)This action returns whether or not an attribute exists for the key passed in as a parameter.
Remove(Libraries.Web.Page.WebTag tag)This action removes the first instance of a webtag found in the list of sub-WebTags.
RemoveAttribute(text name)This action removes an attribute with a particular key.
SetAccessKey(text value)Sets the AccessKey attribute.
SetBorder(boolean value)This action sets the border attribute of the web table.
SetClassAttribute(text value)Sets the ClassAttribute attribute.
SetContentEditable(text value)Sets the ContentEditable attribute.
SetContextMenu(text value)Sets the ContextMenu attribute.
SetDraggable(boolean value)Sets the Draggable attribute.
SetDropZone(text value)Sets the DropZone attribute.
SetHidden(boolean value)Sets the AccessKey attribute.
SetIdentifier(text value)Sets the Identifier attribute.
SetLanguage(text value)Creates and sets an attribute for language.
SetSpellcheck(boolean value)Sets the Spellcheck attribute.
SetStyle(text value)Sets the Style attribute.
SetTabIndex(text value)Sets the TabIndex attribute.
SetTextDirection(text value)Sets the TextDirection attribute.
SetTitle(text value)Sets the Title attribute.

Actions Documentation

Add(Libraries.Compute.Matrix matrix)

This action creates a WebTable object from a two dimensional matrix created with the Matrix class.

Example Code

class Main 
        action Main
            Matrix matrix
            matrix:Fill(3, 3, 1.1)

            WebTable table
            table:Add(matrix)
            output table:Generate()
        end

Parameters

Add(Libraries.Web.Page.Attribute attribute)

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)

Parameters

Add(Libraries.Web.Page.TableRow content)

This action places an TableRow object inside of a WebTable object. There can only be TableRow objects directly in a WebTable if no TableBody is present within the table.

Example Code

use Libraries.Web.Page.all

        class Main
            action Main
                WebPage page
                WebTable table
                TableRow row

                
                page:Add(table)
                table:Add(row)
                text value = page:Generate()
                output value
            end
        end

Parameters

Add(Libraries.Web.Page.TableCaption content)

This action places an TableCaption object inside of a WebTable object.

Example Code

use Libraries.Web.Page.all

        class Main
            action Main
                WebPage page
                WebTable table
                TableCaption caption

                
                page:Add(table)
                caption:SetDescription("This is a table!")
                table:Add(caption)

                text value = page:Generate()
                output value
            end
        end

Parameters

Add(Libraries.Web.Page.TableFooter content)

This action places an TableFooter object inside of a WebTable object.

Example Code

use Libraries.Web.Page.all

        class Main
            action Main
                WebPage page
                WebTable table
                TableFooter footer

                
                page:Add(table)
                footer:SetDescription("Table 1: A list of things")
                table:Add(footer)
                text value = page:Generate()
                output value
            end
        end

Parameters

Add(Libraries.Web.Page.TableHeader content)

This action places an TableHeader object inside of a WebTable object.

Example Code

use Libraries.Web.Page.all

        class Main
            action Main
                WebPage page
                WebTable table
                TableHeader header

                
                page:Add(table)
                header:SetDescription("My Table")
                table:Add(header)
                text value = page:Generate()
                output value
            end
        end

Parameters

Add(Libraries.Web.Page.ColumnGroup content)

This action places an ColumnGroup object inside of a WebTable object.

Example Code

use Libraries.Web.Page.all

        class Main
            action Main
                WebPage page
                WebTable table
                ColumnGroup group
                Column column

                
                page:Add(table)
                group:Add(column)
                table:Add(group)
                text value = page:Generate()
                output value
            end
        end

Parameters

Add(Libraries.Web.Page.TableBody content)

This action places an TableBody object inside of a WebTable object. If a TableBody exists in a WebTable, then TableRows must only be declared within TableBody objects, rather than in the WebTable directly.

Example Code

use Libraries.Web.Page.all

        class Main
            action Main
                WebPage page
                WebTable table
                TableBody tbody
                TableRow row

                
                page:Add(table)
                table:Add(tbody)
                tpage:Add(row)
                text value = page:Generate()
                output value
            end
        end

Parameters

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

Example Code

use Libraries.Web.Page.AttributeAccepter
        use Libraries.Web.Page.Attribute

        AttributeAccepter accept
        accept:AddAttribute("src", "http://www.google.com")

Parameters

AddClassAttribute(text value)

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

Example Code

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

        GlobalAttributeAccepter accept
        accept:AddClassAttribute("myClass")

Parameters

AddText(text value)

This action sets the description text for this WebTag.

Example Code

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)

Parameters

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns a CompareResult. The compare result is either larger if this hash code is larger than the object passed as a parameter, smaller, or equal.

Example Code

use Libraries.Language.Support.CompareResult
        Object o
        Object t
        CompareResult result = o:Compare(t)

Parameters

Return

Libraries.Language.Support.CompareResult: The Compare result, Smaller, Equal, or Larger.

Equals(Libraries.Language.Object object)

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)

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

Generate()

Return

text

GenerateAttributes()

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

Return

text:

GenerateNestedTags()

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

Example Code

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

Return

text: The text including all webtags within this WebTag.

GetAccessKey()

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

Example Code

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

        GlobalAttributeAccepter accept
        Attribute attribute = accept:GetAccessKey()

Return

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

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.

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

Parameters

Return

Libraries.Web.Page.Attribute:

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.

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

Parameters

Return

text:

GetAttributes()

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

Return

Libraries.Web.Page.Attributes: The attributes class contains all of the attributes that have been set for this object.

GetBorder()

This action gets the border attribute of the web table and returns true if there is a border around the cells and false if it does not.

Example Code

use Libraries.Web.Page.WebTable
        WebTable table
        boolean hasBorder = table:GetBorder()

Return

boolean: True if the cells have a border and false if not.

GetClassAttribute()

Returns the ClassAttribute attribute.

Example Code

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

        GlobalAttributeAccepter accept
        Attribute attribute = accept:GetClassAttribute()

Return

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

GetContentEditable()

Returns the ContentEditable attribute.

Example Code

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

        GlobalAttributeAccepter accept
        Attribute attribute = accept:GetContentEditable()

Return

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

GetContextMenu()

Returns the ContextMenu attribute.

Example Code

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

        GlobalAttributeAccepter accept
        Attribute attribute = accept:GetContextMenu()

Return

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

GetDraggable()

Returns the Draggable attribute.

Example Code

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

        GlobalAttributeAccepter accept
        Attribute attribute = accept:GetDraggable()

Return

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

GetDropZone()

Returns the DropZone attribute.

Example Code

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

        GlobalAttributeAccepter accept
        Attribute attribute = accept:GetDropZone()

Return

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

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

Return

integer: The integer hash code of the object.

GetHidden()

Returns the Hidden attribute.

Example Code

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

        GlobalAttributeAccepter accept
        Attribute attribute = accept:GetHidden()

Return

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

GetIdentifier()

Returns the Identifier attribute.

Example Code

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

        GlobalAttributeAccepter accept
        Attribute attribute = accept:GetIdentifier()

Return

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

GetIterator()

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

Return

Libraries.Containers.Iterator:

GetLanguage()

Returns the Language attribute.

Example Code

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

        GlobalAttributeAccepter accept
        Attribute attribute = accept:GetLanguage()

Return

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

GetNumberOfAttributes()

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

Return

integer:

GetNumberOfNestedTags()

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

Example Code

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

Return

integer: The number of nested tags.

GetSpellcheck()

Returns the Spellcheck attribute.

Example Code

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

        GlobalAttributeAccepter accept
        Attribute attribute = accept:GetSpellcheck()

Return

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

GetStyle()

Returns the Style attribute.

Example Code

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

        GlobalAttributeAccepter accept
        Attribute attribute = accept:GetStyle()

Return

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

GetTabIndex()

Returns the TabIndex attribute.

Example Code

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

        GlobalAttributeAccepter accept
        Attribute attribute = accept:GetTabIndex()

Return

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

GetTextDirection()

Returns the TextDirection attribute.

Example Code

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

        GlobalAttributeAccepter accept
        Attribute attribute = accept:GetTextDirection()

Return

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

GetTitle()

Returns the Title attribute.

Example Code

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

        GlobalAttributeAccepter accept
        Attribute attribute = accept:GetTitle()

Return

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

HasAttribute(text name)

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

Parameters

Return

boolean:

Remove(Libraries.Web.Page.WebTag tag)

This action removes the first instance of a webtag found in the list of sub-WebTags.

Example Code

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)
        row:Remove(cell)

Parameters

RemoveAttribute(text name)

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

Parameters

Return

Libraries.Web.Page.Attribute:

SetAccessKey(text value)

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

Example Code

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

        GlobalAttributeAccepter accept
        accept:SetAccessKey("z")

Parameters

SetBorder(boolean value)

This action sets the border attribute of the web table. If set to true there is a border around the cells and if false the cells do not have a a border.

Example Code

use Libraries.Web.Page.WebTable
        WebTable table
        table:SetBorder(true)

Parameters

SetClassAttribute(text value)

Sets the ClassAttribute attribute. Specifies a class name for the element.

Example Code

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

        GlobalAttributeAccepter accept
        accept:SetClassAttribute("myClass")

Parameters

SetContentEditable(text value)

Sets the ContentEditable attribute. Specifies wether content in an element is editable.

Example Code

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

        GlobalAttributeAccepter accept
        accept:SetContentEditable("true")

Parameters

SetContextMenu(text value)

Sets the ContextMenu attribute. Specifies a context menu that contains the element.

Example Code

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

        GlobalAttributeAccepter accept
        accept:SetContextMenu("parentmenu")

Parameters

SetDraggable(boolean value)

Sets the Draggable attribute. Specifies wether an element is draggable or not.

Example Code

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

        GlobalAttributeAccepter accept
        accept:SetDraggable(true)

Parameters

SetDropZone(text value)

Sets the DropZone attribute. This element specifies what happens when an element is dropped on a web page. The three valid values are copy, move, and link.

Example Code

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

        GlobalAttributeAccepter accept
        accept:SetDropZone("move")

Parameters

SetHidden(boolean value)

Sets the AccessKey attribute. Specifies wether an element is hidden or not.

Example Code

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

        GlobalAttributeAccepter accept
        accept:SetHidden(false)

Parameters

SetIdentifier(text value)

Sets the Identifier attribute. Specifies a unique name for the element.

Example Code

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

        GlobalAttributeAccepter accept
        accept:SetIdentifier("myElement")

Parameters

SetLanguage(text value)

Creates and sets an attribute for language. As these codes are esoteric in the standard on the web (HTML), we recommend using the LanguageCode class to help.

Example Code

use Libraries.Web.Page.GlobalAttributeAccepter
        use Libraries.Web.Page.LanguageCode
        use Libraries.Web.Page.Link

        LanguageCode code
        //use any WebItem, in this case a link
        Link link
        link:SetLanguage(code:english)

Parameters

SetSpellcheck(boolean value)

Sets the Spellcheck attribute. Specifies wether spellcheck is on or off.

Example Code

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

        GlobalAttributeAccepter accept
        accept:SetSpellcheck(true)

Parameters

SetStyle(text value)

Sets the Style attribute. Specifies inline css formatting for an element.

Example Code

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

        GlobalAttributeAccepter accept
        accept:SetStyle("color:orange")

Parameters

SetTabIndex(text value)

Sets the TabIndex attribute. Specifies a tab order for elements.

Example Code

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

        GlobalAttributeAccepter accept
        accept:SetTabIndex("0")

Parameters

SetTextDirection(text value)

Sets the TextDirection attribute. Specifies a direction for the text to be written. For example, "ltr" is left-to-right.

Example Code

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

        GlobalAttributeAccepter accept
        accept:SetTextDirection("rtl")

Parameters

SetTitle(text value)

Sets the Title attribute. Specifies title information for the web element.

Example Code

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

        GlobalAttributeAccepter accept
        accept:SetTitle("MyTitle")

Parameters