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
Actions | Description |
---|---|
Compare(Libraries.Language.Object object) | This action compares two object hash codes and returns an integer. |
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 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.
Example Code
Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)
Parameters
- Libraries.Language.Object: The object to compare to.
Return
integer: 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
- Libraries.Language.Object: The to be compared.
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.