changeset 3765:32f8e83c9e92

[DOC-ONLY]: added missing comment.
author Pavel Safrata
date Thu, 30 May 2013 08:29:16 +0100
parents a99a0da62147
children 55c9c3a55f58
files javafx-ui-common/src/javafx/scene/input/MouseEvent.java
diffstat 1 files changed, 11 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/javafx-ui-common/src/javafx/scene/input/MouseEvent.java	Thu May 30 08:26:15 2013 +0100
+++ b/javafx-ui-common/src/javafx/scene/input/MouseEvent.java	Thu May 30 08:29:16 2013 +0100
@@ -784,6 +784,17 @@
      */
     private final boolean popupTrigger;
 
+    /**
+     * Returns {@code true} if this mouse event is the popup menu
+     * trigger event for the platform.
+     * <p><b>Note</b>: Popup menus are triggered differently
+     * on different systems. Therefore, {@code popupTrigger}
+     * should be checked in both {@code onMousePressed}
+     * and {@code mouseReleased} for proper cross-platform functionality.
+     *
+     * @return {@code true} if this mouse event is the popup menu
+     * trigger event for the platform
+     */
     public final boolean isPopupTrigger() {
         return popupTrigger;
     }