mcs/class/System/System.ComponentModel.Design/DesignerTransaction.cs

   1 //
   2 // System.ComponentModel.Design.DesignerTransaction.cs
   3 //
   4 // Author:
   5 //   Alejandro Sánchez Acosta (raciel@es.gnu.org)
   6 //   Andreas Nahr (ClassDevelopment@A-SoftTech.com)
   7 //
   8 // (C) Alejandro Sánchez Acosta
   9 // (C) 2003 Andreas Nahr
  10 // Copyright (C) 2005 Novell, Inc (http://www.novell.com)
  11 //
  12 // Permission is hereby granted, free of charge, to any person obtaining
  13 // a copy of this software and associated documentation files (the
  14 // "Software"), to deal in the Software without restriction, including
  15 // without limitation the rights to use, copy, modify, merge, publish,
  16 // distribute, sublicense, and/or sell copies of the Software, and to
  17 // permit persons to whom the Software is furnished to do so, subject to
  18 // the following conditions:
  19 //
  20 // The above copyright notice and this permission notice shall be
  21 // included in all copies or substantial portions of the Software.
  22 //
  23 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  24 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  25 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  26 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  27 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  28 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  29 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  30 //
  31
  32 namespace System.ComponentModel.Design
  33 {
  34         public abstract class DesignerTransaction : IDisposable
  35         {
  36                 private string description;
  37                 private bool committed;
  38                 private bool canceled;
  39
  40                 protected DesignerTransaction ()
  41                         : this ("")
  42                 {
  43                 }
  44
  45                 protected DesignerTransaction (string description)
  46                 {
  47                         this.description = description;
  48                         this.committed = false;
  49                         this.canceled = false;
  50                 }
  51
  52                 void IDisposable.Dispose ()
  53                 {
  54                         Dispose (true);
  55                 }
  56
  57                 protected virtual void Dispose (bool disposing)
  58                 {
  59                         Cancel ();
  60                         if (disposing) {
  61                                 GC.SuppressFinalize (true);
  62                         }
  63                 }
  64
  65                 protected abstract void OnCancel ();
  66
  67                 protected abstract void OnCommit ();
  68
  69                 public void Cancel ()
  70                 {
  71                         // LAMESPEC Cannot find anything about the exact behavior, but I do some checks that
  72                         // seem to make sense
  73                         if (this.Canceled == false && this.Committed == false) {
  74                                 this.canceled = true;
  75                                 OnCancel ();
  76                         }
  77                 }
  78
  79                 public void Commit ()
  80                 {
  81                         // LAMESPEC Cannot find anything about the exact behavior, but I do some checks that
  82                         // seem to make sense
  83                         if (this.Canceled == false && this.Committed == false) {
  84                                 this.committed = true;
  85                                 OnCommit ();
  86                         }
  87                 }
  88
  89                 public bool Canceled {
  90                         get {
  91                                 return canceled;
  92                         }
  93                 }
  94
  95                 public bool Committed {
  96                         get {
  97                                 return committed;
  98                         }
  99                 }
 100
 101                 public string Description {
 102                         get {
 103                                 return description;
 104                         }
 105                 }
 106
 107                 ~DesignerTransaction ()
 108                 {
 109                         Dispose (false);
 110                 }
 111         }
 112 }