Libraries.Web.Page.WebGenerator Documentation

The WebGenerator class contains a single blueprint action designed for generating web content. Essentially, it is a helper parent class that any related class will need to implement. The examples used in this document show an example of using this blueprint in the WebPage class.

Example Code

use Libraries.Web.Page.WebPage

//by default, this would output a blank web page
WebPage page
output page:Generate()

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
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()Generate method converts web page information into raw text that can be sent to a web server or otherwise printed out.
GetHashCode()This action gets the hash code for an object.

Actions Documentation

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

Generate method converts web page information into raw text that can be sent to a web server or otherwise printed out.

Example Code

use Libraries.Web.Page.WebPage

    //by default, this would output a blank web page
    WebPage page
    output page:Generate()

Return

text: A text representation of the item being generated.

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.