Libraries.Web.Page.WebPageHeader Documentation

The WebPageHeader class represents HTML's (Hypertext Markup Language) head tag which is a container class for any WebTags that belong in the web pages header. You can find more information about this tag at: The head attribute.

Example Code

use Libraries.Web.Page.all
class Main
   action main
      //make a web page
      WebPage page
      //add a TextArea
      WebPageHeader header
      page:SetWebPageHeader(header)
      output page:Generate()
   end
end

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

Summary

Actions Summary Table

ActionsDescription
Add(Libraries.Web.Page.HeaderLink value)This action adds a link to a stylesheet to the header.
Add(Libraries.Web.Page.Attribute attribute)This action adds an attribute to this object.
Add(Libraries.Web.Page.MetaData value)This action adds MetaData to the header.
Add(Libraries.Web.Page.Script value)This action adds a script to the header of a webpage.
Add(Libraries.Web.Page.Base value)This action adds Base to the header.
AddAttribute(text name, text value)This action adds an attribute to this object.
AddClassAttribute(text value)Adds to the ClassAttribute attribute.
AddIcon(text path)This action adds a link to an icon in the header.
AddStylesheet(text path)This action adds a link to a stylesheet in the header.
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.
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.
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.
GetNumberOfMetaDataItems()This action gets the number of meta data items in the header.
GetNumberOfScriptItems()This action gets the number of script items in the header.
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.
GetTitleHeader()This action gets the headers title.
HasAttribute(text name)This action returns whether or not an attribute exists for the key passed in as a parameter.
Remove(Libraries.Web.Page.HeaderLink value)This action removes the first instance of the links to stylesheets found in the meta list.
Remove(Libraries.Web.Page.Script value)This action removes the first instance of the script from the headers list of scripts.
Remove(Libraries.Web.Page.Base value)This action removes the base data from the header.
Remove(Libraries.Web.Page.MetaData value)This action removes the first instance of the meta data value found in the meta list.
RemoveAttribute(text name)This action removes an attribute with a particular key.
SetAccessKey(text value)Sets the AccessKey attribute.
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.
SetTitleHeader(Libraries.Web.Page.Title title)This action sets the title for the header.
SetTitleHeaderValue(text value)This action sets the text of the title in the header.

Actions Documentation

This action adds a link to a stylesheet to the header.

Example Code

use Libraries.Web.Page.WebPageHeader
        use Libraries.Web.Page.HeaderLink
        WebPageHeader header
        HeaderLink md
        header:Add(md)

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.MetaData value)

This action adds MetaData to the header.

Example Code

use Libraries.Web.Page.WebPageHeader
        use Libraries.Web.Page.MetaData
        WebPageHeader header
        MetaData md
        header:Add(md)

Parameters

Add(Libraries.Web.Page.Script value)

This action adds a script to the header of a webpage.

Example Code

use Libraries.Web.Page.WebPageHeader
        use Libraries.Web.Page.Script
        WebPageHeader header
        Script s
        header:Add(s)

Parameters

Add(Libraries.Web.Page.Base value)

This action adds Base to the header. There can only be one base on a page.

Example Code

use Libraries.Web.Page.WebPageHeader
        use Libraries.Web.Page.Base
        WebPageHeader header
        Base base
        header:Add(base)

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

AddIcon(text path)

This action adds a link to an icon in the header. This is sometimes referred to as a "favicon".

Example Code

use Libraries.Web.Page.WebPageHeader

        WebPageHeader header
        header:AddIcon("favicon.ico")

Parameters

Return

Libraries.Web.Page.HeaderLink: The generated link for any further manipulation

AddStylesheet(text path)

This action adds a link to a stylesheet in the header.

Example Code

use Libraries.Web.Page.WebPageHeader

        WebPageHeader header
        header:AddStylesheet("style.css")

Parameters

Return

Libraries.Web.Page.HeaderLink: The generated link for any further manipulation

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:

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.

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:

GetNumberOfMetaDataItems()

This action gets the number of meta data items in the header.

Example Code

use Libraries.Web.Page.WebPageHeader
        WebPageHeader header
        integer val = header:GetNumberOfMetaDataItems()

Return

integer: The number of meta data items in the header.

GetNumberOfScriptItems()

This action gets the number of script items in the header.

Example Code

use Libraries.Web.Page.WebPageHeader
        use Libraries.Web.Page.Script
        WebPageHeader header
        Script s
        header:Add(s)
        integer val = header:GetNumberOfScriptItems()

Return

integer: The number of script items in the header.

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.

GetTitleHeader()

This action gets the headers title.

Example Code

use Libraries.Web.Page.WebPageHeader
        use Libraries.Web.Page.Title
        WebPageHeader header
        Title title
        header:SetTitleHeader(title)
        Title t = header:GetTitleHeader()

Return

Libraries.Web.Page.Title: The headers title.

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:

This action removes the first instance of the links to stylesheets found in the meta list.

Example Code

use Libraries.Web.Page.WebPageHeader
        use Libraries.Web.Page.HeaderLink
        WebPageHeader header
        HeaderLink item
        header:Remove(item)

Parameters

Remove(Libraries.Web.Page.Script value)

This action removes the first instance of the script from the headers list of scripts.

Example Code

use Libraries.Web.Page.WebPageHeader
        use Libraries.Web.Page.Script
        WebPageHeader header
        Script s
        header:Add(s)
        header:Remove(s)

Parameters

Remove(Libraries.Web.Page.Base value)

This action removes the base data from the header.

Example Code

use Libraries.Web.Page.WebPageHeader
        use Libraries.Web.Page.Base
        WebPageHeader header
        Base item
        header:Remove(item)

Parameters

Remove(Libraries.Web.Page.MetaData value)

This action removes the first instance of the meta data value found in the meta list.

Example Code

use Libraries.Web.Page.WebPageHeader
        use Libraries.Web.Page.MetaData
        WebPageHeader header
        MetaData item
        header:Remove(item)

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

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

SetTitleHeader(Libraries.Web.Page.Title title)

This action sets the title for the header. This field is required.

Example Code

use Libraries.Web.Page.WebPageHeader
        use Libraries.Web.Page.Title
        WebPageHeader header
        Title title
        header:SetTitleHeader(title)

Parameters

SetTitleHeaderValue(text value)

This action sets the text of the title in the header.

Example Code

use Libraries.Web.Page.WebPageHeader

        WebPageHeader header
        header:SetTitleHeaderValue("My Title")

Parameters