angel/FlatLaf
1
0
Fork 0
mirror of https://github.com/JFormDesigner/FlatLaf.git synced 2026-02-11 14:37:13 -06:00
Code Issues Packages Projects Releases Wiki Activity

Extras: added class FlatDesktop for easy integration into macOS screen menu (About, Preferences and Quit) when using Java 8

Browse Source 
Demo:
- use class `FlatDesktop`
- hide "File > Exit" and "Help > About" on macOS
This commit is contained in:
Karl Tauber
2021-10-24 09:44:34 +02:00
parent f8b9f4c1fa
commit cc238d3e34
4 changed files with 265 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@@ -34,6 +34,8 @@ FlatLaf Change Log
applications: `lighten()`, `darken()`, `saturate()`, `desaturate()`, `spin()`, applications: `lighten()`, `darken()`, `saturate()`, `desaturate()`, `spin()`,
`tint()`, `shade()` and `luma()`. `tint()`, `shade()` and `luma()`.
- Support defining fonts in FlatLaf properties files. (issue #384) - Support defining fonts in FlatLaf properties files. (issue #384)
- Extras: Added class `FlatDesktop` for easy integration into macOS screen menu
(About, Preferences and Quit) when using Java 8.
#### Fixed bugs #### Fixed bugs

41
flatlaf-demo/src/main/java/com/formdev/flatlaf/demo/DemoFrame.java
View File

@@ -37,6 +37,7 @@ import com.formdev.flatlaf.FlatLightLaf;
import com.formdev.flatlaf.demo.HintManager.Hint; import com.formdev.flatlaf.demo.HintManager.Hint;
import com.formdev.flatlaf.demo.extras.*; import com.formdev.flatlaf.demo.extras.*;
import com.formdev.flatlaf.demo.intellijthemes.*; import com.formdev.flatlaf.demo.intellijthemes.*;
import com.formdev.flatlaf.extras.FlatDesktop;
import com.formdev.flatlaf.extras.FlatAnimatedLafChange; import com.formdev.flatlaf.extras.FlatAnimatedLafChange;
import com.formdev.flatlaf.extras.FlatSVGIcon; import com.formdev.flatlaf.extras.FlatSVGIcon;
import com.formdev.flatlaf.extras.FlatUIDefaultsInspector; import com.formdev.flatlaf.extras.FlatUIDefaultsInspector;
@@ -81,6 +82,22 @@ class DemoFrame
if( tabIndex >= 0 && tabIndex < tabbedPane.getTabCount() && tabIndex != tabbedPane.getSelectedIndex() ) if( tabIndex >= 0 && tabIndex < tabbedPane.getTabCount() && tabIndex != tabbedPane.getSelectedIndex() )
tabbedPane.setSelectedIndex( tabIndex ); tabbedPane.setSelectedIndex( tabIndex );
// hide some menu items on macOS
if( SystemInfo.isMacOS ) {
exitMenuItem.setVisible( false );
aboutMenuItem.setVisible( false );
// do not use HTML text on macOS
htmlMenuItem.setText( "some text" );
}
// integrate into macOS screen menu
FlatDesktop.setAboutHandler( this::aboutActionPerformed );
FlatDesktop.setPreferencesHandler( this::showPreferences );
FlatDesktop.setQuitHandler( response -> {
response.performQuit();
} );
SwingUtilities.invokeLater( () -> { SwingUtilities.invokeLater( () -> {
showHints(); showHints();
} ); } );
@@ -174,6 +191,13 @@ class DemoFrame
"About", JOptionPane.PLAIN_MESSAGE ); "About", JOptionPane.PLAIN_MESSAGE );
} }
private void showPreferences() {
JOptionPane.showMessageDialog( this,
"Sorry, but FlatLaf Demo does not have preferences. :(\n"
+ "This dialog is here to demonstrate usage of class 'FlatDesktop' on macOS.",
"Preferences", JOptionPane.PLAIN_MESSAGE );
}
private void selectedTabChanged() { private void selectedTabChanged() {
DemoPrefs.getState().putInt( FlatLafDemo.KEY_TAB, tabbedPane.getSelectedIndex() ); DemoPrefs.getState().putInt( FlatLafDemo.KEY_TAB, tabbedPane.getSelectedIndex() );
} }
@@ -346,7 +370,7 @@ class DemoFrame
private JLabel accentColorLabel; private JLabel accentColorLabel;
private void initAccentColors() { private void initAccentColors() {
accentColorLabel = new JLabel( "Accent color:" ); accentColorLabel = new JLabel( "Accent color: " );
toolBar.add( Box.createHorizontalGlue() ); toolBar.add( Box.createHorizontalGlue() );
toolBar.add( accentColorLabel ); toolBar.add( accentColorLabel );
@@ -412,7 +436,7 @@ class DemoFrame
JMenuItem openMenuItem = new JMenuItem(); JMenuItem openMenuItem = new JMenuItem();
JMenuItem saveAsMenuItem = new JMenuItem(); JMenuItem saveAsMenuItem = new JMenuItem();
JMenuItem closeMenuItem = new JMenuItem(); JMenuItem closeMenuItem = new JMenuItem();
JMenuItem exitMenuItem = new JMenuItem(); exitMenuItem = new JMenuItem();
JMenu editMenu = new JMenu(); JMenu editMenu = new JMenu();
JMenuItem undoMenuItem = new JMenuItem(); JMenuItem undoMenuItem = new JMenuItem();
JMenuItem redoMenuItem = new JMenuItem(); JMenuItem redoMenuItem = new JMenuItem();
@@ -431,7 +455,7 @@ class DemoFrame
JMenuItem structureViewMenuItem = new JMenuItem(); JMenuItem structureViewMenuItem = new JMenuItem();
JMenuItem propertiesViewMenuItem = new JMenuItem(); JMenuItem propertiesViewMenuItem = new JMenuItem();
JMenuItem menuItem2 = new JMenuItem(); JMenuItem menuItem2 = new JMenuItem();
JMenuItem menuItem1 = new JMenuItem(); htmlMenuItem = new JMenuItem();
JRadioButtonMenuItem radioButtonMenuItem1 = new JRadioButtonMenuItem(); JRadioButtonMenuItem radioButtonMenuItem1 = new JRadioButtonMenuItem();
JRadioButtonMenuItem radioButtonMenuItem2 = new JRadioButtonMenuItem(); JRadioButtonMenuItem radioButtonMenuItem2 = new JRadioButtonMenuItem();
JRadioButtonMenuItem radioButtonMenuItem3 = new JRadioButtonMenuItem(); JRadioButtonMenuItem radioButtonMenuItem3 = new JRadioButtonMenuItem();
@@ -449,7 +473,7 @@ class DemoFrame
JMenuItem showHintsMenuItem = new JMenuItem(); JMenuItem showHintsMenuItem = new JMenuItem();
JMenuItem showUIDefaultsInspectorMenuItem = new JMenuItem(); JMenuItem showUIDefaultsInspectorMenuItem = new JMenuItem();
JMenu helpMenu = new JMenu(); JMenu helpMenu = new JMenu();
JMenuItem aboutMenuItem = new JMenuItem(); aboutMenuItem = new JMenuItem();
toolBar = new JToolBar(); toolBar = new JToolBar();
JButton backButton = new JButton(); JButton backButton = new JButton();
JButton forwardButton = new JButton(); JButton forwardButton = new JButton();
@@ -638,9 +662,9 @@ class DemoFrame
menuItem2.setEnabled(false); menuItem2.setEnabled(false);
viewMenu.add(menuItem2); viewMenu.add(menuItem2);
//---- menuItem1 ---- //---- htmlMenuItem ----
menuItem1.setText("<html>some <b color=\"red\">HTML</b> <i color=\"blue\">text</i></html>"); htmlMenuItem.setText("<html>some <b color=\"red\">HTML</b> <i color=\"blue\">text</i></html>");
viewMenu.add(menuItem1); viewMenu.add(htmlMenuItem);
viewMenu.addSeparator(); viewMenu.addSeparator();
//---- radioButtonMenuItem1 ---- //---- radioButtonMenuItem1 ----
@@ -886,6 +910,8 @@ class DemoFrame
} }
// JFormDesigner - Variables declaration - DO NOT MODIFY //GEN-BEGIN:variables // JFormDesigner - Variables declaration - DO NOT MODIFY //GEN-BEGIN:variables
private JMenuItem exitMenuItem;
private JMenuItem htmlMenuItem;
private JMenu fontMenu; private JMenu fontMenu;
private JMenu optionsMenu; private JMenu optionsMenu;
private JCheckBoxMenuItem windowDecorationsCheckBoxMenuItem; private JCheckBoxMenuItem windowDecorationsCheckBoxMenuItem;
@@ -894,6 +920,7 @@ class DemoFrame
private JCheckBoxMenuItem underlineMenuSelectionMenuItem; private JCheckBoxMenuItem underlineMenuSelectionMenuItem;
private JCheckBoxMenuItem alwaysShowMnemonicsMenuItem; private JCheckBoxMenuItem alwaysShowMnemonicsMenuItem;
private JCheckBoxMenuItem animatedLafChangeMenuItem; private JCheckBoxMenuItem animatedLafChangeMenuItem;
private JMenuItem aboutMenuItem;
private JToolBar toolBar; private JToolBar toolBar;
private JTabbedPane tabbedPane; private JTabbedPane tabbedPane;
private ControlBar controlBar; private ControlBar controlBar;

