Built-In Namespace _global_

Method Summary
Method Attributes	Method Name and Description
	$ac(p, c, b) Append Child.
	$anchor(u) Get the anchor / hash value from a URL.
	$asort(a, c) Sort an array
	$buildControl(l, c) Builds a new control - this function allows for the dynamic addition of a control rather than using the HTML approach.
	$c(t, cn, id) Create element.
	$cc(e) Character Code.
	$ci(id) Pseudonym for JavaScript function clearInterval
	$cl(l, n) Get / Set className attribute.
	$cmom(f, o, x) Copy Matching Object Members.
	$cn(l) Get child nodes of the elements
	$cookie(n, v, d) Get / Set the cookie value
	$cookie_delete(n) Removes a cookie for the browser.
	$css(n, ci, si) Return one or more style object from a loaded stylesheet that match the defined name.
	$cssvalue(n, a, ci, si) Returns the value of the specified style attribute from the matching style rules.
	$ct(id) Pseudonym for JavaScript function clearTimeout
	$ctn(t) Create Text Node.
	$d(l) Destroy (delete) node.
	$datediff(id) Pseudonym for SS.datetime.difference.
	$dbd() Returns the dimensions for the document.
	$dbsl() Document body scroll left
	$dbst() Document body scroll top
	$dc(l) Destroys all childNodes of the specified element.
	$debug(o, f) Inspect the object and output to console.
	$debugclear() Clears the contents of the debug console
	$destroyControl(id) Descroys an existing control.
	$dw(s) Document Write.
	$e(e) Get the event in a cross browser supported way.
	$ea() Pseudonym for SS.events.add.
	$ec(e) Event Cancel.
	$eehadd(l, v, f) Element Event Handler Add.
	$eehcalled(l, e) Element Event Handler - called.
	$eehclear(e, v) Element Event Handler - Clear.
	$ef(f, c, e) Execute function against a control and event
	$erid() Pseudonym for SS.events.removeById.
	$error(m, l, o) Catches an exception and outputs it to the debug window if debugging is defined.
	$esc(s) Encode text as URI.
	$eschtml(s) Encode text to HTML format.
	$ev(s) Evaluate String.
	$fromHexColor(v) Takes an hexadecimal colour string and converts it to its {Integer} equivalent.
	$g(id) Get Element By Id.
	$ga(l, a) Get attribute
	$gc(id) Get Control.
	$gd(l, t, a) Get Descendants.
	$gg(g) Gets elements where the groupname attribute matches the sought after groupname (n).
	$ggv(n) Returns the values of elements which have been assigned a groupname.
	$gt(n) Get elements by tag name.
	$h(l, h) Get / set height of an element.
	$hcn(l) Has Child Nodes
	$headd(l, ft) Add element of intrest for future use e.g.
	$il(l, v, d) In List.
	$iln(l, v, d) In List No Case.
	$input(q, t, f, v, l) Capture input from the user ask question capture answer match input dependent upon type e.g.
	$isa(o) Is Array.
	$isb(o) Is Boolean.
	$isd(o) Is Defined.
	$isdc(r, c) Is Descendent Child Element.
	$ise(o) Is Empty.
	$isf(o) Is Function.
	$isIE() Is the browser Internet Explorer.
	$isIElt7() Is the browser Internet Explorer and less than version 7.
	$isn(o) Is Number.
	$iso(o) Is Object.
	$iss(o) Is String.
	$isu(o) Is Undefined.
	$keys(o) Returns all of the keys in the object (excluding function keys)
	$l(l, p) Get / Set the x-axis position of an element.
	$lc(s) To lower Case.
	$lg2() Get the current user language (2 character code value)
	$ln(l) Length.
	$load(url, param, onload, onerror, ontimeout, timeout, nocache, loadId, loadImageId, title, type) Requests are URI source using the XMLHTTPRequest object.
	$max(n1, n2) Maximum of two numbers.
	$min(n1, n2) Minimum of two numbers.
	$msgbox(s, b, evc, t) Display the message box
	$n(id) Number.
	$nid() Next Id.
	$o2x(o, rt, ns, f) Converts a JavaScript object into an XML document.
	$op(l, v) Opacity.
	$pn(l) Get Parent Node
	$popup(u, ti, dw, dh, oc, id, fid) Display Popup window - (window with iframe inside)
	$popupClose(id) Close a Popup window - (window with iframe inside)
	$psb(v) Parse String to Boolean.
	$rand(m) Random number.
	$rc(p, c) Remove Child.
	$reverse(s) Reverse String.
	$rnd(p) Round number.
	$rp(l) Remove from Parent.
	$ruid() Random unique identifier.
	$sa(l, a, v) Set attribute
	$si(callFunction, interval) Pseudonym for JavaScript function setInterval
	$st(callFunction, interval) Pseudonym for JavaScript function setTimeout
	$stopwatch() Pseudonym for SS.debug.console.
	$submit(f) Submits only a specific form.
	$sxyz(l, p) Sets Element Position.
	$t(l, p) Get / set the y-axis position of an element.
	$ta(o) To Array.
	$tb(v) To Boolean.
	$toHexColor(v) Takes an integer parameter and converts it to a 6 digit hexadecmial string
	$trim(s) Trim.
	$ts(s) To String.
	$uc(s) To UPPER case.
	$uesc(s) Decode URI text.
	$up(p, u) Get URL parameter value.
	$upa(u, p, v) URL Parameter Append.
	$v(l, v, s) Set Element Visibility.
	$validate(g) Validate fields.
	$w(l, w) Get / set width of an element.
	$x(l, p) Get / Set the x-axis position of an element.
	$x2o(x) Converts an XML document into a JavaScript object
	$xload(xml, xsl, param, onload, onerror, ontimeout, timeout, nocache, element, loadImageId, loadId, title) Asynchronously loads data from an XML datasource and applies the specified XSLT transformation template.
	$xyz(l) Element Position.
	$y(l, p) Get / set the y-axis position of an element.
	$z() Get / set z-Index.
	hf(e)
	hfc(e)

