Engine for Web Applications

version 1.9.6

Global utilities.

This class resides in the global namespace. This class participates in the engine library.

Index

Example Index

• Using a Package: Shows how to create and use a new package.
• VerifyPackage: Demonstrates how to verify if a package exists.

Object Index

• public DATATYPES (internal): Enumeration of object types.

Method Index

• public GetPackage: Creates an object hierarchy based on the supplied name.
• public Package: Creates an object hierarchy based on the supplied name.
• public ValidatePackage: Verifies the specified hierarchy exists.

Examples

Using a Package

• Top
• Examples

Shows how to create and use a new package.

Example Code

Package("MyCompany.Products.Widgets");
MyCompany.Products.Widgets.TheWidget = {
   this.CustomFunction = function(){
      /* ... */
   };
};
var MyWidget = new MyCompany.Products.Widgets.TheWidget();

VerifyPackage

• Top
• Examples

Demonstrates how to verify if a package exists.

Example Code

if( VerifyPackage("MyCompany.Products.Widgets") ){
   /* ... */
};

Objects

DATATYPES

• Top
• Objects

Enumeration of object types.

Properties

• TYPE_STRING as String: string
• TYPE_OBJECT as String: object
• TYPE_FUNCTION as String: function
• TYPE_UNDEFINED as String: undefined
• TYPE_NUMBER as String: number

Methods

GetPackage

• Top
• Methods

Creates an object hierarchy based on the supplied name.

Syntax

v = GetPackage( sPath )

Parameters

• sPath as String : Period-delimited hierarchy.

Returns

v as object: Returns the object corresponding to the specified hierarchy.

Package

• Top
• Methods

Creates an object hierarchy based on the supplied name.

Syntax

void Package( sPath )

Parameters

• sPath as String : Period-delimited hierarchy.

ValidatePackage

• Top
• Methods

Verifies the specified hierarchy exists.

Syntax

v = ValidatePackage( sPath, bObjOut )

Parameters

• sPath as String : Period-delimited hierarchy.
• bObjOut as boolean (optional): Bit indicating whether the matching object should be returned.

Returns

v as boolean: Returns true if the hierachy exists, or the matching object if bObjOut is set to true.