dom/webidl/TreeColumns.webidl

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 [ChromeOnly,
   6  Exposed=Window]
   7 interface TreeColumns {
   8   /**
   9    * The tree widget for these columns.
  10    */
  11   readonly attribute XULTreeElement? tree;
  12
  13   /**
  14    * The number of columns.
  15    */
  16   readonly attribute unsigned long count;
  17
  18   /**
  19    * An alias for count (for the benefit of scripts which treat this as an
  20    * array).
  21    */
  22   readonly attribute unsigned long length;
  23
  24   /**
  25    * Get the first/last column.
  26    */
  27   TreeColumn? getFirstColumn();
  28   TreeColumn? getLastColumn();
  29
  30   /**
  31    * Attribute based column getters.
  32    */
  33   TreeColumn? getPrimaryColumn();
  34   TreeColumn? getSortedColumn();
  35   TreeColumn? getKeyColumn();
  36
  37   /**
  38    * Get the column for the given element.
  39    */
  40   TreeColumn? getColumnFor(Element? element);
  41
  42   /**
  43    * Parametric column getters.
  44    */
  45   getter TreeColumn? getNamedColumn(DOMString name);
  46   getter TreeColumn? getColumnAt(unsigned long index);
  47
  48   /**
  49    * This method is called whenever a treecol is added or removed and
  50    * the column cache needs to be rebuilt.
  51    */
  52   undefined invalidateColumns();
  53 };