1 /* 2 * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package java.awt; 27 28 import java.awt.peer.TaskbarPeer; 29 import sun.awt.SunToolkit; 30 31 /** 32 * The {@code Taskbar} class allows a Java application to interact with 33 * the system task area (taskbar, Dock, etc.). 34 * 35 * <p> 36 * There are a variety of interactions depending on the current platform such as 37 * displaying progress of some task, appending user-specified menu to the application 38 * icon context menu, etc. 39 * 40 * @implNote Linux support is currently limited to Unity. However to make these 41 * features work on Unity, the app should be run from a .desktop file with 42 * specified {@code java.desktop.appName} system property set to this .desktop 43 * file name: 44 * {@code Exec=java -Djava.desktop.appName=MyApp.desktop -jar /path/to/myapp.jar} 45 * see <a href="https://help.ubuntu.com/community/UnityLaunchersAndDesktopFiles"> 46 * https://help.ubuntu.com/community/UnityLaunchersAndDesktopFiles</a> 47 * 48 * @since 9 49 */ 50 51 public class Taskbar { 52 53 /** 54 * List of provided features. Each platform supports a different 55 * set of features. You may use the {@link Taskbar#isSupported} 56 * method to determine if the given feature is supported by the 57 * current platform. 58 */ 59 public static enum Feature { 60 61 /** 62 * Represents a textual icon badge feature. 63 * @see #setIconBadge(java.lang.String) 64 */ 65 ICON_BADGE_TEXT, 66 67 /** 68 * Represents a numerical icon badge feature. 69 * @see #setIconBadge(java.lang.String) 70 */ 71 ICON_BADGE_NUMBER, 72 73 /** 74 * Represents a graphical icon badge feature for a window. 75 * @see #setWindowIconBadge(java.awt.Window, java.awt.Image) 76 */ 77 ICON_BADGE_IMAGE_WINDOW, 78 79 /** 80 * Represents an icon feature. 81 * @see #setIconImage(java.awt.Image) 82 */ 83 ICON_IMAGE, 84 85 /** 86 * Represents a menu feature. 87 * @see #setMenu(java.awt.PopupMenu) 88 * @see #getMenu() 89 */ 90 MENU, 91 92 /** 93 * Represents a progress state feature for a specified window. 94 * @see #setWindowProgressState(java.awt.Window, State) 95 */ 96 PROGRESS_STATE_WINDOW, 97 98 /** 99 * Represents a progress value feature. 100 * @see #setProgressValue(int) 101 */ 102 PROGRESS_VALUE, 103 104 /** 105 * Represents a progress value feature for a specified window. 106 * @see #setWindowProgressValue(java.awt.Window, int) 107 */ 108 PROGRESS_VALUE_WINDOW, 109 110 /** 111 * Represents a user attention request feature. 112 * @see #requestUserAttention(boolean, boolean) 113 */ 114 USER_ATTENTION, 115 116 /** 117 * Represents a user attention request feature for a specified window. 118 * @see #requestWindowUserAttention(java.awt.Window) 119 */ 120 USER_ATTENTION_WINDOW 121 } 122 123 /** 124 * Kinds of available window progress states. 125 * 126 * @see #setWindowProgressState(java.awt.Window, java.awt.Taskbar.State) 127 */ 128 public static enum State { 129 /** 130 * Stops displaying the progress. 131 */ 132 OFF, 133 /** 134 * The progress indicator displays with normal color and determinate 135 * mode. 136 */ 137 NORMAL, 138 /** 139 * Shows progress as paused, progress can be resumed by the user. 140 * Switches to the determinate display. 141 */ 142 PAUSED, 143 /** 144 * The progress indicator displays activity without specifying what 145 * proportion of the progress is complete. 146 */ 147 INDETERMINATE, 148 /** 149 * Shows that an error has occurred. Switches to the determinate 150 * display. 151 */ 152 ERROR 153 } 154 155 private TaskbarPeer peer; 156 157 /** 158 * Tests whether a {@code Feature} is supported on the current platform. 159 * @param feature the specified {@link Feature} 160 * @return true if the specified feature is supported on the current platform 161 */ 162 public boolean isSupported(Feature feature) { 163 return peer.isSupported(feature); 164 } 165 166 /** 167 * Checks if the feature type is supported. 168 * 169 * @param featureType the action type in question 170 * @throws UnsupportedOperationException if the specified action type is not 171 * supported on the current platform 172 */ 173 private void checkFeatureSupport(Feature featureType){ 174 if (!isSupported(featureType)) { 175 throw new UnsupportedOperationException("The " + featureType.name() 176 + " feature is not supported on the current platform!"); 177 } 178 } 179 180 /** 181 * Calls to the security manager's {@code checkPermission} method with 182 * an {@code RuntimePermission("canProcessApplicationEvents")} permissions. 183 */ 184 private void checkEventsProcessingPermission(){ 185 SecurityManager sm = System.getSecurityManager(); 186 if (sm != null) { 187 sm.checkPermission(new RuntimePermission( 188 "canProcessApplicationEvents")); 189 } 190 } 191 192 private Taskbar() { 193 Toolkit defaultToolkit = Toolkit.getDefaultToolkit(); 194 if (defaultToolkit instanceof SunToolkit) { 195 peer = ((SunToolkit) defaultToolkit).createTaskbarPeer(this); 196 } 197 } 198 199 private static Taskbar taskbar; 200 201 /** 202 * Returns the {@code Taskbar} instance of the current 203 * taskbar context. On some platforms the Taskbar API may not be 204 * supported; use the {@link #isTaskbarSupported} method to 205 * determine if the current taskbar is supported. 206 * @return the Taskbar instance 207 * @throws HeadlessException if {@link 208 * GraphicsEnvironment#isHeadless()} returns {@code true} 209 * @throws UnsupportedOperationException if this class is not 210 * supported on the current platform 211 * @see #isTaskbarSupported() 212 * @see java.awt.GraphicsEnvironment#isHeadless 213 */ 214 public static synchronized Taskbar getTaskbar(){ 215 if (GraphicsEnvironment.isHeadless()) throw new HeadlessException(); 216 217 if (!Taskbar.isTaskbarSupported()) { 218 throw new UnsupportedOperationException("Taskbar API is not " + 219 "supported on the current platform"); 220 } 221 222 Taskbar taskbar = null; 223 sun.awt.AppContext context = sun.awt.AppContext.getAppContext(); 224 225 taskbar = (context == null) 226 ? Taskbar.taskbar 227 : (Taskbar)context.get(Taskbar.class); 228 229 if (taskbar == null) { 230 taskbar = new Taskbar(); 231 if (context != null) { 232 context.put(Taskbar.class, taskbar); 233 } 234 } 235 236 return taskbar; 237 } 238 239 /** 240 * Tests whether this class is supported on the current platform. 241 * If it's supported, use {@link #getTaskbar()} to retrieve an 242 * instance. 243 * 244 * @return {@code true} if this class is supported on the 245 * current platform; {@code false} otherwise 246 * @see #getTaskbar() 247 */ 248 public static boolean isTaskbarSupported(){ 249 Toolkit defaultToolkit = Toolkit.getDefaultToolkit(); 250 if (defaultToolkit instanceof SunToolkit) { 251 return ((SunToolkit)defaultToolkit).isTaskbarSupported(); 252 } 253 return false; 254 } 255 256 /** 257 * Requests user attention to this application. 258 * 259 * Depending on the platform, this may be visually indicated by a bouncing 260 * or flashing icon in the task area. It may have no effect on an already active 261 * application. 262 * 263 * On some platforms (e.g. Mac OS) this effect may disappear upon app activation 264 * and cannot be dismissed by setting {@code enabled} to false. 265 * Other platforms may require an additional call 266 * {@link #requestUserAttention} to dismiss this request 267 * with {@code enabled} parameter set to false. 268 * 269 * @param enabled disables this request if false 270 * @param critical if this is an important request 271 * @throws SecurityException if a security manager exists and it denies the 272 * {@code RuntimePermission("canProcessApplicationEvents")} permission. 273 * @throws UnsupportedOperationException if the current platform 274 * does not support the {@link Taskbar.Feature#USER_ATTENTION} feature 275 */ 276 public void requestUserAttention(final boolean enabled, final boolean critical) { 277 checkEventsProcessingPermission(); 278 checkFeatureSupport(Feature.USER_ATTENTION); 279 peer.requestUserAttention(enabled, critical); 280 } 281 282 /** 283 * Requests user attention to the specified window. 284 * 285 * @param w window 286 * @throws SecurityException if a security manager exists and it denies the 287 * {@code RuntimePermission("canProcessApplicationEvents")} permission. 288 * @throws UnsupportedOperationException if the current platform 289 * does not support the {@link Taskbar.Feature#USER_ATTENTION_WINDOW} feature 290 */ 291 public void requestWindowUserAttention(Window w) { 292 checkEventsProcessingPermission(); 293 checkFeatureSupport(Feature.USER_ATTENTION_WINDOW); 294 peer.requestWindowUserAttention(w); 295 } 296 297 /** 298 * Attaches the contents of the provided PopupMenu to the application icon 299 * in the task area. 300 * 301 * @param menu the PopupMenu to attach to this application 302 * @throws SecurityException if a security manager exists and it denies the 303 * {@code RuntimePermission("canProcessApplicationEvents")} permission. 304 * @throws UnsupportedOperationException if the current platform 305 * does not support the {@link Taskbar.Feature#MENU} feature 306 */ 307 public void setMenu(final PopupMenu menu) { 308 checkEventsProcessingPermission(); 309 checkFeatureSupport(Feature.MENU); 310 peer.setMenu(menu); 311 } 312 313 /** 314 * Gets PopupMenu used to add items to this application's icon in system task area. 315 * 316 * @return the PopupMenu 317 * @throws SecurityException if a security manager exists and it denies the 318 * {@code RuntimePermission("canProcessApplicationEvents")} permission. 319 * @throws UnsupportedOperationException if the current platform 320 * does not support the {@link Taskbar.Feature#MENU} feature 321 */ 322 public PopupMenu getMenu() { 323 checkEventsProcessingPermission(); 324 checkFeatureSupport(Feature.MENU); 325 return peer.getMenu(); 326 } 327 328 /** 329 * Changes this application's icon to the provided image. 330 * 331 * @param image to change 332 * @throws SecurityException if a security manager exists and it denies the 333 * {@code RuntimePermission("canProcessApplicationEvents")} permission. 334 * @throws UnsupportedOperationException if the current platform 335 * does not support the {@link Taskbar.Feature#ICON_IMAGE} feature 336 */ 337 public void setIconImage(final Image image) { 338 checkEventsProcessingPermission(); 339 checkFeatureSupport(Feature.ICON_IMAGE); 340 peer.setIconImage(image); 341 } 342 343 /** 344 * Obtains an image of this application's icon. 345 * 346 * @return an image of this application's icon 347 * @throws SecurityException if a security manager exists and it denies the 348 * {@code RuntimePermission("canProcessApplicationEvents")} permission. 349 * @throws UnsupportedOperationException if the current platform 350 * does not support the {@link Taskbar.Feature#ICON_IMAGE} feature 351 */ 352 public Image getIconImage() { 353 checkEventsProcessingPermission(); 354 checkFeatureSupport(Feature.ICON_IMAGE); 355 return peer.getIconImage(); 356 } 357 358 /** 359 * Affixes a small system-provided badge to this application's icon. 360 * Usually a number. 361 * 362 * Some platforms do not support string values and accept only integer 363 * values. In this case, pass an integer represented as a string as parameter. 364 * This can be tested by {@code Feature.ICON_BADGE_TEXT} and 365 * {@code Feature.ICON_BADGE_NUMBER}. 366 * 367 * Passing {@code null} as parameter hides the badge. 368 * @param badge label to affix to the icon 369 * @throws SecurityException if a security manager exists and it denies the 370 * {@code RuntimePermission("canProcessApplicationEvents")} permission. 371 * @throws UnsupportedOperationException if the current platform 372 * does not support the {@link Taskbar.Feature#ICON_BADGE_NUMBER} 373 * or {@link Taskbar.Feature#ICON_BADGE_TEXT} feature 374 */ 375 public void setIconBadge(final String badge) { 376 checkEventsProcessingPermission(); 377 checkFeatureSupport(Feature.ICON_BADGE_NUMBER); 378 peer.setIconBadge(badge); 379 } 380 381 /** 382 * Affixes a small badge to this application's icon in the task area 383 * for the specified window. 384 * It may be disabled by system settings. 385 * 386 * @param w window to update 387 * @param badge image to affix to the icon 388 * @throws SecurityException if a security manager exists and it denies the 389 * {@code RuntimePermission("canProcessApplicationEvents")} permission. 390 * @throws UnsupportedOperationException if the current platform 391 * does not support the {@link Taskbar.Feature#ICON_BADGE_IMAGE_WINDOW} feature 392 */ 393 public void setWindowIconBadge(Window w, final Image badge) { 394 checkEventsProcessingPermission(); 395 checkFeatureSupport(Feature.ICON_BADGE_IMAGE_WINDOW); 396 if (w != null) { 397 peer.setWindowIconBadge(w, badge); 398 } 399 } 400 401 402 /** 403 * Affixes a small system-provided progress bar to this application's icon. 404 * 405 * @param value from 0 to 100, other to disable progress indication 406 * @throws SecurityException if a security manager exists and it denies the 407 * {@code RuntimePermission("canProcessApplicationEvents")} permission. 408 * @throws UnsupportedOperationException if the current platform 409 * does not support the {@link Taskbar.Feature#PROGRESS_VALUE} feature 410 */ 411 public void setProgressValue(int value) { 412 checkEventsProcessingPermission(); 413 checkFeatureSupport(Feature.PROGRESS_VALUE); 414 peer.setProgressValue(value); 415 } 416 417 /** 418 * Displays a determinate progress bar in the task area for the specified 419 * window. 420 * <br> 421 * The visual behavior is platform and {@link State} dependent. 422 * <br> 423 * This call cancels the {@link State#INDETERMINATE INDETERMINATE} state 424 * of the window. 425 * <br> 426 * Note that when multiple windows is grouped in the task area 427 * the behavior is platform specific. 428 * 429 * @param w window to update 430 * @param value from 0 to 100, other to switch to {@link State#OFF} state 431 * and disable progress indication 432 * @see #setWindowProgressState(java.awt.Window, State) 433 * @throws SecurityException if a security manager exists and it denies the 434 * {@code RuntimePermission("canProcessApplicationEvents")} permission. 435 * @throws UnsupportedOperationException if the current platform 436 * does not support the {@link Taskbar.Feature#PROGRESS_VALUE_WINDOW} feature 437 */ 438 public void setWindowProgressValue(Window w, int value) { 439 checkEventsProcessingPermission(); 440 checkFeatureSupport(Feature.PROGRESS_VALUE_WINDOW); 441 if (w != null) { 442 peer.setWindowProgressValue(w, value); 443 } 444 } 445 446 /** 447 * Sets a progress state for a specified window. 448 * <br> 449 * Each state displays a progress in a platform-dependent way. 450 * <br> 451 * Note than switching from {@link State#INDETERMINATE INDETERMINATE} state 452 * to any of determinate states may reset value set by 453 * {@link #setWindowProgressValue(java.awt.Window, int) setWindowProgressValue} 454 * 455 * @param w window 456 * @param state to change to 457 * @see State#OFF 458 * @see State#NORMAL 459 * @see State#PAUSED 460 * @see State#ERROR 461 * @see State#INDETERMINATE 462 * @see #setWindowProgressValue(java.awt.Window, int) 463 * @throws SecurityException if a security manager exists and it denies the 464 * {@code RuntimePermission("canProcessApplicationEvents")} permission. 465 * @throws UnsupportedOperationException if the current platform 466 * does not support the {@link Taskbar.Feature#PROGRESS_STATE_WINDOW} feature 467 */ 468 public void setWindowProgressState(Window w, State state) { 469 checkEventsProcessingPermission(); 470 checkFeatureSupport(Feature.PROGRESS_STATE_WINDOW); 471 if (w != null) { 472 peer.setWindowProgressState(w, state); 473 } 474 } 475 }