Method Detail

$ac(p, c, b)

Append Child. Attaches the element to its parent.
Defined in: SS.core.js.

Parameters:
{Node} p: Parent node to attach the element to
{Node} c: Element to attach
{Node} b: Insert Before This Node (optional) - since v1.0.7.20090731

Returns:: null

{String} $anchor(u)

Get the anchor / hash value from a URL. E.g. "www.spiderscript.net/index.htm#abc" would return "abc".
Defined in: SS.core.js.

Parameters:
{String} u: (Optional) URL to get the parameter from. Default = window.location.href

Since:: v1.0.7.20090731

Returns:: {String} Value of the URL parameter

{Array} $asort(a, c)

Sort an array
Defined in: SS.core.js.

Parameters:
{Array} a: Array to be sorted
{Array} c: Sort criteria e.g. [{member,direction}] where direction:{1:ascending,2:descending}

Returns:: {Array} Sorted array

{SS.control.Object} $buildControl(l, c)

Builds a new control - this function allows for the dynamic addition of a control rather than using the HTML approach.
Defined in: SS.init.js.

Parameters:
{HTMLElement} l: Element to attach the control to (l)
{String} c: control name e.g. "window"

Returns:: {SS.control.Object} Returns the instantiated control built from the element passed in (l).

{Node} $c(t, cn, id)

Create element. Creates and element for use in the DOM.
Defined in: SS.core.js.

Parameters:
{String} t: Type of node to create e.g. INPUT, DIV, LABEL ... or override with {Object} t {tagName : {String}, className : {String}, id : {String}}
{String} cn: Class name to assign to the element
{String} id: Identifier to assign to the element. Default = next available Id. See $nid

Returns:: {Node} Created element.

{Integer} $cc(e)

Character Code. Get character code from event
Defined in: SS.core.js.

Parameters:
{Event} e: Event (or window.event) containing a character code

Returns:: {Integer} Character code for the event

$ci(id)

Pseudonym for JavaScript function clearInterval
Defined in: SS.core.js.

Parameters:
id: Identifier as returned from the setInterval or $st functions.

{String} $cl(l, n)

Get / Set className attribute. Gets or sets the class name of an element
Defined in: SS.core.js.

Parameters:
{HTMLElement} l: HTML element to get or set the className attribute
{String} n: (Optional) Class name value. Leave to only query the className would setting it

Returns:: {String} Class name attribute of the element

$cmom(f, o, x)

Copy Matching Object Members. Copy the member values from the first object into the second object only if the second object has the same member name defined
Defined in: SS.core.js.

Parameters:
{Object} f: object from
{Object} o: object to
{String} x: exclude member names (do not copy) - comma separated list

Returns:: null

{Array} $cn(l)

Get child nodes of the elements
Defined in: SS.core.js.

Parameters:
{HTMLElement} l: HTML element to get the child nodes from

Returns:: {Array} Array of child nodes for the element, else null.

{String} $cookie(n, v, d)

Get / Set the cookie value
Defined in: SS.core.js.

Parameters:
{String} n: Cookie name (specify only name to perform select)
{String} v: Value (must be defined in order to set or delete a cookie)
{Integer} d: Duration (days) (default = 28 days) (0 = delete on browser close)

Returns:: {String} Class name attribute of the element

$cookie_delete(n)

Removes a cookie for the browser.
Defined in: SS.core.js.

Parameters:
{String} n: Cookie name to be deleted.

Returns:: null

{CSSStyleRule} $css(n, ci, si)

Return one or more style object from a loaded stylesheet that match the defined name.
Defined in: SS.core.js.

