utils Class

Show Source

Common functions and utilities used by the webcontrols

Constructors

There are no public constructors.

Events

onRender( el, callback )

Used to check whether DOM element has been added to the document. Calls a callback if it exists or when it is added.

Show Source

Public Methods

get( url, config )

Used to execute an HTTP GET request. Example:

    get(url + "?filter=" + encodeURIComponent(filter), {
        success: function(text){
            var arr = JSON.parse(text).records;
        },
        failure: function(request){
            alert(request.status);
        }
    });

url	Required.
config	Optional. Common config settings include a "success" callback function, "failure" callback function, and "payload". Note that if a payload is given, an HTTP POST request will be executed. See the http() method for a full range of options.

Show Source

post( url, payload, config )

Used to execute an HTTP POST request.

Show Source

delete( url, config )

Used to execute an HTTP DELETE request.

Show Source

http( url, config )

Used to execute an HTTP request.

Show Source

getParameter( name, url )

Returns the value of a given parameter name in a URL querystring

name	Parameter name
url	URL (e.g. window.location.href)

Show Source

merge( settings, defaults )

Used to merge properties from one json object into another. Credit: https://github.com/stevenleadbeater/JSONT/blob/master/JSONT.js

Show Source

clone( obj )

Used to clone a json object

Show Source

isDirty( obj, org )

Returns true if the given json object differs from the original.

Show Source

diff( obj1, obj2 )

Used to compare 2 json objects. Returns a json object with differences. Credit: https://stackoverflow.com/a/13389935/

Show Source

isEmpty( obj )

Returns true if the given json object has no key/value pairs.

Show Source

isArray( obj )

Used to check whether a given object is an array. Note that this check does not use the "instanceof Array" approach because of issues with frames.

Show Source

isString( obj )

Return true if a given object is a string.

Show Source

isNumber( n )

Return true if a given object is a number or can be parsed into a number.

Show Source

isDate( d )

Return true if a given object can be parsed into a date. Returns false if the object is a number (e.g. "3", "1.2")

Show Source

isElement( obj )

Return true if a given object is a DOM element.

Show Source

setStyle( el, style )

Used to set the style for a given element, replacing whatever style was there before.

el	DOM element.
style	If a string is provided, assumes that the string represents a CSS class name update "class" attribute of given element. If a JSON object is provided, will assign the key/value pairs to the "style" attribute of the node.

Show Source

addStyle( el, style )

Used to add style to a given element.

el	DOM element.
style	If a string is provided, assumes that the string represents a CSS class name update "class" attribute of given element. If a JSON object is provided, will assign the key/value pairs to the "style" attribute of the node.

Show Source

hasStyleRule( selector )

Returns true if there is a style rule defined for a given selector.

selector

CSS selector (e.g. ".deleteIcon", "h2", "#mid")

Show Source

addNoSelectRule( )

Inserts the "javaxt-noselect" class into the document if it is not present.

Show Source

createElement( type, obj, style )

Used to create a DOM element

type	Node type (string). Example "div". This field is required.
obj	Optional. If a DOM element is provided, will append the newly created node into the element. Otherwise, will assume that the object is a style.
style	Optional. If a string is provided, assumes that the string represents a CSS class name update "class" attribute of the newly created node. If a JSON object is provided, will assign the key/value pairs to the "style" attribute.

Show Source

createTable( parent )

Used to create a table element.

parent

DOM element to append to (optional)

Show Source

getSuggestedColumnWidths( records, pixelsPerChar )

Used to analyze a given dataset and suggest column widths for a table or a datagrid

records	A two-dimensional array representing rows and columns
pixelsPerChar	Approximate, average width of a character

Show Source

updateDOM( )

Used to update the default befaviour of the browser to prevent things like right mouse click, scrolling beyond a page, and drag and drop.

Show Source

getRect( el )

Returns the geometry of a given element.

Show Source

intersects( r1, r2 )

Used to test whether two rectangles intersect.

Show Source

getAreaOfIntersection( r1, r2 )

Returns the area of intersection between 2 rectangles.

Show Source

getZScores( values, normalize )

Returns z-scores for a given set of values

values	An array of numbers
normalize	If true, will return positive values for z-scores

Show Source

initDrag( dragHandle, config )

Show Source

addResizeListener( element, fn )

Used to watch for resize events for a given element. Credit: http://www.backalleycoder.com/2013/03/18/cross-browser-event-based-element-resize-detection/

Show Source

getHighestElements( obj )

Returns an array of elements at the highest z-index in the document

Show Source

getNextHighestZindex( obj )

Returns an integer represeting the highest z-value of all the DOM elements that appear with the given object + 1

Show Source

addShowHide( el )

Adds show/hide methods to a DOM element or javaxt component

Show Source

destroy( me )

Used to help destroy javaxt components

Show Source

round( number, decimalPlaces )

Rounds decimal to the nearest 10ths place.

Show Source