13
flatlaf-demo/src/main/java/com/formdev/flatlaf/demo/DemoFrame.jfd
View File

@@ -1,4 +1,4 @@
JFDML JFormDesigner: "7.0.4.0.360" Java: "11.0.11" encoding: "UTF-8" JFDML JFormDesigner: "7.0.4.0.360" Java: "17" encoding: "UTF-8"
new FormModel { new FormModel {
contentType: "form/swing" contentType: "form/swing"
@@ -170,6 +170,9 @@ new FormModel {
"text": "Exit" "text": "Exit"
"accelerator": static javax.swing.KeyStroke getKeyStroke( 81, 4226, false ) "accelerator": static javax.swing.KeyStroke getKeyStroke( 81, 4226, false )
"mnemonic": 88 "mnemonic": 88
auxiliary() {
"JavaCodeGenerator.variableLocal": false
}
addEvent( new FormEvent( "java.awt.event.ActionListener", "actionPerformed", "exitActionPerformed", false ) ) addEvent( new FormEvent( "java.awt.event.ActionListener", "actionPerformed", "exitActionPerformed", false ) )
} ) } )
} ) } )
@@ -285,8 +288,11 @@ new FormModel {
"enabled": false "enabled": false
} ) } )
add( new FormComponent( "javax.swing.JMenuItem" ) { add( new FormComponent( "javax.swing.JMenuItem" ) {
name: "menuItem1" name: "htmlMenuItem"
"text": "<html>some <b color=\"red\">HTML</b> <i color=\"blue\">text</i></html>" "text": "<html>some <b color=\"red\">HTML</b> <i color=\"blue\">text</i></html>"
auxiliary() {
"JavaCodeGenerator.variableLocal": false
}
} ) } )
add( new FormComponent( "javax.swing.JPopupMenu$Separator" ) { add( new FormComponent( "javax.swing.JPopupMenu$Separator" ) {
name: "separator8" name: "separator8"
@@ -415,6 +421,9 @@ new FormModel {
name: "aboutMenuItem" name: "aboutMenuItem"
"text": "About" "text": "About"
"mnemonic": 65 "mnemonic": 65
auxiliary() {
"JavaCodeGenerator.variableLocal": false
}
addEvent( new FormEvent( "java.awt.event.ActionListener", "actionPerformed", "aboutActionPerformed", false ) ) addEvent( new FormEvent( "java.awt.event.ActionListener", "actionPerformed", "aboutActionPerformed", false ) )
} ) } )
} ) } )

