Skip to content

Fix sticky scroll height calculation for variable line heights #3748

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
utafrali wants to merge 2 commits into
base: master
Choose a base branch
from
+28 −4
Open

Fix sticky scroll height calculation for variable line heights #3748

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
70575d9
Fix #3745: use offset-based getLineHeight() in StickyScrollingControl
utafrali Feb 26, 2026
6ee96b2
Version bump(s) for 4.40 stream
eclipse-platform-bot Feb 27, 2026
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
2 changes: 1 addition & 1 deletion bundles/org.eclipse.ui.editors/META-INF/MANIFEST.MF
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: %pluginName
Bundle-SymbolicName: org.eclipse.ui.editors; singleton:=true
Bundle-Version: 3.21.0.qualifier
Bundle-Version: 3.21.100.qualifier
Bundle-Activator: org.eclipse.ui.internal.editors.text.EditorsPlugin
Bundle-ActivationPolicy: lazy
Bundle-Vendor: %providerName
Expand Down
8 changes: 6 additions & 2 deletions ...i.editors/src/org/eclipse/ui/internal/texteditor/stickyscroll/StickyScrollingControl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,10 @@ private void calculateAndSetStickyLinesCanvasBounds() {
StyledText textWidget= sourceViewer.getTextWidget();

int numberStickyLines= getNumberStickyLines();
int lineHeight= stickyLineText.getLineHeight() * numberStickyLines;
int lineHeight= 0;
for (int i= 0; i < numberStickyLines; i++) {
lineHeight+= stickyLineText.getLineHeight(stickyLineText.getOffsetAtLine(i));
}
int spacingHeight= stickyLineText.getLineSpacing() * (numberStickyLines - 1);
int separatorHeight= bottomSeparator.getBounds().height;

Expand Down Expand Up @@ -450,7 +453,8 @@ private boolean areStickyLinesOutDated(StyledText textWidget) {
}

private void limitVisibleStickyLinesToTextWidgetHeight(StyledText textWidget) {
int lineHeight= textWidget.getLineHeight() + textWidget.getLineSpacing();
int topOffset= textWidget.getOffsetAtLine(textWidget.getTopIndex());
int lineHeight= textWidget.getLineHeight(topOffset) + textWidget.getLineSpacing();
int textWidgetHeight= textWidget.getBounds().height;

int visibleLinesInTextWidget= textWidgetHeight / lineHeight;
Expand Down
2 changes: 1 addition & 1 deletion tests/org.eclipse.ui.editors.tests/META-INF/MANIFEST.MF
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: %Plugin.name
Bundle-SymbolicName: org.eclipse.ui.editors.tests;singleton:=true
Bundle-Version: 3.14.0.qualifier
Bundle-Version: 3.14.100.qualifier
Bundle-Vendor: %Plugin.providerName
Bundle-Localization: plugin
Export-Package: org.eclipse.jface.text.tests.codemining,
Expand Down
20 changes: 20 additions & 0 deletions ...tests/src/org/eclipse/ui/internal/texteditor/stickyscroll/StickyScrollingControlTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,26 @@ void testStyling() {
assertEquals(hoverColor, stickyLineText.getForeground());
}

@Test
void testCanvasBoundsHeightMatchesPerLineHeights() {
sourceViewer.getTextWidget().setBounds(0, 0, 200, 200);
List<IStickyLine> stickyLines = List.of(new StickyLineStub("line 1", 0), new StickyLineStub("line 2", 1));
stickyScrollingControl.setStickyLines(stickyLines);

Canvas stickyControlCanvas = getStickyControlCanvas(shell);
StyledText stickyLineText = getStickyLineText();
Composite stickyLineSeparator = getStickyLineSeparator();

int expectedHeight = 0;
for (int i = 0; i < 2; i++) {
expectedHeight += stickyLineText.getLineHeight(stickyLineText.getOffsetAtLine(i));
}
expectedHeight += stickyLineText.getLineSpacing(); // (2-1) * spacing
expectedHeight += stickyLineSeparator.getBounds().height;

assertEquals(expectedHeight, stickyControlCanvas.getBounds().height);
}

@Test
void testLayoutStickyLinesCanvasOnResize() {
sourceViewer.getTextWidget().setBounds(0, 0, 200, 200);
Expand Down
Loading