Skip to content

Have chats respond to PgUp and PgDown #4158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
neminatha wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Have chats respond to PgUp and PgDown #4158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
154 changes: 154 additions & 0 deletions apps/desktop/desktop/src/main/java/bisq/desktop/common/utils/PageScrollHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
/*
* This file is part of Bisq.
*
* Bisq is free software: you can redistribute it and/or modify it
* under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or (at
* your option) any later version.
*
* Bisq is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
* License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with Bisq. If not, see <http://www.gnu.org/licenses/>.
*/

package bisq.desktop.common.utils;

import bisq.desktop.components.list_view.ListViewUtil;
import javafx.event.EventHandler;
import javafx.geometry.Orientation;
import javafx.scene.AccessibleAction;
import javafx.scene.Node;
import javafx.scene.Scene;
import javafx.scene.control.ListView;
import javafx.scene.control.ScrollBar;
import javafx.scene.control.TextInputControl;
import javafx.scene.input.KeyCode;
import javafx.scene.input.KeyEvent;
import lombok.extern.slf4j.Slf4j;
import org.fxmisc.easybind.Subscription;

import java.util.Objects;

/**
* Handler to enable page-wise keyboard scrolling for a JavaFX ListView Control.
* <p>
* Utility that installs a key event handler on a JavaFX ListView to perform page-wise
* scrolling when the PAGE_UP and PAGE_DOWN keys are pressed. The handler locates the
* control's vertical ScrollBar (if present) and adjusts its value by the ScrollBar's
* block increment, mimicking a page click on the scrollbar trough. The key event is
* consumed only when a scroll action is performed.
* </p>
* <p>
* Note: the handler is registered using {@code addEventFilter}, i.e. it runs in the
* capturing phase (filter phase) while events travel from the root toward the target node.
* This allows centralized preprocessing of PageUp/PageDown keys for the ListView before
* the event reaches the target node.
* </p>
* <p>
* To ensure that input fields keep their normal keyboard behavior, the handler
* checks with {@link #isInlineEditorActive()} whether a descendant editable
* {@link TextInputControl} is currently focused. If an editor is active, the filter does
* not consume the event — the event will continue to the normal target/bubbling phase and
* can be handled by the editor. If no editor is focused, the filter consumes the event
* (via {@code event.consume()}) after a scroll occurred.
* </p>
* <p>
* Typical usage:
* <ul>
* <li>Instantiate with a JavaFX ListView Control.</li>
* <li>Call {@link #subscribe()} to enable the handler.</li>
* <li>Call {@link #unsubscribe()} to remove the handler.</li>
* </ul>
* </p>
* <p>
* Note: methods that inspect or modify the scene graph (e.g. locating ScrollBars)
* must be called on the JavaFX Application Thread.
* </p>
*/
@Slf4j
public class PageScrollHandler implements Subscription {

private final ListView<?> listView;
private final EventHandler<KeyEvent> keyEventFilter;

public PageScrollHandler(ListView<?> listView) {
this.listView = Objects.requireNonNull(listView);
this.keyEventFilter = createKeyEventFilter();
}

private EventHandler<KeyEvent> createKeyEventFilter() {
return event -> {
if (event.getCode() == KeyCode.PAGE_UP) {
if (!isInlineEditorActive()) {
if (scrollPageUp()) {
event.consume();
}
}
} else if (event.getCode() == KeyCode.PAGE_DOWN) {
if (!isInlineEditorActive()) {
if (scrollPageDown()) {
event.consume();
}
}
}
};
}

public void subscribe() {
unsubscribe();
listView.addEventFilter(KeyEvent.KEY_PRESSED, keyEventFilter);
}

public void unsubscribe() {
listView.removeEventFilter(KeyEvent.KEY_PRESSED, keyEventFilter);
}

public boolean scrollPageUp() {
return ListViewUtil.findScrollbar(listView, Orientation.VERTICAL)
.map(this::adjustScrollBarBlockDecrement)
.orElse(false);
}

public boolean scrollPageDown() {
return ListViewUtil.findScrollbar(listView, Orientation.VERTICAL)
.map(this::adjustScrollBarBlockIncrement)
.orElse(false);
}

private boolean adjustScrollBarBlockDecrement(ScrollBar vbar) {
return adjustScrollBar(vbar, AccessibleAction.BLOCK_DECREMENT);
}

private boolean adjustScrollBarBlockIncrement(ScrollBar vbar) {
return adjustScrollBar(vbar, AccessibleAction.BLOCK_INCREMENT);
}

private boolean adjustScrollBar(ScrollBar vbar, AccessibleAction action) {
double oldValue = vbar.getValue();
vbar.executeAccessibleAction(action);
return oldValue != vbar.getValue();
}

private boolean isInlineEditorActive() {
Scene scene = listView.getScene();
if (scene == null) return false;
Node focusOwner = scene.getFocusOwner();
return isEditable(focusOwner) && isChildOfList(focusOwner);
}

private boolean isEditable(Node focusOwner) {
return focusOwner instanceof TextInputControl && ((TextInputControl) focusOwner).isEditable();
}

private boolean isChildOfList(Node node) {
while (node != null) {
if (node == listView) return true;
node = node.getParent();
}
return false;
}
}
8 changes: 8 additions & 0 deletions ...java/bisq/desktop/main/content/chat/message_container/ChatMessageContainerController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,14 @@ void onArrowUpKeyPressed() {
chatMessagesListController.editMyLastMessage();
}

