Class PTCommonUtil

Object
   |
   +--PTCommonUtil

class PTCommonUtil

Static class containing commonly used methods.

Usage:	
 	PTCommonUtil.isDefined(myobject)
 

Field Detail

VERSION

<static> <final> Object VERSION

See Also:

Constant Field Values

PTCommonUtil

PTCommonUtil()

PTCommonUtil static object constructor

Returns:
New PTCommonUtil object. Author Legacy Code

copyObject

<static> Object copyObject(srcObj,destObj)

Returns a new object which is a copy of a given object.

Parameters:
srcObj - the object to copy
destObj - an existing object onto which the srcObj should be copied (optional)

Returns:
an object

getCSSClassStyleProperty

<static> Object getCSSClassStyleProperty(className, propertyName)

Returns a style property value for a given CSS class and style property name.

Parameters:
className - the name of the CSS class.
propertyName - the name of the CSS style property

Returns:
a Style object property value

getCSSClassStyles

<static> Object getCSSClassStyles(className)

Returns the style object for a given CSS class name.

Parameters:
className - the name of the CSS class.

Returns:
a Style object

getElementById

<static> Element getElementById(id)

Wrapper for document.getElementById with performance improvements.

Parameters:
id - id of element to retrieve (string)

Returns:
a DOM element

Deprecated Use PTDOMUtil.getElementById instead

getIEVersion

<static> Number getIEVersion()

Returns "dot" version of MSIE browser (eg. 5.5). Any non-MSIE browser returns 0.

Returns:
a version number

Deprecated Use PTBrowserInfo.getIEVersion instead

getNNVersion

<static> Number getNNVersion()

Returns "dot" version of NN browser (eg. 6.0). Any non-NN browser returns 0.

Returns:
a version number

Deprecated Use PTBrowserInfo.getNNVersion instead

getRelativePosition

<static> Object getRelativePosition(childDiv,parentDiv,ignoreBorders)

Computes relative placement of child within parent. This method is NOT safe for Netscape 4.x.

Parameters:
childDiv - Inner object (DOM Object)
parentDiv - Outer / bounding object (DOM Object)
ignoreBorders - Whether or not to factor in border size (boolean)

Returns:
Object with .x and .y position properties

getRemoteStyleClassProperty

<static> Object getRemoteStyleClassProperty(doc,className,attrName)

Retrieves an attribute's value from a style class in a specified document

Parameters:
doc - Document to read style class attribute value from (DOM Document)
className - Name of class containing attribute (string)
attrName - Name of attribute value to retrieve (string)

Returns:
a remote style class property value

Deprecated Getting styles from the doc will only work if the css file is on the same host as the including page. If not, an "Access Denied" error gets thrown. Use of getCSSClassStyles or getCSSClassStyleProperty is now prefered.

getScripts

<static> Array getScripts()

Retrieves an array of the scripts on a page

Returns:
an array of Script tags

getServerFromURL

<static> String getServerFromURL(url)

Returns the machine name portion of a URL (eg. www.yahoo.com)

Parameters:
sURL - URL to parse (string)

Returns:
a server host name

getStyleClass

<static> Object getStyleClass(className)

Retrieves a style class from the current document's stylesheets

Parameters:
className - Name of class to fetch (string)

Returns:
style class Object

Deprecated Getting styles from the doc will only work if the css file is on the same host as the including page. If not, an "Access Denied" error gets thrown. Use of getCSSClassStyles or getCSSClassStyleProperty is now prefered.

getStyleClassFromDocument

<static> Object getStyleClassFromDocument(doc,className)

Retrieves a style class from a document's stylesheets

Parameters:
doc - Document to read style class from (DOM Document)
className - Name of class to fetch (string)

Returns:
style class Object

Deprecated Getting styles from the doc will only work if the css file is on the same host as the including page. If not, an "Access Denied" error gets thrown. Use of getCSSClassStyles or getCSSClassStyleProperty is now prefered.

getStyleClassProperty

<static> Object getStyleClassProperty(className,attrName)

Retrieves an attribute's value from a style class in the current document

Parameters:
className - Name of class containing attribute (string)
attrName - Name of attribute value to retrieve (string)

Returns:
a style class property value

Deprecated Getting styles from the doc will only work if the css file is on the same host as the including page. If not, an "Access Denied" error gets thrown. Use of getCSSClassStyles or getCSSClassStyleProperty is now prefered.

getValueForStyleAttribute

<static> String getValueForStyleAttribute(s,attr)

Parses a style string, examining it for a single attribute, and returns the value of that attribute if found

Parameters:
s - Style string to examine (string)
attr - Name of attribute (string)

Returns:
the value of the style attribute

isDefined

<static> Boolean isDefined(obj)

Tests an object to see if it is currently defined in memory

Parameters:
obj - object to test (Object)

Returns:
true if the object is defined

parseGet

<static> Hash parseGet(url)

Parses a URL, returning the query string variables separated in to key/value pairs. This method has been shown to be compatible back to Netscape 2.

Parameters:
url - URL to parse for query information (string)

Returns:
Array of name value pairs fromt the URL query string

scrollDivIntoView

<static> void scrollDivIntoView(object,container)

Repositions the document vertically so that one object becomes visible within the scrolling area of another object. This method is NOT safe for Netscape 4.x.

Parameters:
object - Object to scroll into view (DOM Object)
container - Outer container of object [default = document.body] (DOM Object)

sortCaseInsensitive

<static> Number sortCaseInsensitive(aa,bb)

Sorts alphabetically, ignoring case

Parameters:
aa - one item (string)
bb - another item (string)

Returns:
an integer indictating the comparison between the two arguments

sortForward

<static> Number sortForward(aa,bb)

Sorts in forward alpha order

Parameters:
aa - one item (string)
bb - another item (string)

Returns:
an integer indictating the comparison between the two arguments

sortHashByKeys

<static> Hash sortHashByKeys(hash,preserveFirstKey,isCaseInsensitive,doReverseSort)

Sorts the objects in a hash by order of its keys

Parameters:
hash - Associative Array to sort (Array)
preserveFirstKey - Option to keep first key in place while sorting all others (boolean)
isCaseInsensitive - Option to ignore case during sort (boolean)
doReverseSort - Option to sort in reverse order (boolean)

Returns:
a sorted associative array

sortNumeric

<static> Number sortNumeric(a,b)

Sorts using numeric comparators (instead of default alpha comparator)

Parameters:
a - one item (number)
b - another item (number)

Returns:
an integer indictating the comparison between the two arguments

sortReverse

<static> Number sortReverse(aa,bb)

Sorts in reverse alpha order

Parameters:
aa - one item (string)
bb - another item (string)

Returns:
an integer indictating the comparison between the two arguments

sortReverseCaseInsensitive

<static> Number sortReverseCaseInsensitive(aa,bb)

Sorts reverse-alphabetically, ignoring case

Parameters:
aa - one item (string)
bb - another item (string)

Returns:
an integer indictating the comparison between the two arguments

wait

<static> void wait(ms)

Causes the browser to idle in complete thread-blocking inactivity for a specified number of milliseconds.

Parameters:
ms - Number of milliseconds to idle (integer)