class/Managed.Windows.Forms/System.Windows.Forms/ListViewGroupCollection.cs

   1 //
   2 //  ListViewGroupCollection.cs
   3 //
   4 // Permission is hereby granted, free of charge, to any person obtaining
   5 // a copy of this software and associated documentation files (the
   6 // "Software"), to deal in the Software without restriction, including
   7 // without limitation the rights to use, copy, modify, merge, publish,
   8 // distribute, sublicense, and/or sell copies of the Software, and to
   9 // permit persons to whom the Software is furnished to do so, subject to
  10 // the following conditions:
  11 //
  12 // The above copyright notice and this permission notice shall be
  13 // included in all copies or substantial portions of the Software.
  14 //
  15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  16 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  17 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  18 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  19 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  20 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  21 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  22 //
  23 // Copyright (c) 2006 Daniel Nauck
  24 //
  25 // Author:
  26 //      Daniel Nauck    (dna(at)mono-project(dot)de)
  27 //      Carlos Alberto Cortez <calberto.cortez@gmail.com>
  28
  29 #if NET_2_0
  30
  31 using System;
  32 using System.Text;
  33 using System.Collections;
  34 using System.Collections.Generic;
  35 using System.ComponentModel;
  36
  37 namespace System.Windows.Forms
  38 {
  39         [ListBindable(false)]
  40         public class ListViewGroupCollection : IList, ICollection, IEnumerable
  41         {
  42                 private List<ListViewGroup> list = null;
  43                 private ListView list_view_owner = null;
  44                 private ListViewGroup default_group;
  45
  46                 ListViewGroupCollection()
  47                 {
  48                         list = new List<ListViewGroup> ();
  49
  50                         default_group = new ListViewGroup ("Default Group");
  51                         default_group.IsDefault = true;
  52                 }
  53
  54                 internal ListViewGroupCollection(ListView listViewOwner) : this()
  55                 {
  56                         list_view_owner = listViewOwner;
  57                         default_group.ListViewOwner = listViewOwner;
  58                 }
  59
  60                 internal ListView ListViewOwner {
  61                         get { return list_view_owner; }
  62                         set { list_view_owner = value; }
  63                 }
  64
  65                 #region IEnumerable Members
  66
  67                 public IEnumerator GetEnumerator()
  68                 {
  69                         return list.GetEnumerator();
  70                 }
  71
  72                 #endregion
  73
  74                 #region ICollection Members
  75
  76                 public void CopyTo(Array array, int index)
  77                 {
  78                         ((ICollection) list).CopyTo(array, index);
  79                 }
  80
  81                 public int Count {
  82                         get { return list.Count; }
  83                 }
  84
  85                 bool ICollection.IsSynchronized {
  86                         get { return true; }
  87                 }
  88
  89                 object ICollection.SyncRoot {
  90                         get { return this; }
  91                 }
  92
  93                 #endregion
  94
  95                 #region IList Members
  96
  97                 int IList.Add(object value)
  98                 {
  99                         if (!(value is ListViewGroup))
 100                                 throw new ArgumentException("value");
 101
 102                         return Add((ListViewGroup)value);
 103                 }
 104
 105                 public int Add(ListViewGroup group)
 106                 {
 107                         if (Contains(group))
 108                                 return -1;
 109
 110                         AddGroup (group);
 111
 112                         if (this.list_view_owner != null)
 113                                 list_view_owner.Redraw(true);
 114
 115                         return list.Count - 1;
 116                 }
 117
 118                 public ListViewGroup Add(string key, string headerText)
 119                 {
 120                         ListViewGroup newGroup = new ListViewGroup(key, headerText);
 121                         Add(newGroup);
 122
 123                         return newGroup;
 124                 }
 125
 126                 public void Clear()
 127                 {
 128                         foreach (ListViewGroup group in list)
 129                                 group.ListViewOwner = null;
 130
 131                         list.Clear ();
 132
 133                         if(list_view_owner != null)
 134                                 list_view_owner.Redraw(true);
 135                 }
 136
 137                 bool IList.Contains(object value)
 138                 {
 139                         if (value is ListViewGroup)
 140                                 return Contains((ListViewGroup)value);
 141                         else
 142                                 return false;
 143                 }
 144
 145                 public bool Contains(ListViewGroup value)
 146                 {
 147                         return list.Contains(value);
 148                 }
 149
 150                 int IList.IndexOf(object value)
 151                 {
 152                         if (value is ListViewGroup)
 153                                 return IndexOf((ListViewGroup)value);
 154                         else
 155                                 return -1;
 156                 }
 157
 158                 public int IndexOf(ListViewGroup value)
 159                 {
 160                         return list.IndexOf(value);
 161                 }
 162
 163                 void IList.Insert(int index, object value)
 164                 {
 165                         if (value is ListViewGroup)
 166                                 Insert(index, (ListViewGroup)value);
 167                 }
 168
 169                 public void Insert(int index, ListViewGroup group)
 170                 {
 171                         if (Contains(group))
 172                                 return;
 173
 174                         CheckListViewItemsInGroup(group);
 175                         group.ListViewOwner = list_view_owner;
 176                         list.Insert(index, group);
 177
 178                         if(list_view_owner != null)
 179                                 list_view_owner.Redraw(true);
 180                 }
 181
 182                 bool IList.IsFixedSize {
 183                         get { return false; }
 184                 }
 185
 186                 bool IList.IsReadOnly {
 187                         get { return false; }
 188                 }
 189
 190                 void IList.Remove(object value)
 191                 {
 192                         Remove((ListViewGroup)value);
 193                 }
 194
 195                 public void Remove (ListViewGroup group)
 196                 {
 197                         int idx = list.IndexOf (group);
 198                         if (idx != -1)
 199                                 RemoveAt (idx);
 200                 }
 201
 202                 public void RemoveAt (int index)
 203                 {
 204                         if (list.Count <= index || index < 0)
 205                                 return;
 206
 207                         ListViewGroup group = list [index];
 208                         group.ListViewOwner = null;
 209
 210                         list.RemoveAt (index);
 211                         if (list_view_owner != null)
 212                                 list_view_owner.Redraw (true);
 213                 }
 214
 215                 object IList.this[int index] {
 216                         get { return this[index]; }
 217                         set {
 218                                 if (value is ListViewGroup)
 219                                         this[index] = (ListViewGroup)value;
 220                         }
 221                 }
 222
 223                 public ListViewGroup this[int index] {
 224                         get {
 225                                 if (list.Count <= index || index < 0)
 226                                         throw new ArgumentOutOfRangeException("index");
 227
 228                                 return list [index];
 229                         }
 230                         set {
 231                                 if (list.Count <= index || index < 0)
 232                                         throw new ArgumentOutOfRangeException("index");
 233
 234                                 if (Contains (value))
 235                                         return;
 236
 237                                 if (value != null)
 238                                         CheckListViewItemsInGroup (value);
 239
 240                                 list [index] = value;
 241
 242                                 if (list_view_owner != null)
 243                                         list_view_owner.Redraw(true);
 244                         }
 245                 }
 246
 247                 public ListViewGroup this [string key] {
 248                         get {
 249                                 int idx = IndexOfKey (key);
 250                                 if (idx != -1)
 251                                         return this [idx];
 252
 253                                 return null;
 254                         }
 255                         set {
 256                                 int idx = IndexOfKey (key);
 257                                 if (idx == -1)
 258                                         return;
 259
 260                                 this [idx] = value;
 261                         }
 262                 }
 263
 264                 int IndexOfKey (string key)
 265                 {
 266                         for (int i = 0; i < list.Count; i++)
 267                                 if (list [i].Name == key)
 268                                         return i;
 269
 270                         return -1;
 271                 }
 272
 273                 #endregion
 274
 275                 public void AddRange(ListViewGroup[] groups)
 276                 {
 277                         foreach (ListViewGroup group in groups)
 278                                 AddGroup (group);
 279
 280                         if (list_view_owner != null)
 281                                 list_view_owner.Redraw (true);
 282                 }
 283
 284                 public void AddRange(ListViewGroupCollection groups)
 285                 {
 286                         foreach (ListViewGroup group in groups)
 287                                 AddGroup (group);
 288
 289                         if (list_view_owner != null)
 290                                 list_view_owner.Redraw (true);
 291                 }
 292
 293                 internal ListViewGroup GetInternalGroup (int index)
 294                 {
 295                         if (index == 0)
 296                                 return default_group;
 297
 298                         return list [index - 1];
 299                 }
 300
 301                 internal int InternalCount {
 302                         get {
 303                                 return list.Count + 1;
 304                         }
 305                 }
 306
 307                 internal ListViewGroup DefaultGroup {
 308                         get {
 309                                 return default_group;
 310                         }
 311                 }
 312
 313                 void AddGroup (ListViewGroup group)
 314                 {
 315                         if (Contains (group))
 316                                 return;
 317
 318                         CheckListViewItemsInGroup (group);
 319                         group.ListViewOwner = list_view_owner;
 320                         list.Add (group);
 321                 }
 322
 323                 private void CheckListViewItemsInGroup(ListViewGroup value)
 324                 {
 325                         //check for correct ListView
 326                         foreach (ListViewItem item in value.Items)
 327                         {
 328                                 if (item.ListView != null && item.ListView != this.list_view_owner)
 329                                         throw new ArgumentException("ListViewItem belongs to a ListView control other than the one that owns this ListViewGroupCollection.",
 330                                                 "ListViewGroup");
 331                         }
 332                 }
 333         }
 334 }
 335 #endif