boolean onPageUpKeyPressed() {
return chatMessagesListController.scrollPageUp();
}

boolean onPageDownKeyPressed() {
return chatMessagesListController.scrollPageDown();
}

void onUserProfileSelected(UserProfile user) {
String content = model.getTextInput().get().replaceAll("@[a-zA-Z\\d]*$", "@" + user.getUserName() + " ");
model.getTextInput().set(content);
Expand Down
17 changes: 17 additions & 0 deletions .../main/java/bisq/desktop/main/content/chat/message_container/ChatMessageContainerView.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
import javafx.scene.image.ImageView;
import javafx.scene.input.KeyCode;
import javafx.scene.input.KeyEvent;
import javafx.scene.input.MouseEvent;
import javafx.scene.layout.HBox;
import javafx.scene.layout.Pane;
import javafx.scene.layout.Priority;
Expand Down Expand Up @@ -89,6 +90,9 @@ public ChatMessageContainerView(ChatMessageContainerModel model,

@Override
protected void onViewAttached() {
// Consume mouse pressed events on the root to prevent them from propagating to underlying layers
root.setOnMousePressed(MouseEvent::consume);

userProfileSelectionRoot.visibleProperty().bind(model.getShouldShowUserProfileSelection());
userProfileSelectionRoot.managedProperty().bind(model.getShouldShowUserProfileSelection());
myProfileCatHashImageView.visibleProperty().bind(model.getShouldShowUserProfile());
Expand Down Expand Up @@ -152,6 +156,7 @@ protected void onViewDetached() {
inputField.removeEventFilter(KEY_PRESSED, keyPressedHandler);
sendButton.setOnAction(null);
userMentionPopup.cleanup();
root.setOnMousePressed(null);
}

private VBox createAndGetBottomBar(UserProfileSelection userProfileSelection) {
Expand Down Expand Up @@ -256,6 +261,18 @@ private void processKeyPressed(KeyEvent keyEvent) {
inputField.positionCaret(0);
}
}
} else if (keyEvent.getCode() == KeyCode.PAGE_UP) {
if (inputField.getText().isEmpty()) {
if (controller.onPageUpKeyPressed()) {
keyEvent.consume();
}
}
} else if (keyEvent.getCode() == KeyCode.PAGE_DOWN) {
if (inputField.getText().isEmpty()) {
if (controller.onPageDownKeyPressed()) {
keyEvent.consume();
}
}
}
}
}
7 changes: 7 additions & 0 deletions ...ava/bisq/desktop/main/content/chat/message_container/list/ChatMessagesListController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -669,6 +669,13 @@ void onScrollToBottom() {
applyScrollValue(1);
}

public boolean scrollPageUp() {
return view.getPageScrollHandler().scrollPageUp();
}

public boolean scrollPageDown() {
return view.getPageScrollHandler().scrollPageDown();
}

/* --------------------------------------------------------------------- */
// Private
Expand Down
8 changes: 8 additions & 0 deletions ...main/java/bisq/desktop/main/content/chat/message_container/list/ChatMessagesListView.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import bisq.chat.ChatChannel;
import bisq.chat.ChatMessage;
import bisq.desktop.common.ManagedDuration;
import bisq.desktop.common.utils.PageScrollHandler;
import bisq.desktop.components.controls.Badge;
import bisq.desktop.components.controls.BisqTooltip;
import bisq.desktop.components.list_view.ListViewUtil;
Expand All @@ -46,6 +47,7 @@
import javafx.scene.layout.Priority;
import javafx.scene.layout.StackPane;
import javafx.scene.layout.VBox;
import lombok.AccessLevel;
import lombok.Getter;
import lombok.extern.slf4j.Slf4j;
import org.fxmisc.easybind.EasyBind;
Expand Down Expand Up @@ -74,6 +76,8 @@ protected void layoutChildren() {
private final Label placeholderTitle = new Label("");
private final Label placeholderDescription = new Label("");
private final Pane scrollDownBackground;
@Getter(AccessLevel.PACKAGE)
private final PageScrollHandler pageScrollHandler;
private Optional<ScrollBar> scrollBar = Optional.empty();
private Subscription hasUnreadMessagesPin, showScrolledDownButtonPin;
private Timeline fadeInScrollDownBadgeTimeline;
Expand All @@ -93,6 +97,8 @@ public ChatMessagesListView(ChatMessagesListModel model, ChatMessagesListControl
listView.setSelectionModel(new NoSelectionModel<>());
VBox.setVgrow(listView, Priority.ALWAYS);

pageScrollHandler = new PageScrollHandler(listView);

scrollDownBackground = new Pane();
scrollDownBackground.getStyleClass().add("scroll-down-bg");

Expand Down Expand Up @@ -171,6 +177,7 @@ protected void onViewAttached() {
model.getLayoutChildrenDone().bind(root.getLayoutChildrenDone());

scrollDownBadge.setOnMouseClicked(e -> controller.onScrollToBottom());
pageScrollHandler.subscribe();
}

@Override
Expand All @@ -185,6 +192,7 @@ protected void onViewDetached() {
model.getLayoutChildrenDone().unbind();
hasUnreadMessagesPin.unsubscribe();
showScrolledDownButtonPin.unsubscribe();
pageScrollHandler.unsubscribe();

Tooltip.uninstall(scrollDownBadge, scrollDownTooltip);

Expand Down
Loading