Parameters:
{String} n: Name. Name of the style rule. Alternatively specify a Regular Expression using the RegExp object for custom matching.
{Boolean} ci: (Optional) Case Insensitive Matching. true = compare with no case, false = case sensitive comparison. Default = false.
{Integer} si: (Optional) Stylesheet index. Use this to prevent looking through all stylesheets.

Returns:: {CSSStyleRule} CSS style object. Alternatively, if more than one rule found, return {Array} of {CSSStyleRule} objects.

{String} $cssvalue(n, a, ci, si)

Returns the value of the specified style attribute from the matching style rules.
Defined in: SS.core.js.

Parameters:
{String} n: Name. Name of the style rule. Alternatively specify a Regular Expression using the RegExp object for custom matching.
{String} a: Style Attribute. Name of the style attribute to get the value of e.g. backgroundColor. This is case sensitive.
{Boolean} ci: (Optional) Case Insensitive Matching. true = compare with no case, false = case sensitive comparison. Default = false.
{Integer} si: (Optional) Stylesheet index. Use this to prevent looking through all stylesheets.

Returns:: {String} Value of the style attribute. If there is more than one definition of this attribute in matching style sheet rules then the last value found will take precedence.

$ct(id)

Pseudonym for JavaScript function clearTimeout
Defined in: SS.core.js.

Parameters:
id: Identifier as returned from the setInterval or $st functions.

{Node} $ctn(t)

Create Text Node. Pseudonym for document.createTextNode
Defined in: SS.core.js.

Parameters:
{String} t: Text assigned to the text node

Returns:: {Node} Text node.

$d(l)

Destroy (delete) node. Remove the element from the DOM and destroy the node including all nodes in all sub-trees recursively. This fix gives the best chance that the element is truly deleted and can be cleaned up by the garbage collector to free up memory without causing a JavaScript memory leak.
Defined in: SS.core.js.

Parameters:
{Node} l: Node to be destroyed

Returns:: null

$datediff(id)

Pseudonym for SS.datetime.difference.
Defined in: SS.datetime.js.

Parameters:
id: Identifier as returned from the setInterval or $st functions.

{Object} $dbd()

Returns the dimensions for the document. These dimensions refer to the content window and do not include the browser window including any toolbars.
Defined in: SS.geom.js.

Returns:: {Object} {w = Width, h = Height}

{Integer} $dbsl()

Document body scroll left
Defined in: SS.geom.js.

Returns:: {Integer} Position of the horizontal scroll bar

{Integer} $dbst()

Document body scroll top
Defined in: SS.geom.js.

Returns:: {Integer} Position of the vertical scroll bar

$dc(l)

Destroys all childNodes of the specified element. Cycles through the child nodes of the element (l) and destroys them using $d
Defined in: SS.core.js.

Parameters:
{Node} l: Node to destroy the child nodes of

Returns:: null

$debug(o, f)

Inspect the object and output to console. Pseudonym for SS.debug.console
Defined in: SS.debug.js.

Parameters:
{Object} o: Object to be inspected
{Boolean} f: (Optional) Include functions of object. Default = false.

Returns:: null

$debugclear()

Clears the contents of the debug console
Defined in: SS.debug.js.

Returns:: null

$destroyControl(id)

Descroys an existing control.
Defined in: SS.init.js.

Parameters:
{String} id: Id of the control to be destoryed

Since:: v1.0.7.20090731

Returns:: null

$dw(s)

Document Write. Pseudonym for document.write.
Defined in: SS.core.js.

Parameters:
{String} s: String to write.

Returns:: null

{Event} $e(e)

Get the event in a cross browser supported way. Add scroll information to the event as well.
Defined in: SS.events.js.

Parameters:
{Event} e: Event (typically null if Internet Explorer as the event is held in window.event)

Returns:: {Event} Maximum for the two numbers

$ea()

Pseudonym for SS.events.add.
Defined in: SS.events.js.

{Boolean} $ec(e)

Event Cancel. Cancel a JavaScript event and stops it from bubbling / propagating any further.
Defined in: SS.events.js.

Parameters:
{Event} e: Event to be cancelled.

Returns:: {Boolean} false

$eehadd(l, v, f)

Element Event Handler Add. Allows more than one function to be assigned to an event handler of an element. Adds a function (f) to the element (l) to be executed on event type (v).
Defined in: SS.events.js.

Parameters:
{HTMLElement} l: Element to assign the event handler to.
{String} v: Event type. e.g. onclick.
{Function} f: Function to execute on the event.

Returns:: null

{Object} $eehcalled(l, e)

Element Event Handler - called. Attached to each elements event so this function can cascade the event to other registered functions.
Defined in: SS.events.js.

Parameters:
{HTMLElement} l: Element where the raised event originated from.
{Event} e: Triggered event.

Returns:: {Object} r Return value from function.

{Boolean} $eehclear(e, v)

