SitedObject

Here's how to add a click event handler to a button to call the global function myFunction:

function myFunction() { alert('Called'); }

var b = new ButtonControl();
b.addEventHandler(ID_click, new Delegate(null, myFunction));

This takes a binding path specified as an array. It traverses the binding path and returns the value at the end of the path, or null if the binding fails.

This is the method called by all #bind() expressions.

The path argument must be an array containing the following element types:

When you write a binding expression like <onClick="alert(#bind(person.firstName))", this is compiled into something like:

alert(this.getPathValue([ '../', 'person', 'firstName' ]));

(Since creating arrays dynamically is slow, the page compiler generates all path arrays as global variables which it reuses, so the actual code you see in a page will be more like:

// shared paths at the top of the page
var sp.b1 = [ '../', 'person', 'firstName' ];

	...
	alert(this.getPathValue(sp.b1));
	...

The following code prints the displayName of the ID_firstName property on an object, if it exists.

var pinfo = obj.getPropertyInfo(ID_firstName);
if (pinfo != null)
	Diagnostics.write(pinfo.getValue(ID_displayName));

In this example we create a SitedObject obj, make another SitedObject s1, and then set s1 as the value of ID_someProperty on obj:

var obj = new SitedObject();
var s1 = new SitedObject();
obj.setValue(ID_someProperty, s1);
// Now s1.getSite() == obj

In this next example, we add a SitedObject to a list:

var list = new SitedList();
var s2 = new SitedObject();
list.add(s2);
// Now s2.getSite() == list

Call this method rather than dotting into an object using the object.propertyName convention, since the object may need to do additional work to retrieve the value.

Avoid using string literals as property IDs (object.getValue('foo')), since this won't work if you compile your application with the cruncher.

Here's how to make the text property of a control uppercase.

function makeTextUpperCase(control) {
   var text = control.getValue(ID_text);
   control.setValue(ID_text, text.toUpperCase());
}

This overridable method is called any time someone calls setValue on this object to change the object's properties. Subclasses override this to respond to changes in properties as appropriate.

If you override the method, be sure to call the base class's version.

This overridable method is called when this object is about to lose its site, i.e. when this object gets removed from its "parent" site. The default version does nothing.

If you override the method, be sure to call the base class's version.

This overridable method is called when an object is sited in this. i.e. when this object becomes the ID_parent of another sited object. The default version does nothing.

If you override the method, be sure to call the base class's version.

This overridable method is called when an object is about to be unsited from this object, i.e. when this object is about to stop being the ID_parent of another sited object. The default version does nothing.

If you override the method, be sure to call the base class's version.

Here is an example from the basic_button.html quick tour - this code was generated by the page compiler:

function initializeApp0(target, resourceOwner, data) {
	var o;

	// Create <Button> (line: 9)
	o = new ButtonControl();
	o.addEventHandler("click", new Delegate(target, line9_Button_click));
	o.setInitialValues(
		"text", 'Hello World');

	target.setInitialValues(
		"childControls", new SitedList(o));
};

When you write a binding expression like <onClick="#bind(person.age) = 12;", this is compiled into something like:

this.setPathValue([ '../', 'person', 'firstName' ], 12);

Call this method rather than dotting into an object using the object.propertyName = value convention, since setting the value may have side effects (e.g. causing the DOM to get re-rendered).

Also, avoid using string literals for property keys (object.setValue('foo', 12)), since this won't work if you compile your application with the cruncher. Always use the property ID.

Here's how to make the text property of a control uppercase.

function makeTextUpperCase(control) {
   var text = control.getValue(ID_text);
   control.setValue(ID_text, text.toUpperCase());
}