218
flatlaf-extras/src/main/java/com/formdev/flatlaf/extras/FlatDesktop.java Normal file
View File

@@ -0,0 +1,218 @@
/*
* Copyright 2021 FormDev Software GmbH
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.formdev.flatlaf.extras;
import java.awt.Desktop;
import java.awt.EventQueue;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.util.function.Consumer;
import com.formdev.flatlaf.util.LoggingFacade;
import com.formdev.flatlaf.util.SystemInfo;
/**
* Supports interaction with desktop.
* <p>
* <strong>Note</strong>: If you application requires Java 9 or later,
* then use class {@link java.awt.Desktop} instead of this class.
*
* @author Karl Tauber
* @since 2
*/
public class FlatDesktop
{
public enum Action { APP_ABOUT, APP_PREFERENCES, APP_QUIT_HANDLER };
/**
* Checks whether the given action is supported on the current platform.
*/
public static boolean isSupported( Action action ) {
if( SystemInfo.isJava_9_orLater ) {
try {
return Desktop.getDesktop().isSupported( Enum.valueOf( Desktop.Action.class, action.name() ) );
} catch( Exception ex ) {
LoggingFacade.INSTANCE.logSevere( null, ex );
return false;
}
} else if( SystemInfo.isMacOS )
return true;
else
return false;
}
/**
* Sets a handler to show a custom About dialog.
* <p>
* Useful for macOS to enable menu item "MyApp > About".
* <p>
* Uses:
* <ul>
* <li>Java 8 on macOS: com.apple.eawt.Application.getApplication().setAboutHandler(com.apple.eawt.AboutHandler)
* <li>Java 9+: java.awt.Desktop.getDesktop().setAboutHandler(java.awt.desktop.AboutHandler)
* </ul>
*/
public static void setAboutHandler( Runnable aboutHandler ) {
if( !isSupported( Action.APP_ABOUT ) )
return;
String handlerClassName;
if( SystemInfo.isJava_9_orLater )
handlerClassName = "java.awt.desktop.AboutHandler";
else if( SystemInfo.isMacOS )
handlerClassName = "com.apple.eawt.AboutHandler";
else
return;
setHandler( "setAboutHandler", handlerClassName, aboutHandler );
}
/**
* Sets a handler to show a custom Preferences dialog.
* <p>
* Useful for macOS to enable menu item "MyApp > Preferences".
* <p>
* Uses:
* <ul>
* <li>Java 8 on macOS: com.apple.eawt.Application.getApplication().setPreferencesHandler(com.apple.eawt.PreferencesHandler)
* <li>Java 9+: java.awt.Desktop.getDesktop().setPreferencesHandler(java.awt.desktop.PreferencesHandler)
* </ul>
*/
public static void setPreferencesHandler( Runnable preferencesHandler ) {
if( !isSupported( Action.APP_PREFERENCES ) )
return;
String handlerClassName;
if( SystemInfo.isJava_9_orLater )
handlerClassName = "java.awt.desktop.PreferencesHandler";
else if( SystemInfo.isMacOS )
handlerClassName = "com.apple.eawt.PreferencesHandler";
else
return;
setHandler( "setPreferencesHandler", handlerClassName, preferencesHandler );
}
private static void setHandler( String setHandlerMethodName, String handlerClassName,
Runnable handler )
{
try {
Object desktopOrApplication = getDesktopOrApplication();
Class<?> handlerClass = Class.forName( handlerClassName );
Method m = desktopOrApplication.getClass().getMethod( setHandlerMethodName, handlerClass );
m.invoke( desktopOrApplication, Proxy.newProxyInstance( FlatDesktop.class.getClassLoader(),
new Class[] { handlerClass },
(proxy, method, args) -> {
// Use invokeLater to release the listener firing for the case
// that the action listener shows a modal dialog.
// This (hopefully) prevents application hunging.
EventQueue.invokeLater( () -> {
handler.run();
} );
return null;
} ) );
} catch( Exception ex ) {
LoggingFacade.INSTANCE.logSevere( null, ex );
}
}
/**
* Sets a handler which is invoked when the application should quit.
* The handler must invoke either {@link QuitResponse#performQuit} or
* {@link QuitResponse#cancelQuit}.
* <p>
* Useful for macOS to get notified when user clicks menu item "MyApp > Quit".
* <p>
* Uses:
* <ul>
* <li>Java 8 on macOS: com.apple.eawt.Application.getApplication().setQuitHandler(com.apple.eawt.QuitHandler)
* <li>Java 9+: java.awt.Desktop.getDesktop().setQuitHandler(java.awt.desktop.QuitHandler)
* </ul>
*/
public static void setQuitHandler( Consumer<QuitResponse> quitHandler ) {
if( !isSupported( Action.APP_QUIT_HANDLER ) )
return;
String handlerClassName;
if( SystemInfo.isJava_9_orLater )
handlerClassName = "java.awt.desktop.QuitHandler";
else if( SystemInfo.isMacOS )
handlerClassName = "com.apple.eawt.QuitHandler";
else
return;
try {
Object desktopOrApplication = getDesktopOrApplication();
Class<?> handlerClass = Class.forName( handlerClassName );
Method m = desktopOrApplication.getClass().getMethod( "setQuitHandler", handlerClass );
m.invoke( desktopOrApplication, Proxy.newProxyInstance( FlatDesktop.class.getClassLoader(),
new Class[] { handlerClass },
(proxy, method, args) -> {
Object response = args[1];
String responseClass = SystemInfo.isJava_9_orLater
? "java.awt.desktop.QuitResponse"
: "com.apple.eawt.QuitResponse";
quitHandler.accept( new QuitResponse() {
@Override
public void performQuit() {
try {
Class.forName( responseClass ).getMethod( "performQuit" ).invoke( response );
} catch( Exception ex ) {
LoggingFacade.INSTANCE.logSevere( null, ex );
}
}
@Override
public void cancelQuit() {
try {
Class.forName( responseClass ).getMethod( "cancelQuit" ).invoke( response );
} catch( Exception ex ) {
LoggingFacade.INSTANCE.logSevere( null, ex );
}
}
} );
return null;
} ) );
} catch( Exception ex ) {
LoggingFacade.INSTANCE.logSevere( null, ex );
}
}
private static Object getDesktopOrApplication() throws Exception {
if( SystemInfo.isJava_9_orLater )
return Desktop.getDesktop();
else if( SystemInfo.isMacOS ) {
try {
Class<?> cls = Class.forName( "com.apple.eawt.Application" );
return cls.getMethod( "getApplication" ).invoke( null );
} catch( Exception ex ) {
LoggingFacade.INSTANCE.logSevere( null, ex );
throw new UnsupportedOperationException();
}
} else
throw new UnsupportedOperationException();
}
//---- interface QuitResponse ---------------------------------------------
public interface QuitResponse {
void performQuit();
void cancelQuit();
}
}