[TAPESTRY-1430] Add searchIds parameter to Shell component (passthrough to djConfig)

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 4.1.1
• Fix Version/s: 4.1.5
• Component/s: Core Components, Framework, JavaScript, tapestry-core, Web, XHR/dhtml/Ajax
• Assignee: Andreas Andreou
• Reporter: Greg Woolsey
• Created: 26/Apr/07 19:15
• Updated: 22/Sep/07 01:23
• Resolved: 22/Sep/07 01:23

Description

The djConfig parameter "searchIds" provides a way to have Dojo automatically parse a known set of page widgets without enabling full automatic parsing (slow for performance reasons).

When an application has a component defined around the Shell component to provide common functionality (navigation, etc) and look-and-feel consistency across pages in an application, it would be nice to be able to specify a fixed list of client IDs for Dojo to parse for widgets rather than needing to instantiate them individually via JavaScript in the component.

For example, I just tested a page where our menu widgets (a TreeV3 and related controllers and selectors) are all defined inside a wrapper DIV with an ID of "menuControls". Adding this DIV ID to djConfig.searchIds allowed the menu to be parsed from the markup without needing to traverse the entire page or manually configure all the widgets involved in a tree via JavaScript.

This is especially useful when a hybrid tree instantiation fails because of a bug in Dojo - creating a TreeV3 widget via JavaScript from an existing DOM node with child nodes specifying tree node dojoType values fails because the tree widget domNode hasn't been appended to the document yet at the time the child nodes try to register.