mirror of
https://github.com/flutter/flutter.git
synced 2025-06-03 00:51:18 +00:00

- - When I added notification of key events before processing them as text, it made it so that shortcut key bindings like the spacebar would prevent spaces from being inserted into text fields, which is obviously not desirable (and so that change was reverted). At the same time, we do want to make it possible to override key events so that they can do things like intercept a tab key or arrow keys that change the focus. This PR changes the behavior of the Shortcuts widget so that if it has a shortcut defined, but no action is bound to the intent, then instead of responding that the key is "handled", it responds as if nothing handled it. This allows the engine to continue to process the key as text entry. This PR includes: - Modification of the callback type for key handlers to return a KeyEventResult instead of a bool, so that we can return more information (i.e. the extra state of "stop propagation"). - Modification of the ActionDispatcher.invokeAction contract to require that Action.isEnabled return true before calling it. It will now assert if the action isn't enabled when invokeAction is called. This is to allow optimization of the number of calls to isEnabled, since the shortcuts widget now wants to know if the action was enabled before deciding to either handle the key or to return ignored. - Modification to ShortcutManager.handleKeypress to return KeyEventResult.ignored for keys which don't have an enabled action associated with them. - Adds an attribute to DoNothingAction that allows it to mark a key as not handled, even though it does have an action associated with it. This will allow disabling of a shortcut for a subtree.
215 lines
6.3 KiB
Dart
215 lines
6.3 KiB
Dart
// Copyright 2014 The Flutter Authors. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style license that can be
|
|
// found in the LICENSE file.
|
|
|
|
import 'package:flutter/foundation.dart';
|
|
import 'package:flutter/material.dart';
|
|
import 'package:flutter/services.dart';
|
|
import 'package:flutter/widgets.dart';
|
|
|
|
void main() {
|
|
runApp(const MaterialApp(
|
|
title: 'Focus Demo',
|
|
home: FocusDemo(),
|
|
));
|
|
}
|
|
|
|
class DemoButton extends StatefulWidget {
|
|
const DemoButton({this.name, this.canRequestFocus = true, this.autofocus = false});
|
|
|
|
final String name;
|
|
final bool canRequestFocus;
|
|
final bool autofocus;
|
|
|
|
@override
|
|
_DemoButtonState createState() => _DemoButtonState();
|
|
}
|
|
|
|
class _DemoButtonState extends State<DemoButton> {
|
|
FocusNode focusNode;
|
|
|
|
@override
|
|
void initState() {
|
|
super.initState();
|
|
focusNode = FocusNode(
|
|
debugLabel: widget.name,
|
|
canRequestFocus: widget.canRequestFocus,
|
|
);
|
|
}
|
|
|
|
@override
|
|
void dispose() {
|
|
focusNode?.dispose();
|
|
super.dispose();
|
|
}
|
|
|
|
@override
|
|
void didUpdateWidget(DemoButton oldWidget) {
|
|
super.didUpdateWidget(oldWidget);
|
|
focusNode.canRequestFocus = widget.canRequestFocus;
|
|
}
|
|
|
|
void _handleOnPressed() {
|
|
focusNode.requestFocus();
|
|
print('Button ${widget.name} pressed.');
|
|
debugDumpFocusTree();
|
|
}
|
|
|
|
@override
|
|
Widget build(BuildContext context) {
|
|
return TextButton(
|
|
focusNode: focusNode,
|
|
autofocus: widget.autofocus,
|
|
style: ButtonStyle(
|
|
overlayColor: MaterialStateProperty.resolveWith<Color>((Set<MaterialState> states) {
|
|
if (states.contains(MaterialState.focused))
|
|
return Colors.red.withOpacity(0.25);
|
|
if (states.contains(MaterialState.hovered))
|
|
return Colors.blue.withOpacity(0.25);
|
|
return null;
|
|
}),
|
|
),
|
|
onPressed: () => _handleOnPressed(),
|
|
child: Text(widget.name),
|
|
);
|
|
}
|
|
}
|
|
|
|
class FocusDemo extends StatefulWidget {
|
|
const FocusDemo({Key key}) : super(key: key);
|
|
|
|
@override
|
|
_FocusDemoState createState() => _FocusDemoState();
|
|
}
|
|
|
|
class _FocusDemoState extends State<FocusDemo> {
|
|
FocusNode outlineFocus;
|
|
|
|
@override
|
|
void initState() {
|
|
super.initState();
|
|
outlineFocus = FocusNode(debugLabel: 'Demo Focus Node');
|
|
}
|
|
|
|
@override
|
|
void dispose() {
|
|
outlineFocus.dispose();
|
|
super.dispose();
|
|
}
|
|
|
|
KeyEventResult _handleKeyPress(FocusNode node, RawKeyEvent event) {
|
|
if (event is RawKeyDownEvent) {
|
|
print('Scope got key event: ${event.logicalKey}, $node');
|
|
print('Keys down: ${RawKeyboard.instance.keysPressed}');
|
|
if (event.logicalKey == LogicalKeyboardKey.tab) {
|
|
debugDumpFocusTree();
|
|
if (event.isShiftPressed) {
|
|
print('Moving to previous.');
|
|
node.previousFocus();
|
|
return KeyEventResult.handled;
|
|
} else {
|
|
print('Moving to next.');
|
|
node.nextFocus();
|
|
return KeyEventResult.handled;
|
|
}
|
|
}
|
|
if (event.logicalKey == LogicalKeyboardKey.arrowLeft) {
|
|
node.focusInDirection(TraversalDirection.left);
|
|
return KeyEventResult.handled;
|
|
}
|
|
if (event.logicalKey == LogicalKeyboardKey.arrowRight) {
|
|
node.focusInDirection(TraversalDirection.right);
|
|
return KeyEventResult.handled;
|
|
}
|
|
if (event.logicalKey == LogicalKeyboardKey.arrowUp) {
|
|
node.focusInDirection(TraversalDirection.up);
|
|
return KeyEventResult.handled;
|
|
}
|
|
if (event.logicalKey == LogicalKeyboardKey.arrowDown) {
|
|
node.focusInDirection(TraversalDirection.down);
|
|
return KeyEventResult.handled;
|
|
}
|
|
}
|
|
return KeyEventResult.ignored;
|
|
}
|
|
|
|
@override
|
|
Widget build(BuildContext context) {
|
|
final TextTheme textTheme = Theme.of(context).textTheme;
|
|
|
|
return FocusTraversalGroup(
|
|
policy: ReadingOrderTraversalPolicy(),
|
|
child: FocusScope(
|
|
debugLabel: 'Scope',
|
|
onKey: _handleKeyPress,
|
|
autofocus: true,
|
|
child: DefaultTextStyle(
|
|
style: textTheme.headline4,
|
|
child: Scaffold(
|
|
appBar: AppBar(
|
|
title: const Text('Focus Demo'),
|
|
),
|
|
floatingActionButton: FloatingActionButton(
|
|
child: const Text('+'),
|
|
onPressed: () {},
|
|
),
|
|
body: Center(
|
|
child: Builder(builder: (BuildContext context) {
|
|
return Column(
|
|
mainAxisAlignment: MainAxisAlignment.center,
|
|
children: <Widget>[
|
|
Row(
|
|
mainAxisAlignment: MainAxisAlignment.center,
|
|
children: const <Widget>[
|
|
DemoButton(
|
|
name: 'One',
|
|
autofocus: true,
|
|
),
|
|
],
|
|
),
|
|
Row(
|
|
mainAxisAlignment: MainAxisAlignment.center,
|
|
children: const <Widget>[
|
|
DemoButton(name: 'Two'),
|
|
DemoButton(
|
|
name: 'Three',
|
|
canRequestFocus: false,
|
|
),
|
|
],
|
|
),
|
|
Row(
|
|
mainAxisAlignment: MainAxisAlignment.center,
|
|
children: const <Widget>[
|
|
DemoButton(name: 'Four'),
|
|
DemoButton(name: 'Five'),
|
|
DemoButton(name: 'Six'),
|
|
],
|
|
),
|
|
OutlinedButton(onPressed: () => print('pressed'), child: const Text('PRESS ME')),
|
|
const Padding(
|
|
padding: EdgeInsets.all(8.0),
|
|
child: TextField(
|
|
decoration: InputDecoration(labelText: 'Enter Text', filled: true),
|
|
),
|
|
),
|
|
const Padding(
|
|
padding: EdgeInsets.all(8.0),
|
|
child: TextField(
|
|
decoration: InputDecoration(
|
|
border: OutlineInputBorder(),
|
|
labelText: 'Enter Text',
|
|
filled: false,
|
|
),
|
|
),
|
|
),
|
|
],
|
|
);
|
|
}),
|
|
),
|
|
),
|
|
),
|
|
),
|
|
);
|
|
}
|
|
}
|