FlutterTextField Class Reference

#import <FlutterTextInputSemanticsObject.h>

Inheritance diagram for FlutterTextField:

Instance Methods
(instancetype)	- initWithPlatformNode:fieldEditor:
(void)	- updateString:withSelection:
(void)	- startEditing

Detailed Description

An NSTextField implementation that represents the NativeViewAccessible for the FlutterTextPlatformNode

The NSAccessibility protocol does not provide full support for text editing. This appkit text field is used to get around this problem. The FlutterTextPlatformNode creates a hidden FlutterTextField, since VoiceOver only provides text editing announcements for NSTextField subclasses.

All of the text editing events in this native text field are redirected to the FlutterTextInputPlugin.

Definition at line 81 of file FlutterTextInputSemanticsObject.h.

Method Documentation

initWithPlatformNode:fieldEditor:

- (instancetype) initWithPlatformNode:		(flutter::FlutterTextPlatformNode*)	node
fieldEditor:		(FlutterTextInputPlugin*)	plugin

Initializes a FlutterTextField that uses the FlutterTextInputPlugin as its field editor. The text field redirects all of the text editing events to the FlutterTextInputPlugin.

Definition at line 69 of file FlutterTextInputSemanticsObject.mm.

                                    :(flutter::FlutterTextPlatformNode*)node
                         fieldEditor:(FlutterTextInputPlugin*)plugin {
  self = [super initWithFrame:NSZeroRect];
  if (self) {
    _node = node;
    _plugin = plugin;
    [self setCell:[[FlutterTextFieldCell alloc] initWithTextField:self fieldEditor:plugin]];
  }
  return self;
}

References _plugin.

startEditing

- (void) startEditing

Makes the field editor (plugin) current editor for this TextField, meaning that the text field will start getting editing events.

Definition at line 112 of file FlutterTextInputSemanticsObject.mm.

                     {
  if (!_plugin) {
    return;
  }
  if (self.currentEditor == _plugin) {
    return;
  }
  if (!_node) {
    return;
  }
  // Selecting text seems to be the only way to make the field editor
  // current editor.
  [self selectText:self];
  NSAssert(self.currentEditor == _plugin, @"Failed to set current editor");
 
  _plugin.client = self;
 
  // Restore previous selection.
  NSString* textValue = @(_node->GetStringAttribute(ax::mojom::StringAttribute::kValue).data());
  int start = _node->GetIntAttribute(ax::mojom::IntAttribute::kTextSelStart);
  int end = _node->GetIntAttribute(ax::mojom::IntAttribute::kTextSelEnd);
  NSAssert((start >= 0 && end >= 0) || (start == -1 && end == -1), @"selection is invalid");
  NSRange selection;
  if (start >= 0 && end >= 0) {
    selection = NSMakeRange(MIN(start, end), ABS(end - start));
  } else {
    // The native behavior is to place the cursor at the end of the string if
    // there is no selection.
    selection = NSMakeRange([self stringValue].length, 0);
  }
  [self updateString:textValue withSelection:selection];
}

References _plugin, FlutterTextInputPlugin::client, and updateString:withSelection:.

Referenced by flutter::testing::TEST().

updateString:withSelection:

- (void) updateString:		(NSString*)	string
withSelection:		(NSRange)	selection

Updates the string value and the selection of this text field.

Calling this method is necessary for macOS to get notified about string and selection changes.

Definition at line 80 of file FlutterTextInputSemanticsObject.mm.

                    :(NSString*)string withSelection:(NSRange)selection {
  NSAssert(_plugin.client == self,
           @"Can't update FlutterTextField when it is not the first responder");
  if (![[self stringValue] isEqualToString:string]) {
    [self setStringValue:string];
  }
  if (!NSEqualRanges(_plugin.selectedRange, selection)) {
    [_plugin setSelectedRange:selection];
  }
}

References _plugin, and FlutterTextInputPlugin::client.

Referenced by startEditing.

---

The documentation for this class was generated from the following files:

• shell/platform/darwin/macos/framework/Source/FlutterTextInputSemanticsObject.h
• shell/platform/darwin/macos/framework/Source/FlutterTextInputSemanticsObject.mm