Core/Automaion/FooTextBoxAutomationPeer.cs

   1 /*
   2  * Copyright (C) 2013 FooProject
   3  * * This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by
   4  * the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
   5
   6  * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
   7  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
   8
   9 You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
  10  */
  11 using System;
  12 using System.Collections.Generic;
  13 using System.Linq;
  14 using System.Text;
  15 using System.Text.RegularExpressions;
  16 using System.Threading.Tasks;
  17 #if METRO || WINDOWS_UWP
  18 using Windows.UI.Xaml;
  19 using Windows.UI.Xaml.Media;
  20 using Windows.UI.Xaml.Automation;
  21 using Windows.UI.Xaml.Automation.Peers;
  22 using Windows.UI.Xaml.Automation.Provider;
  23 using Windows.UI.Xaml.Automation.Text;
  24 #if METRO
  25 using FooEditEngine.Metro;
  26 #else
  27 using FooEditEngine.UWP;
  28 #endif
  29 #endif
  30 #if WPF
  31 using System.Windows.Automation;
  32 using System.Windows.Automation.Peers;
  33 using System.Windows.Automation.Provider;
  34 using System.Windows.Automation.Text;
  35 using FooEditEngine.WPF;
  36 #endif
  37
  38 namespace FooEditEngine
  39 {
  40 #if ENABLE_AUTMATION
  41     /// <summary>
  42     /// Automation Peer class for CustomInputBox2.
  43     ///
  44     /// Note: The difference between this and CustomControl1AutomationPeer is that this one implements
  45     /// Text Pattern (ITextProvider) and Value Pattern (IValuePattern) interfaces.  So Touch keyboard shows
  46     /// automatically when user taps on the control with Touch or Pen.
  47     /// </summary>
  48     sealed class FooTextBoxAutomationPeer : FrameworkElementAutomationPeer, ITextProvider, IValueProvider
  49     {
  50         private FooTextBox fooTextBox;
  51         private string accClass = "FooTextBox";
  52
  53         /// <summary>
  54         ///
  55         /// </summary>
  56         /// <param name="owner"></param>
  57         public FooTextBoxAutomationPeer(FooTextBox owner)
  58             : base(owner)
  59         {
  60             this.fooTextBox = owner;
  61         }
  62
  63         public void OnNotifyTextChanged()
  64         {
  65             this.RaiseAutomationEvent(AutomationEvents.TextPatternOnTextChanged);
  66         }
  67
  68         public void OnNotifyCaretChanged()
  69         {
  70             this.RaiseAutomationEvent(AutomationEvents.TextPatternOnTextSelectionChanged);
  71         }
  72
  73 #if METRO || WINDOWS_UWP
  74         /// <summary>
  75         /// Override GetPatternCore to return the object that supports the specified pattern.  In this case the Value pattern, Text
  76         /// patter and any base class patterns.
  77         /// </summary>
  78         /// <param name="patternInterface"></param>
  79         /// <returns>the object that supports the specified pattern</returns>
  80         protected override object GetPatternCore(PatternInterface patternInterface)
  81         {
  82             if (patternInterface == PatternInterface.Value)
  83             {
  84                 return this;
  85             }
  86             else if (patternInterface == PatternInterface.Text)
  87             {
  88                 return this;
  89             }
  90             return base.GetPatternCore(patternInterface);
  91         }
  92 #endif
  93 #if WPF
  94         public override object GetPattern(PatternInterface patternInterface)
  95         {
  96             if (patternInterface == PatternInterface.Value)
  97             {
  98                 return this;
  99             }
 100             else if (patternInterface == PatternInterface.Text)
 101             {
 102                 return this;
 103             }
 104             return base.GetPattern(patternInterface);
 105         }
 106 #endif
 107
 108         protected override string GetAutomationIdCore()
 109         {
 110             return this.accClass;
 111         }
 112
 113         /// <summary>
 114         /// Override GetClassNameCore and set the name of the class that defines the type associated with this control.
 115         /// </summary>
 116         /// <returns>The name of the control class</returns>
 117         protected override string GetClassNameCore()
 118         {
 119             return this.accClass;
 120         }
 121
 122         protected override AutomationControlType GetAutomationControlTypeCore()
 123         {
 124             return AutomationControlType.Edit;
 125         }
 126
 127         protected override bool IsContentElementCore()
 128         {
 129             return true;
 130         }
 131
 132         protected override bool IsKeyboardFocusableCore()
 133         {
 134             return true;
 135         }
 136
 137 #if METRO || WINDOWS_UWP
 138         protected override Windows.Foundation.Rect GetBoundingRectangleCore()
 139         {
 140             double scale = Util.GetScale();
 141             return new Windows.Foundation.Rect(0, 0, this.fooTextBox.ActualWidth * scale, this.fooTextBox.ActualHeight * scale);
 142         }
 143 #endif
 144 #if WPF
 145         protected override System.Windows.Rect GetBoundingRectangleCore()
 146         {
 147             System.Windows.Point left = this.fooTextBox.PointToScreen(new System.Windows.Point(0, 0));
 148             System.Windows.Point bottom = this.fooTextBox.PointToScreen(new System.Windows.Point(this.fooTextBox.ActualWidth, this.fooTextBox.ActualHeight));
 149             return new System.Windows.Rect(left, bottom);
 150         }
 151 #endif
 152
 153     #region Implementation for ITextPattern interface
 154         // Complete implementation of the ITextPattern is beyond the scope of this sample.  The implementation provided
 155         // is specific to this sample's custom control, so it is unlikely that they are directly transferable to other
 156         // custom control.
 157
 158         ITextRangeProvider ITextProvider.DocumentRange
 159         {
 160             // A real implementation of this method is beyond the scope of this sample.
 161             // If your custom control has complex text involving both readonly and non-readonly ranges,
 162             // it will need a smarter implementation than just returning a fixed range
 163             get
 164             {
 165                 return new FooTextBoxRangeProvider(this.fooTextBox, this);
 166             }
 167         }
 168
 169         ITextRangeProvider[] ITextProvider.GetSelection()
 170         {
 171             ITextRangeProvider[] ret = new ITextRangeProvider[1];
 172             int selStart = this.fooTextBox.Selection.Index;
 173             int selLength = this.fooTextBox.Selection.Length;
 174             ret[0] = new FooTextBoxRangeProvider(this.fooTextBox, selStart, selLength, this);
 175             return ret;
 176         }
 177
 178         ITextRangeProvider[] ITextProvider.GetVisibleRanges()
 179         {
 180             ITextRangeProvider[] ret = new ITextRangeProvider[1];
 181             if (this.fooTextBox.LayoutLineCollection.Count == 0)
 182             {
 183                 ret[0] = new FooTextBoxRangeProvider(this.fooTextBox, 0, 0, this);
 184             }
 185             else
 186             {
 187 #if METRO || WINDOWS_UWP
 188                 int startIndex = this.fooTextBox.GetIndexFromPostion(new Windows.Foundation.Point(0,0));
 189                 int endIndex = this.fooTextBox.GetIndexFromPostion(new Windows.Foundation.Point(this.fooTextBox.ActualWidth, this.fooTextBox.ActualHeight));
 190 #endif
 191 #if WPF
 192                 int startIndex = this.fooTextBox.GetIndexFromPostion(new System.Windows.Point(0, 0));
 193                 int endIndex = this.fooTextBox.GetIndexFromPostion(new System.Windows.Point(this.fooTextBox.ActualWidth, this.fooTextBox.ActualHeight));
 194 #endif
 195                 ret[0] = new FooTextBoxRangeProvider(this.fooTextBox, startIndex, endIndex - startIndex, this);
 196             }
 197             return ret;
 198         }
 199
 200         ITextRangeProvider ITextProvider.RangeFromChild(IRawElementProviderSimple childElement)
 201         {
 202             return new FooTextBoxRangeProvider(this.fooTextBox,0,0, this);
 203         }
 204
 205 #if METRO || WINDOWS_UWP
 206         ITextRangeProvider ITextProvider.RangeFromPoint(Windows.Foundation.Point screenLocation)
 207         {
 208             Point pt = Util.GetClientPoint(screenLocation, this.fooTextBox);
 209
 210             int index = this.fooTextBox.GetIndexFromPostion(pt);
 211             int length = 1;
 212             if (index == this.fooTextBox.Document.Length)
 213                 length = 0;
 214
 215             return new FooTextBoxRangeProvider(this.fooTextBox, index, length, this);
 216         }
 217 #endif
 218 #if WPF
 219         ITextRangeProvider ITextProvider.RangeFromPoint(System.Windows.Point screenLocation)
 220         {
 221             System.Windows.Point pt = this.fooTextBox.PointFromScreen(screenLocation);
 222
 223             int index = this.fooTextBox.GetIndexFromPostion(pt);
 224             int length = 1;
 225             if (index == this.fooTextBox.Document.Length)
 226                 length = 0;
 227
 228             return new FooTextBoxRangeProvider(this.fooTextBox, index, length, this);
 229         }
 230 #endif
 231
 232         SupportedTextSelection ITextProvider.SupportedTextSelection
 233         {
 234             get { return SupportedTextSelection.Single; }
 235         }
 236
 237     #endregion
 238
 239     #region Implementation for IValueProvider interface
 240         // Complete implementation of the IValueProvider is beyond the scope of this sample.  The implementation provided
 241         // is specific to this sample's custom control, so it is unlikely that they are directly transferable to other
 242         // custom control.
 243
 244         /// <summary>
 245         /// The value needs to be false for the Touch keyboard to be launched automatically because Touch keyboard
 246         /// does not appear when the input focus is in a readonly UI control.
 247         /// </summary>
 248         bool IValueProvider.IsReadOnly
 249         {
 250             get { return false; }
 251         }
 252
 253         void IValueProvider.SetValue(string value)
 254         {
 255             string oldText = this.fooTextBox.Document.ToString(0);
 256             this.fooTextBox.Document.Replace(0,this.fooTextBox.Document.Length,value);
 257             this.RaisePropertyChangedEvent(ValuePatternIdentifiers.ValueProperty, oldText, this.fooTextBox.Document.ToString(0));
 258         }
 259
 260         string IValueProvider.Value
 261         {
 262             get
 263             {
 264                 return this.fooTextBox.Document.ToString(0,this.fooTextBox.Document.Length);
 265             }
 266         }
 267
 268     #endregion //Implementation for IValueProvider interface
 269
 270         public IRawElementProviderSimple GetRawElementProviderSimple()
 271         {
 272             return ProviderFromPeer(this);
 273         }
 274     }
 275
 276     /// <summary>
 277     /// A minimal implementation of ITextRangeProvider, used by CustomControl2AutomationPeer
 278     /// A real implementation is beyond the scope of this sample
 279     /// </summary>
 280     sealed class FooTextBoxRangeProvider : ITextRangeProvider
 281     {
 282         private FooTextBox textbox;
 283         private FooTextBoxAutomationPeer _peer;
 284         private int start, end;
 285
 286         public FooTextBoxRangeProvider(FooTextBox textbox, FooTextBoxAutomationPeer peer)
 287             : this(textbox,0,textbox.Document.Length,peer)
 288         {
 289         }
 290         public FooTextBoxRangeProvider(FooTextBox textbox, int start, int length, FooTextBoxAutomationPeer peer)
 291         {
 292             this.textbox = textbox;
 293             this.start = start;
 294             this.end = start + length;
 295             _peer = peer;
 296         }
 297
 298         public void AddToSelection()
 299         {
 300             throw new InvalidOperationException();
 301         }
 302
 303         public ITextRangeProvider Clone()
 304         {
 305             return new FooTextBoxRangeProvider(this.textbox,this.start,this.end - this.start, _peer);
 306         }
 307
 308         public bool Compare(ITextRangeProvider o)
 309         {
 310             FooTextBoxRangeProvider other = o as FooTextBoxRangeProvider;
 311             if (other == null)
 312                 throw new ArgumentNullException("null以外の値を指定してください");
 313             if (this.start == other.start && this.end == other.end)
 314                 return true;
 315             else
 316                 return false;
 317         }
 318
 319         public int CompareEndpoints(TextPatternRangeEndpoint endpoint, ITextRangeProvider targetRange, TextPatternRangeEndpoint targetEndpoint)
 320         {
 321             FooTextBoxRangeProvider other = targetRange as FooTextBoxRangeProvider;
 322
 323             if (other == null)
 324                 throw new ArgumentException("");
 325
 326             if (endpoint == TextPatternRangeEndpoint.Start)
 327             {
 328                 if (targetEndpoint == TextPatternRangeEndpoint.Start)
 329                     return this.Compare(this.start,other.start);
 330                 if(targetEndpoint == TextPatternRangeEndpoint.End)
 331                     return this.Compare(this.start,other.end);
 332             }
 333             if (endpoint == TextPatternRangeEndpoint.End)
 334             {
 335                 if (targetEndpoint == TextPatternRangeEndpoint.Start)
 336                     return this.Compare(this.start, other.end);
 337                 if (targetEndpoint == TextPatternRangeEndpoint.End)
 338                     return this.Compare(this.end, other.end);
 339             }
 340             throw new ArgumentException("endpointに未知の値が指定されました");
 341         }
 342
 343         int Compare(int self, int other)
 344         {
 345             if (self < other)
 346                 return -1;
 347             else if (self > other)
 348                 return 1;
 349             else
 350                 return 0;
 351         }
 352
 353         public void ExpandToEnclosingUnit(TextUnit unit)
 354         {
 355             Controller ctrl = this.textbox.Controller;
 356             Document doc = this.textbox.Document;
 357             if (unit == TextUnit.Character)
 358             {
 359                 return;
 360             }
 361             if (unit == TextUnit.Format || unit == TextUnit.Word)
 362             {
 363                 var t = doc.GetSepartor(this.start, (c) => Util.IsWordSeparator(c));
 364                 if (t == null)
 365                     this.start = this.end = 0;
 366                 else
 367                 {
 368                     this.start = t.Item1;
 369                     this.end = t.Item2;
 370                 }
 371                 return;
 372             }
 373             if (unit == TextUnit.Line || unit == TextUnit.Paragraph)
 374             {
 375                 var t = doc.GetSepartor(this.start, (c) => c == Document.NewLine);
 376                 if (t == null)
 377                     this.start = this.end = 0;
 378                 else
 379                 {
 380                     this.start = t.Item1;
 381                     this.end = t.Item2;
 382                 }
 383                 return;
 384             }
 385             if (unit == TextUnit.Page || unit == TextUnit.Document)
 386             {
 387                 this.start = 0;
 388                 this.end = this.textbox.Document.Length;
 389                 return;
 390             }
 391             throw new NotImplementedException();
 392         }
 393
 394         public ITextRangeProvider FindAttribute(int attribute, Object value, bool backward)
 395         {
 396             return null;
 397         }
 398
 399         public ITextRangeProvider FindText(String text, bool backward, bool ignoreCase)
 400         {
 401             if (backward)
 402                 throw new NotImplementedException();
 403             textbox.Document.SetFindParam(text, false, ignoreCase ? RegexOptions.IgnoreCase : RegexOptions.None);
 404             IEnumerator<SearchResult> it = textbox.Document.Find();
 405             if (it.MoveNext())
 406             {
 407                 SearchResult sr = it.Current;
 408                 return new FooTextBoxRangeProvider(this.textbox, sr.Start, sr.End - sr.Start + 1, _peer);
 409             }
 410             return null;
 411         }
 412
 413         public Object GetAttributeValue(int attribute)
 414         {
 415             return null;
 416         }
 417
 418 #if METRO || WINDOWS_UWP
 419         public void GetBoundingRectangles(out double[] rectangles)
 420 #endif
 421 #if WPF
 422         public double[] GetBoundingRectangles()
 423 #endif
 424         {
 425             LineToIndexTable layoutLineCollection = this.textbox.LayoutLineCollection;
 426             TextPoint topLeft = layoutLineCollection.GetTextPointFromIndex(this.start);
 427             TextPoint bottomRight = this.textbox.LayoutLineCollection.GetTextPointFromIndex(IsNewLine(this.end) ? this.end - 1 : this.end);
 428
 429
 430 #if METRO || WINDOWS_UWP
 431             float dpi;
 432             Util.GetDpi(out dpi,out dpi);
 433             double scale = dpi / 96;
 434             Point topLeftPos = this.textbox.GetPostionFromTextPoint(topLeft);
 435             Point bottomRightPos = this.textbox.GetPostionFromTextPoint(bottomRight);
 436             topLeftPos = topLeftPos.Scale(scale);
 437             bottomRightPos = bottomRightPos.Scale(scale);
 438 #endif
 439 #if WPF
 440             System.Windows.Point topLeftPos = this.textbox.GetPostionFromTextPoint(topLeft);
 441             System.Windows.Point bottomRightPos = this.textbox.GetPostionFromTextPoint(bottomRight);
 442             topLeftPos = this.textbox.PointToScreen(topLeftPos);
 443             bottomRightPos = this.textbox.PointToScreen(bottomRightPos);
 444 #endif
 445
 446             double width = bottomRightPos.X - topLeftPos.X;
 447             if (width == 0)
 448                 width = 1;
 449             Rectangle rect = new Rectangle(topLeftPos.X, topLeftPos.Y,
 450                  width,
 451                  bottomRightPos.Y - topLeftPos.Y + layoutLineCollection.GetLayout(bottomRight.row).Height);
 452
 453 #if METRO || WINDOWS_UWP
 454             rectangles = new double[4]{
 455                 rect.X,
 456                 rect.Y,
 457                 rect.Width,
 458                 rect.Height
 459             };
 460 #endif
 461 #if WPF
 462             return new double[4]{
 463                 rect.X,
 464                 rect.Y,
 465                 rect.Width,
 466                 rect.Height
 467             };
 468 #endif
 469         }
 470
 471         bool IsNewLine(int index)
 472         {
 473             if (this.textbox.Document.Length > 0)
 474                 return this.textbox.Document[index == 0 ? 0 : index - 1] == Document.NewLine;
 475             else
 476                 return false;
 477         }
 478
 479         public IRawElementProviderSimple[] GetChildren()
 480         {
 481             return new IRawElementProviderSimple[0];
 482         }
 483
 484         public IRawElementProviderSimple GetEnclosingElement()
 485         {
 486             return _peer.GetRawElementProviderSimple();
 487         }
 488
 489         public String GetText(int maxLength)
 490         {
 491             if (this.textbox.Document.Length == 0)
 492                 return "";
 493             int length = this.end - this.start;
 494             if (maxLength < 0)
 495                 return this.textbox.Document.ToString(this.start, length);
 496             else
 497                 return this.textbox.Document.ToString(this.start, (int)Math.Min(length, maxLength));
 498         }
 499
 500         public int Move(TextUnit unit, int count)
 501         {
 502             if (count == 0)
 503                 return 0;
 504             Controller ctrl = textbox.Controller;
 505             LineToIndexTable layoutLine = textbox.LayoutLineCollection;
 506             int moved = this.MoveEndpointByUnit(TextPatternRangeEndpoint.Start, unit, count);
 507             this.ExpandToEnclosingUnit(unit);
 508             return moved;
 509         }
 510
 511         public void MoveEndpointByRange(TextPatternRangeEndpoint endpoint, ITextRangeProvider targetRange, TextPatternRangeEndpoint targetEndpoint)
 512         {
 513             FooTextBoxRangeProvider other = targetRange as FooTextBoxRangeProvider;
 514
 515             if (other == null)
 516                 throw new ArgumentException("");
 517
 518             if (endpoint == TextPatternRangeEndpoint.Start)
 519             {
 520                 if (targetEndpoint == TextPatternRangeEndpoint.Start)
 521                     this.start = other.start;
 522                 if (targetEndpoint == TextPatternRangeEndpoint.End)
 523                     this.start = other.end;
 524                 if (this.start > this.end)
 525                     this.end = this.start;
 526                 return;
 527             }
 528             if (endpoint == TextPatternRangeEndpoint.End)
 529             {
 530                 if (targetEndpoint == TextPatternRangeEndpoint.Start)
 531                     this.end = other.start;
 532                 if (targetEndpoint == TextPatternRangeEndpoint.End)
 533                     this.end = other.end;
 534                 return;
 535             }
 536             throw new ArgumentException("endpointに未知の値が指定されました");
 537         }
 538
 539         public int MoveEndpointByUnit(TextPatternRangeEndpoint endpoint, TextUnit unit, int count)
 540         {
 541             if (count == 0)
 542                 return 0;
 543
 544             int moved = 0;
 545             TextPoint caret = TextPoint.Null,newCaret = TextPoint.Null;
 546             Controller ctrl = textbox.Controller;
 547             LineToIndexTable layoutLine = textbox.LayoutLineCollection;
 548
 549             if (endpoint == TextPatternRangeEndpoint.Start)
 550                 caret = layoutLine.GetTextPointFromIndex(this.start);
 551             else if (endpoint == TextPatternRangeEndpoint.End)
 552                 caret = layoutLine.GetTextPointFromIndex(this.end);
 553
 554             switch(unit)
 555             {
 556                 case TextUnit.Character:
 557                     newCaret = ctrl.GetNextCaret(caret, count, MoveFlow.Character, out moved);
 558                     break;
 559                 case TextUnit.Format:
 560                 case TextUnit.Word:
 561                     newCaret = ctrl.GetNextCaret(caret, count, MoveFlow.Word, out moved);
 562                     break;
 563                 case TextUnit.Line:
 564                 case TextUnit.Paragraph:
 565                     newCaret = ctrl.GetNextCaret(caret, count, MoveFlow.Paragraph, out moved);
 566                     break;
 567                 case TextUnit.Page:
 568                 case TextUnit.Document:
 569                     this.start = 0;
 570                     this.end = this.textbox.Document.Length - 1;
 571                     moved = 1;
 572                     break;
 573             }
 574
 575             if (endpoint == TextPatternRangeEndpoint.Start)
 576             {
 577                 this.start = layoutLine.GetIndexFromTextPoint(newCaret);
 578                 if (this.start > this.end)
 579                     this.end = this.start;
 580             }
 581             else if (endpoint == TextPatternRangeEndpoint.End)
 582             {
 583                 this.end = layoutLine.GetIndexFromTextPoint(newCaret);
 584                 if (this.end < this.start)
 585                     this.start = this.end;
 586             }
 587             return moved;
 588         }
 589
 590         public void RemoveFromSelection()
 591         {
 592             throw new InvalidOperationException();
 593         }
 594
 595         public void ScrollIntoView(bool alignToTop)
 596         {
 597             int row = this.textbox.LayoutLineCollection.GetLineNumberFromIndex(alignToTop ? this.start : this.end);
 598             this.textbox.ScrollIntoView(row, alignToTop);
 599         }
 600
 601         public void Select()
 602         {
 603             this.textbox.Select(this.start, this.end - this.start + 1);
 604         }
 605     }
 606 #endif
 607 }