[2653] | 1 | #region License Information
|
---|
| 2 | /* HeuristicLab
|
---|
[2790] | 3 | * Copyright (C) 2002-2010 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
|
---|
[2653] | 4 | *
|
---|
| 5 | * This file is part of HeuristicLab.
|
---|
| 6 | *
|
---|
| 7 | * HeuristicLab is free software: you can redistribute it and/or modify
|
---|
| 8 | * it under the terms of the GNU General Public License as published by
|
---|
| 9 | * the Free Software Foundation, either version 3 of the License, or
|
---|
| 10 | * (at your option) any later version.
|
---|
| 11 | *
|
---|
| 12 | * HeuristicLab is distributed in the hope that it will be useful,
|
---|
| 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
| 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
---|
| 15 | * GNU General Public License for more details.
|
---|
| 16 | *
|
---|
| 17 | * You should have received a copy of the GNU General Public License
|
---|
| 18 | * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
|
---|
| 19 | */
|
---|
| 20 | #endregion
|
---|
| 21 |
|
---|
| 22 | using System;
|
---|
[2830] | 23 | using System.Linq;
|
---|
[2653] | 24 | using System.Collections.Generic;
|
---|
[2790] | 25 | using System.Drawing;
|
---|
[2653] | 26 | using HeuristicLab.Collections;
|
---|
| 27 | using HeuristicLab.Common;
|
---|
[2790] | 28 | using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
|
---|
[2653] | 29 |
|
---|
| 30 | namespace HeuristicLab.Core {
|
---|
[2790] | 31 | [Item("NamedItemCollection<T>", "Represents a collection of named items.")]
|
---|
| 32 | public class NamedItemCollection<T> : ObservableKeyedCollection<string, T>, IItem where T : class, INamedItem {
|
---|
| 33 | public virtual string ItemName {
|
---|
| 34 | get { return ItemAttribute.GetName(this.GetType()); }
|
---|
| 35 | }
|
---|
| 36 | public virtual string ItemDescription {
|
---|
| 37 | get { return ItemAttribute.GetDescription(this.GetType()); }
|
---|
| 38 | }
|
---|
| 39 | public virtual Image ItemImage {
|
---|
| 40 | get { return HeuristicLab.Common.Resources.VS2008ImageLibrary.Class; }
|
---|
| 41 | }
|
---|
| 42 |
|
---|
[2653] | 43 | [Storable(Name = "RestoreEvents")]
|
---|
| 44 | private object RestoreEvents {
|
---|
| 45 | get { return null; }
|
---|
[2830] | 46 | set { RegisterItemEvents(this); }
|
---|
[2653] | 47 | }
|
---|
| 48 |
|
---|
| 49 | public NamedItemCollection() : base() { }
|
---|
| 50 | public NamedItemCollection(int capacity) : base(capacity) { }
|
---|
[2830] | 51 | public NamedItemCollection(IEnumerable<T> collection) : base(collection) {
|
---|
| 52 | RegisterItemEvents(this);
|
---|
| 53 | }
|
---|
[2653] | 54 |
|
---|
| 55 | public object Clone() {
|
---|
| 56 | return Clone(new Cloner());
|
---|
| 57 | }
|
---|
[2830] | 58 | public virtual IDeepCloneable Clone(Cloner cloner) {
|
---|
| 59 | NamedItemCollection<T> clone = (NamedItemCollection<T>)Activator.CreateInstance(this.GetType(), this.Select(x => (T)cloner.Clone(x)));
|
---|
[2653] | 60 | cloner.RegisterClonedObject(this, clone);
|
---|
| 61 | return clone;
|
---|
| 62 | }
|
---|
| 63 |
|
---|
[2790] | 64 | public override string ToString() {
|
---|
| 65 | return ItemName;
|
---|
| 66 | }
|
---|
| 67 |
|
---|
[2653] | 68 | public event ChangedEventHandler Changed;
|
---|
| 69 | protected void OnChanged() {
|
---|
| 70 | OnChanged(new ChangedEventArgs());
|
---|
| 71 | }
|
---|
| 72 | protected virtual void OnChanged(ChangedEventArgs e) {
|
---|
| 73 | if ((e.RegisterChangedObject(this)) && (Changed != null))
|
---|
| 74 | Changed(this, e);
|
---|
| 75 | }
|
---|
| 76 |
|
---|
| 77 | protected override string GetKeyForItem(T item) {
|
---|
| 78 | return item.Name;
|
---|
| 79 | }
|
---|
| 80 |
|
---|
| 81 | protected override void OnItemsAdded(IEnumerable<T> items) {
|
---|
[2830] | 82 | RegisterItemEvents(items);
|
---|
[2653] | 83 | base.OnItemsAdded(items);
|
---|
| 84 | }
|
---|
| 85 | protected override void OnItemsRemoved(IEnumerable<T> items) {
|
---|
[2830] | 86 | DeregisterItemEvents(items);
|
---|
[2653] | 87 | base.OnItemsRemoved(items);
|
---|
| 88 | }
|
---|
| 89 | #region NOTE
|
---|
| 90 | // NOTE: OnItemsReplaced is not overridden as ItemsReplaced is only fired
|
---|
[2676] | 91 | // by ObservableKeyedCollection when the key of an item has changed. The items stays
|
---|
[2653] | 92 | // in the collection and therefore the NameChanging, NameChanged and Changed event handler
|
---|
| 93 | // do not have to be removed and added again.
|
---|
| 94 | #endregion
|
---|
| 95 | protected override void OnCollectionReset(IEnumerable<T> items, IEnumerable<T> oldItems) {
|
---|
[2830] | 96 | DeregisterItemEvents(oldItems);
|
---|
| 97 | RegisterItemEvents(items);
|
---|
| 98 | base.OnCollectionReset(items, oldItems);
|
---|
| 99 | }
|
---|
| 100 | protected override void OnPropertyChanged(string propertyName) {
|
---|
| 101 | base.OnPropertyChanged(propertyName);
|
---|
| 102 | OnChanged();
|
---|
| 103 | }
|
---|
| 104 |
|
---|
| 105 | private void RegisterItemEvents(IEnumerable<T> items) {
|
---|
[2653] | 106 | foreach (T item in items) {
|
---|
| 107 | item.NameChanging += new EventHandler<CancelEventArgs<string>>(Item_NameChanging);
|
---|
| 108 | item.NameChanged += new EventHandler(Item_NameChanged);
|
---|
| 109 | item.Changed += new ChangedEventHandler(Item_Changed);
|
---|
| 110 | }
|
---|
| 111 | }
|
---|
[2830] | 112 | private void DeregisterItemEvents(IEnumerable<T> items) {
|
---|
| 113 | foreach (T item in items) {
|
---|
| 114 | item.NameChanging -= new EventHandler<CancelEventArgs<string>>(Item_NameChanging);
|
---|
| 115 | item.NameChanged -= new EventHandler(Item_NameChanged);
|
---|
| 116 | item.Changed -= new ChangedEventHandler(Item_Changed);
|
---|
| 117 | }
|
---|
[2653] | 118 | }
|
---|
| 119 |
|
---|
| 120 | private void Item_NameChanging(object sender, CancelEventArgs<string> e) {
|
---|
[2669] | 121 | e.Cancel = e.Cancel || this.ContainsKey(e.Value);
|
---|
[2653] | 122 | }
|
---|
| 123 | private void Item_NameChanged(object sender, EventArgs e) {
|
---|
| 124 | T item = (T)sender;
|
---|
| 125 | UpdateItemKey(item);
|
---|
| 126 | }
|
---|
| 127 | private void Item_Changed(object sender, ChangedEventArgs e) {
|
---|
| 128 | OnChanged(e);
|
---|
| 129 | }
|
---|
| 130 | }
|
---|
| 131 | }
|
---|