vegui. std.js

function vui_module_add( type, module, filename )

Makes a vegUI module accessable by the manager.  When developing addons for vegUI make sure you initialize your module using this function instead of adding it’s type directly to the VEGUIOBJ array.

If there are colliding types an error message will be displayed and the script is halted

Added in

2.0.6

Parameters

Returns

Example

vui_module_add(VUI_NODE, VegUINode, 'vegui.std.js');

var browser_str = navigator.userAgent.toLowerCase( ); function iesucks(Node)

Internet explorer 6 leaks memory in closures, in order to fix that iesucks is called when the page is unloaded if the browser is ie6

Parameters

function Clone( Obj )

Creates a new instance of a javascript object

Parameters

Example

In this example newObj will be an exact clone of Obj

var newObj = new Clone(Obj);

function merge( srcObj, trgObj )

Attempt to append the properties of trgObj to srcObj

Parameters

Example

Any non-existing properties of Obj2 will be copied to Obj1, existing properties will be overwritten

merge(Obj1, Obj2);

function cloneArray( Arr )

clones an array

Parameters

Returns

Example

newArr will be an exact copy of oldArr

var newArrr = cloneArray(oldArr);

function has_parent( Node, Parent )

checks if Node is the child of Parent somewhere up the parent chain

Parameters

Returns

Example

var node1 = document.createElement('div');
var node2 = document.createElement('div');
var node3 = document.createElement('div');
node1.appendChild(node2);
node2.appendChild(node3);

// as node1 is the parent node of node 2, this will return true
return has_parent(node2, node1);

// returns true as well, since node1 is the parent of node2 which
// is the parent of node3
return has_parent(node3, node1);

function get_mouse( e )

get mouse pointer location, sets mouseX and mouseY

Parameters

Example

node.onmousemove = function(e) {
  get_mouse((e ? e : event));
  alert(mouseX+','+mouseY);
}

function htmlnode( nodeName, parentNode )

Wrapper for document.createElement with the option to append the created node to another html node right away

Paramters

Returns

function imgnode( src, w, h, parentNode )

Wrapper for document.createElement to create an image node with the option to define proportions and image source right away

Parameters

Returns

function txtnode( txt )

Wrapper for document.createTextNode

Parameters

Returns

function vui_rand( min, max )

generate a random number

Parameters

Returns

Example

// n may be any number between 1 and 30
var n = vui_rand(1,30);

function VegUIMouseState( eventType, Parent )

Parameters

function VegUINode( refName, Parent, Manager )

Parameters

this.abs_middle = function( stopAt )

Parameters

Returns

See also

abs_x, abs_y, x, y

this.abs_x = function( stopAt )

Parameters

Returns

See also

abs_y, abs_middle, x, y

this.abs_y = function( stopAt )

Returns

See also

abs_x, abs_middle, x, y

this.add_child = function( name, type, nodeName, pos )

Creates a VegUI element as a child of this element.  Childs can be accessed over the Child or C property of this element by their unique child name

Parameters

Returns

See also

add_skin, add_child_o

Example

var c = myNode.add_child('mychild', VUI_NODE, 'div', 'absolute');

this.add_child_o = function( name, Obj )

Adds an existing VegUI Element to this element as a child

Parameters

See also

add_child, add_skin

Example

var node1 = Manager.get_new(VUI_NODE);
var node2 = Manager.get_new(VUI_NODE);
node2.add_child_o(node1);

this.add_skin = function( n, w, h, x, y, c, rm, bm, rm_nr, bm_nr, nN, i )

Wrapper function to add a new vegui element to this element as a child with the ability to set the most common template properties

Parameters

Returns

See also

add_child, add_child_o

this.align_childs = function( Child )

(Re)Aligns all child elements of this element to their margins

Parameters

See also

set_marg

this.attach = this.attach_node = function( Element, offsetX, offsetY,