Element Event Handler - Clear. Removes the event against the specified element if the event is specified.
Defined in: SS.events.js.

Parameters:
{Event} e: Event to be cancelled.
v

Returns:: {Boolean} false

{Object} $ef(f, c, e)

Execute function against a control and event
Defined in: SS.core.js.

Parameters:
{Function} f: Function to be executed, or {String} to be evaluated to be run as a function
{Object} c: Control that the function is to be executed against
{Event} e: Event that triggered the calling of the function

Returns:: {Object} Result from function

$erid()

Pseudonym for SS.events.removeById.
Defined in: SS.events.js.

$error(m, l, o)

Catches an exception and outputs it to the debug window if debugging is defined.
Defined in: SS.core.js.

Parameters:
{Exception} m: Exception
l
o

Returns:: null

{String} $esc(s)

Encode text as URI. Pseudonym for encodeURIComponent.
Defined in: SS.core.js.

Parameters:
{String} s: String to encode

Returns:: {String} Encoded string

{String} $eschtml(s)

Encode text to HTML format.
Defined in: SS.core.js.

Parameters:
{String} s: String to encode

Returns:: {String} Encoded string

$ev(s)

Evaluate String. Pseudonym for eval.
Defined in: SS.core.js.

Parameters:
{String} s: String to be evaluated.

Returns:: null

{Integer} $fromHexColor(v)

Takes an hexadecimal colour string and converts it to its {Integer} equivalent.
Defined in: SS.util.js.

Parameters:
{String} v: Hexidecimal colour string. E.g. #000000

Returns:: {Integer} Integer representation of the hexadecimal colour string.

{Node} $g(id)

Get Element By Id. Pseudonym for document.getElementById but also has support for matching characters ":" and "$" as "_".
Defined in: SS.core.js.

Parameters:
{String} id: Identifier of the element to find

Returns:: {Node} Element if found in the DOM, else false.

{string} $ga(l, a)

Get attribute
Defined in: SS.core.js.

Parameters:
{HTMLElement} l: Element to query the attribute value of
{String} a: Name of the attribute

Returns:: {string} Value of the attribute stored in the element

{Object} $gc(id)

Get Control. Selects the Spiderscript control
Defined in: SS.core.js.

Parameters:
{String} id: Identifier of the control to be returned

Returns:: {Object} Spiderscript control (SS.control.object)

{Array} $gd(l, t, a)

Get Descendants. Returns all the descendants of the node in a single array
Defined in: SS.core.js.

Parameters:
{HTMLElement} l: Element or {Sting} element id
{String} t: Tag Name Filter. Only return elements which match this tag type e.g. "INPUT"
a

Returns:: {Array} Array of HTML elements

{Array} $gg(g)

Gets elements where the groupname attribute matches the sought after groupname (n). A groupname attribute can contain more than one group name by using a comma seperated list. Pseudonym for SS.htmlextension.getElementsByGroupName.
Defined in: SS.htmlextension.js.

Parameters:
{String} g: Group Name. Name of the group of elements to return.

Returns:: {Array} Array of {HTMLElement} objects, else empty array.

{Array} $ggv(n)

Returns the values of elements which have been assigned a groupname. Pseudonym for SS.htmlextension.getGroupValues.
Defined in: SS.htmlextension.js.

Parameters:
{String} n: Group Name. Name of the group of elements to return.

Returns:: {Array} Array of objects {HTMLElement.id : HTMLElement.value}

{Number} $gt(n)

Get elements by tag name. Pseudonym for document.getElementsByTagName
Defined in: SS.core.js.

Parameters:
{String} n: Tag name of elements to be returned. Use "*" to return all elements in the document instead of using document.all

Returns:: {Number} Rounded number.

$h(l, h)

Get / set height of an element. Pseudonym for SS.geom.height
Defined in: SS.geom.js.

Parameters:
l: element
h: set height. Optional. Leave blank to only return the height without changing it.

{Boolean} $hcn(l)

Has Child Nodes
Defined in: SS.core.js.

Parameters:
{HTMLElement} l: HTML element to see if it has child nodes

Returns:: {Boolean} true if the element does have child nodes, else false.

$headd(l, ft)

Add element of intrest for future use e.g. getting values from groupname. Pseudonym $headd
Defined in: SS.htmlextension.js.

Parameters:
{HTMLElement} l: Element to add
{Boolean} ft: First time. Flag to indicate that this has been called as part of the
initial loading process. (Optional).

Returns:: null

{Boolean} $il(l, v, d)

In List. Checks to see if the value (v) is in the list (l) delimited by (d). Case sensitive.
Defined in: SS.core.js.

Parameters:
{String} l: String List e.g. "1,2,3"
{String} v: Value to search for e.g. "2"
{String} d: Delimiter. Default is ",".

Returns:: {Boolean} true if the value exists, else returns false.

{Boolean} $iln(l, v, d)

