Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8300180

[macos] Default About menu item not shown for javaFX applications

XMLWordPrintable

      ADDITIONAL SYSTEM INFORMATION :
      macOS Monterey 12.6

      openjdk version "20-loom" 2023-03-21
      OpenJDK Runtime Environment (build 20-loom+2-40)
      OpenJDK 64-Bit Server VM (build 20-loom+2-40, mixed mode, sharing)

      also in testing for built...

      openjdk version "20-internal" 2023-03-21
      OpenJDK Runtime Environment (build 20-internal-adhoc.mjh.jdk)
      OpenJDK 64-Bit Server VM (build 20-internal-adhoc.mjh.jdk, mixed mode, sharing)


      A DESCRIPTION OF THE PROBLEM :
      OS/X applications normally have an Application menu with an 'About app name' menu item. Even if java.awt.Desktop setAboutHandler isn't used java applications get a default 'Cocoa' About menu item.
      javaFX applications do not get this.
      This is normal Mac application behavior and is part of the java application being considered first class.
      The code, such as LWCToolkit.m, already includes exceptions to normal processing, such as...

        } else {
              // could happen if we are embedded inside SWT application,
              // in this case just spin a single empty block through
              // the event loop to give it a chance to process pending events
              [ThreadUtilities performOnMainThreadWaiting:YES block:^(){}];
          }

      although these probably go back to Apple. It appears this code is prepared to run either on or off the main thread. So I am not sure why things don't work for javaFX applications by default.
      I tried testing both ways including the following in the javaFX Application class...

      static {
      //java.awt.Toolkit.getDefaultToolkit(); // Start AppKit
      Thread t = new Thread(() -> { java.awt.Toolkit.getDefaultToolkit(); });
             t.start();
      }
      to initialize things. With this set to run on it's own thread the code comes into ApplicationDelegate and the system menu bar can be accessed. But there is no About menu item. The following change can add one at this point.
       
      Add…
      #import "PropertiesUtilities.h"
      #import “ThreadUtilities.h"

      Make the following change in the ‘init’…
         //self.fAboutMenu = (NSMenuItem*)[appMenu itemAtIndex:0];
         if ([[[appMenu itemAtIndex:0] title] hasPrefix:@"About"])
             self.fAboutMenu = (NSMenuItem*)[appMenu itemAtIndex:0];
         else {
      JNIEnv *env = [ThreadUtilities getJNIEnv];
      NSString* appName = [PropertiesUtilities javaSystemPropertyForKey:@"apple.awt.application.name" withEnv:env];
      if (appName != nil) {
      NSMenuItem *aboutItem = [[NSMenuItem alloc] init];
      [aboutItem setTitle:[NSString stringWithFormat:@"About %@", appName]];
      [appMenu insertItem:aboutItem atIndex:0];
      self.fAboutMenu = aboutItem;
      }
         }

      This fixes the previously mentioned bug where the code assumes it has an ‘About’ menu item when it doesn’t.
      The javaFX application then gets the default 'Cocoa' About application menu item.

      If run on the normal javaFX thread the access to the menu bar appears to be nulled. This doesn't seem to cause errors or crashes but somehow runs through with the menu referencing code doing nothing?

      I noticed that this in ApplicationDelegate also seems buggy doing nothing at best...
          if (aboutAvailable) {
              // Make sure About is around
              if ([self.fAboutMenu menu] == nil) {
                  addMenuItem(self.fAboutMenu, 0);
              }

      The Preferences menu code seems a little more robust? Possibly this could be changed to similar.

      Given these changes, java.awt.Desktop setAboutHandler can also be made to work. To my javaFX java code I changed/added...

      public class HelloWorld extends Application implements AboutHandler {
      ...
      @Override
      public void init() {
           Thread t = new Thread(() -> {
      Desktop desktop = Desktop.getDesktop();
      desktop.setAboutHandler((AboutHandler)this);
      });
      t.start();
      }
      ...
          public void handleAbout(AboutEvent evt) {
           System.out.println("got to handleAbout");
           Platform.runLater(() -> {
           Alert alert = new Alert(AlertType.INFORMATION, "About HelloWorld");
      alert.showAndWait();
      });
          }

      So javaFX applications can use java.awt.Desktop as well. Again, this code was intended to give java applications the ability to do things native Mac applications do. Make them 'first class' platform applications. I think this functionality is still needed for javaFX applications. Until they come up with their own or it is determined this is in fact the long term way to provide this.





      STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
      Run any java Swing application that doesn't do java.awt.Desktop setAboutHandler and you should see the default 'Cocoa' about menu item.

      Run any javaFX application without my changes (e.g. SceneBuilder) and you should see this menu item is absent.

      EXPECTED VERSUS ACTUAL BEHAVIOR :
      EXPECTED -
      javaFX applications should be able to get the default Cocoa About menu item.

      javaFX applications should be able to use java.awt.Desktop setAboutHandler to get custom about menu item windows.

      javaFX applications should have full ability to use java.awt.Desktop?
      ACTUAL -
      This functionality is normally not available at all to javaFX applications.

      ---------- BEGIN SOURCE ----------
      The javaFX test application

      import javafx.application.Application;
      import javafx.application.Platform;
      import javafx.scene.Scene;
      import javafx.scene.control.Alert;
      import javafx.scene.control.Alert.AlertType;
      import javafx.scene.control.Button;
      import javafx.scene.control.MenuBar;
      import javafx.scene.layout.StackPane;
      import javafx.stage.Stage;
      import java.awt.desktop.AboutEvent;
      import java.awt.desktop.AboutHandler;
      import java.awt.Desktop;
      import javax.swing.SwingUtilities;

      public class HelloWorld extends Application implements AboutHandler {

      static {
      //java.awt.Toolkit.getDefaultToolkit(); // Start AppKit
      Thread t = new Thread(() -> { java.awt.Toolkit.getDefaultToolkit(); });
             t.start();
      }

      @Override
      public void init() {
           Thread t = new Thread(() -> {
      Desktop desktop = Desktop.getDesktop();
      desktop.setAboutHandler((AboutHandler)this);
      });
      t.start();
      }

      @Override
      public void start(Stage primaryStage) {
      // create a button with specified text
      Button button = new Button("Say 'Hello World'");
      // set a handler that is executed when the user activates the button
      // e.g. by clicking it or pressing enter while it's focused
      button.setOnAction(e -> {
      //Open information dialog that says hello
      String prop = System.getProperty("apple.awt.application.name","No such");
      System.out.println("prop -> " + prop + " on main thread");
      Alert alert = new Alert(AlertType.INFORMATION, prop);
      alert.showAndWait();
      });

      // the root of the scene shown in the main window
      StackPane root = new StackPane();
      // add button as child of the root
      root.getChildren().add(button);
      // create a scene specifying the root and the size
      Scene scene = new Scene(root, 500, 300);
      // add scene to the stage
      primaryStage.setScene(scene);
      // make the stage visible
      primaryStage.show();
          }
          
          public void handleAbout(AboutEvent evt) {
           System.out.println("got to handleAbout");
           Platform.runLater(() -> {
           Alert alert = new Alert(AlertType.INFORMATION, "About HelloWorld");
      alert.showAndWait();
      });
          }

      public static void main(String[] args) {
      // launch the HelloWorld application.
      // Since this method is a member of the HelloWorld class the first
      // parameter is not required
      Application.launch(HelloWorld.class, args);
      }
      }

      The changed ApplicationDegegate.m

      /*
       * Copyright (c) 2011, 2018, Oracle and/or its affiliates. All rights reserved.
       * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
       *
       * This code is free software; you can redistribute it and/or modify it
       * under the terms of the GNU General Public License version 2 only, as
       * published by the Free Software Foundation. Oracle designates this
       * particular file as subject to the "Classpath" exception as provided
       * by Oracle in the LICENSE file that accompanied this code.
       *
       * This code 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 General Public License
       * version 2 for more details (a copy is included in the LICENSE file that
       * accompanied this code).
       *
       * You should have received a copy of the GNU General Public License version
       * 2 along with this work; if not, write to the Free Software Foundation,
       * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
       *
       * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
       * or visit www.oracle.com if you need additional information or have any
       * questions.
       */

      #import "ApplicationDelegate.h"

      #import "com_apple_eawt_Application.h"
      #import "com_apple_eawt__AppDockIconHandler.h"
      #import "com_apple_eawt__AppEventHandler.h"
      #import "com_apple_eawt__AppMenuBarHandler.h"
      #import "com_apple_eawt__AppMenuBarHandler.h"
      #import "com_apple_eawt__AppMiscHandlers.h"

      #import "CPopupMenu.h"
      #import "CMenuBar.h"
      #import "ThreadUtilities.h"
      #import "NSApplicationAWT.h"
      #import "JNIUtilities.h"
      #import "PropertiesUtilities.h"
      #import "ThreadUtilities.h"

      #pragma mark App Menu helpers

      // The following is a AWT convention?
      #define PREFERENCES_TAG 42

      static void addMenuItem(NSMenuItem* menuItem, NSInteger index) {
      AWT_ASSERT_APPKIT_THREAD;

          NSMenu *menuBar = [[NSApplication sharedApplication] mainMenu];
          NSMenu *appMenu = [[menuBar itemAtIndex:0] submenu];

          [appMenu insertItem:menuItem atIndex:index];
          [appMenu insertItem:[NSMenuItem separatorItem] atIndex:index + 1]; // Add the following separator
      }

      static void removeMenuItem(NSMenuItem* menuItem) {
      AWT_ASSERT_APPKIT_THREAD;

          NSMenu *menuBar = [[NSApplication sharedApplication] mainMenu];
          NSMenu *appMenu = [[menuBar itemAtIndex:0] submenu];

          NSInteger index = [appMenu indexOfItem:menuItem];
          if (index < 0) return; // something went wrong

          [appMenu removeItemAtIndex:index + 1]; // Get the following separator
          [appMenu removeItem:menuItem];
      }

      @interface NSBundle (EAWTOverrides)
      - (BOOL)_hasEAWTOverride:(NSString *)key;
      @end


      @implementation NSBundle (EAWTOverrides)

      - (BOOL)_hasEAWTOverride:(NSString *)key {
          return [[[[self objectForInfoDictionaryKey:@"Java"] objectForKey:@"EAWTOverride"] objectForKey:key] boolValue];
      }

      @end


      // used by JavaRuntimeSupport.framework's [JRSAppKitAWT awtAppDelegate]
      // to expose our app delegate to the SWT or other apps that have knoledge
      // of Java's AWT and want to install their own app delegate that will delegate
      // to the AWT for some operations

      @interface JavaAWTAppDelegateLoader : NSObject { }
      @end

      @implementation JavaAWTAppDelegateLoader
      + (ApplicationDelegate *) awtAppDelegate {
          return [ApplicationDelegate sharedDelegate];
      }
      @end


      @implementation ApplicationDelegate

      @synthesize fPreferencesMenu;
      @synthesize fAboutMenu;
      @synthesize fProgressIndicator;

      @synthesize fDockMenu;
      @synthesize fDefaultMenuBar;


      + (ApplicationDelegate *)sharedDelegate {
          static ApplicationDelegate *sApplicationDelegate = nil;
          static BOOL checked = NO;

          if (sApplicationDelegate != nil) return sApplicationDelegate;
          if (checked) return nil;

      AWT_ASSERT_APPKIT_THREAD;

          // don't install the EAWT delegate if another kind of NSApplication is installed, like say, Safari
          BOOL shouldInstall = NO;
          if (NSApp != nil) {
              if ([NSApp isMemberOfClass:[NSApplication class]]) shouldInstall = YES;
              if ([NSApp isKindOfClass:[NSApplicationAWT class]]) shouldInstall = YES;
          }
          checked = YES;
          if (!shouldInstall) return nil;

          sApplicationDelegate = [[ApplicationDelegate alloc] init];
          return sApplicationDelegate;
      }

      - (void)_updatePreferencesMenu:(BOOL)prefsAvailable enabled:(BOOL)prefsEnabled {
      AWT_ASSERT_APPKIT_THREAD;

          if (prefsAvailable) {
              // Make sure Prefs is around
              if ([self.fPreferencesMenu menu] == nil) {
                  // Position of Prefs depends upon About availability.
                  NSInteger index = ([self.fAboutMenu menu] != nil) ? 2 : 0;

                  addMenuItem(self.fPreferencesMenu, index);
              }

              if (prefsEnabled) {
                  [self.fPreferencesMenu setEnabled:YES];
                  [self.fPreferencesMenu setTarget:self];
                  [self.fPreferencesMenu setAction:@selector(_preferencesMenuHandler)];
              } else {
                  [self.fPreferencesMenu setEnabled:NO];
                  [self.fPreferencesMenu setTarget:nil];
                  [self.fPreferencesMenu setAction:nil];
              }
          } else {
              if ([self.fPreferencesMenu menu] == nil) return;

              // Remove the preferences item
              removeMenuItem(self.fPreferencesMenu);
          }
      }

      - (void)_updateAboutMenu:(BOOL)aboutAvailable enabled:(BOOL)aboutEnabled {
      AWT_ASSERT_APPKIT_THREAD;

          if (aboutAvailable) {
              // Make sure About is around
              if ([self.fAboutMenu menu] == nil) {
                  addMenuItem(self.fAboutMenu, 0);
              }

              if (aboutEnabled) {
                  [self.fAboutMenu setEnabled:YES];
                  [self.fAboutMenu setTarget:self];
                  [self.fAboutMenu setAction:@selector(_aboutMenuHandler)];
              } else {
                  [self.fAboutMenu setEnabled:NO];
                  [self.fAboutMenu setTarget:nil];
                  [self.fAboutMenu setAction:nil];
              }
          } else {
              if ([self.fAboutMenu menu] == nil) return;

              // Remove About item.
              removeMenuItem(self.fAboutMenu);
          }
      }

      - (id) init {
      AWT_ASSERT_APPKIT_THREAD;

          self = [super init];
          if (!self) return self;

          // Prep for about and preferences menu
          BOOL usingDefaultNib = YES;
          if ([NSApp isKindOfClass:[NSApplicationAWT class]]) {
              usingDefaultNib = [NSApp usingDefaultNib];
          }
          if (!usingDefaultNib) return self;

          NSMenu *menuBar = [[NSApplication sharedApplication] mainMenu];
          NSMenu *appMenu = [[menuBar itemAtIndex:0] submenu];

          self.fPreferencesMenu = (NSMenuItem*)[appMenu itemWithTag:PREFERENCES_TAG];
          //self.fAboutMenu = (NSMenuItem*)[appMenu itemAtIndex:0];
          if ([[[appMenu itemAtIndex:0] title] hasPrefix:@"About"])
              self.fAboutMenu = (NSMenuItem*)[appMenu itemAtIndex:0];
          else {
      JNIEnv *env = [ThreadUtilities getJNIEnv];
      NSString* appName = [PropertiesUtilities javaSystemPropertyForKey:@"apple.awt.application.name" withEnv:env];
      if (appName != nil) {
      NSMenuItem *aboutItem = [[NSMenuItem alloc] init];
      [aboutItem setTitle:[NSString stringWithFormat:@"About %@", appName]];
      [appMenu insertItem:aboutItem atIndex:0];
      self.fAboutMenu = aboutItem;
      }
          }
          
          NSDockTile *dockTile = [NSApp dockTile];
          self.fProgressIndicator = [[NSProgressIndicator alloc]
                                      initWithFrame:NSMakeRect(3.f, 0.f, dockTile.size.width - 6.f, 20.f)];

          [fProgressIndicator setStyle:NSProgressIndicatorBarStyle];
          [fProgressIndicator setIndeterminate:NO];
          [[dockTile contentView] addSubview:fProgressIndicator];
          [fProgressIndicator setMinValue:0];
          [fProgressIndicator setMaxValue:100];
          [fProgressIndicator setHidden:YES];
          [fProgressIndicator release];

          // If the java application has a bundle with an Info.plist file with
          // a CFBundleDocumentTypes entry, then it is set up to handle Open Doc
          // and Print Doc commands for these files. Therefore java AWT will
          // cache Open Doc and Print Doc events that are sent prior to a
          // listener being installed by the client java application.
          NSBundle *bundle = [NSBundle mainBundle];
          fHandlesDocumentTypes = [bundle objectForInfoDictionaryKey:@"CFBundleDocumentTypes"] != nil || [bundle _hasEAWTOverride:@"DocumentHandler"];
          fHandlesURLTypes = [bundle objectForInfoDictionaryKey:@"CFBundleURLTypes"] != nil || [bundle _hasEAWTOverride:@"URLHandler"];
          if (fHandlesURLTypes) {
              [[NSAppleEventManager sharedAppleEventManager] setEventHandler:self
                                                                 andSelector:@selector(_handleOpenURLEvent:withReplyEvent:)
                                                               forEventClass:kInternetEventClass
                                                                  andEventID:kAEGetURL];
          }

          // By HIG, Preferences are not available unless there is a handler. By default in Mac OS X,
          // there is not a handler, but it is in the nib file for convenience.
          removeMenuItem(self.fPreferencesMenu);

          [self _updateAboutMenu:YES enabled:YES];

          // Now that the AppKit objects are known and set up, initialize the model data
          BOOL aboutAvailable = ([self.fAboutMenu menu] != nil);
          BOOL aboutEnabled = (aboutAvailable && [self.fAboutMenu isEnabled] && ([self.fAboutMenu target] != nil));

          BOOL prefsAvailable = ([self.fPreferencesMenu menu] != nil);
          BOOL prefsEnabled = (prefsAvailable && [self.fPreferencesMenu isEnabled] && ([self.fPreferencesMenu target] != nil));

          JNIEnv *env = [ThreadUtilities getJNIEnv];
          DECLARE_CLASS_RETURN(sjc_AppMenuBarHandler, "com/apple/eawt/_AppMenuBarHandler", NULL);
          DECLARE_STATIC_METHOD_RETURN(sjm_initMenuStates, sjc_AppMenuBarHandler, "initMenuStates", "(ZZZZ)V", NULL);
          (*env)->CallStaticVoidMethod(env, sjc_AppMenuBarHandler, sjm_initMenuStates,
                                       aboutAvailable, aboutEnabled, prefsAvailable, prefsEnabled);
          CHECK_EXCEPTION();

          // register for the finish launching and system power off notifications by default
          NSNotificationCenter *ctr = [NSNotificationCenter defaultCenter];
          Class clz = [ApplicationDelegate class];
          [ctr addObserver:clz selector:@selector(_willFinishLaunching) name:NSApplicationWillFinishLaunchingNotification object:nil];
          [ctr addObserver:clz selector:@selector(_systemWillPowerOff) name:NSWorkspaceWillPowerOffNotification object:nil];
          [ctr addObserver:clz selector:@selector(_appDidActivate) name:NSApplicationDidBecomeActiveNotification object:nil];
          [ctr addObserver:clz selector:@selector(_appDidDeactivate) name:NSApplicationDidResignActiveNotification object:nil];
          [ctr addObserver:clz selector:@selector(_appDidHide) name:NSApplicationDidHideNotification object:nil];
          [ctr addObserver:clz selector:@selector(_appDidUnhide) name:NSApplicationDidUnhideNotification object:nil];

          return self;
      }

      - (void)dealloc {
          self.fPreferencesMenu = nil;
          self.fAboutMenu = nil;
          self.fDockMenu = nil;
          self.fDefaultMenuBar = nil;
          self.fProgressIndicator = nil;

          [super dealloc];
      }

      #pragma mark Callbacks from AppKit

      static jclass sjc_AppEventHandler = NULL;
      #define GET_APPEVENTHANDLER_CLASS() \
          GET_CLASS(sjc_AppEventHandler, "com/apple/eawt/_AppEventHandler");

      #define GET_APPEVENTHANDLER_CLASS_RETURN(ret) \
          GET_CLASS_RETURN(sjc_AppEventHandler, "com/apple/eawt/_AppEventHandler", ret);

      - (void)_handleOpenURLEvent:(NSAppleEventDescriptor *)openURLEvent withReplyEvent:(NSAppleEventDescriptor *)replyEvent {
      AWT_ASSERT_APPKIT_THREAD;
          if (!fHandlesURLTypes) return;

          NSString *url = [[openURLEvent paramDescriptorForKeyword:keyDirectObject] stringValue];

          //fprintf(stderr,"jm_handleOpenURL\n");
          JNIEnv *env = [ThreadUtilities getJNIEnv];
          jstring jURL = NSStringToJavaString(env, url);
          GET_APPEVENTHANDLER_CLASS();
          DECLARE_STATIC_METHOD(jm_handleOpenURI, sjc_AppEventHandler, "handleOpenURI", "(Ljava/lang/String;)V");
          (*env)->CallStaticVoidMethod(env, sjc_AppEventHandler, jm_handleOpenURI, jURL);
          CHECK_EXCEPTION();
          (*env)->DeleteLocalRef(env, jURL);

          [replyEvent insertDescriptor:[NSAppleEventDescriptor nullDescriptor] atIndex:0];
      }

      // Helper for both open file and print file methods
      // Creates a Java list of files from a native list of files
      - (jobject)_createFilePathArrayFrom:(NSArray *)filenames withEnv:(JNIEnv *)env {
          static jclass sjc_ArrayList = NULL;
          if (sjc_ArrayList == NULL) {
              sjc_ArrayList = (*env)->FindClass(env, "java/util/ArrayList");
              if (sjc_ArrayList != NULL) sjc_ArrayList = (*env)->NewGlobalRef(env, sjc_ArrayList); \
          }
          CHECK_NULL_RETURN(sjc_ArrayList, NULL);
          DECLARE_METHOD_RETURN(jm_ArrayList_ctor, sjc_ArrayList, "<init>", "(I)V", NULL);
          DECLARE_METHOD_RETURN(jm_ArrayList_add, sjc_ArrayList, "add", "(Ljava/lang/Object;)Z", NULL);

          jobject jFileNamesArray = (*env)->NewObject(env, sjc_ArrayList, jm_ArrayList_ctor, (jint)[filenames count]);
          CHECK_EXCEPTION_NULL_RETURN(jFileNamesArray, NULL);

          for (NSString *filename in filenames) {
              jstring jFileName = NormalizedPathJavaStringFromNSString(env, filename);
              (*env)->CallVoidMethod(env, jFileNamesArray, jm_ArrayList_add, jFileName);
              CHECK_EXCEPTION();
          }

          return jFileNamesArray;
      }

      // Open file handler
      - (void)application:(NSApplication *)theApplication openFiles:(NSArray *)fileNames {
      AWT_ASSERT_APPKIT_THREAD;
          if (!fHandlesDocumentTypes) {
              [theApplication replyToOpenOrPrint:NSApplicationDelegateReplyCancel];
              return;
          }

          //fprintf(stderr,"jm_handleOpenFile\n");
          JNIEnv *env = [ThreadUtilities getJNIEnv];

          // if these files were opened from a Spotlight query, try to get the search text from the current AppleEvent
          NSAppleEventDescriptor *currentEvent = [[NSAppleEventManager sharedAppleEventManager] currentAppleEvent];
          NSString *searchString = [[currentEvent paramDescriptorForKeyword:keyAESearchText] stringValue];
          jstring jSearchString = NSStringToJavaString(env, searchString);

          // convert the file names array
          jobject jFileNamesArray = [self _createFilePathArrayFrom:fileNames withEnv:env];

          GET_APPEVENTHANDLER_CLASS();
          DECLARE_STATIC_METHOD(jm_handleOpenFiles, sjc_AppEventHandler,
                                    "handleOpenFiles", "(Ljava/util/List;Ljava/lang/String;)V");
          (*env)->CallStaticVoidMethod(env, sjc_AppEventHandler, jm_handleOpenFiles, jFileNamesArray, jSearchString);
          CHECK_EXCEPTION();
          (*env)->DeleteLocalRef(env, jFileNamesArray);
          (*env)->DeleteLocalRef(env, jSearchString);

          [theApplication replyToOpenOrPrint:NSApplicationDelegateReplySuccess];
      }

      // Print handler
      - (NSApplicationPrintReply)application:(NSApplication *)application printFiles:(NSArray *)fileNames withSettings:(NSDictionary *)printSettings showPrintPanels:(BOOL)showPrintPanels {
      AWT_ASSERT_APPKIT_THREAD;
          if (!fHandlesDocumentTypes) return NSPrintingCancelled;

          //fprintf(stderr,"jm_handlePrintFile\n");
          JNIEnv *env = [ThreadUtilities getJNIEnv];
          jobject jFileNamesArray = [self _createFilePathArrayFrom:fileNames withEnv:env];
          GET_APPEVENTHANDLER_CLASS_RETURN(NSPrintingCancelled);
          DECLARE_STATIC_METHOD_RETURN(jm_handlePrintFile, sjc_AppEventHandler,
                                    "handlePrintFiles", "(Ljava/util/List;)V", NSPrintingCancelled);
          (*env)->CallStaticVoidMethod(env, sjc_AppEventHandler, jm_handlePrintFile, jFileNamesArray);
          CHECK_EXCEPTION();
          (*env)->DeleteLocalRef(env, jFileNamesArray);

          return NSPrintingSuccess;
      }

      // Open app handler, registered in -init
      + (void)_notifyJava:(jint)notificationType {
      AWT_ASSERT_APPKIT_THREAD;

          //fprintf(stderr,"jm_handleOpenApplication\n");
          JNIEnv *env = [ThreadUtilities getJNIEnv];
          GET_APPEVENTHANDLER_CLASS();
          DECLARE_STATIC_METHOD(jm_handleNativeNotification, sjc_AppEventHandler, "handleNativeNotification", "(I)V");
          (*env)->CallStaticVoidMethod(env, sjc_AppEventHandler, jm_handleNativeNotification, notificationType);
          CHECK_EXCEPTION();
      }

      // About menu handler
      - (void)_aboutMenuHandler {
          [ApplicationDelegate _notifyJava:com_apple_eawt__AppEventHandler_NOTIFY_ABOUT];
      }

      // Preferences handler
      - (void)_preferencesMenuHandler {
          [ApplicationDelegate _notifyJava:com_apple_eawt__AppEventHandler_NOTIFY_PREFS];
      }

      // Open app handler, registered in -init
      + (void)_willFinishLaunching {
          [self _notifyJava:com_apple_eawt__AppEventHandler_NOTIFY_OPEN_APP];
      }

      // ReOpen app handler
      - (BOOL)applicationShouldHandleReopen:(NSApplication *)theApplication hasVisibleWindows:(BOOL)flag {
          [ApplicationDelegate _notifyJava:com_apple_eawt__AppEventHandler_NOTIFY_REOPEN_APP];
          return YES;
      }

      // Quit handler
      - (NSApplicationTerminateReply)applicationShouldTerminate:(NSApplication *)app {
          [ApplicationDelegate _notifyJava:com_apple_eawt__AppEventHandler_NOTIFY_QUIT];
          return NSTerminateLater;
      }

      + (void)_systemWillPowerOff {
          [self _notifyJava:com_apple_eawt__AppEventHandler_NOTIFY_SHUTDOWN];
      }

      + (void)_appDidActivate {
          [self _notifyJava:com_apple_eawt__AppEventHandler_NOTIFY_ACTIVE_APP_GAINED];
      }

      + (void)_appDidDeactivate {
          [self _notifyJava:com_apple_eawt__AppEventHandler_NOTIFY_ACTIVE_APP_LOST];
      }

      + (void)_appDidHide {
          [self _notifyJava:com_apple_eawt__AppEventHandler_NOTIFY_APP_HIDDEN];
      }

      + (void)_appDidUnhide {
          [self _notifyJava:com_apple_eawt__AppEventHandler_NOTIFY_APP_SHOWN];
      }

      + (void)_sessionDidActivate {
          [self _notifyJava:com_apple_eawt__AppEventHandler_NOTIFY_USER_SESSION_ACTIVE];
      }

      + (void)_sessionDidDeactivate {
          [self _notifyJava:com_apple_eawt__AppEventHandler_NOTIFY_USER_SESSION_INACTIVE];
      }

      + (void)_screenDidSleep {
          [self _notifyJava:com_apple_eawt__AppEventHandler_NOTIFY_SCREEN_SLEEP];
      }

      + (void)_screenDidWake {
          [self _notifyJava:com_apple_eawt__AppEventHandler_NOTIFY_SCREEN_WAKE];
      }

      + (void)_systemDidSleep {
          [self _notifyJava:com_apple_eawt__AppEventHandler_NOTIFY_SYSTEM_SLEEP];
      }

      + (void)_systemDidWake {
          [self _notifyJava:com_apple_eawt__AppEventHandler_NOTIFY_SYSTEM_WAKE];
      }

      + (void)_registerForNotification:(NSNumber *)notificationTypeNum {
          NSNotificationCenter *ctr = [[NSWorkspace sharedWorkspace] notificationCenter];
          Class clz = [ApplicationDelegate class];

          jint notificationType = [notificationTypeNum intValue];
          switch (notificationType) {
              case com_apple_eawt__AppEventHandler_REGISTER_USER_SESSION:
                  [ctr addObserver:clz selector:@selector(_sessionDidActivate) name:NSWorkspaceSessionDidBecomeActiveNotification object:nil];
                  [ctr addObserver:clz selector:@selector(_sessionDidDeactivate) name:NSWorkspaceSessionDidResignActiveNotification object:nil];
                  break;
              case com_apple_eawt__AppEventHandler_REGISTER_SCREEN_SLEEP:
                  [ctr addObserver:clz selector:@selector(_screenDidSleep) name:NSWorkspaceScreensDidSleepNotification object:nil];
                  [ctr addObserver:clz selector:@selector(_screenDidWake) name:NSWorkspaceScreensDidWakeNotification object:nil];
                  break;
              case com_apple_eawt__AppEventHandler_REGISTER_SYSTEM_SLEEP:
                  [ctr addObserver:clz selector:@selector(_systemDidSleep) name:NSWorkspaceWillSleepNotification object:nil];
                  [ctr addObserver:clz selector:@selector(_systemDidWake) name:NSWorkspaceDidWakeNotification object:nil];
                  break;
              default:
                  NSLog(@"EAWT attempting to register for unknown notification: %d", (int)notificationType);
                  break;
          }
      }

      // Retrieves the menu to be attached to the Dock icon (AppKit callback)
      - (NSMenu *)applicationDockMenu:(NSApplication *)sender {
      AWT_ASSERT_APPKIT_THREAD;
          return self.fDockMenu;
      }

      - (CMenuBar *)defaultMenuBar {
          return [[self.fDefaultMenuBar retain] autorelease];
      }


      #pragma mark Helpers called on the main thread from Java

      // Sets a new NSImageView on the Dock tile
      + (void)_setDockIconImage:(NSImage *)image {
      AWT_ASSERT_APPKIT_THREAD;

          NSDockTile *dockTile = [NSApp dockTile];
          if (image == nil) {
              [dockTile setContentView:nil];
              return;
          }

          // setup an image view for the dock tile
          NSRect frame = NSMakeRect(0, 0, dockTile.size.width, dockTile.size.height);
          NSImageView *dockImageView = [[NSImageView alloc] initWithFrame: frame];
          [dockImageView setImageScaling:NSImageScaleProportionallyUpOrDown];
          [dockImageView setImage:image];

          [[ApplicationDelegate sharedDelegate].fProgressIndicator removeFromSuperview];
          [dockImageView addSubview:[ApplicationDelegate sharedDelegate].fProgressIndicator];

          // add it to the NSDockTile
          [dockTile setContentView: dockImageView];
          [dockTile display];

          [dockImageView release];
      }

      + (void)_setDockIconProgress:(NSNumber *)value {
      AWT_ASSERT_APPKIT_THREAD;

          ApplicationDelegate *delegate = [ApplicationDelegate sharedDelegate];
          if ([value doubleValue] >= 0 && [value doubleValue] <=100) {
              [delegate.fProgressIndicator setDoubleValue:[value doubleValue]];
              [delegate.fProgressIndicator setHidden:NO];
          } else {
              [delegate.fProgressIndicator setHidden:YES];
          }

          [[NSApp dockTile] display];
      }

      // Obtains the image of the Dock icon, either manually set, a drawn copy, or the default NSApplicationIcon
      + (NSImage *)_dockIconImage {
      AWT_ASSERT_APPKIT_THREAD;

          NSDockTile *dockTile = [NSApp dockTile];
          NSView *view = [dockTile contentView];

          if ([view isKindOfClass:[NSImageView class]]) {
              NSImage *img = [((NSImageView *)view) image];
              if (img) return img;
          }

          if (view == nil) {
              return [NSImage imageNamed:@"NSApplicationIcon"];
          }

          NSRect frame = [view frame];
          NSImage *image = [[NSImage alloc] initWithSize:frame.size];
          [image lockFocus];
          [view drawRect:frame];
          [image unlockFocus];
          [image autorelease];
          return image;
      }

      @end


      #pragma mark Native JNI calls

      /*
       * Class: com_apple_eawt_Application
       * Method: nativeInitializeApplicationDelegate
       * Signature: ()V
       */
      JNIEXPORT void JNICALL Java_com_apple_eawt_Application_nativeInitializeApplicationDelegate
      (JNIEnv *env, jclass clz)
      {
      JNI_COCOA_ENTER(env);
          // Force initialization to happen on AppKit thread!
          [ThreadUtilities performOnMainThreadWaiting:NO block:^(){
              [ApplicationDelegate sharedDelegate];
          }];
      JNI_COCOA_EXIT(env);
      }

      /*
       * Class: com_apple_eawt__AppEventHandler
       * Method: nativeOpenCocoaAboutWindow
       * Signature: ()V
       */
      JNIEXPORT void JNICALL Java_com_apple_eawt__1AppEventHandler_nativeOpenCocoaAboutWindow
      (JNIEnv *env, jclass clz)
      {
      JNI_COCOA_ENTER(env);

          [ThreadUtilities performOnMainThreadWaiting:NO block:^(){
              [NSApp orderFrontStandardAboutPanel:nil];
          }];

      JNI_COCOA_EXIT(env);
      }

      /*
       * Class: com_apple_eawt__AppEventHandler
       * Method: nativeReplyToAppShouldTerminate
       * Signature: (Z)V
       */
      JNIEXPORT void JNICALL Java_com_apple_eawt__1AppEventHandler_nativeReplyToAppShouldTerminate
      (JNIEnv *env, jclass clz, jboolean doTerminate)
      {
      JNI_COCOA_ENTER(env);

          [ThreadUtilities performOnMainThreadWaiting:NO block:^(){
              [NSApp replyToApplicationShouldTerminate:doTerminate];
          }];

      JNI_COCOA_EXIT(env);
      }

      /*
       * Class: com_apple_eawt__AppEventHandler
       * Method: nativeRegisterForNotification
       * Signature: (I)V
       */
      JNIEXPORT void JNICALL Java_com_apple_eawt__1AppEventHandler_nativeRegisterForNotification
      (JNIEnv *env, jclass clz, jint notificationType)
      {
      JNI_COCOA_ENTER(env);
          [ThreadUtilities performOnMainThread:@selector(_registerForNotification:)
                                            on:[ApplicationDelegate class]
                                    withObject:[NSNumber numberWithInt:notificationType]
                                 waitUntilDone:NO];
      JNI_COCOA_EXIT(env);
      }

      /*
       * Class: com_apple_eawt__AppDockIconHandler
       * Method: nativeSetDockMenu
       * Signature: (J)V
       */
      JNIEXPORT void JNICALL Java_com_apple_eawt__1AppDockIconHandler_nativeSetDockMenu
      (JNIEnv *env, jclass clz, jlong nsMenuPtr)
      {
      JNI_COCOA_ENTER(env);

          NSMenu *menu = (NSMenu *)jlong_to_ptr(nsMenuPtr);
          [ThreadUtilities performOnMainThreadWaiting:YES block:^(){
              [ApplicationDelegate sharedDelegate].fDockMenu = menu;
          }];

      JNI_COCOA_EXIT(env);
      }

      /*
       * Class: com_apple_eawt__AppDockIconHandler
       * Method: nativeSetDockIconImage
       * Signature: (J)V
       */
      JNIEXPORT void JNICALL Java_com_apple_eawt__1AppDockIconHandler_nativeSetDockIconImage
      (JNIEnv *env, jclass clz, jlong nsImagePtr)
      {
      JNI_COCOA_ENTER(env);

          NSImage *_image = (NSImage *)jlong_to_ptr(nsImagePtr);
          [ThreadUtilities performOnMainThread:@selector(_setDockIconImage:)
                                            on:[ApplicationDelegate class]
                                    withObject:_image
                                 waitUntilDone:NO];

      JNI_COCOA_EXIT(env);
      }

      /*
       * Class: com_apple_eawt__AppDockIconHandler
       * Method: nativeSetDockIconProgress
       * Signature: (I)V
       */
      JNIEXPORT void JNICALL Java_com_apple_eawt__1AppDockIconHandler_nativeSetDockIconProgress
        (JNIEnv *env, jclass clz, jint value)
      {
          JNI_COCOA_ENTER(env);

           [ThreadUtilities performOnMainThread:@selector(_setDockIconProgress:)
                                             on:[ApplicationDelegate class]
                                     withObject:[NSNumber numberWithInt:value]
                                  waitUntilDone:NO];

          JNI_COCOA_EXIT(env);
      }

      /*
       * Class: com_apple_eawt__AppDockIconHandler
       * Method: nativeGetDockIconImage
       * Signature: ()J
       */
      JNIEXPORT jlong JNICALL Java_com_apple_eawt__1AppDockIconHandler_nativeGetDockIconImage
      (JNIEnv *env, jclass clz)
      {
          __block NSImage *image = nil;

      JNI_COCOA_ENTER(env);

          [ThreadUtilities performOnMainThreadWaiting:YES block:^(){
              image = [[ApplicationDelegate _dockIconImage] retain];
          }];

      JNI_COCOA_EXIT(env);

          return ptr_to_jlong(image);
      }

      /*
       * Class: com_apple_eawt__AppDockIconHandler
       * Method: nativeSetDockIconBadge
       * Signature: (Ljava/lang/String;)V
       */
      JNIEXPORT void JNICALL Java_com_apple_eawt__1AppDockIconHandler_nativeSetDockIconBadge
      (JNIEnv *env, jclass clz, jstring badge)
      {
      JNI_COCOA_ENTER(env);

          NSString *badgeString = JavaStringToNSString(env, badge);
          [ThreadUtilities performOnMainThreadWaiting:NO block:^(){
              NSDockTile *dockTile = [NSApp dockTile];
              [dockTile setBadgeLabel:badgeString];
              [dockTile display];
          }];

      JNI_COCOA_EXIT(env);
      }

      /*
       * Class: com_apple_eawt__AppMiscHandlers
       * Method: nativeRequestActivation
       * Signature: (Z)V
       */
      JNIEXPORT void JNICALL Java_com_apple_eawt__1AppMiscHandlers_nativeRequestActivation
      (JNIEnv *env, jclass clz, jboolean allWindows)
      {
      JNI_COCOA_ENTER(env);

          [ThreadUtilities performOnMainThreadWaiting:NO block:^(){
              NSApplicationActivationOptions options = allWindows ? NSApplicationActivateAllWindows : 0;
              options |= NSApplicationActivateIgnoringOtherApps; // without this, nothing happens!
              [[NSRunningApplication currentApplication] activateWithOptions:options];
          }];

      JNI_COCOA_EXIT(env);
      }

      /*
       * Class: com_apple_eawt__AppMiscHandlers
       * Method: nativeRequestUserAttention
       * Signature: (Z)V
       */
      JNIEXPORT void JNICALL Java_com_apple_eawt__1AppMiscHandlers_nativeRequestUserAttention
      (JNIEnv *env, jclass clz, jboolean critical)
      {
      JNI_COCOA_ENTER(env);

          [ThreadUtilities performOnMainThreadWaiting:NO block:^(){
              [NSApp requestUserAttention:critical ? NSCriticalRequest : NSInformationalRequest];
          }];

      JNI_COCOA_EXIT(env);
      }

      /*
       * Class: com_apple_eawt__AppMiscHandlers
       * Method: nativeOpenHelpViewer
       * Signature: ()V
       */
      JNIEXPORT void JNICALL Java_com_apple_eawt__1AppMiscHandlers_nativeOpenHelpViewer
      (JNIEnv *env, jclass clz)
      {
      JNI_COCOA_ENTER(env);

          [ThreadUtilities performOnMainThread:@selector(showHelp:)
                                            on:NSApp
                                    withObject:nil
                                 waitUntilDone:NO];

      JNI_COCOA_EXIT(env);
      }

      /*
       * Class: com_apple_eawt__AppMiscHandlers
       * Method: nativeEnableSuddenTermination
       * Signature: ()V
       */
      JNIEXPORT void JNICALL Java_com_apple_eawt__1AppMiscHandlers_nativeEnableSuddenTermination
      (JNIEnv *env, jclass clz)
      {
      JNI_COCOA_ENTER(env);

          [[NSProcessInfo processInfo] enableSuddenTermination]; // Foundation thread-safe

      JNI_COCOA_EXIT(env);
      }

      /*
       * Class: com_apple_eawt__AppMiscHandlers
       * Method: nativeDisableSuddenTermination
       * Signature: ()V
       */
      JNIEXPORT void JNICALL Java_com_apple_eawt__1AppMiscHandlers_nativeDisableSuddenTermination
      (JNIEnv *env, jclass clz)
      {
      JNI_COCOA_ENTER(env);

          [[NSProcessInfo processInfo] disableSuddenTermination]; // Foundation thread-safe

      JNI_COCOA_EXIT(env);
      }

      /*
       * Class: com_apple_eawt__AppMenuBarHandler
       * Method: nativeSetMenuState
       * Signature: (IZZ)V
       */
      JNIEXPORT void JNICALL Java_com_apple_eawt__1AppMenuBarHandler_nativeSetMenuState
      (JNIEnv *env, jclass clz, jint menuID, jboolean visible, jboolean enabled)
      {
      JNI_COCOA_ENTER(env);

          [ThreadUtilities performOnMainThreadWaiting:NO block:^(){
              ApplicationDelegate *delegate = [ApplicationDelegate sharedDelegate];
              switch (menuID) {
                  case com_apple_eawt__AppMenuBarHandler_MENU_ABOUT:
                      [delegate _updateAboutMenu:visible enabled:enabled];
                      break;
                  case com_apple_eawt__AppMenuBarHandler_MENU_PREFS:
                      [delegate _updatePreferencesMenu:visible enabled:enabled];
                      break;
              }
          }];

      JNI_COCOA_EXIT(env);
      }

      /*
       * Class: com_apple_eawt__AppMenuBarHandler
       * Method: nativeSetDefaultMenuBar
       * Signature: (J)V
       */
      JNIEXPORT void JNICALL Java_com_apple_eawt__1AppMenuBarHandler_nativeSetDefaultMenuBar
      (JNIEnv *env, jclass clz, jlong cMenuBarPtr)
      {
      JNI_COCOA_ENTER(env);

          CMenuBar *menu = (CMenuBar *)jlong_to_ptr(cMenuBarPtr);
          [ThreadUtilities performOnMainThreadWaiting:NO block:^(){
              [ApplicationDelegate sharedDelegate].fDefaultMenuBar = menu;
          }];

      JNI_COCOA_EXIT(env);
      }

      /*
       * Class: com_apple_eawt__AppMenuBarHandler
       * Method: nativeActivateDefaultMenuBar
       * Signature: (J)V
       */
      JNIEXPORT void JNICALL Java_com_apple_eawt__1AppMenuBarHandler_nativeActivateDefaultMenuBar
      (JNIEnv *env, jclass clz, jlong cMenuBarPtr)
      {
      JNI_COCOA_ENTER(env);

          CMenuBar *menu = (CMenuBar *)jlong_to_ptr(cMenuBarPtr);
          [ThreadUtilities performOnMainThreadWaiting:NO block:^(){
              if (menu) {
                  [CMenuBar activate:menu modallyDisabled:NO];
              }
          }];

      JNI_COCOA_EXIT(env);
      }

      ---------- END SOURCE ----------

      CUSTOMER SUBMITTED WORKAROUND :
      As shown in description and test case.

      FREQUENCY : always


        1. HelloWorld.java
          2 kB
          Praveen Narayanaswamy

            kizune Alexander Zuev
            webbuggrp Webbug Group
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated: