mcs/class/Managed.Windows.Forms/System.Windows.Forms/TreeNodeCollection.cs

   1 // Permission is hereby granted, free of charge, to any person obtaining
   2 // a copy of this software and associated documentation files (the
   3 // "Software"), to deal in the Software without restriction, including
   4 // without limitation the rights to use, copy, modify, merge, publish,
   5 // distribute, sublicense, and/or sell copies of the Software, and to
   6 // permit persons to whom the Software is furnished to do so, subject to
   7 // the following conditions:
   8 //
   9 // The above copyright notice and this permission notice shall be
  10 // included in all copies or substantial portions of the Software.
  11 //
  12 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  13 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  14 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  15 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  16 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  17 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  18 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  19 //
  20 // Copyright (c) 2004-2006 Novell, Inc.
  21 //
  22 // Authors:
  23 //      Jackson Harper (jackson@ximian.com)
  24
  25
  26 using System;
  27 using System.Collections;
  28 using System.ComponentModel;
  29 using System.Globalization;
  30
  31 #if NET_2_0
  32 using System.Collections.Generic;
  33 #endif
  34
  35 namespace System.Windows.Forms {
  36         [Editor("System.Windows.Forms.Design.TreeNodeCollectionEditor, " + Consts.AssemblySystem_Design, typeof(System.Drawing.Design.UITypeEditor))]
  37         public class TreeNodeCollection : IList, ICollection, IEnumerable {
  38
  39                 private static readonly int OrigSize = 50;
  40
  41                 private TreeNode owner;
  42                 private int count;
  43                 private TreeNode [] nodes;
  44
  45                 private TreeNodeCollection ()
  46                 {
  47                 }
  48
  49                 internal TreeNodeCollection (TreeNode owner)
  50                 {
  51                         this.owner = owner;
  52                         nodes = new TreeNode [OrigSize];
  53                 }
  54
  55 #if !NET_2_0
  56                 [EditorBrowsable(EditorBrowsableState.Advanced)]
  57 #endif
  58                 [Browsable(false)]
  59                 public int Count {
  60                         get { return count; }
  61                 }
  62
  63                 public bool IsReadOnly {
  64                         get { return false; }
  65                 }
  66
  67                 bool ICollection.IsSynchronized {
  68                         get { return false; }
  69                 }
  70
  71                 object ICollection.SyncRoot {
  72                         get { return this; }
  73                 }
  74
  75                 bool IList.IsFixedSize {
  76                         get { return false; }
  77                 }
  78
  79                 object IList.this [int index] {
  80                         get {
  81                                 return this [index];
  82                         }
  83                         set {
  84                                 if (!(value is TreeNode))
  85                                         throw new ArgumentException ("Parameter must be of type TreeNode.", "value");
  86                                 this [index] = (TreeNode) value;
  87                         }
  88                 }
  89
  90                 public virtual TreeNode this [int index] {
  91                         get {
  92                                 if (index < 0 || index >= Count)
  93                                         throw new ArgumentOutOfRangeException ("index");
  94                                 return nodes [index];
  95                         }
  96                         set {
  97                                 if (index < 0 || index >= Count)
  98                                         throw new ArgumentOutOfRangeException ("index");
  99                                 SetupNode (value);
 100                                 nodes [index] = value;
 101                         }
 102                 }
 103
 104 #if NET_2_0
 105                 public virtual TreeNode this [string key] {
 106                         get {
 107                                 for (int i = 0; i < count; i++)
 108                                         if (string.Compare (key, nodes[i].Name, true) == 0)
 109                                                 return nodes[i];
 110
 111                                 return null;
 112                         }
 113                 }
 114 #endif
 115
 116                 public virtual TreeNode Add (string text)
 117                 {
 118                         TreeNode res = new TreeNode (text);
 119                         Add (res);
 120                         return res;
 121                 }
 122
 123                 public virtual int Add (TreeNode node)
 124                 {
 125                         if (node == null)
 126                                 throw new ArgumentNullException("node");
 127
 128                         int res;
 129                         TreeView tree_view = null;
 130
 131                         if (owner != null)
 132                                 tree_view = owner.TreeView;
 133
 134                         if (tree_view != null && tree_view.Sorted) {
 135                                 res = AddSorted (node);
 136                         } else {
 137                                 if (count >= nodes.Length)
 138                                         Grow ();
 139                                 nodes[count] = node;
 140                                 res = count;
 141                                 count++;
 142                         }
 143
 144                         SetupNode (node);
 145 #if NET_2_0
 146                         // UIA Framework Event: Collection Changed
 147                         if (tree_view != null)
 148                                 tree_view.OnUIACollectionChanged (owner, new CollectionChangeEventArgs (CollectionChangeAction.Add, node));
 149 #endif
 150                         return res;
 151                 }
 152
 153 #if NET_2_0
 154                 public virtual TreeNode Add (string key, string text)
 155                 {
 156                         TreeNode node = new TreeNode (text);
 157                         node.Name = key;
 158                         Add (node);
 159                         return node;
 160                 }
 161
 162                 public virtual TreeNode Add (string key, string text, int imageIndex)
 163                 {
 164                         TreeNode node = Add (key, text);
 165                         node.ImageIndex = imageIndex;
 166                         return node;
 167                 }
 168
 169                 public virtual TreeNode Add (string key, string text, string imageKey)
 170                 {
 171                         TreeNode node = Add (key, text);
 172                         node.ImageKey = imageKey;
 173                         return node;
 174
 175                 }
 176
 177                 public virtual TreeNode Add (string key, string text, int imageIndex, int selectedImageIndex)
 178                 {
 179                         TreeNode node = Add (key, text);
 180                         node.ImageIndex = imageIndex;
 181                         node.SelectedImageIndex = selectedImageIndex;
 182                         return node;
 183                 }
 184
 185                 public virtual TreeNode Add (string key, string text, string imageKey, string selectedImageKey)
 186                 {
 187                         TreeNode node = Add (key, text);
 188                         node.ImageKey = imageKey;
 189                         node.SelectedImageKey = selectedImageKey;
 190                         return node;
 191                 }
 192
 193
 194 #endif
 195
 196                 public virtual void AddRange (TreeNode [] nodes)
 197                 {
 198                         if (nodes == null)
 199                                 throw new ArgumentNullException("nodes");
 200
 201                         // We can't just use Array.Copy because the nodes also
 202                         // need to have some properties set when they are added.
 203                         for (int i = 0; i < nodes.Length; i++)
 204                                 Add (nodes [i]);
 205                 }
 206
 207                 public virtual void Clear ()
 208                 {
 209                         while (count > 0)
 210                                 RemoveAt (0, false);
 211
 212                         Array.Clear (nodes, 0, count);
 213                         count = 0;
 214
 215                         TreeView tree_view = null;
 216                         if (owner != null) {
 217                                 tree_view = owner.TreeView;
 218                                 if (tree_view != null) {
 219                                         tree_view.UpdateBelow (owner);
 220                                         tree_view.RecalculateVisibleOrder (owner);
 221                                         tree_view.UpdateScrollBars (false);
 222                                 }
 223                         }
 224                 }
 225
 226                 public bool Contains (TreeNode node)
 227                 {
 228                         return Array.IndexOf (nodes, node, 0, count) != -1;
 229                 }
 230 #if NET_2_0
 231                 public virtual bool ContainsKey (string key)
 232                 {
 233                         for (int i = 0; i < count; i++) {
 234                                 if (string.Compare (nodes [i].Name, key, true, CultureInfo.InvariantCulture) == 0)
 235                                         return true;
 236                         }
 237                         return false;
 238                 }
 239 #endif
 240
 241                 public void CopyTo (Array dest, int index)
 242                 {
 243                         Array.Copy (nodes, index, dest, index, count);
 244                 }
 245
 246                 public IEnumerator GetEnumerator ()
 247                 {
 248                         return new TreeNodeEnumerator (this);
 249                 }
 250
 251                 public int IndexOf (TreeNode node)
 252                 {
 253                         return Array.IndexOf (nodes, node);
 254                 }
 255
 256 #if NET_2_0
 257                 public virtual int IndexOfKey (string key)
 258                 {
 259                         for (int i = 0; i < count; i++) {
 260                                 if (string.Compare (nodes [i].Name, key, true, CultureInfo.InvariantCulture) == 0)
 261                                         return i;
 262                         }
 263                         return -1;
 264                 }
 265
 266                 public virtual TreeNode Insert (int index, string text)
 267                 {
 268                         TreeNode node = new TreeNode (text);
 269                         Insert (index, node);
 270                         return node;
 271                 }
 272 #endif
 273
 274                 public virtual void Insert (int index, TreeNode node)
 275                 {
 276                         if (count >= nodes.Length)
 277                                 Grow ();
 278
 279                         Array.Copy (nodes, index, nodes, index + 1, count - index);
 280                         nodes [index] = node;
 281                         count++;
 282
 283                         SetupNode (node);
 284                 }
 285
 286 #if NET_2_0
 287                 public virtual TreeNode Insert (int index, string key, string text)
 288                 {
 289                         TreeNode node = new TreeNode (text);
 290                         node.Name = key;
 291                         Insert (index, node);
 292                         return node;
 293                 }
 294
 295                 public virtual TreeNode Insert (int index, string key, string text, int imageIndex)
 296                 {
 297                         TreeNode node = new TreeNode (text);
 298                         node.Name = key;
 299                         node.ImageIndex = imageIndex;
 300                         Insert (index, node);
 301                         return node;
 302                 }
 303
 304                 public virtual TreeNode Insert (int index, string key, string text, string imageKey)
 305                 {
 306                         TreeNode node = new TreeNode (text);
 307                         node.Name = key;
 308                         node.ImageKey = imageKey;
 309                         Insert (index, node);
 310                         return node;
 311                 }
 312
 313                 public virtual TreeNode Insert (int index, string key, string text, int imageIndex, int selectedImageIndex)
 314                 {
 315                         TreeNode node = new TreeNode (text, imageIndex, selectedImageIndex);
 316                         node.Name = key;
 317                         Insert (index, node);
 318                         return node;
 319                 }
 320
 321                 public virtual TreeNode Insert (int index, string key, string text, string imageKey, string selectedImageKey)
 322                 {
 323                         TreeNode node = new TreeNode (text);
 324                         node.Name = key;
 325                         node.ImageKey = imageKey;
 326                         node.SelectedImageKey = selectedImageKey;
 327                         Insert (index, node);
 328                         return node;
 329                 }
 330 #endif
 331
 332                 public void Remove (TreeNode node)
 333                 {
 334                         if (node == null)
 335                                 throw new NullReferenceException ();
 336
 337                         int index = IndexOf (node);
 338                         if (index != -1)
 339                                 RemoveAt (index);
 340 #if ONLY_1_1
 341                         else
 342                                 throw new NullReferenceException ();
 343 #endif
 344                 }
 345
 346                 public virtual void RemoveAt (int index)
 347                 {
 348                         RemoveAt (index, true);
 349                 }
 350
 351                 private void RemoveAt (int index, bool update)
 352                 {
 353                         TreeNode removed = nodes [index];
 354                         TreeNode prev = GetPrevNode (removed);
 355                         TreeNode new_selected = null;
 356                         bool re_set_selected = false;
 357                         bool visible = removed.IsVisible;
 358
 359                         TreeView tree_view = null;
 360                         if (owner != null)
 361                                 tree_view = owner.TreeView;
 362
 363                         if (tree_view != null) {
 364                                 tree_view.RecalculateVisibleOrder (prev);
 365
 366                                 if (removed == tree_view.SelectedNode) {
 367                                         re_set_selected = true;
 368                                         OpenTreeNodeEnumerator oe = new OpenTreeNodeEnumerator (removed);
 369                                         if (oe.MoveNext () && oe.MoveNext ()) {
 370                                                 new_selected = oe.CurrentNode;
 371                                         } else {
 372                                                 oe = new OpenTreeNodeEnumerator (removed);
 373                                                 oe.MovePrevious ();
 374                                                 new_selected = oe.CurrentNode == removed ? null : oe.CurrentNode;
 375                                         }
 376                                 }
 377                         }
 378
 379                         Array.Copy (nodes, index + 1, nodes, index, count - index - 1);
 380                         count--;
 381
 382                         nodes[count] = null;
 383
 384                         if (nodes.Length > OrigSize && nodes.Length > (count * 2))
 385                                 Shrink ();
 386
 387                         if (tree_view != null && re_set_selected) {
 388                                 tree_view.SelectedNode = new_selected;
 389                         }
 390
 391                         TreeNode parent = removed.parent;
 392                         removed.parent = null;
 393
 394                         if (update && tree_view != null && visible) {
 395                                 tree_view.RecalculateVisibleOrder (prev);
 396                                 tree_view.UpdateScrollBars (false);
 397                                 tree_view.UpdateBelow (parent);
 398                         }
 399 #if NET_2_0
 400                         // UIA Framework Event: Collection Changed
 401                         if (tree_view != null)
 402                                 tree_view.OnUIACollectionChanged (owner, new CollectionChangeEventArgs (CollectionChangeAction.Remove, removed));
 403 #endif
 404                 }
 405
 406 #if NET_2_0
 407                 public virtual void RemoveByKey (string key)
 408                 {
 409                         TreeNode node = this[key];
 410
 411                         if (node != null)
 412                                 Remove (node);
 413                 }
 414 #endif
 415
 416                 private TreeNode GetPrevNode (TreeNode node)
 417                 {
 418                         OpenTreeNodeEnumerator one = new OpenTreeNodeEnumerator (node);
 419
 420                         if (one.MovePrevious () && one.MovePrevious ())
 421                                 return one.CurrentNode;
 422                         return null;
 423                 }
 424
 425                 private void SetupNode (TreeNode node)
 426                 {
 427                         // Remove it from any old parents
 428                         node.Remove ();
 429
 430                         node.parent = owner;
 431
 432                         TreeView tree_view = null;
 433                         if (owner != null)
 434                                 tree_view = owner.TreeView;
 435
 436                         if (tree_view != null) {
 437                                 bool sorted = false;
 438                                 if (tree_view.Sorted || tree_view.TreeViewNodeSorter != null) {
 439                                         owner.Nodes.Sort (tree_view.TreeViewNodeSorter);
 440                                         tree_view.sorted = sorted = true;
 441                                 }
 442
 443                                 // We may need to invalidate this entire node collection if sorted.
 444                                 TreeNode prev = sorted ? owner : GetPrevNode (node);
 445
 446                                 if (tree_view.IsHandleCreated && node.ArePreviousNodesExpanded)
 447                                         tree_view.RecalculateVisibleOrder (prev);
 448                                 if (owner == tree_view.root_node || node.Parent.IsVisible && node.Parent.IsExpanded)
 449                                         tree_view.UpdateScrollBars (false);
 450                         }
 451
 452                         if (owner != null && tree_view != null && (owner.IsExpanded || owner.IsRoot)) {
 453                                  tree_view.UpdateBelow (owner);
 454                         } else if (owner != null && tree_view != null) {
 455                                 tree_view.UpdateBelow (owner);
 456                         }
 457                 }
 458
 459                 int IList.Add (object node)
 460                 {
 461                         return Add ((TreeNode) node);
 462                 }
 463
 464                 bool IList.Contains (object node)
 465                 {
 466                         return Contains ((TreeNode) node);
 467                 }
 468
 469                 int IList.IndexOf (object node)
 470                 {
 471                         return IndexOf ((TreeNode) node);
 472                 }
 473
 474                 void IList.Insert (int index, object node)
 475                 {
 476                         Insert (index, (TreeNode) node);
 477                 }
 478
 479                 void IList.Remove (object node)
 480                 {
 481                         Remove ((TreeNode) node);
 482                 }
 483
 484                 private int AddSorted (TreeNode node)
 485                 {
 486                         if (count >= nodes.Length)
 487                                 Grow ();
 488
 489                         CompareInfo compare = Application.CurrentCulture.CompareInfo;
 490                         int pos = 0;
 491                         bool found = false;
 492                         for (int i = 0; i < count; i++) {
 493                                 pos = i;
 494                                 int comp = compare.Compare (node.Text, nodes [i].Text);
 495                                 if (comp < 0) {
 496                                         found = true;
 497                                         break;
 498                                 }
 499                         }
 500
 501                         // Stick it at the end
 502                         if (!found)
 503                                 pos = count;
 504
 505                         // Move the nodes up and adjust their indices
 506                         for (int i = count - 1; i >= pos; i--) {
 507                                 nodes [i + 1] = nodes [i];
 508                         }
 509                         count++;
 510                         nodes [pos] = node;
 511
 512                         return count;
 513                 }
 514
 515                 // Would be nice to do this without running through the collection twice
 516                 internal void Sort (IComparer sorter) {
 517                         Array.Sort (nodes, 0, count, sorter == null ? new TreeNodeComparer (Application.CurrentCulture.CompareInfo) : sorter);
 518
 519                         for (int i = 0; i < count; i++) {
 520                                 nodes [i].Nodes.Sort (sorter);
 521                         }
 522                 }
 523
 524                 private void Grow ()
 525                 {
 526                         TreeNode [] nn = new TreeNode [nodes.Length + 50];
 527                         Array.Copy (nodes, nn, nodes.Length);
 528                         nodes = nn;
 529                 }
 530
 531                 private void Shrink ()
 532                 {
 533                         int len = (count + 1 > OrigSize ? count + 1 : OrigSize);
 534                         TreeNode [] nn = new TreeNode [len];
 535                         Array.Copy (nodes, nn, count);
 536                         nodes = nn;
 537                 }
 538
 539 #if NET_2_0
 540                 public TreeNode[] Find (string key, bool searchAllChildren)
 541                 {
 542                         List<TreeNode> results = new List<TreeNode> (0);
 543                         Find (key, searchAllChildren, this, results);
 544
 545                         return results.ToArray ();
 546                 }
 547
 548                 private static void Find (string key, bool searchAllChildren, TreeNodeCollection nodes, List<TreeNode> results)
 549                 {
 550                         for (int i = 0; i < nodes.Count; i++) {
 551                                 TreeNode thisNode = nodes [i];
 552
 553                                 if (string.Compare (thisNode.Name, key, true, CultureInfo.InvariantCulture) == 0)
 554                                         results.Add (thisNode);
 555
 556                         }
 557                         // Need to match the Microsoft order.
 558
 559                         if (searchAllChildren){
 560                                 for (int i = 0; i < nodes.Count; i++){
 561                                         TreeNodeCollection childNodes = nodes [i].Nodes;
 562                                         if (childNodes.Count > 0) {
 563                                                 Find (key, searchAllChildren, childNodes, results);
 564                                         }
 565                                 }
 566                         }
 567                 }
 568 #endif
 569                 internal class TreeNodeEnumerator : IEnumerator {
 570
 571                         private TreeNodeCollection collection;
 572                         private int index = -1;
 573
 574                         public TreeNodeEnumerator (TreeNodeCollection collection)
 575                         {
 576                                 this.collection = collection;
 577                         }
 578
 579                         public object Current {
 580                                 get {
 581                                         if (index == -1)
 582                                                 return null;
 583                                         return collection [index];
 584                                 }
 585                         }
 586
 587                         public bool MoveNext ()
 588                         {
 589                                 if (index + 1 >= collection.Count)
 590                                         return false;
 591                                 index++;
 592                                 return true;
 593                         }
 594
 595                         public void Reset ()
 596                         {
 597                                 index = -1;
 598                         }
 599                 }
 600
 601                 private class TreeNodeComparer : IComparer {
 602
 603                         private CompareInfo compare;
 604
 605                         public TreeNodeComparer (CompareInfo compare)
 606                         {
 607                                 this.compare = compare;
 608                         }
 609
 610                         public int Compare (object x, object y)
 611                         {
 612                                 TreeNode l = (TreeNode) x;
 613                                 TreeNode r = (TreeNode) y;
 614                                 int res = compare.Compare (l.Text, r.Text);
 615
 616                                 return (res == 0 ? l.Index - r.Index : res);
 617                         }
 618                 }
 619         }
 620 }
 621