RFR: 8313424: JavaFX controls in the title bar [v3]
Thiago Milczarek Sayao
tsayao at openjdk.org
Tue Oct 22 10:09:18 UTC 2024
On Sun, 20 Oct 2024 01:23:01 GMT, Michael Strauß <mstrauss at openjdk.org> wrote:
>> This PR is a new take on a highly requested feature: JavaFX controls in the header bar (see also #594 for an earlier iteration).
>>
>> This is a feature with many possible ways to skin the cat, and it has taken quite a bit of effort to come up with a good user model. In contrast to the previous iteration, the focus has shifted from providing an entirely undecorated window to providing a window with a user-configurable header bar.
>>
>> The customizable header bar is a new layout container: `javafx.scene.layout.HeaderBar`. It has three areas that accept child nodes: leading, center, and trailing. `HeaderBar` also automatically adjusts for the placement of the default window buttons (minimize, maximize, close) on the left or right side of the window.
>>
>> The customizable header bar is combined with a new `EXTENDED` stage style, which extends the client area into the header bar area. The new extended stage style is supported on Windows, macOS, and Linux. For platforms that don't support this stage style, it automatically downgrades to `DECORATED`.
>>
>> This is how it looks like on each of the three operating systems:
>>
>> 
>>
>> The window buttons (minimize, maximize, close) are provided by JavaFX, not by the application developer. This makes it easier to get basic window functionality without recreating the entirety of the window controls for all platforms.
>>
>> ## Usage
>> This is a minimal example that uses a custom header bar with a `TextField` in the center area. `HeaderBar` is usually placed in the top area of a `BorderPane` root container:
>>
>> public class MyApp extends Application {
>> @Override
>> public void start(Stage stage) {
>> var headerBar = new HeaderBar();
>> headerBar.setCenter(new TextField());
>>
>> var root = new BorderPane();
>> root.setTop(headerBar);
>>
>> stage.setScene(new Scene(root));
>> stage.initStyle(StageStyle.EXTENDED);
>> stage.show();
>> }
>> }
>>
>> To learn more about the details of the API, refer to the documentation of `StageStyle.EXTENDED` and `HeaderBar`.
>>
>> ## Platform integration
>> The implementation varies per platform, and ranges from pretty easy to quite involved:
>> 1. **macOS**: The window buttons are provided by macOS, we just leave an empty area where the window buttons will appear. The client area is extended to cover the entire window by setting the `NSW...
>
> Michael Strauß has updated the pull request incrementally with one additional commit since the last revision:
>
> revert unintended change
I think we should look at uses cases and design a simple solution that can be extended.
Doing this with JavaFX as it is now will be hacky, since it would need to touch internals that are not exposed by default.
Intellij Idea
Nautilus
Chrome
Amberol (music player).
App Center (Ubuntu Software Store) - This one uses flutter
Some of them has no title at all. Some fuses the HeaderBar with the body, like nautilus. Even chrome, the tabs on the HeaderBar are not "isolated" from the body.
On modern Gnome, everything is client side decorated. Server side decoration is legacy. It's better for rendering since the window manager does not need to calculate, draw and sync with the window. It's probably less flickery.
Since JavaFx accounts the title as part of the window size, the current glass implementation is very hacky because it needs to request the decoration sizes from the window manager and then recalculate it. Having it on the client side is much better, because no hacky solution is required.
-------------
PR Comment: https://git.openjdk.org/jfx/pull/1605#issuecomment-2428857756
More information about the openjfx-dev
mailing list