class/System.Windows/System.Windows.Automation.Peers/AutomationPeer.cs

   1 //
   2 // System.Windows.Automation.Peers.AutomationPeer
   3 //
   4 // Contact:
   5 //   Moonlight List (moonlight-list@lists.ximian.com)
   6 //
   7 // Copyright (C) 2008,2009 Novell, Inc (http://www.novell.com)
   8 //
   9 // Permission is hereby granted, free of charge, to any person obtaining
  10 // a copy of this software and associated documentation files (the
  11 // "Software"), to deal in the Software without restriction, including
  12 // without limitation the rights to use, copy, modify, merge, publish,
  13 // distribute, sublicense, and/or sell copies of the Software, and to
  14 // permit persons to whom the Software is furnished to do so, subject to
  15 // the following conditions:
  16 //
  17 // The above copyright notice and this permission notice shall be
  18 // included in all copies or substantial portions of the Software.
  19 //
  20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27 //
  28
  29 using System;
  30 using System.Linq;
  31 using System.Collections.Generic;
  32 using System.Windows.Automation.Provider;
  33
  34 namespace System.Windows.Automation.Peers {
  35
  36         public abstract class AutomationPeer : DependencyObject {
  37
  38                 protected AutomationPeer ()
  39                 {
  40                 }
  41
  42                 public AutomationPeer EventsSource {
  43                         get;
  44                         set;
  45                 }
  46
  47                 public void RaiseAutomationEvent (AutomationEvents events)
  48                 {
  49                         AutomationSingleton.Instance.RaiseAutomationEvent (this, events);
  50                 }
  51
  52                 public static bool ListenerExists (AutomationEvents events)
  53                 {
  54                         return AutomationSingleton.Instance.ListenerExists (events);
  55                 }
  56
  57                 protected IRawElementProviderSimple ProviderFromPeer (AutomationPeer peer)
  58                 {
  59                         if (peer == null)
  60                                 return null;
  61                         return new IRawElementProviderSimple (peer);
  62                 }
  63
  64                 public AutomationPeer GetLabeledBy ()
  65                 {
  66                         return GetLabeledByCore ();
  67                 }
  68
  69                 public string GetName ()
  70                 {
  71                         AutomationPeer labeledByPeer = GetLabeledBy ();
  72                         if (labeledByPeer != null)
  73                                 return labeledByPeer.GetName () ?? string.Empty;
  74                         else
  75                                 return GetNameCore ();
  76                 }
  77
  78                 public string GetItemType ()
  79                 {
  80                         return GetItemTypeCore ();
  81                 }
  82
  83                 public List<AutomationPeer> GetChildren ()
  84                 {
  85                         return GetChildrenCore ();
  86                 }
  87
  88                 protected abstract AutomationPeer GetLabeledByCore ();
  89                 protected abstract string GetNameCore ();
  90                 protected abstract string GetItemTypeCore ();
  91                 protected abstract List<AutomationPeer> GetChildrenCore ();
  92                 protected abstract string GetAcceleratorKeyCore ();
  93                 protected abstract string GetAccessKeyCore ();
  94                 protected abstract AutomationControlType GetAutomationControlTypeCore ();
  95                 protected abstract string GetAutomationIdCore ();
  96                 protected abstract Rect GetBoundingRectangleCore ();
  97                 protected abstract string GetClassNameCore ();
  98                 protected abstract bool IsOffscreenCore ();
  99                 protected abstract bool IsPasswordCore ();
 100                 protected abstract Point GetClickablePointCore ();
 101                 protected abstract string GetItemStatusCore ();
 102                 protected abstract string GetHelpTextCore ();
 103                 protected abstract AutomationOrientation GetOrientationCore ();
 104                 protected abstract bool HasKeyboardFocusCore ();
 105                 protected abstract bool IsContentElementCore ();
 106                 protected abstract bool IsControlElementCore ();
 107                 protected abstract bool IsEnabledCore ();
 108                 protected abstract bool IsKeyboardFocusableCore ();
 109                 protected abstract bool IsRequiredForFormCore ();
 110                 protected abstract string GetLocalizedControlTypeCore ();
 111                 protected abstract void SetFocusCore ();
 112
 113                 public abstract object GetPattern (PatternInterface patternInterface);
 114
 115                 public string GetAcceleratorKey ()
 116                 {
 117                         return GetAcceleratorKeyCore ();
 118                 }
 119
 120                 public string GetAccessKey ()
 121                 {
 122                         return GetAccessKeyCore ();
 123                 }
 124
 125                 public AutomationControlType GetAutomationControlType ()
 126                 {
 127                         return GetAutomationControlTypeCore ();
 128                 }
 129
 130                 public string GetAutomationId ()
 131                 {
 132                         return GetAutomationIdCore ();
 133                 }
 134
 135                 public Rect GetBoundingRectangle ()
 136                 {
 137                         return GetBoundingRectangleCore ();
 138                 }
 139
 140                 public string GetClassName ()
 141                 {
 142                         return GetClassNameCore ();
 143                 }
 144
 145                 public Point GetClickablePoint ()
 146                 {
 147                         return GetClickablePointCore ();
 148                 }
 149
 150                 public string GetHelpText ()
 151                 {
 152                         return GetHelpTextCore ();
 153                 }
 154
 155                 public string GetItemStatus ()
 156                 {
 157                         return GetItemStatusCore ();
 158                 }
 159
 160                 public string GetLocalizedControlType ()
 161                 {
 162                         return GetLocalizedControlTypeCore ();
 163                 }
 164
 165                 public AutomationOrientation GetOrientation ()
 166                 {
 167                         return GetOrientationCore ();
 168                 }
 169
 170                 public AutomationPeer GetParent ()
 171                 {
 172                         return GetParentCore ();
 173                 }
 174
 175                 public bool HasKeyboardFocus ()
 176                 {
 177                         return HasKeyboardFocusCore ();
 178                 }
 179
 180                 public void InvalidatePeer ()
 181                 {
 182                         AutomationSingleton.Instance.InvalidatePeer (this);
 183                 }
 184
 185                 public bool IsContentElement ()
 186                 {
 187                         return IsContentElementCore ();
 188                 }
 189
 190                 public bool IsControlElement ()
 191                 {
 192                         return IsControlElementCore ();
 193                 }
 194
 195                 public bool IsEnabled ()
 196                 {
 197                         return IsEnabledCore ();
 198                 }
 199
 200                 public bool IsKeyboardFocusable ()
 201                 {
 202                         return IsKeyboardFocusableCore ();
 203                 }
 204
 205                 public bool IsOffscreen ()
 206                 {
 207                         return IsOffscreenCore ();
 208                 }
 209
 210                 public bool IsPassword ()
 211                 {
 212                         return IsPasswordCore ();
 213                 }
 214
 215                 public bool IsRequiredForForm ()
 216                 {
 217                         return IsRequiredForFormCore ();
 218                 }
 219
 220                 protected AutomationPeer PeerFromProvider (IRawElementProviderSimple provider)
 221                 {
 222                         // SL2 will NRE too if 'provider' is null
 223                         return provider.AutomationPeer;
 224                 }
 225
 226                 public void RaisePropertyChangedEvent (AutomationProperty property, object oldValue, object newValue)
 227                 {
 228                         AutomationSingleton.Instance.RaisePropertyChangedEvent (this, property, oldValue, newValue);
 229                 }
 230
 231                 public void SetFocus ()
 232                 {
 233                         SetFocusCore ();
 234                 }
 235
 236                 // Overriden by FrameworkElementAutomationPeer to return Parent peer using recursion
 237                 internal virtual AutomationPeer GetParentCore ()
 238                 {
 239                         return null;
 240                 }
 241
 242                 // Method used to cache main properties to RaisePropertyChanged when calling
 243                 // InvalidatePeer. This method is also called by FrameworkElementAutomationPeer.CreatePeerForElement
 244                 internal void CacheMainProperties ()
 245                 {
 246                         // We are keeping a list of cached properties to raise events depending on the
 247                         // accessibility status, because the bridge is loaded by request, ie,
 248                         // when an AT requests a11y information is loaded
 249
 250                         if (cacheProperties == null) {
 251                                 // Main properties defined in AutomationElementIdentifiers static fields
 252                                 cacheProperties = new IAutomationCacheProperty[] {
 253                                         new AutomationCacheProperty<string> () { Property = AutomationElementIdentifiers.AcceleratorKeyProperty,
 254                                                                                  OldValue = GetAcceleratorKey (),
 255                                                                                  Delegate =  GetAcceleratorKey },
 256                                         new AutomationCacheProperty<string> () { Property = AutomationElementIdentifiers.AccessKeyProperty,
 257                                                                                  OldValue = GetAccessKey (),
 258                                                                                  Delegate = GetAccessKey },
 259                                         new AutomationCacheProperty<string> () { Property = AutomationElementIdentifiers.AutomationIdProperty,
 260                                                                                  OldValue = GetAutomationId (),
 261                                                                                  Delegate = GetAutomationId },
 262                                         new AutomationCacheProperty<string> () { Property = AutomationElementIdentifiers.ClassNameProperty,
 263                                                                                  OldValue = GetClassName (),
 264                                                                                  Delegate = GetClassName },
 265                                         new AutomationCacheProperty<string> () { Property = AutomationElementIdentifiers.HelpTextProperty,
 266                                                                                  OldValue = GetHelpText (),
 267                                                                                  Delegate = GetHelpText },
 268                                         new AutomationCacheProperty<string> () { Property = AutomationElementIdentifiers.ItemStatusProperty,
 269                                                                                  OldValue = GetItemStatus (),
 270                                                                                  Delegate = GetItemStatus },
 271                                         new AutomationCacheProperty<string> () { Property = AutomationElementIdentifiers.ItemTypeProperty,
 272                                                                                  OldValue = GetItemType (),
 273                                                                                  Delegate = GetItemType },
 274                                         new AutomationCacheProperty<string> () { Property = AutomationElementIdentifiers.NameProperty,
 275                                                                                  OldValue = GetName (),
 276                                                                                  Delegate = GetName },
 277                                         new AutomationCacheProperty<string> () { Property = AutomationElementIdentifiers.LocalizedControlTypeProperty,
 278                                                                                  OldValue = GetLocalizedControlType (),
 279                                                                                  Delegate = GetLocalizedControlType },
 280                                         new AutomationCacheProperty<bool> () { Property = AutomationElementIdentifiers.HasKeyboardFocusProperty,
 281                                                                                OldValue = HasKeyboardFocus (),
 282                                                                                Delegate = HasKeyboardFocus },
 283                                         new AutomationCacheProperty<bool> () { Property = AutomationElementIdentifiers.IsOffscreenProperty,
 284                                                                                OldValue = IsOffscreen (),
 285                                                                                Delegate = IsOffscreen },
 286                                         new AutomationCacheProperty<bool> () { Property = AutomationElementIdentifiers.IsContentElementProperty,
 287                                                                                OldValue = IsContentElement (),
 288                                                                                Delegate = IsContentElement },
 289                                         new AutomationCacheProperty<bool> () { Property = AutomationElementIdentifiers.IsControlElementProperty,
 290                                                                                OldValue = IsControlElement (),
 291                                                                                Delegate = IsControlElement },
 292                                         new AutomationCacheProperty<bool> () { Property = AutomationElementIdentifiers.IsEnabledProperty,
 293                                                                                OldValue = IsEnabled (),
 294                                                                                Delegate = IsEnabled },
 295                                         new AutomationCacheProperty<bool> () { Property = AutomationElementIdentifiers.IsPasswordProperty,
 296                                                                                OldValue = IsPassword (),
 297                                                                                Delegate = IsPassword },
 298                                         new AutomationCacheProperty<bool> () { Property = AutomationElementIdentifiers.IsRequiredForFormProperty,
 299                                                                                OldValue = IsRequiredForForm (),
 300                                                                                Delegate = IsRequiredForForm },
 301                                         new AutomationCacheProperty<bool> () { Property = AutomationElementIdentifiers.IsKeyboardFocusableProperty,
 302                                                                                OldValue = IsKeyboardFocusable (),
 303                                                                                Delegate = IsKeyboardFocusable },
 304                                         new AutomationCacheProperty<Rect> () { Property = AutomationElementIdentifiers.BoundingRectangleProperty,
 305                                                                                OldValue = GetBoundingRectangle (),
 306                                                                                Delegate = GetBoundingRectangle },
 307                                         new AutomationCacheProperty<Point> () { Property = AutomationElementIdentifiers.ClickablePointProperty,
 308                                                                                 OldValue = GetClickablePoint (),
 309                                                                                 Delegate = GetClickablePoint },
 310                                         new AutomationCachePeerProperty () { Property = AutomationElementIdentifiers.LabeledByProperty,
 311                                                                              OldValue = GetLabeledBy (),
 312                                                                              Delegate = GetLabeledBy },
 313                                         new AutomationCacheProperty<AutomationOrientation> () { Property = AutomationElementIdentifiers.OrientationProperty,
 314                                                                                                 OldValue = GetOrientation (),
 315                                                                                                 Delegate = GetOrientation },
 316                                         new AutomationCacheProperty<AutomationControlType> () { Property = AutomationElementIdentifiers.ControlTypeProperty,
 317                                                                                                 OldValue = GetAutomationControlType (),
 318                                                                                                 Delegate = GetAutomationControlType }
 319                                 };
 320                         }
 321                 }
 322
 323                 internal IAutomationCacheProperty GetCachedProperty (AutomationProperty property)
 324                 {
 325                         CacheMainProperties ();
 326
 327                         return (from p in cacheProperties where p.Property == property select p).FirstOrDefault();
 328                 }
 329
 330                 internal IEnumerable<IAutomationCacheProperty> CacheProperties {
 331                         get { return cacheProperties; }
 332                 }
 333
 334                 internal virtual void RaiseNameChanged ()
 335                 {
 336                 }
 337
 338                 private IAutomationCacheProperty []cacheProperties;
 339         }
 340 }
 341
 342