source: trunk/sources/HeuristicLab.Parameters.Views/3.3/ValueParameterView.cs @ 2948

Last change on this file since 2948 was 2948, checked in by swagner, 12 years ago

Operator architecture refactoring (#95)

  • implemented reviewers' comments on version r2917.
File size: 5.9 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2010 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
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
22using System;
23using System.Windows.Forms;
24using HeuristicLab.Core;
25using HeuristicLab.Core.Views;
26using HeuristicLab.MainForm;
27
28namespace HeuristicLab.Parameters.Views {
29  /// <summary>
30  /// The visual representation of a <see cref="Parameter"/>.
31  /// </summary>
32  [View("ValueParameter View")]
33  [Content(typeof(OptionalValueParameter<>), true)]
34  [Content(typeof(ValueParameter<>), true)]
35  [Content(typeof(IValueParameter<>), false)]
36  public partial class ValueParameterView<T> : ParameterView where T : class, IItem {
37    protected TypeSelectorDialog typeSelectorDialog;
38
39    /// <summary>
40    /// Gets or sets the variable to represent visually.
41    /// </summary>
42    /// <remarks>Uses property <see cref="ViewBase.Item"/> of base class <see cref="ViewBase"/>.
43    /// No own data storage present.</remarks>
44    public new IValueParameter<T> Content {
45      get { return (IValueParameter<T>)base.Content; }
46      set { base.Content = value; }
47    }
48
49    /// <summary>
50    /// Initializes a new instance of <see cref="VariableView"/> with caption "Variable".
51    /// </summary>
52    public ValueParameterView() {
53      InitializeComponent();
54      Caption = "ValueParameter";
55    }
56    /// <summary>
57    /// Initializes a new instance of <see cref="VariableView"/> with the given <paramref name="variable"/>.
58    /// </summary>
59    /// <remarks>Calls <see cref="VariableView()"/>.</remarks>
60    /// <param name="variable">The variable to represent visually.</param>
61    public ValueParameterView(IValueParameter<T> content)
62      : this() {
63      Content = content;
64    }
65
66    /// <summary>
67    /// Removes the eventhandlers from the underlying <see cref="IVariable"/>.
68    /// </summary>
69    /// <remarks>Calls <see cref="ViewBase.RemoveItemEvents"/> of base class <see cref="ViewBase"/>.</remarks>
70    protected override void DeregisterContentEvents() {
71      Content.ValueChanged -= new EventHandler(Content_ValueChanged);
72      base.DeregisterContentEvents();
73    }
74
75    /// <summary>
76    /// Adds eventhandlers to the underlying <see cref="IVariable"/>.
77    /// </summary>
78    /// <remarks>Calls <see cref="ViewBase.AddItemEvents"/> of base class <see cref="ViewBase"/>.</remarks>
79    protected override void RegisterContentEvents() {
80      base.RegisterContentEvents();
81      Content.ValueChanged += new EventHandler(Content_ValueChanged);
82    }
83
84    protected override void OnContentChanged() {
85      base.OnContentChanged();
86      if (Content == null) {
87        Caption = "ValueParameter";
88        setValueButton.Enabled = false;
89        clearValueButton.Visible = true;
90        clearValueButton.Enabled = false;
91        viewHost.Content = null;
92        valueGroupBox.Enabled = false;
93      } else {
94        Caption = Content.Name + " (" + Content.GetType().Name + ")";
95        setValueButton.Enabled = true;
96        clearValueButton.Visible = !(Content is ValueParameter<T>);
97        clearValueButton.Enabled = Content.Value != null;
98        valueGroupBox.Enabled = true;
99        viewHost.Content = Content.Value;
100      }
101    }
102
103    protected virtual void Content_ValueChanged(object sender, EventArgs e) {
104      if (InvokeRequired)
105        Invoke(new EventHandler(Content_ValueChanged), sender, e);
106      else {
107        clearValueButton.Enabled = Content.Value != null;
108        viewHost.Content = Content.Value;
109      }
110    }
111
112    protected virtual void changeValueButton_Click(object sender, EventArgs e) {
113      if (typeSelectorDialog == null) {
114        typeSelectorDialog = new TypeSelectorDialog();
115        typeSelectorDialog.Caption = "Select Value";
116        typeSelectorDialog.TypeSelector.Configure(Content.DataType, false, false);
117      }
118      if (typeSelectorDialog.ShowDialog(this) == DialogResult.OK)
119        Content.Value = (T)typeSelectorDialog.TypeSelector.CreateInstanceOfSelectedType();
120    }
121    protected virtual void setValueButton_Click(object sender, EventArgs e) {
122      Content.Value = null;
123    }
124    protected virtual void valuePanel_DragEnterOver(object sender, DragEventArgs e) {
125      e.Effect = DragDropEffects.None;
126      Type type = e.Data.GetData("Type") as Type;
127      if ((type != null) && (Content.DataType.IsAssignableFrom(type))) {
128        if ((e.KeyState & 8) == 8) e.Effect = DragDropEffects.Copy;  // CTRL key
129        else if ((e.KeyState & 4) == 4) e.Effect = DragDropEffects.Move;  // SHIFT key
130        else if ((e.AllowedEffect & DragDropEffects.Link) == DragDropEffects.Link) e.Effect = DragDropEffects.Link;
131        else if ((e.AllowedEffect & DragDropEffects.Copy) == DragDropEffects.Copy) e.Effect = DragDropEffects.Copy;
132        else if ((e.AllowedEffect & DragDropEffects.Move) == DragDropEffects.Move) e.Effect = DragDropEffects.Move;
133      }
134    }
135    protected virtual void valuePanel_DragDrop(object sender, DragEventArgs e) {
136      if (e.Effect != DragDropEffects.None) {
137        T value = e.Data.GetData("Value") as T;
138        if ((e.Effect & DragDropEffects.Copy) == DragDropEffects.Copy) value = (T)value.Clone();
139        Content.Value = value;
140      }
141    }
142  }
143}
Note: See TracBrowser for help on using the repository browser.