In List No Case. Checks to see if the value (v) is in the list (l) delimited by (d). Case insensitive. See $il
Defined in: SS.core.js.

Parameters:
{String} l: String List e.g. "1,2,3"
{String} v: Value to search for e.g. "2"
{String} d: Delimiter. Default is ",".

Returns:: {Boolean} true if the value exists, else returns false.

$input(q, t, f, v, l)

Capture input from the user ask question capture answer match input dependent upon type e.g. integer, date, string length etc
Defined in: SS.control.window.js.

Parameters:
q: : string - text displayed to the user
t: : string - window title text
f: : function - call this function when the input box closes
v: : int - input validation type
l: : int - maximum input length

{Boolean} $isa(o)

Is Array. Check to see if the object passed is an array.
Defined in: SS.core.js.

Parameters:
{Object} o: Object to test

Returns:: {Boolean} true if passed object is an array else returns false.

{Boolean} $isb(o)

Is Boolean. Check to see if the object passed is a boolean.
Defined in: SS.core.js.

Parameters:
{Object} o: Object to test

Returns:: {Boolean} true if passed object is a boolean else returns false.

{Boolean} $isd(o)

Is Defined. Check to see if the object passed is defined.
Defined in: SS.core.js.

Parameters:
{Object} o: Object to test

Returns:: {Boolean} true if passed object is defined else returns false.

{Boolean} $isdc(r, c)

Is Descendent Child Element. Checks to see if an element node (c) belongs in the sub-tree of element (r) i.e child, grandchild, great grandchild ...
Defined in: SS.core.js.

Parameters:
{Node} r: Root Node
{Node} c: Child Node

Returns:: {Boolean} true if the node (c) exists in the sub-tree of the root node (r), else false.

{Boolean} $ise(o)

Is Empty. Check to see if the object passed is empty i.e is null, undefined, "", [].
Defined in: SS.core.js.

Parameters:
{Object} o: Object to test

Returns:: {Boolean} true if object is considered as being empty, else false.

{Boolean} $isf(o)

Is Function. Check to see if the object passed is a function
Defined in: SS.core.js.

Parameters:
{Object} o: Object to test

Returns:: {Boolean} true if passed object is a function else returns false.

{Boolean} $isIE()

Is the browser Internet Explorer. Useful for detecting users who are running Internet Explorer.
Defined in: SS.core.js.

Returns:: {Boolean} True = Browser is Internet Explorer, else False.

{Boolean} $isIElt7()

Is the browser Internet Explorer and less than version 7. Useful for detecting users who are running Internet Explorer 6.
Defined in: SS.core.js.

Returns:: {Boolean} True = Browser is Internet Explorer [1 - 6], else False.

{Boolean} $isn(o)

Is Number. Check to see if the object passed is a number.
Defined in: SS.core.js.

Parameters:
{Object} o: Object to test

Returns:: {Boolean} true if passed object is a number else returns false.

{Boolean} $iso(o)

Is Object. Check to see if the object passed is an object
Defined in: SS.core.js.

Parameters:
{Object} o: Object to test

Returns:: {Boolean} true if passed object is an object else returns false.

{Boolean} $iss(o)

Is String. Check to see if the object passed is a string.
Defined in: SS.core.js.

Parameters:
{Object} o: Object to test

Returns:: {Boolean} true if passed object is a string else returns false.

{Boolean} $isu(o)

Is Undefined. Check to see if the object passed is in is of type {undefined}.
Defined in: SS.core.js.

Parameters:
{Object} o: Object to test

Returns:: {Boolean} true if passed object has not been defined.

{Array} $keys(o)

Returns all of the keys in the object (excluding function keys)
Defined in: SS.core.js.

Parameters:
{Object} o: Object to be query the keys of.

Returns:: {Array} Array of {String} keys names

$l(l, p)

Get / Set the x-axis position of an element. In other words, how far left is it. Pseudonym for SS.geom.left
Defined in: SS.geom.js.

Parameters:
l: element
p: set position. Optional. Leave blank to only return the left / x-axis position without changing it.

{String} $lc(s)

To lower Case. Converts a string into lowercase
Defined in: SS.core.js.

Parameters:
{String} s: String to convert to lowercase

Returns:: {String} lower case representation of the string passed into the function else returns "" if not possible to convert object to lowercase string

{String} $lg2()

Get the current user language (2 character code value)
Defined in: SS.core.js.

Returns:: {String} 2 character value of the browser user language

{Integer} $ln(l)

Length. Get the length value of an object e.g. {String} or {Array}
Defined in: SS.core.js.

Parameters:
{Object} l: Object to get length of

Returns:: {Integer} Length of the object or 0 if the object is null or does not implement the length attribute.

$load(url, param, onload, onerror, ontimeout, timeout, nocache, loadId, loadImageId, title, type)

