JavaScript API Reference for Oracle ADF Faces

oracle.adfinternal.view.js.bootstrap
Class goog

org.ecmascript.object.Object
   |
   +--oracle.adfinternal.view.js.bootstrap.goog

protected class goog
extends Object

basePath

public static {string} basePath

Path for included scripts

DEBUG

public static Object DEBUG

dependencies_

private static {Object} dependencies_

This object is used to keep track of dependencies and other data that is used for loading scripts

evalWorksForGlobals_

private static {?boolean} evalWorksForGlobals_

Indicates whether or not we can call 'eval' directly to eval code in the global scope. Set to a Boolean by the first call to goog.globalEval (which empirically tests whether eval works for globals).

See also:

"goog.globalEval"

getHashCode

public static Object getHashCode

Adds a hash code field to an object. The hash code is unique for the given object.

Deprecated: Use goog.getUid instead.

global

public static Object global

Reference to the global context. In most cases this will be 'window'.

implicitNamespaces_

private static {Object} implicitNamespaces_

Namespaces implicitly defined by goog.provide. For example, goog.provide('goog.events.Event') implicitly declares that 'goog' and 'goog.events' must be namespaces.

included_

private static {Object} included_

Object used to keep track of urls that have already been added. This record allows the prevention of circular dependencies.

LOCALE

public static Object LOCALE

now

public static Object now

removeHashCode

public static Object removeHashCode

Removes the hash code field from an object.

Deprecated: Use goog.removeUid instead.

typedef

public static {Array|NodeList} / goog.ArrayLike = goog.typedef; will tell JSCompiler to replace all appearances of goog.ArrayLike in type definitions with the union of Array and NodeList. Does nothing in uncompiled code. typedef

A macro for defining composite types. By assigning goog.typedef to a name, this tells JSCompiler that this is not the name of a class, but rather it's the name of a composite type. For example, /**

