Class GLOBALS

Object
   |
   +--GLOBALS

class GLOBALS

base64ToString

<static> string base64ToString(<string> encStr)

decode a string of Base64 to normal text See this site for the method usede: http://www.faqts.com/knowledge_base/view.phtml/aid/1748

Parameters:
encStr - the Base64 encoded text

Returns:
decocded text

checkRemoteFileLength

<static> int checkRemoteFileLength( url )

Trys to determine the length of a remote file using an HTTP "HEAD" request.

Parameters:
URL - the URL of the file to check

Returns:
length of the file or null if an error occurs

downloadWithManager

<static> void downloadWithManager( <string> sourceUri, <File> targetFile, <boolean> suppress )

Download a file using the "Download Manager" to allow the user to monitor progress.

Parameters:
sourceUri - - string uri (NOT nsURI) of file or page to save
targetFile - - File object or nsIFile to save to. should be writable by user
suppress - - whether to suppress the download manager window from opening

geid

<static> DOMElement geid( <string> id )

does the equivelent of document.getElementById( id )

Parameters:
id - The id of the DOM element to get

Returns:
the DOM element

getFilepathFromURL

<static> string getFilepathFromURL( <string> url )

Return a proper platform specific filepath from a "file://" url.

Parameters:
url - the file URL (usuall generated form rdf:files)

Returns:
native filepath

getGemstonePref

<static> Object getGemstonePref( <string> pref )

Provides access to Gemstone's user and internal preferences

Parameters:
pref - preference to obtain

Returns:
string, bool, or int value of the preference

getTempDir

<static> File getTempDir( <string> name, <int> permissions )

create a dir for temporary use

Parameters:
name - - an additional identifier
permissions - - unix style permissions to give to the dir

getTempFile

<static> File getTempFile( <string> name, <int> permissions )

create a file for temporary use on a mac the file is created in Library/Cache/

Parameters:
name - - an additional identifier
permissions - - unix style permissions to give to the file

openExternalURI

<static> void openExternalURI(<string> aPath)

last resort for opening an unknown file/directory on the system.

Parameters:
aPath - should be a string file url

paramErrorCheck

<static> Object paramErrorCheck( <string> mode, <string> paramName, <array> paramArray, msg, custom)

Check whether various given parameters are NOT valid. Will exit and return a message upon the first error found.

Parameters:
mode - -any/some of the following: NULL_BLANK check to make sure parameters are not null or "". NUMBER make sure parameters do not include any numbers. WORD make sure parameters do not include any characters. SPACE make sure parameters do not include any whitespace. CUSTOM check params using a custom regexp
paramName - - the name of the parameter we're checking
paramArray - - Array of paramters to check
msg - - [optional] an additional message to include
custom - - [optional] a custom regular expression to check for. Must set mode to CUSTOM as well. msg should also be set to provide an explanation of the possilbe error.

Returns:
null if no errors have been found. Otherwise a String containing paramName, type of error, offending value, optional message, is returned

readByteArray

<static> array readByteArray( content, <string> mode )

return file contents as an array of bytes

Parameters:
mode - "file": interpret "content" as a file path and convert the file. "string" treat "content" as plain text
text - or a filepath

saveLocalFile

<static> void saveLocalFile( <string> path, <string> text, replace )

Save text to a file

Parameters:
path - the location of where to create the file
text - text to save TODO: action: append/write mode: binary/string

setGemstoneBoolPref

<static> void setGemstoneBoolPref( <string> pref, <boolean> value )

Sets a boolean preference

Parameters:
pref - name of the preference to set
value - the boolean value to set

setGemstoneIntPref

<static> void setGemstoneIntPref( <string> pref, <int> value )

Sets an integer preference

Parameters:
pref - name of the preference to set
value - the integer value to set

setGemstoneStringPref

<static> void setGemstoneStringPref( <string> pref, <string> value )

Sets a string preference

Parameters:
pref - name of the preference to set
value - the string value to set

showFilePicker

<static> Object showFilePicker( <string> aMode, <string> aTitle, <array> filters, <string> aDefaultName, <nsILocalFile> aDefaultDir )

display a filepicker and return the selection does not catch exceptions, caller is responsible.

Parameters:
aMode - String, specifying the mode to open filepicker in: open, save, etc as defined here http://www.xulplanet.com/references/xpcomref/ifaces/nsIFilePicker.html
aTitle - title string of the dialog (optional)
filters - array, strings each of which specifies a content filter to append (optional)
aDefaultName - default filename to display. Only useful for save mode (optional)
aDefaultDir - nsILocalFile, default directory to display (optional)

Returns:
an object containing the nsIFile, fileURL and filepath of the file chosen. Or, if modeOpenMultiple was used, an Array of filepaths is returned.

simplePrompt

<static> string simplePrompt( <string> msg, <string> initial )

Prompt the user for a simple string of info from the user

Parameters:
msg - the message to display
initial - text to pre-fill the textbox

Returns:
value entered by user

stringToBase64

<static> string stringToBase64( <string> aString )

convert a string of text to Base64

Parameters:
aString - string of text

Returns:
converted text

trace

<static> void trace( <string> msg )

logs an information-level message to the JavaScript/Error console. If hidden these messages can be seen by clicking the "Messages" icon in the console window.

Parameters:
msg - the text message to log

xPathSearch

<static> array xPathSearch(<DOM> aXmlDoc, <string> aXpath)

do an xPath search on a document

Parameters:
aXmlDoc - the DOM document to search in
aXpath - xPath query

Returns:
nodes found