Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Add DOM TouchEvent modifiers accessors #36836

Merged
merged 2 commits into from
Oct 19, 2022
Merged

Add DOM TouchEvent modifiers accessors #36836

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
958875e
Add DOM TouchEvent modifier accessors
bleroux Oct 18, 2022
23d288c
Remove _KeyboardModifiersMixin
bleroux Oct 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions lib/web_ui/lib/src/engine/dom.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1142,6 +1142,10 @@ extension DomWheelEventExtension on DomWheelEvent {
class DomTouchEvent extends DomUIEvent {}

extension DomTouchEventExtension on DomTouchEvent {
external bool get altKey;
external bool get ctrlKey;
external bool get metaKey;
external bool get shiftKey;
List<DomTouch>? get changedTouches => js_util
.getProperty<List<Object?>?>(this, 'changedTouches')
?.cast<DomTouch>();
Expand Down
82 changes: 79 additions & 3 deletions lib/web_ui/test/engine/pointer_binding_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,19 @@ void testMain() {
expect(events[1].buttons, equals(0));
expect(events[1].client.x, equals(0));
expect(events[1].client.y, equals(0));

context.pressAllModifiers();
event = expectCorrectType(context.primaryDown(clientX: 100, clientY: 101));
expect(event.getModifierState('Alt'), true);
expect(event.getModifierState('Control'), true);
expect(event.getModifierState('Meta'), true);
expect(event.getModifierState('Shift'), true);
context.unpressAllModifiers();
event = expectCorrectType(context.primaryDown(clientX: 100, clientY: 101));
expect(event.getModifierState('Alt'), false);
expect(event.getModifierState('Control'), false);
expect(event.getModifierState('Meta'), false);
expect(event.getModifierState('Shift'), false);
});

test('_TouchEventContext generates expected events', () {
Expand Down Expand Up @@ -330,6 +343,19 @@ void testMain() {
expect(events[0].changedTouches![1].identifier, equals(105));
expect(events[0].changedTouches![1].client.x, equals(322));
expect(events[0].changedTouches![1].client.y, equals(323));

context.pressAllModifiers();
event = expectCorrectType(context.primaryDown(clientX: 100, clientY: 101));
expect(event.altKey, true);
expect(event.ctrlKey, true);
expect(event.metaKey, true);
expect(event.shiftKey, true);
context.unpressAllModifiers();
event = expectCorrectType(context.primaryDown(clientX: 100, clientY: 101));
expect(event.altKey, false);
expect(event.ctrlKey, false);
expect(event.metaKey, false);
expect(event.shiftKey, false);
});

test('_MouseEventContext generates expected events', () {
Expand Down Expand Up @@ -419,6 +445,19 @@ void testMain() {
expect(event.buttons, equals(0));
expect(event.client.x, equals(400));
expect(event.client.y, equals(401));

context.pressAllModifiers();
event = expectCorrectType(context.primaryDown(clientX: 100, clientY: 101));
expect(event.getModifierState('Alt'), true);
expect(event.getModifierState('Control'), true);
expect(event.getModifierState('Meta'), true);
expect(event.getModifierState('Shift'), true);
context.unpressAllModifiers();
event = expectCorrectType(context.primaryDown(clientX: 100, clientY: 101));
expect(event.getModifierState('Alt'), false);
expect(event.getModifierState('Control'), false);
expect(event.getModifierState('Meta'), false);
expect(event.getModifierState('Shift'), false);
});

// ALL ADAPTERS
Expand Down Expand Up @@ -2571,10 +2610,35 @@ mixin _MultiPointerEventMixin on _BasicEventContext {
}
}

mixin _KeyboardModifiersMixin on _BasicEventContext {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My memory to this file is getting vague, but since this mixin is used for all three event classes, can we just add these new properties to _BasicEventContext?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we just add these new properties to _BasicEventContext?

Done, my first implementation was more complex so I did not want to clutter _BasicEventContent.

// Accepted modifier keys are 'Alt', 'Control', 'Meta' and 'Shift'.
// https://www.w3.org/TR/uievents-key/#keys-modifier defines more modifiers,
// but only the four main modifiers could be set from MouseEvent, PointerEvent
// and TouchEvent constructors.
bool altPressed = false;
bool ctrlPressed = false;
bool metaPressed = false;
bool shitPressed = false;

void pressAllModifiers() {
altPressed = true;
ctrlPressed = true;
metaPressed = true;
shitPressed = true;
}

void unpressAllModifiers() {
altPressed = false;
ctrlPressed = false;
metaPressed = false;
shitPressed = false;
}
}

// A test context for `_TouchAdapter`, including its name, PointerSupportDetector
// to override, and how to generate events.
class _TouchEventContext extends _BasicEventContext
with _MultiPointerEventMixin
with _MultiPointerEventMixin, _KeyboardModifiersMixin
implements PointerSupportDetector {
_TouchEventContext() : _target = domDocument.createElement('div');

Expand Down Expand Up @@ -2622,6 +2686,10 @@ class _TouchEventContext extends _BasicEventContext
),
)
.toList(),
'altKey': altPressed,
'ctrlKey': ctrlPressed,
'metaKey': metaPressed,
'shiftKey': shitPressed,
},
);
}
Expand Down Expand Up @@ -2652,7 +2720,7 @@ class _TouchEventContext extends _BasicEventContext
//
// For the difference between MouseEvent and PointerEvent, see _MouseAdapter.
class _MouseEventContext extends _BasicEventContext
with _ButtonedEventMixin
with _ButtonedEventMixin, _KeyboardModifiersMixin
implements PointerSupportDetector {
@override
String get name => 'MouseAdapter';
Expand Down Expand Up @@ -2757,6 +2825,10 @@ class _MouseEventContext extends _BasicEventContext
'button': button,
'clientX': clientX,
'clientY': clientY,
'altKey': altPressed,
'ctrlKey': ctrlPressed,
'metaKey': metaPressed,
'shiftKey': shitPressed,
}
];
return js_util.callConstructor<DomMouseEvent>(
Expand All @@ -2771,7 +2843,7 @@ class _MouseEventContext extends _BasicEventContext
//
// For the difference between MouseEvent and PointerEvent, see _MouseAdapter.
class _PointerEventContext extends _BasicEventContext
with _ButtonedEventMixin
with _ButtonedEventMixin, _KeyboardModifiersMixin
implements PointerSupportDetector, _MultiPointerEventMixin {
@override
String get name => 'PointerAdapter';
Expand Down Expand Up @@ -2835,6 +2907,10 @@ class _PointerEventContext extends _BasicEventContext
'clientX': clientX,
'clientY': clientY,
'pointerType': pointerType,
'altKey': altPressed,
'ctrlKey': ctrlPressed,
'metaKey': metaPressed,
'shiftKey': shitPressed,
});
}

Expand Down