Class mozile

Object
   |
   +--mozile

class mozile

Field Detail

about

<static> Object about

Other Mozile information.

acknowledgements

<static> Object acknowledgements

alternateSpace

<static> String alternateSpace

Specify a non-breaking space character to be used throughout.

browser

<static> Object browser

Tools for dealing with the browser.

copyright

<static> Object copyright

credits

<static> Object credits

debug

<static> Object debug

Tools for debugging Mozile.

defaultNS

<static> String defaultNS

The default namespace is null. This means that the document's namespace is always used, which will usually be HTML.

deferrals

<static> Array deferrals

An array of modules which have been required but had loading deferred.

deferRequirements

<static> Boolean deferRequirements

Indicates whether module requirements should be deferred until mozile.loadDeferred() is called. Used when Mozile is precompiled. This is set automatically by Mozile's build tools.

document

<static> Object document

dom

<static> Object dom

A collection of DOM classes and methods.

edit

<static> Object edit

Editing tools.

emptyToken

<static> String emptyToken

The empty token is used when there is a text node which is only a place-holder inside an empty element. By default it is a non-breaking space character.

enhance

<static> Object enhance

Mozilla enhancement tools.

event

<static> Object event

Tools for dealing with browser events.

filesep

<static> Object filesep

gui

<static> Object gui

Tools for displaying a graphical user interface.

help

<static> String help

When true, designMode will be used by Mozile in browsers that support it. When false designMode will not be changed.

homepage

<static> Object homepage

license

<static> Object license

linesep

<static> Object linesep

locale

<static> Object locale

os

<static> Object os

Tools for dealing with the operating system.

precompiled

<static> Boolean precompiled

Indicates whether Mozile has been "compiled" into a single file. This is set automatically by Mozile's build tools.

rng

<static> Object rng

Tools for parsing RelaxNG schemas and validating XML documents.

root

<static> Object root

save

<static> Object save

Tools for saving Mozile results.

updateInterval

<static> Integer updateInterval

The default update interval in milliseconds.

useDesignMode

<static> Boolean useDesignMode

When true, designMode will be used by Mozile in browsers that support it. When false designMode will not be changed.

util

<static> Object util

A collection of utility functions.

version

<static> Object version

Set the version number.

window

<static> Object window

xml

<static> Object xml

A collection of XML functions.

xpath

<static> Object xpath

A collection of XPath functions.

_nullFunction

<static> Object _nullFunction()

alert

<static> Void alert(<String> message)

Informs the user about a problem. The method used to inform the user varies by what

Parameters:
message -

dumpError

<static> String dumpError(object)

Dumps information from error objects. Internet Explorer needs special attention.

Parameters:
object - The error object or object that the error is attached to.

editDocument

<static> Void editDocument(<Document> doc)

Makes the whole document editable.

Parameters:
doc - Optional. The document to make editable. Defaults to the current document.

editElement

<static> Void editElement(elementOrId)

Makes a single element editable.

Parameters:
elementOrId - Either a DOM element or the id of an element.

editElements

<static> Void editElements(listOrValue, name)

Makes a set of elements editable.

Parameters:
listOrValue - Either an array (or nodeList) of DOM elements or the value of an attribute (defaults to the "class" attribute).
attribute - Optional. The name of an attribute to search for. Defaults to "class". If the value is "local name" then the local name of the element is used (lowercase).

enableEditing

<static> Void enableEditing(<Boolean> rich)

Makes all text nodes inside editable elements editable by adding default commands to mozile.edit.

Parameters:
rich - Optional. When true rich editing commands are included.

execCommand

<static> mozile.edit.State execCommand(<String> name, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)

Executes the named command with the given arguments.

Parameters:
name - The name of the command to be executed
a - * Other optional arguments, which will be sent to the prepare() method.

findModule

<static> Object findModule(<String> moduleName)