Deprecated: Please use the {@code

UID_PROPERTY_

private static {string} UID_PROPERTY_

Name for unique ID property. Initialized in a way to help avoid collisions with other closure javascript on the same page.

uidCounter_

private static {number} uidCounter_

Counter for UID.

goog

public goog()

abstractMethod

public static Object abstractMethod()

When defining a class Foo with an abstract method bar(), you can do: Foo.prototype.bar = goog.abstractMethod Now if a subclass of Foo fails to override bar(), an error will be thrown when bar() is invoked. Note: This does not take the name of the function to override as an argument because that would make it more difficult to obfuscate our JavaScript code.

Return:

Object

Throws:

"when" invoked to indicate the method should be overridden.

addDependency

public static Object addDependency(string relPath,
                                   Array provides,
                                   Array requires)

Adds a dependency from a file to the files it requires.

Parameters:

relPath	-	The path to the js file.
provides	-	An array of strings with the names of the objects this file provides.
requires	-	An array of strings with the names of the objects this file requires.

Return:

Object

addSingletonGetter

public static Object addSingletonGetter(!Function ctor)

Adds a {@code getInstance} static method that always return the same instance object.

Parameters:

ctor

-

The constructor for the class to add the static method to.

Return:

Object

base

public static * base(!Object me,
                     *= opt_methodName,
                     ...* var_args)

Call up to the superclass. If this is called from a constructor, then this calls the superclass contructor with arguments 1-N. If this is called from a prototype method, then you must pass the name of the method as the second argument to this function. If you do not, you will get a runtime error. This calls the superclass' method with arguments 2-N. This function only works if you use goog.inherits to express inheritance relationships between your classes. This function is a compiler primitive. At compile-time, the compiler will do macro expansion to remove a lot of the extra overhead that this function introduces. The compiler will also enforce a lot of the assumptions that this function makes, and treat it as a compiler error if you break them.

Parameters:

me	-	Should always be "this".
opt_methodName	-	The method name if calling a super method.
var_args	-	The rest of the arguments.

Return:

* - The return value of the superclass method.

bind

public static !Function bind(Function fn,
                             Object|undefined selfObj,
                             ...* var_args)

Partially applies this function to a particular 'this object' and zero or more arguments. The result is a new function with some arguments of the first function pre-filled and the value of |this| 'pre-specified'.

Remaining arguments specified at call-time are appended to the pre- specified ones.

Also see: partial(Function, ...*).

Usage:

var barMethBound = bind(myFunction, myObj, 'arg1', 'arg2');
barMethBound('arg3', 'arg4');

Parameters:

fn	-	A function to partially apply.
selfObj	-	Specifies the object which |this| should point to when the function is run. If the value is null or undefined, it will default to the global object.
var_args	-	Additional arguments that are partially applied to the function.

Return:

!Function - A partially-applied form of the function bind() was invoked as a method of.

bindJs_

private static !Function bindJs_(Function fn,
                                 Object|undefined selfObj,
                                 ...* var_args)

A pure-JS implementation of goog.bind.

Parameters:

fn	-	A function to partially apply.
selfObj	-	Specifies the object which |this| should point to when the function is run. If the value is null or undefined, it will default to the global object.
var_args	-	Additional arguments that are partially applied to the function.

Return:

!Function - A partially-applied form of the function bind() was invoked as a method of.

bindNative_

private static !Function bindNative_(Function fn,
                                     Object|undefined selfObj,
                                     ...* var_args)

A native implementation of goog.bind.

Parameters:

fn	-	A function to partially apply.
selfObj	-	Specifies the object which |this| should point to when the function is run. If the value is null or undefined, it will default to the global object.
var_args	-	Additional arguments that are partially applied to the function.

Return:

!Function - A partially-applied form of the function bind() was invoked as a method of.

cloneObject

public static * cloneObject(* obj)

Clones a value. The input may be an Object, Array, or basic type. Objects and arrays will be cloned recursively. WARNINGS: goog.cloneObject does not detect reference loops. Objects that refer to themselves will cause infinite recursion. goog.cloneObject is unaware of unique identifiers, and copies UIDs created by getUid into cloned results.

Deprecated: goog.cloneObject is unsafe. Prefer the goog.object methods.

Parameters:

obj

-

The value to clone.

Return:

* - A clone of the input value.

exportPath_

private static Object exportPath_(string name,
                                  *= opt_object,
                                  Object= opt_objectToExportTo)

Builds an object structure for the provided namespace path, ensuring that names that already exist are not overwritten. For example: "a.b.c" -> a = {};a.b={};a.b.c={}; Used by goog.provide and goog.exportSymbol.

Parameters:

name	-	name of the object that this file defines.
opt_object	-	the object to expose at the end of the path.
opt_objectToExportTo	-	The object to add the path to; default is |goog.global|.

Return:

Object

exportProperty

public static Object exportProperty(Object object,
                                    string publicName,
                                    * symbol)

Exports a property unobfuscated into the object's namespace. ex. goog.exportProperty(Foo, 'staticFunction', Foo.staticFunction); ex. goog.exportProperty(Foo.prototype, 'myMethod', Foo.prototype.myMethod);

Parameters:

object	-	Object whose static property is being exported.
publicName	-	Unobfuscated name to export.
symbol	-	Object the name should point to.

Return:

Object

exportSymbol

public static Object exportSymbol(string publicPath,
                                  * object,
                                  Object= opt_objectToExportTo)

Exposes an unobfuscated global namespace path for the given object. Note that fields of the exported object *will* be obfuscated, unless they are exported in turn via this function or goog.exportProperty

Also handy for making public items that are defined in anonymous closures. ex. goog.exportSymbol('Foo', Foo); ex. goog.exportSymbol('public.path.Foo.staticFunction', Foo.staticFunction); public.path.Foo.staticFunction(); ex. goog.exportSymbol('public.path.Foo.prototype.myMethod', Foo.prototype.myMethod); new public.path.Foo().myMethod();

Parameters:

publicPath	-	Unobfuscated name to export.
object	-	Object the name should point to.
opt_objectToExportTo	-	The object to add the path to; default is |goog.global|.

Return:

Object

findBasePath_

private static Object findBasePath_()

Tries to detect the base path of the base.js script that bootstraps Closure

Return:

Object

getCssName

public static string getCssName(string className,
                                string= opt_modifier)

Handles strings that are intended to be used as CSS class names. This function works in tandem with

Parameters:

className	-	The class name.
opt_modifier	-	A modifier to be appended to the class name.

Return:

string - The class name or the concatenation of the class name and the modifier.

See also:

"goog.setCssNameMapping. Without any mapping set, the arguments are simple joined with a hyphen and passed through unaltered. When there is a mapping, there are two possible styles in which these mappings are used. In the BY_PART style, each part (i.e. in between hyphens) of the passed in css name is rewritten according to the map. In the BY_WHOLE style, the full css name is looked up in the map directly. If a rewrite is not specified by the map, the compiler will output a warning. When the mapping is passed to the compiler, it will replace calls to goog.getCssName with the strings from the mapping, e.g. var x = goog.getCssName('foo'); var y = goog.getCssName(this.baseClass, 'active'); becomes: var x= 'foo'; var y = this.baseClass + '-active'; If one argument is passed it will be processed, if two are passed only the modifier will be processed, as it is assumed the first argument was generated as a result of calling goog.getCssName."

getMsg

public static string getMsg(string str,
                            Object= opt_values)

Abstract implementation of goog.getMsg for use with localized messages.

Parameters:

str	-	Translatable string, places holders in the form {$foo}.
opt_values	-	Map of place holder name to value.

Return:

string - message with placeholders filled.

getObjectByName

public static Object getObjectByName(string name,
                                     Object= opt_obj)

Returns an object based on its fully qualified external name. If you are using a compilation pass that renames property names beware that using this function will not find renamed properties.

Parameters:

name	-	The fully qualified name.
opt_obj	-	The object within which to look; default is |goog.global|.

Return:

Object - The object or, if not found, null.

getPathFromDeps_

private static ?string getPathFromDeps_(string rule)

Looks at the dependency rules and tries to determine the script file that fulfills a particular rule.

Parameters:

rule

-

In the form goog.namespace.Class or project.script.

Return:

?string - Url corresponding to the rule, or null.

getUid

public static number getUid(Object obj)

Gets a unique ID for an object. This mutates the object so that further calls with the same object as a parameter returns the same value. The unique ID is guaranteed to be unique across the current session amongst objects that are passed into {@code getUid}. There is no guarantee that the ID is unique or consistent across sessions. It is unsafe to generate unique ID for function prototypes.

Parameters:

obj

-

The object to get the unique ID for.

Return:

number - The unique ID for the object.

globalEval

public static Object globalEval(string script)

Evals javascript in the global scope. In IE this uses execScript, other browsers use goog.global.eval. If goog.global.eval does not evaluate in the global scope (for example, in Safari), appends a script tag instead. Throws an exception if neither execScript or eval is defined.

Parameters:

script

-

JavaScript string.

Return:

Object

globalize

public static Object globalize(Object obj,
                               Object= opt_global)

Globalizes a whole namespace, such as goog or goog.lang.

Deprecated: Properties may be explicitly exported to the global scope, but this should no longer be done in bulk.

Parameters:

obj	-	The namespace to globalize.
opt_global	-	The object to add the properties to.

Return:

Object

identityFunction

public static * identityFunction(...* var_args)

The identity function. Returns its first argument.

Deprecated: Use goog.functions.identity instead.

Parameters:

var_args

-

The arguments of the function.

Return:

* - The first argument.

importScript_

private static Object importScript_(string src)

Imports a script if, and only if, that script hasn't already been imported. (Must be called at execution time)

Parameters:

src

-

Script source.

Return:

Object

inherits

public static Object inherits(Function childCtor,
                              Function parentCtor)

Inherit the prototype methods from one constructor into another. Usage:

function ParentClass(a, b) { }
ParentClass.prototype.foo = function(a) { }
function ChildClass(a, b, c) {
ParentClass.call(this, a, b);
}
goog.inherits(ChildClass, ParentClass);
var child = new ChildClass('a', 'b', 'see');
child.foo(); // works

In addition, a superclass' implementation of a method can be invoked as follows:

ChildClass.prototype.foo = function(a) {
ChildClass.superClass_.foo.call(this, a);
// other code
};

Parameters:

childCtor	-	Child class.
parentCtor	-	Parent class.

Return:

Object

inHtmlDocument_

private static boolean inHtmlDocument_()

Tries to detect whether is in the context of an HTML document.

Return:

boolean - True if it looks like HTML document.

isArray

public static boolean isArray(* val)

Returns true if the specified value is an array

Parameters:

val

-

Variable to test.

Return:

boolean - Whether variable is an array.

isArrayLike

public static boolean isArrayLike(* val)

Returns true if the object looks like an array. To qualify as array like the value needs to be either a NodeList or an object with a Number length property.

Parameters:

val

-

Variable to test.

Return:

boolean - Whether variable is an array.

isBoolean

public static boolean isBoolean(* val)

Returns true if the specified value is a boolean

Parameters:

val

-

Variable to test.

Return:

boolean - Whether variable is boolean.

isDateLike

public static boolean isDateLike(* val)

Returns true if the object looks like a Date. To qualify as Date-like the value needs to be an object and have a getFullYear() function.

Parameters:

val

-

Variable to test.

Return:

boolean - Whether variable is a like a Date.

isDef

public static boolean isDef(* val)

Returns true if the specified value is not |undefined|. WARNING: Do not use this to test if an object has a property. Use the in operator instead. Additionally, this function assumes that the global undefined variable has not been redefined.

Parameters:

val

-

Variable to test.

Return:

boolean - Whether variable is defined.

isDefAndNotNull

public static boolean isDefAndNotNull(* val)

Returns true if the specified value is defined and not null

Parameters:

val

-

Variable to test.

Return:

boolean - Whether variable is defined and not null.

isFunction

public static boolean isFunction(* val)

Returns true if the specified value is a function

Parameters:

val

-

Variable to test.

Return:

boolean - Whether variable is a function.

isNull

public static boolean isNull(* val)

Returns true if the specified value is |null|

Parameters:

val

-

Variable to test.

Return:

boolean - Whether variable is null.

isNumber

public static boolean isNumber(* val)

Returns true if the specified value is a number

Parameters:

val

-

Variable to test.

Return:

boolean - Whether variable is a number.

isObject

public static boolean isObject(* val)

Returns true if the specified value is an object. This includes arrays and functions.

Parameters:

val

-

Variable to test.

Return:

boolean - Whether variable is an object.

isString

public static boolean isString(* val)

Returns true if the specified value is a string

Parameters:

val

-

Variable to test.

Return:

boolean - Whether variable is a string.

mixin

public static Object mixin(Object target,
                           Object source)

Copies all the members of a source object to a target object. This method does not work on all browsers for all objects that contain keys such as toString or hasOwnProperty. Use goog.object.extend for this purpose.

Parameters:

target	-	Target.
source	-	Source.

Return:

Object

nullFunction

public static void nullFunction()

Null function used for default values of callbacks, etc.

Return:

void - Nothing .

partial

public static !Function partial(Function fn,
                                ...* var_args)

Like bind(), except that a 'this object' is not required. Useful when the target function is already bound. Usage: var g = partial(f, arg1, arg2); g(arg3, arg4);

Parameters:

fn	-	A function to partially apply.
var_args	-	Additional arguments that are partially applied to fn.

Return:

!Function - A partially-applied form of the function bind() was invoked as a method of.

propertyIsEnumerable_

private static boolean propertyIsEnumerable_(Object object,
                                             string propName)

Safe way to test whether a property is enumarable. It allows testing for enumerable on objects where 'propertyIsEnumerable' is overridden or does not exist (like DOM nodes in IE).

Parameters:

object	-	The object to test if the property is enumerable.
propName	-	The property name to check for.

Return:

boolean - True if the property is enumarable.

propertyIsEnumerableCustom_

private static boolean propertyIsEnumerableCustom_(Object object,
                                                   string propName)

Safe way to test whether a property is enumarable. It allows testing for enumerable on objects where 'propertyIsEnumerable' is overridden or does not exist (like DOM nodes in IE). Does not use browser native Object.propertyIsEnumerable.

Parameters:

object	-	The object to test if the property is enumerable.
propName	-	The property name to check for.

Return:

boolean - True if the property is enumarable.

provide

public static Object provide(string name)

Creates object stubs for a namespace. When present in a file, goog.provide also indicates that the file defines the indicated object. Calls to goog.provide are resolved by the compiler if --closure_pass is set.

Parameters:

name

-

name of the object that this file defines.

Return:

Object

removeUid

public static Object removeUid(Object obj)

Removes the unique ID from an object. This is useful if the object was previously mutated using {@code goog.getUid} in which case the mutation is undone.

Parameters:

obj

-

The object to remove the unique ID field from.

Return:

Object

require

public static Object require(string rule)

Implements a system for the dynamic resolution of dependencies that works in parallel with the BUILD system. Note that all calls to goog.require will be stripped by the JSCompiler when the --closure_pass option is used.

Parameters:

rule

-

Rule to include, in the form goog.package.part.

Return:

Object

scope

public static Object scope(function() fn)

Allow for aliasing within scope functions. This function exists for uncompiled code - in compiled code the calls will be inlined and the aliases applied. In uncompiled code the function is simply run since the aliases as written are valid JavaScript.

Parameters:

fn

-

Function to call. This function can contain aliases to namespaces (e.g. "var dom = goog.dom") or classes (e.g. "var Timer = goog.Timer").

Return:

Object

setCssNameMapping

public static Object setCssNameMapping(!Object mapping,
                                       string= style)

Sets the map to check when returning a value from goog.getCssName(). Example:

goog.setCssNameMapping({
"goog": "a",
"disabled": "b",
});
var x = goog.getCssName('goog');
// The following evaluates to: "a a-b".
goog.getCssName('goog') + ' ' + goog.getCssName(x, 'disabled')

When declared as a map of string literals to string literals, the JSCompiler will replace all calls to goog.getCssName() using the supplied map if the --closure_pass flag is set.

Parameters:

mapping	-	A map of strings to strings where keys are possible arguments to goog.getCssName() and values are the corresponding values that should be returned.
style	-	The style of css name mapping. There are two valid options: 'BY_PART', and 'BY_WHOLE'.

Return:

Object

See also:

"goog.getCssName for a description."

setTestOnly

public static Object setTestOnly(string= opt_message)

Marks that the current file should only be used for testing, and never for live code in production.

Parameters:

opt_message

-

Optional message to add to the error that's raised when used in production code.

Return:

Object

typeOf

public static string typeOf(* value)

This is a "fixed" version of the typeof operator. It differs from the typeof operator in such a way that null returns 'null' and arrays return 'array'.

Parameters:

value

-

The value to get the type of.

Return:

string - The name of the type.

writeScripts_

private static Object writeScripts_()

Resolves dependencies based on the dependencies added using addDependency and calls importScript_ in the correct order.

Return:

Object

writeScriptTag_

private static boolean writeScriptTag_(string src)

The default implementation of the import function. Writes a script tag to import the script.

Parameters:

src

-

The script source.

Return:

boolean - True if the script was imported, false otherwise.