mcs/class/System.Windows.Forms/System.Windows.Forms.Design/ComponentEditorPage.cs

   1 //
   2 // System.Windows.Forms.Design.ComponentEditorPage.cs
   3 //
   4 // Author:
   5 //   Andreas Nahr (ClassDevelopment@A-SoftTech.com)
   6 //
   7
   8 using System.ComponentModel;
   9 using System.Drawing;
  10
  11 namespace System.Windows.Forms.Design
  12 {
  13         public abstract class ComponentEditorPage : Panel
  14         {
  15                 private bool commitOnDeactivate = false;
  16                 private IComponent component;
  17                 private bool firstActivate = true;
  18                 private Icon icon;
  19                 private int loading = 0;
  20                 private bool loadRequired = false;
  21                 private IComponentEditorPageSite pageSite;
  22
  23                 public ComponentEditorPage ()
  24                 {
  25                 }
  26
  27                 public bool CommitOnDeactivate {
  28                         get { return commitOnDeactivate; }
  29                         set { commitOnDeactivate = value; }
  30                 }
  31
  32                 protected IComponent Component {
  33                         get { return component; }
  34                         set { component = value; }
  35                 }
  36
  37                 [MonoTODO ("Find out what this does.")]
  38                 protected override CreateParams CreateParams {
  39                         get {
  40                                 throw new NotImplementedException ();
  41                         }
  42                 }
  43
  44                 protected bool FirstActivate {
  45                         get { return firstActivate; }
  46                         set { firstActivate = value; }
  47                 }
  48
  49                 public Icon Icon {
  50                         get { return icon; }
  51                         set { icon = value; }
  52                 }
  53
  54                 protected int Loading {
  55                         get { return loading; }
  56                         set { loading = value; }
  57                 }
  58
  59                 protected bool LoadRequired {
  60                         get { return loadRequired; }
  61                         set { loadRequired = value; }
  62                 }
  63
  64                 protected IComponentEditorPageSite PageSite {
  65                         get { return pageSite; }
  66                         set { pageSite = value; }
  67                 }
  68
  69                 public virtual string Title {
  70                         get { return base.Text; }
  71                 }
  72
  73                 public virtual void Activate ()
  74                 {
  75                         Visible = true;
  76                         firstActivate = false;
  77                         if (loadRequired) {
  78                                 EnterLoadingMode ();
  79                                 LoadComponent ();
  80                                 ExitLoadingMode ();
  81                         }
  82                 }
  83
  84                 public virtual void ApplyChanges ()
  85                 {
  86                         SaveComponent ();
  87                 }
  88
  89                 public virtual void Deactivate ()
  90                 {
  91                         Visible = false;
  92                 }
  93
  94                 protected void EnterLoadingMode ()
  95                 {
  96                         loading++;
  97                 }
  98
  99                 protected void ExitLoadingMode ()
 100                 {
 101                         loading--;
 102                 }
 103
 104                 public virtual Control GetControl ()
 105                 {
 106                         return this;
 107                 }
 108
 109                 protected IComponent GetSelectedComponent ()
 110                 {
 111                         return component;
 112                 }
 113
 114                 protected bool IsFirstActivate ()
 115                 {
 116                         return firstActivate;
 117                 }
 118
 119                 protected bool IsLoading ()
 120                 {
 121                         return (loading != 0);
 122                 }
 123
 124                 public virtual bool IsPageMessage (ref Message msg)
 125                 {
 126                         return PreProcessMessage (ref msg);
 127                 }
 128
 129                 protected abstract void LoadComponent ();
 130
 131                 [MonoTODO ("Find out what this does.")]
 132                 public virtual void OnApplyComplete ()
 133                 {
 134                 }
 135
 136                 protected virtual void ReloadComponent ()
 137                 {
 138                         loadRequired = true;
 139                 }
 140
 141                 protected abstract void SaveComponent ();
 142
 143                 public virtual void SetComponent (IComponent component)
 144                 {
 145                         this.component = component;
 146                         ReloadComponent ();
 147                 }
 148
 149                 [MonoTODO ("Find out what this does.")]
 150                 protected virtual void SetDirty ()
 151                 {
 152                 }
 153
 154                 public virtual void SetSite (IComponentEditorPageSite site)
 155                 {
 156                         pageSite = site;
 157                         pageSite.GetControl ().Controls.Add (this);
 158
 159                 }
 160
 161                 public virtual void ShowHelp ()
 162                 {
 163                 }
 164
 165                 public virtual bool SupportsHelp ()
 166                 {
 167                         return false;
 168                 }
 169         }
 170 }