mcs/class/Managed.Windows.Forms/System.Windows.Forms/ColumnHeader.cs

   1 // Permission is hereby granted, free of charge, to any person obtaining
   2 // a copy of this software and associated documentation files (the
   3 // "Software"), to deal in the Software without restriction, including
   4 // without limitation the rights to use, copy, modify, merge, publish,
   5 // distribute, sublicense, and/or sell copies of the Software, and to
   6 // permit persons to whom the Software is furnished to do so, subject to
   7 // the following conditions:
   8 //
   9 // The above copyright notice and this permission notice shall be
  10 // included in all copies or substantial portions of the Software.
  11 //
  12 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  13 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  14 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  15 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  16 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  17 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  18 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  19 //
  20 // Copyright (c) 2004 Novell, Inc. (http://www.novell.com)
  21 //
  22 // Author:
  23 //      Ravindra (rkumar@novell.com)
  24 //
  25
  26
  27 // COMPLETE
  28
  29
  30 using System.ComponentModel;
  31 using System.Drawing;
  32
  33 namespace System.Windows.Forms
  34 {
  35         [DefaultProperty ("Text")]
  36         [DesignTimeVisible (false)]
  37         [ToolboxItem (false)]
  38         public class ColumnHeader : Component, ICloneable
  39         {
  40                 #region Instance Variables
  41                 private StringFormat format = new StringFormat ();
  42                 private string text = "ColumnHeader";
  43                 private HorizontalAlignment text_alignment = HorizontalAlignment.Left;
  44                 private int width = ThemeEngine.Current.ListViewDefaultColumnWidth;
  45
  46                 // internal variables
  47                 internal Rectangle column_rect = Rectangle.Empty;
  48                 internal bool pressed = false;
  49                 internal ListView owner;
  50                 #endregion      // Instance Variables
  51
  52                 #region Internal Constructor
  53                 internal ColumnHeader (ListView owner, string text,
  54                                        HorizontalAlignment alignment, int width)
  55                 {
  56                         this.owner = owner;
  57                         this.text = text;
  58                         this.width = width;
  59                         this.text_alignment = alignment;
  60                         CalcColumnHeader ();
  61                 }
  62                 #endregion      // Internal Constructor
  63
  64                 #region Public Constructors
  65                 public ColumnHeader () { }
  66                 #endregion      // Public Constructors
  67
  68                 #region Private Internal Methods Properties
  69                 // Since this class inherits from MarshalByRef,
  70                 // we can't do ColumnHeader.column_rect.XXX. Hence,
  71                 // we have some of the following properties to work around CS0197.
  72                 internal bool Pressed {
  73                         get { return this.pressed; }
  74                 }
  75
  76                 internal int X {
  77                         get { return this.column_rect.X; }
  78                         set { this.column_rect.X = value; }
  79                 }
  80
  81                 internal int Y {
  82                         get { return this.column_rect.Y; }
  83                         set { this.column_rect.Y = value; }
  84                 }
  85
  86                 internal int Wd {
  87                         get { return this.column_rect.Width; }
  88                         set { this.column_rect.Width = value; }
  89                 }
  90
  91                 internal int Ht {
  92                         get { return this.column_rect.Height; }
  93                         set { this.column_rect.Height = value; }
  94                 }
  95
  96                 internal Rectangle Rect {
  97                         get { return this.column_rect; }
  98                 }
  99
 100                 internal StringFormat Format {
 101                         get { return this.format; }
 102                 }
 103
 104                 internal void CalcColumnHeader ()
 105                 {
 106                         if (text_alignment == HorizontalAlignment.Center)
 107                                 format.Alignment = StringAlignment.Center;
 108                         else if (text_alignment == HorizontalAlignment.Right)
 109                                 format.Alignment = StringAlignment.Far;
 110                         else
 111                                 format.Alignment = StringAlignment.Near;
 112                         format.LineAlignment = StringAlignment.Center;
 113                         format.Trimming = StringTrimming.EllipsisWord;
 114                         // text is wrappable only in LargeIcon and SmallIcon views
 115                         format.FormatFlags = StringFormatFlags.NoWrap;
 116
 117                         if (width >= 0) {
 118                                 this.column_rect.Width = width;
 119                                 if (owner != null)
 120                                         this.column_rect.Height = owner.Font.Height + 5 ;
 121                                 else
 122                                         this.column_rect.Height = ThemeEngine.Current.DefaultFont.Height + 5;
 123                         }
 124                         else if (this.Index != -1)
 125                                 this.column_rect.Size = owner.GetChildColumnSize (this.Index);
 126                         else
 127                                 this.column_rect.Size = Size.Empty;
 128                 }
 129                 #endregion      // Private Internal Methods Properties
 130
 131                 #region Public Instance Properties
 132                 [Browsable (false)]
 133                 public int Index {
 134                         get {
 135                                 if (owner != null && owner.Columns != null
 136                                     && owner.Columns.Contains (this)) {
 137                                         return owner.Columns.IndexOf (this);
 138                                 }
 139                                 return -1;
 140                         }
 141                 }
 142
 143                 [Browsable (false)]
 144                 public ListView ListView {
 145                         get { return owner; }
 146                 }
 147
 148                 [Localizable (true)]
 149                 public string Text {
 150                         get { return text; }
 151                         set {
 152                                 text = value;
 153                                 if (owner != null)
 154                                         owner.Redraw (true);
 155                         }
 156                 }
 157
 158                 [DefaultValue (HorizontalAlignment.Left)]
 159                 [Localizable (true)]
 160                 public HorizontalAlignment TextAlign {
 161                         get { return text_alignment; }
 162                         set {
 163                                 text_alignment = value;
 164                                 if (owner != null)
 165                                         owner.Redraw (true);
 166                         }
 167                 }
 168
 169                 [DefaultValue (60)]
 170                 [Localizable (true)]
 171                 public int Width {
 172                         get { return width; }
 173                         set {
 174                                 width = value;
 175                                 if (owner != null)
 176                                         owner.Redraw (true);
 177                         }
 178                 }
 179                 #endregion // Public Instance Properties
 180
 181                 #region Public Methods
 182                 public object Clone ()
 183                 {
 184                         ColumnHeader columnHeader = new ColumnHeader ();
 185                         columnHeader.text = text;
 186                         columnHeader.text_alignment = text_alignment;
 187                         columnHeader.width = width;
 188                         columnHeader.owner = owner;
 189                         columnHeader.format = (StringFormat) Format.Clone ();
 190                         columnHeader.column_rect = Rectangle.Empty;
 191                         return columnHeader;
 192                 }
 193
 194                 public override string ToString ()
 195                 {
 196                         return string.Format ("ColumnHeader: Text: {0}", text);
 197                 }
 198                 #endregion // Public Methods
 199
 200                 #region Protected Methods
 201                 protected override void Dispose (bool disposing)
 202                 {
 203                         base.Dispose (disposing);
 204                 }
 205                 #endregion // Protected Methods
 206         }
 207 }