Class DHTMLSuite.common

Object
   |
   +--DHTMLSuite.common

class DHTMLSuite.common

A class containing common method used by one or more of the gui classes below, example: loadCSS. An object("DHTMLSuite.commonObj") of this class will always be available to the other classes.
Defined in dhtml-suite-for-applications.js

Author: Alf Magne Kalleland(www.dhtmlgoodies.com)
Version: 1.0

Field Detail

cssCacheStatus

Object cssCacheStatus

eventEls

Object eventEls

okToSelect

Object okToSelect

DHTMLSuite.common

DHTMLSuite.common()

Author: Alf Magne Kalleland(www.dhtmlgoodies.com)
Version: 1.0

addEvent

void addEvent( obj, type, fn,suffix )

This function adds an event listener to an element on the page.

Parameters:
Object - whichObject = Reference to HTML element(Which object to assigne the event)
String - eventType = Which type of event, example "mousemove" or "mouseup" (NOT "onmousemove")
functionName - = Name of function to execute.

cancelEvent

Object cancelEvent()

This function only returns false. It is used to cancel selections and drag

correctPng

void correctPng(el)

Correct png for old IE browsers

Parameters:
Object - el - Id or direct reference to image

deleteCookie

void deleteCookie( name, path, domain )

This function deletes a cookie. (This method has been slighhtly modified)

Parameters:
String - name = Name of cookie
String - path = Path for cookie (Usually left empty)
String - domain = Cookie domain

getAssociativeArrayFromString

Object getAssociativeArrayFromString(propertyString)

Returns an associative array from a comma delimited string

Parameters:
String - propertyString - commaseparated string(DHTMLSuite.common.prototype.example = "id:myid,title:My title,contentUrl:includes/tab.inc";)

Returns:
Associative array of keys + property value(DHTMLSuite.common.prototype.example = key;: id, DHTMLSuite.common.prototype.value = myId;)

getCookie

Object getCookie(name)

These cookie functions are downloaded from http://www.mach5.com/support/analyzer/manual/html/General/CookiesJavaScript.htm This function returns the value of a cookie

Parameters:
String - name = Name of cookie
Object - inputObj = Reference to HTML element

getEl

Object getEl(elRef)

Return a reference to an object

Parameters:
Object - elRef = Id, name or direct reference to element

Returns:
Object HTMLElement - direct reference to element

getKeyCode

Object getKeyCode(e)

Returns key code from event

Parameters:
Event - e = Event object

getKeyFromEvent

Object getKeyFromEvent(e)

Returns key from event object

Parameters:
Event - e = Event object

getLeftPos

Object getLeftPos(el)

This method will return the left coordinate(pixel) of an HTML element

Parameters:
Object - el = Reference to HTML element

getObjectByAttribute

Object getObjectByAttribute(e,attribute)

Walks up the DOM tree and returns first found object with a given attribute set

Parameters:
Event - e = Event object
String - attribute = Custom attribute

getObjectByClassName

Object getObjectByClassName(e,className)

Walks up the DOM tree and returns first found object with a given class name

Parameters:
Event - e = Event object
String - className = CSS - Class name

getSrcElement

Object getSrcElement(e)

Returns a reference to the HTML element which triggered an event.

Parameters:
Event - e = Event object

getStyle

Object getStyle(el,property)

Return specific style attribute for an element

Parameters:
Object - el = Reference to HTML element
String - property = Css property

getTopPos

Object getTopPos(el)

This method will return the top coordinate(pixel) of an HTML element/tag

Parameters:
Object - el = Reference to HTML element

getUniqueId

Object getUniqueId()

Returns a unique numeric id

init

void init()

This method initializes the DHTMLSuite_common object. This class contains a lot of useful methods used by most widgets.

isArray

Object isArray(el)

Return true if element is an array

Parameters:
Object - el = Reference to HTML element

isObjectClicked

Object isObjectClicked(obj,e)

Returns true if an object is clicked, false otherwise. This method will also return true if you clicked on a sub element

Parameters:
Object - obj = Reference to HTML element
Event - e = Event object

loadCSS

void loadCSS(cssFile,prefixConfigPath)

This method loads a CSS file(Cascading Style Sheet) dynamically - i.e. an alternative to tag in the document.

Parameters:
string - cssFile = Name of css file. It will be loaded from the path specified in the DHTMLSuite.common object
Boolean - prefixConfigPath = Use config path as prefix.

removeEvent

void removeEvent(obj,type,fn,suffix)

This function removes an event listener from an element on the page.

Parameters:
Object - whichObject = Reference to HTML element(Which object to assigne the event)
String - eventType = Which type of event, example "mousemove" or "mouseup"
functionName - = Name of function to execute.

setCookie

void setCookie(name,value,expires,path,domain,secure)

These cookie functions are downloaded from http://www.mach5.com/support/analyzer/manual/html/General/CookiesJavaScript.htm This function creates a cookie. (This method has been slighhtly modified)

Parameters:
String - name = Name of cookie
String - value = Value of cookie
Int - expires = Timestamp - days
String - path = Path for cookie (Usually left empty)
String - domain = Cookie domain
Boolean - secure = Secure cookie(SSL)

setCssCacheStatus

void setCssCacheStatus(cssCacheStatus)

Specify if css files should be cached or not.

Parameters:
Boolean - cssCacheStatus = true = cache on, false = cache off