Requests are URI source using the XMLHTTPRequest object. This function can also be called specifiing the URL parameter as an object. e.g. SS.events.load({url:"myurl.htm",onload:function(){alert("hello world");});. Pseudonym for SS.net.load.
Defined in: SS.net.js.

Parameters:
{String} url: Location of the document to load.
{Object} param: Parameters to send to the url using POST method, else leave blank. e.g. {param1:"1",param2:"2" ...}.
{Function} onload: Function to call after the document has loaded successfully
{Function} onerror: Function to call if there was an error processing the request for the document
{Function} ontimeout: Function to call if the request timed out
{Integer} timeout: Number of seconds the request must be completed in before raising a timeout error
{Boolean} nocache: Request the document using a random query parameter to prevent caching
{String} loadId: Id assigned to the request object used for fetching the data
{String} loadImageId: Id of an element, typically an image, which is made visible / hidden during the fetching of data
{String} title: Data Loader Title Description. Optional use to hold a free text description of what the data loader is doing.
type

Returns:: null

{Number} $max(n1, n2)

Maximum of two numbers. Pseudonym for Math.max
Defined in: SS.core.js.

Parameters:
{Number} n1: First number
{Number} n2: second number

Returns:: {Number} Maximum for the two numbers

{Number} $min(n1, n2)

Minimum of two numbers. Pseudonym for Math.min
Defined in: SS.core.js.

Parameters:
{Number} n1: First number
{Number} n2: second number

Returns:: {Number} Minimum for the two numbers

$msgbox(s, b, evc, t)

Display the message box
Defined in: SS.control.window.js.

Parameters:
s
b
evc
t

{Number} $n(id)

Number. Pseudonym for Number function.
Defined in: SS.core.js.

Parameters:
{String} id: Identifier of the element to find

Returns:: {Number} Number.

{Integer} $nid()

Next Id. Returns the next available Id as a number.
Defined in: SS.core.js.

Returns:: {Integer} Next available number.

{XMLDocument} $o2x(o, rt, ns, f)

Converts a JavaScript object into an XML document. Functions are
Defined in: SS.core.js.

Parameters:
{Object} o: XMLdocument to convert to a JavaScript object representation.
{String} rt: Root tag name (optional). Needed if the JavaScript object has more than one top level element.
{String} ns: Namespace (optional)
{Boolean} f: Include functions (optional). Default = false.

Since:: v1.0.7.20090731

Returns:: {XMLDocument} XML document representation of the JavaScript object input.

{Integer} $op(l, v)

Opacity. Get / set the opacity of an element. Pseudonym for SS.geom.opacity.
Defined in: SS.geom.js.

Parameters:
{HTMLElement} l: Element.
{Integer} v: Opacity percentage between 0 and 100 where 0 is invisible and 100 is opaque.

Returns:: {Integer} Opacity of the element.

{HTMLElement} $pn(l)

Get Parent Node
Defined in: SS.core.js.

Parameters:
{HTMLElement} l: HTML element to find the parent of

Returns:: {HTMLElement} Parent of the HTML element, else null.

$popup(u, ti, dw, dh, oc, id, fid)

Display Popup window - (window with iframe inside)
Defined in: SS.control.window.js.

Parameters:
u: : string
object - url to open or object of parameters
ti: : string - window title
dw: : string - width dimension e.g. 450px or 90%
dh: : string - height dimension e.g. 450px or 90%
oc: : function - onclose - function called when the window is closed
id: : string - window Id
fid: : string - iframe Id. Iframe is used to open the document inside the popup window.

$popupClose(id)

Close a Popup window - (window with iframe inside)
Defined in: SS.control.window.js.

Parameters:
id: : string - id of the window to close (default = "SSPopup")

{Boolean} $psb(v)

Parse String to Boolean. Converts a string containing a boolean message into a boolean.
Defined in: SS.core.js.

Parameters:
{String} v: Value to convert

Returns:: {Boolean} true if the value is in the case insensitive values of "yes,true,1,y,on", else false.

{Number} $rand(m)

Random number. Return a random number between 0 and m
Defined in: SS.core.js.

Parameters:
{Number} m: Maximum number to be returned

Returns:: {Number} Random number between 0 and m

{Node} $rc(p, c)

Remove Child. Remove child from parent node if it supports this functionality
Defined in: SS.core.js.

Parameters:
{Node} p: Parent node
{Node} c: Child node

Returns:: {Node} Removed node.

$reverse(s)

Reverse String. Returns the string passed but in reverse order
Defined in: SS.util.js.

Parameters:
{String} s: String to reverse

Returns:: Reversed string.

{Number} $rnd(p)

Round number. Pseudonym for Math.round
Defined in: SS.core.js.

Parameters:
{Number} p: Number to be rounded

Returns:: {Number} Rounded number.

{Node} $rp(l)

Remove from Parent. Remove the node from its parent if this functionality is supported by the node.
Defined in: SS.core.js.

Parameters:
{Node} l: Node to detach from its parent

Returns:: {Node} Removed node.

{String} $ruid()

Random unique identifier. Similar to a GUID but uses random numbers to generate the id.
Defined in: SS.core.js.

Since:: v1.0.7.20090731

Returns:: {String} Unique Identifier in the lowercase form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

$sa(l, a, v)

Set attribute
Defined in: SS.core.js.

Parameters:
{HTMLElement} l: Element to query the attribute value of
{String} a: Name of the attribute
{Value} v: New value for the attribute

Returns:: null

$si(callFunction, interval)

Pseudonym for JavaScript function setInterval
Defined in: SS.core.js.

Parameters:
{Function} callFunction
{Integer} interval: Duration in milliseconds

$st(callFunction, interval)

Pseudonym for JavaScript function setTimeout
Defined in: SS.core.js.

Parameters:
{Function} callFunction
{Integer} interval: Duration in milliseconds

$stopwatch()

Pseudonym for SS.debug.console.
Defined in: SS.debug.js.

$submit(f)

Submits only a specific form.
Defined in: SS.htmlextension.js.

Parameters:
f

$sxyz(l, p)

Sets Element Position. Sets the x, y , z position of an element. Pseudonym for SS.geom.setPosition.
Defined in: SS.geom.js.

Parameters:
{HTMLElement} l: Element
{SS.coord} p: Position. Co-ordinates to set for the element (l).
Alternatively use {x: value, y: value, z: value} syntax.
See $t and $l for setting only one axis.

Returns:: null

$t(l, p)

Get / set the y-axis position of an element. In other words, how far from the top is it. Pseudonym for SS.geom.top
Defined in: SS.geom.js.

Parameters:
l: element
p: set position. Optional. Leave blank to only return the top / y-axis position without changing it.

{Array} $ta(o)

To Array. Takes an object and converts it to an array unless the object passed is already an array. If null or undefined are passed, an empty array returned. A single object o would be returned as [o].
Defined in: SS.core.js.

Parameters:
{Object} o: Object to be turned into an array

Returns:: {Array} Array containing the object passed, else an empty array.

{Boolean} $tb(v)

To Boolean. Converts the object passed to a boolean. Is this is a string, the meaning of the string is looked up using $psb.
Defined in: SS.core.js.

Parameters:
{Object} v: Value object

Returns:: {Boolean} true if the value exists, else false.

{String} $toHexColor(v)

Takes an integer parameter and converts it to a 6 digit hexadecmial string
Defined in: SS.util.js.

Parameters:
{Integer} v: Integer value between 0 (#000000) and 16777215 (#FFFFFF)

Returns:: {String} Hexidecimal colour string.

{String} $trim(s)

Trim. Trim leading and trailing blank spaces off the string passed
Defined in: SS.core.js.

Parameters:
{String} s: String to be trimmed

Returns:: {String} Trimmed string.

{String} $ts(s)

To String. Takes an object and converts it to a string using the .toString function where possible. If null or undefined are passed, an empty string is returned.
Defined in: SS.core.js.

Parameters:
{String} s: String to be trimmed

Returns:: {String} String representation of the object, else "".

{String} $uc(s)

To UPPER case. Converts a string into uppercase .
Defined in: SS.core.js.

Parameters:
{String} s: String to convert to uppercase

Returns:: {String} UPPER case representation of the string passed into the function else returns "" if not possible to convert object to uppercase string

{String} $uesc(s)

Decode URI text. Pseudonym for decodeURIComponent
Defined in: SS.core.js.

Parameters:
{String} s: String to decode

Returns:: {String} Decoded string

{String} $up(p, u)

Get URL parameter value. Returns the value of the URL parameter
Defined in: SS.core.js.

Parameters:
{String} p: Name of the URL parameter
{String} u: (Optional) URL to get the parameter from. Default = window.location.href

Returns:: {String} Value of the URL parameter

{String} $upa(u, p, v)

URL Parameter Append. Insert or update URL parameter value.
Defined in: SS.core.js.

Parameters:
{String} u: URL to alter.
{String} p: Name of the URL parameter
{String} v: New value for the URL parameter

Returns:: {String} Modified URL.

$v(l, v, s)

Set Element Visibility. Show / hide an element using the display (default) or visibility style sheet rules. Pseudonym for SS.geom.display.
Defined in: SS.geom.js.

Parameters:
{HTMLElement} l: Element or {String} Element Id
{Boolean} v: Visible flag. True for visible, false for hidden (display:none)
{Boolean} s: Static. Static display, uses the visibility style instead of the display style attribute.
This means that the space the element occupies remains filled when hidden.

Returns:: null

{Boolean} $validate(g)

Validate fields. Pseudonym for SS.htmlextension.validate.
Defined in: SS.htmlextension.js.

Parameters:
{String} g: Group Name (optional)

Returns:: {Boolean} True if all fields in the form / group validate correctly, else false if one or more fields are in error.

$w(l, w)

Get / set width of an element. Pseudonym for SS.geom.width
Defined in: SS.geom.js.

Parameters:
l: element
w: set width. Optional. Leave blank to only return the width without changing it.

$x(l, p)

Get / Set the x-axis position of an element. In other words, how far left is it. Pseudonym for SS.geom.left
Defined in: SS.geom.js.

Parameters:
l: element
p: set position. Optional. Leave blank to only return the left / x-axis position without changing it.

{Object} $x2o(x)

Converts an XML document into a JavaScript object
Defined in: SS.core.js.

Parameters:
{XMLDocument} x: XMLdocument to convert to a JavaScript object representation.
An important note, where there exists a series of nodes of the same type,
they are stored together in an array. If only one node of that type exists,
it is stored as a single object. Use $ta to convert single objects into
an array where there could be one or more items.

Returns:: {Object} JavaScript object representation of the XMLDocument input.

$xload(xml, xsl, param, onload, onerror, ontimeout, timeout, nocache, element, loadImageId, loadId, title)

Asynchronously loads data from an XML datasource and applies the specified XSLT transformation template. The result of which is either rendered to the entire page or to a specified element.
Defined in: SS.net.js.

Parameters:
{Object} xml: Either define xml as a URL {String} or alternatively define it as an object.
{
xml : "URL XML File to load"
xmlparam : Object of parameters posted on the xml request
xsl : "URL XSLT sheet to transform the XML with",
xslparam : Object of parameters posted on the xsl request
xsltparam : Object of parameters made available to the XSLT transformation. If set the value xslparam is ignored in the request for the XSLT stylesheet for Internet Explorer only.
element : Element to attach the resulting xml xslt transformation to
onload : function called after loading both xml and xsl
onerror : function called if there is an error in either xml or xsl request
ontimeout : function called if the request for xml or xsl timesout
timeout : maximum duration in seconds given to request either xml or xsl before the timeout function is called
nocache : request xml and xsl using a random query parameter to prevent caching. default = true.
loadImageId : image / element to display whilst the request is loading
loadId : id of the request
title : title of the request
xmlonload : function called after loading xml and before onload
xmlonerror : function called if there is an error in the xml request
xmlontimeout : function called if the request for xml times out
xmltimeout : maximum duration in seconds given to request xml before the timeout function is called
xmlnocache : request xml using a random query parameter to prevent caching. default = {nocache} true.
xmlloadimage : image / element to display whilst the xml request is loading
xmlid : id of the xml request
xmltitle : title of the xml request
xslonload : function called after loading xsl and before onload
xslonerror : function called if there is an error in the xsl request
xslontimeout : function called if the request for xml times out
xsltimeout : maximum duration in seconds given to request xsl before the timeout function is called
xslnocache : request xsl using a random query parameter to prevent caching. default = {nocache} true.
xslloadimage : image / element to display whilst the xsl request is loading
xslid : id of the xsl request
xsltitle : title of the xsl request
xslcharesc : XSL transformation character escaping. Needed in non IE browsers to render raw HTML elements on the page.
}
{String} xsl: URL XSLT sheet to transform the XML with
{Object} param: Object of parameters posted on the xml request
{Function} onload: Function called if the XML and XSLT transforms have loaded and been successfully transformed.
{Function} onerror: Function called if either the XML and XSLT transforms have not loaded or there was an error in the transformation.
{Function} ontimeout: Function called if either the XML and XSLT transforms have exceeded the timeout limit.
{Integer} timeout: Number of seconds the request has to complete in before it is.
{Boolean} nocache: Request xml and xsl using a random query parameter to prevent caching.
{HTMLElement} element: Element to attach the transformation to. If not specified, then the transformation will be applied to document.body.
{HTMLElement} loadImageId: image / element to display whilst the xml and xsl request is loading.
{String} loadId: Name of the load object.
{String} title: Title of the xml and xsl request.

{SS.coord} $xyz(l)

Element Position. Gets the absolute position of an element within the document including size dimensions. Pseudonym for SS.geom.getXYZ.
Defined in: SS.geom.js.

Parameters:
{HTMLElement} l: Element

Returns:: {SS.coord} Co-ordinates of the element (l).

$y(l, p)

Get / set the y-axis position of an element. In other words, how far from the top is it. Pseudonym for SS.geom.top
Defined in: SS.geom.js.

Parameters:
l: element
p: set position. Optional. Leave blank to only return the top / y-axis position without changing it.

$z()

Get / set z-Index. Pseudonym for SS.geom.zIndex.
Defined in: SS.geom.js.

hf(e)

Defined in: SS.control.popup.js.

Parameters:
e

hfc(e)

Defined in: SS.control.popup.js.

Parameters:
e

Classes

Classes

Built-In Namespace _global_