Skip to content

Improve JFace notification snippets and documentation #3810

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

Draft
vogella wants to merge 1 commit into
base: master
Choose a base branch
from
+45 −88
Draft

Improve JFace notification snippets and documentation #3810

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
25 changes: 9 additions & 16 deletions docs/JFaceSnippets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,35 +43,28 @@ The JFace ColorSelector widget is a convenient composition of button and color s
Notification
------------

### [Snippet081 - Notification API](https://raw.githubusercontent.com/eclipse-platform/eclipse.platform.ui/master/examples/org.eclipse.jface.snippets/Eclipse%20JFace%20Snippets/org/eclipse/jface/snippets/dialogs/Snippet081NotificationPopup.java)
### [Snippet001 - Simple Notification Popup with Strings](https://github.com/eclipse-platform/eclipse.platform.ui/blob/master/examples/org.eclipse.jface.snippets/Eclipse%20JFace%20Snippets/org/eclipse/jface/snippets/notifications/Snippet001NotificationPopupWithStrings.java)

* [Snippet081 - Notication API](https://raw.githubusercontent.com/eclipse-platform/eclipse.platform.ui/master/examples/org.eclipse.jface.snippets/Eclipse%20JFace%20Snippets/org/eclipse/jface/snippets/dialogs/Snippet081NotificationPopup.java)
Demonstrates the simplest usage of the `NotificationPopup` builder API with plain strings for title and content.


Demonstrates usage of the non-blocking notification API
### [Snippet081 - Notification API](https://raw.githubusercontent.com/eclipse-platform/eclipse.platform.ui/master/examples/org.eclipse.jface.snippets/Eclipse%20JFace%20Snippets/org/eclipse/jface/snippets/dialogs/Snippet081NotificationPopup.java)

Demonstrates usage of the non-blocking notification API with `forShell()`, showing notifications triggered by button clicks.


![Snippet081 Shell1.gif](images/Snippet081_Shell1.gif)

### [Snippet083 - Notification Popup with Functions](https://github.com/eclipse-platform/eclipse.platform.ui/blob/master/examples/org.eclipse.jface.snippets/Eclipse%20JFace%20Snippets/org/eclipse/jface/snippets/notifications/Snippet083NotificationPopupWithFunctions.java)

* [Snippet083 - Notification Popup with Functions](https://github.com/eclipse-platform/eclipse.platform.ui/blob/master/examples/org.eclipse.jface.snippets/Eclipse%20JFace%20Snippets/org/eclipse/jface/snippets/notifications/Snippet083NotificationPopupWithFunctions.java)

Demonstrates the creation of notification popups that include function callbacks for user interactions.
Demonstrates the creation of notification popups using `Function<Composite, Control>` for custom title and content creation.

### [Snippet084 - Notification Popup with Custom Delay and Fade](https://github.com/eclipse-platform/eclipse.platform.ui/blob/master/examples/org.eclipse.jface.snippets/Eclipse%20JFace%20Snippets/org/eclipse/jface/snippets/notifications/Snippet084NotificationPopupWithCustomDelayAndFade.java)

* [Snippet084 - Notification Popup with Custom Delay and Fade](https://github.com/eclipse-platform/eclipse.platform.ui/blob/master/examples/org.eclipse.jface.snippets/Eclipse%20JFace%20Snippets/org/eclipse/jface/snippets/notifications/Snippet084NotificationPopupWithCustomDelayAndFade.java)

Shows how to create notification popups with custom delay and fade effects for enhanced visual feedback.

### [Snippet085 - Notification popup with user interaction](https://github.com/eclipse-platform/eclipse.platform.ui/blob/master/examples/org.eclipse.jface.snippets/Eclipse%20JFace%20Snippets/org/eclipse/jface/snippets/notifications/Snippet085NotificationPopupWithUserInteraction.java)
Shows how to create notification popups with custom delay and fade-in effects using the `delay()` and `fadeIn()` builder methods.

This snippet demonstrates how to create a `NotificationPopup` that includes user interaction with a button. When the button is clicked, a confirmation dialog is shown.
### [Snippet085 - Notification Popup with User Interaction](https://github.com/eclipse-platform/eclipse.platform.ui/blob/master/examples/org.eclipse.jface.snippets/Eclipse%20JFace%20Snippets/org/eclipse/jface/snippets/notifications/Snippet085NotificationPopupWithUserInteraction.java)

For the full code, please visit the [GitHub repository](https://github.com/eclipse-platform/eclipse.platform.ui/blob/master/examples/org.eclipse.jface.snippets/Eclipse%20JFace%20Snippets/org/eclipse/jface/snippets/notifications/Snippet085NotificationPopupWithUserInteraction.java).
Demonstrates a `NotificationPopup` with interactive content — a label and a button that opens a confirmation dialog when clicked.


![Snippet085.png](images/Snippet085NotificationPopupWithUserInteraction.png)


Expand Down
2 changes: 1 addition & 1 deletion ...nippet001NotifcationPopupWithStrings.java → ...ippet001NotificationPopupWithStrings.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell;

public class Snippet001NotifcationPopupWithStrings {
public class Snippet001NotificationPopupWithStrings {

public static void main(String[] args) {
Display display = new Display();
Expand Down
18 changes: 9 additions & 9 deletions ...lipse/jface/snippets/notifications/Snippet084NotificationPopupWithCustomDelayAndFade.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ public class Snippet084NotificationPopupWithCustomDelayAndFade {
public static void main(String[] args) {
Display display = new Display();

NotificationPopup.forDisplay(display).text("Just a notification").title("Test", false).delay(500)
.fadeIn(true).open();
NotificationPopup.forDisplay(display).text("Just a notification").title("Test", false).delay(500).fadeIn(true)
.open();

Shell shell = display.getShells()[0];
while (!shell.isDisposed()) {
if (!display.readAndDispatch())
display.sleep();
}
Shell shell = display.getShells()[0];
while (!shell.isDisposed()) {
if (!display.readAndDispatch())
display.sleep();
}

display.dispose();
display.dispose();
}
}
}
88 changes: 26 additions & 62 deletions .../eclipse/jface/snippets/notifications/Snippet085NotificationPopupWithUserInteraction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,71 +4,35 @@
import org.eclipse.jface.notifications.NotificationPopup;
import org.eclipse.jface.widgets.WidgetFactory;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Shell;

public class Snippet085NotificationPopupWithUserInteraction {

public static void main(String[] args) {
Display display = new Display();
Shell shell = new Shell(display); // Create the shell

// Set the size of the shell
shell.setSize(400, 200);

// Create content for the notification popup
Composite contentComposite = new Composite(shell, SWT.NONE);
GridLayout layout = new GridLayout();
layout.marginWidth = 10; // Margin width
layout.marginHeight = 10; // Margin height
contentComposite.setLayout(layout);

// Create a bold label with wrapped text
Label firstLine = new Label(contentComposite, SWT.WRAP);
firstLine.setText("It is recommended that you");
Font boldFont = new Font(display, "Arial", 10, SWT.BOLD);
firstLine.setFont(boldFont);
// Create a bold label with wrapped text
Label secondLine = new Label(contentComposite, SWT.WRAP);
secondLine.setText("update your configuration");
secondLine.setFont(boldFont);


// Create a button that will show the confirmation dialog when clicked
Button button = new Button(contentComposite, SWT.PUSH);
button.setText("Confirm");

button.addListener(SWT.Selection, event -> {
MessageDialog.openConfirm(shell, "Confirmation", "Button was pressed!");
});

// Set GridData for button to align properly in the layout
GridData gridData = new GridData(SWT.LEFT, SWT.CENTER, false, false);
button.setLayoutData(gridData);

// Create the notification popup
NotificationPopup.forDisplay(display)
.content(composite -> {
contentComposite.setParent(composite);
return composite;
})
.title(composite -> WidgetFactory.label(SWT.NONE).text("System update!!!").create(composite), true)
.open();

shell.open(); // Open the shell

while (!shell.isDisposed()) {
if (!display.readAndDispatch())
display.sleep();
}

boldFont.dispose(); // Dispose of the font when done
display.dispose();
}
public static void main(String[] args) {
Display display = new Display();
Shell shell = new Shell(display);
shell.setSize(400, 200);

NotificationPopup.forDisplay(display)
.content(parent -> {
WidgetFactory.label(SWT.WRAP).text("It is recommended that you\nupdate your configuration")
.create(parent);
WidgetFactory.button(SWT.PUSH).text("Confirm")
.onSelect(e -> MessageDialog.openConfirm(shell, "Confirmation", "Button was pressed!"))
.create(parent);
return parent;
})
.title("System update", true)
.open();

shell.open();

while (!shell.isDisposed()) {
if (!display.readAndDispatch())
display.sleep();
}

display.dispose();
}
}
Loading