Implement automatic load of composed/embedded automation trees

chrome/common/extensions/api/automation.idl

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // The <code>chrome.automation</code> API allows developers to access the
 // automation (accessibility) tree for the browser. The tree resembles the DOM
 // tree, but only exposes the <em>semantic</em> structure of a page. It can be
 // used to programmatically interact with a page by examining names, roles, and
 // states, listening for events, and performing actions on nodes.
 [nocompile] namespace automation {
@@ skipping 267 matching lines @@
 
     // Places focus on this node.
     static void focus();
 
     // Scrolls this node to make it visible.
     static void makeVisible();
 
     // Sets selection within a text field.
     static void setSelection(long startIndex, long endIndex);
 
+    // Whether this AutomationRootNode is loaded or not. If false, call load()
+    // to get the contents. Only applicable on webArea nodes.
+    boolean loaded;

[dmazzoni, 2014/10/29 06:53:30]

Should this be boolean? so that it can be undefined on other nodes?

+
+    // Load the accessibility tree for this AutomationRootNode. Only
+    // applicable on webArea nodes.
+    static void load(RootCallback callback);

[dmazzoni, 2014/10/29 06:53:30]

can a method be optional?

+
     // Adds a listener for the given event type and event phase.
     static void addEventListener(
         EventType eventType, AutomationListener listener, boolean capture);
 
     // Removes a listener for the given event type and event phase.
     static void removeEventListener(
         EventType eventType, AutomationListener listener, boolean capture);
   };
 
   // Called when the <code>AutomationRootNode</code> for the page is available.
   callback RootCallback = void(AutomationRootNode rootNode);
 
   // The root node of the automation tree for a single frame or desktop.
   // This may be:
   // <ul>
   //   <li> The desktop
   //   <li> The top frame of a page
   //   <li> A frame or iframe within a page
   // </ul>
   // Thus, an <code>AutomationRootNode</code> may be a descendant of one or
   // more <code>AutomationRootNode</code>s, and in turn have one or more
   // <code>AutomationRootNode</code>s in its descendants. Thus, the
   // <code>root</code> property of the <code>AutomationRootNode</code> will be
   // the immediate parent <code>AutomationRootNode</code>, or <code>null</code>
   // if this is the top-level <code>AutomationRootNode</code>.
   //
   // Extends $(ref:automation.AutomationNode).
   [nocompile, noinline_doc] dictionary AutomationRootNode {
-    // TODO(aboxhall/dtseng): implement loading. Kept separate to not include
-    // in generated docs.
-
-    // Whether this AutomationRootNode is loaded or not. If false, call load()
-    // to get the contents.
-    boolean loaded;
-
-    // Load the accessibility tree for this AutomationRootNode.
-    static void load(RootCallback callback);
   };
 
   interface Functions {
     // Get the automation tree for the tab with the given tabId, or the current
     // tab if no tabID is given, enabling automation if necessary. Returns a
     // tree with a placeholder root node; listen for the "loadComplete" event to
     // get a notification that the tree has fully loaded (the previous root node
     // reference will stop working at or before this point).
     [nocompile] static void getTree(optional long tabId, RootCallback callback);
 
     // Get the automation tree for the whole desktop which consists of all on
     // screen views. Note this API is currently only supported on Chrome OS.
     [nocompile] static void getDesktop(RootCallback callback);
   };
 };