Finds an object in the "mozile" hierarchy, if it exists. Given a name of the format "mozile.foo.bar", it starts with the global "window" object and checks for the presence of a "mozile" property. Then it checks the "mozile" object for a "foo" property, and so on.

Parameters:
moduleName - A module name of the form "mozile.foo" or "mozile.foo.Bar".

findRoot

<static> String findRoot()

Searches for a script tag with src like "mozile.js". Returns the path leading to "mozile.js".

getAbsolutePath

<static> String getAbsolutePath(<String> path, <String> root)

Ensures that a path is absolute. Appends the path to the root if it is not absolute.

Parameters:
path - The path to convert.
root - An absolute root URL. If none is given the document location is used.

getDirectory

<static> String getDirectory(<String> path)

Gets a directory from a path. Be careful, because this method isn't very smart. TODO: Handle Windows paths.

Parameters:
path - The path to use.

getLocalization

<static> Object getLocalization(<String> moduleName, bundleName, <String> locale)

Loads a localization object for the given module, bundle, and locale.

Parameters:
moduleName - The name of the module to find the localization in.
locale - Optional. The locale to use. Defaults to mozile.locale.
bindleName - The particular localization file to use.

getPath

<static> String getPath(<String> url)

Strips non-path information from a URL.

Parameters:
url - The URL to strip.

isPathAbsolute

<static> Boolean isPathAbsolute(<String> path)

Determines whether a path is absolute.

Parameters:
path - The path to check.

joinPaths

<static> String joinPaths()

Concatenates any number of strings using the mozile.filesep character.

Parameters:
path - Paths to join. Accepts any number of string arguments.

load

<static> String load(<String> uri)

A cross-browser compatible loading method. Uses XMLHttpRequest to get the text content of a file.

Parameters:
uri - The URI of the file to be loaded.

loadDeferred

<static> Void loadDeferred()

Uses require() to load each module on the deferrals list. Clears the list.

loadModule

<static> Boolean loadModule(<String> moduleName)

Tries to load a module of code. The method first tries to load the file "$ROOT/src/foo/bar.js". If that fails, it tries to load "$ROOT/src/foo.js".

When a file is successfully loaded it is then evaluated using eval(). Note that it is evaluated in the context of this function, which will cause problems for any variables in the file which are declared outside the "mozile" hierarchy.

Parameters:
moduleName - A module name of the form "mozile.foo" or "mozile.foo.Bar".

prompt

<static> String prompt(title, message, value, fn, scope, multiline)

Ensures that a path is absolute. Appends the path to the root if it is not absolute.

Parameters:
path - The path to convert.
root - An absolute root URL. If none is given the document location is used.

protectElement

<static> Boolean protectElement(elementOrId)

Prevents a single element from editing.

Parameters:
elementOrId - Either a DOM element or the id of an element.

protectElements

<static> Void protectElements(listOrValue, name)

Protects a set of elements from editing.

Parameters:
listOrValue - Either an array (or nodeList) of DOM elements or the value of an attribute (defaults to the "class" attribute).
attribute - Optional. The name of an attribute to search for. Defaults to "class". If the value is "local name" then the local name of the element is used (lowercase).

provide

<static> Void provide()

This function is used by modules to indicate what properties, methods, and classes they provide. Currently the function does nothing, but its use it still required for all modules.

require

<static> Boolean require(<String> moduleName)

Loads a module if it has not already been loaded. This method is used by modules to indicate that they require the support of another module.

Parameters:
moduleName - A module name of the form "mozile.foo" or "mozile.foo.Bar".

setTarget

<static> Void setTarget(win)

Sets the moziel.window and mozile.document propeties based on a given window object.

useSchema

<static> Boolean useSchema(<String> target, localeBundle)

Load the target RNG schema and use it as the schema for this document.

Parameters:
target - The desired schema. Can be any value accepted by mozile.rng.Schema.parse().
localeBund - Optional. The name of the localization bundle to use. If none is given, the method uses a name based on the target.

Returns:
True if the schema is found and parsed correctly.