YUI Library Examples: Menu Family: Setting Menu Configuration Properties At Runtime

Setting MenuItem configuration properties at runtime

A MenuItem has a number of configuration properties that affect its behavior and visual rendering. Any of these configuration properties can be set at runtime via the setProperty method of the item's configuration object (accessible via its cfg property.

This example ulitizes the following configuration properties: text, selected, disabled, helptext, url, emphasis, strongemphasis, and checked.


1	/*
2	"configChange" event handler for each MenuItem instance - used
3	to log info about the configuration property that was changed.
4	*/
5
6	function onMenuItemConfigChange(p_sType, p_aArgs) {
7
8	var sPropertyName = p_aArgs[0][0],
9	sPropertyValue = p_aArgs[0][1];
10
11	YAHOO.log(("Index: " + this.index + ", " +
12	"Group Index: " + this.groupIndex + ", " +
13	"Custom Event Type: " + p_sType + ", " +
14	"\"" + sPropertyName + "\" Property Set To: \""
15	+ sPropertyValue + "\""), "info", "example12");
16
17	}
18
19
20	/*
21	Instantiate a Menu: The first argument passed to the constructor
22	is the id for the Menu element to be created, the second is an
23	object literal of configuration properties.
24	*/
25
26	var oMenu = new YAHOO.widget.Menu("basicmenu", { fixedcenter: true });
27
28
29	/*
30	Subscribe to the Menu instance's "itemAdded" event in order to
31	subscribe to the "configChange" event handler of each MenuItem
32	instance's configuration object.
33	*/
34
35	oMenu.subscribe("itemAdded", function (p_sType, p_aArgs) {
36
37	var oMenuItem = p_aArgs[0];
38
39	/*
40	Subscribe to the "configChange" event handler of each MenuItem
41	instance's configuration object.
42	*/
43
44	oMenuItem.cfg.subscribe("configChanged", onMenuItemConfigChange);
45
46	});
47
48
49	/*
50	Add items to the Menu instance by passing an array of strings
51	(each of which represents the "text" configuration property of a
52	YAHOO.widget.MenuItem instance) to the "addItems" method.
53	*/
54
55	oMenu.addItems([
56
57	"Selected MenuItem",
58	"Disabled MenuItem",
59	"MenuItem With A URL",
60	"Checked MenuItem"
61
62	]);
63
64
65	/*
66	Since this Menu instance is built completely from script, call the
67	"render" method passing in the DOM element that it should be
68	appended to.
69	*/
70
71	oMenu.render("rendertarget");
72
73
74	/*
75	Set a configuration property of each MenuItem to trigger the firing
76	of its configuration object's "configChanged" event.
77	*/
78
79	oMenu.getItem(0).cfg.setProperty("selected", true);
80	oMenu.getItem(1).cfg.setProperty("disabled", true);
81	oMenu.getItem(2).cfg.setProperty("url", "http://www.yahoo.com");
82	oMenu.getItem(3).cfg.setProperty("checked", true);
	view plain \| print \| ?

/*
     "configChange" event handler for each MenuItem instance - used 
     to log info about the configuration property that was changed.
*/

function onMenuItemConfigChange(p_sType, p_aArgs) {

var sPropertyName = p_aArgs[0][0],
        sPropertyValue = p_aArgs[0][1];

YAHOO.log(("Index: " + this.index + ", " +
               "Group Index: " + this.groupIndex + ", " +
               "Custom Event Type: " + p_sType + ", " +                  
               "\"" + sPropertyName + "\" Property Set To: \"" 
               + sPropertyValue + "\""), "info", "example12");

}

/*
	Instantiate a Menu:  The first argument passed to the constructor
	is the id for the Menu element to be created, the second is an 
	object literal of configuration properties.
*/

var oMenu = new YAHOO.widget.Menu("basicmenu", { fixedcenter: true });

/*
     Subscribe to the Menu instance's "itemAdded" event in order to 
     subscribe to the "configChange" event handler of each MenuItem 
     instance's configuration object.
*/

oMenu.subscribe("itemAdded", function (p_sType, p_aArgs) {

var oMenuItem = p_aArgs[0];
   
    /*
         Subscribe to the "configChange" event handler of each MenuItem 
         instance's configuration object.
    */

oMenuItem.cfg.subscribe("configChanged", onMenuItemConfigChange);

});

/*
    Add items to the Menu instance by passing an array of strings 
    (each of which represents the "text" configuration property of a 
    YAHOO.widget.MenuItem instance) to the "addItems" method.
*/

oMenu.addItems([
    
        "Selected MenuItem",
        "Disabled MenuItem",
        "MenuItem With A URL",
        "Checked MenuItem"

]);

/*
    Since this Menu instance is built completely from script, call the 
    "render" method passing in the DOM element that it should be 
    appended to.
*/

oMenu.render("rendertarget");

/*
     Set a configuration property of each MenuItem to trigger the firing
     of its configuration object's "configChanged" event.
*/

oMenu.getItem(0).cfg.setProperty("selected", true);
oMenu.getItem(1).cfg.setProperty("disabled", true);
oMenu.getItem(2).cfg.setProperty("url", "http://www.yahoo.com");
oMenu.getItem(3).cfg.setProperty("checked", true);

Configuration for This Example

You can load the necessary JavaScript and CSS for this example from Yahoo's servers. Click here to load the YUI Dependency Configurator with all of this example's dependencies preconfigured.

YUI Library Examples: Menu Family: Setting Menu Configuration Properties At Runtime

Setting MenuItem configuration properties at runtime

Configuration for This Example

YUI Logger Output:

Logger Console

Menu Family Examples:

More Menu Family Resources: