モジュール java.desktop
パッケージ java.awt

クラスTaskbar


  • public class Taskbar
extends Object
    Taskbarクラスを使用すると、Javaアプリケーションはシステム・タスク領域(タスク・バー、ドックなど。)と対話できます。

    現在のプラットフォームによっては、タスクの進捗状況の表示、アプリケーション・アイコンのコンテキスト・メニューへのユーザー指定メニューの追加など、さまざまな相互作用があります。

    実装上の注意:
    Linuxのサポートは現在Unityに限られています。 しかし、これらの機能をUnity上で動作させるには、指定したjava.desktop.appNameシステム・プロパティを.desktopファイル名に設定して.desktopファイルからアプリケーションを実行する必要があります: Exec=java -Djava.desktop.appName=MyApp.desktop -jar /path/to/myapp.jarを参照してくださいhttps://help.ubuntu.com/community/UnityLaunchersAndDesktopFiles
    導入されたバージョン:
    9

    • ネストされたクラスのサマリー

      ネストされたクラス 
      修飾子と型 クラス 説明
      static class  Taskbar.Feature
      提供される機能のリスト。
      static class  Taskbar.State
      使用可能なウィンドウの進行状況の種類。

    • メソッドのサマリー

      すべてのメソッド 静的メソッド インスタンス・メソッド 具象メソッド 
      修飾子と型 メソッド 説明
      Image getIconImage​()
      このアプリケーション・アイコンのイメージを取得します。
      PopupMenu getMenu​()
      システム・タスク領域のこのアプリケーション・アイコンにアイテムを追加するために使用されるPopupMenuを取得します。
      static Taskbar getTaskbar​()
      現在のタスク・バー・コンテキストのTaskbarインスタンスを返します。
      boolean isSupported​(Taskbar.Feature feature)
      Featureが現在のプラットフォームでサポートされているかどうかをテストします。
      static boolean isTaskbarSupported​()
      このクラスが現在のプラットフォームでサポートされているかどうかを判定します。
      void requestUserAttention​(boolean enabled, boolean critical)
      このアプリケーションへのユーザーの注意をリクエストします。
      void requestWindowUserAttention​(Window w)
      指定されたウィンドウへのユーザーの注意をリクエストします。
      void setIconBadge​(String badge)
      システムの小さなバッジをこのアプリケーション・アイコンに貼り付けます。
      void setIconImage​(Image image)
      このアプリケーション・アイコンを提供されたイメージに変更します。
      void setMenu​(PopupMenu menu)
      提供されたPopupMenuの内容をタスク領域のアプリケーション・アイコンにアタッチします。
      void setProgressValue​(int value)
      システムの小さなプログレス・バーをこのアプリケーション・アイコンに貼り付けます。
      void setWindowIconBadge​(Window w, Image badge)
      指定したウィンドウのタスク領域のこのアプリケーション・アイコンに小さいバッジを貼り付けます。
      void setWindowProgressState​(Window w, Taskbar.State state)
      指定されたウィンドウの進行状況を設定します。
      void setWindowProgressValue​(Window w, int value)
      指定されたウィンドウのタスク領域に確定バーを表示します。

    • メソッドの詳細

      • isSupported

        public boolean isSupported​(Taskbar.Feature feature)
        Featureが現在のプラットフォームでサポートされているかどうかをテストします。
        パラメータ:
        feature - 指定されたTaskbar.Feature
        戻り値:
        指定された機能が現在のプラットフォームでサポートされている場合はtrue

      • isTaskbarSupported

        public static boolean isTaskbarSupported​()
        このクラスが現在のプラットフォームでサポートされているかどうかを判定します。 サポートされている場合は、getTaskbar()を使用してインスタンスを取得します。
        戻り値:
        このクラスが現在のプラットフォームでサポートされている場合はtrue、そうでない場合はfalse
        関連項目:
        getTaskbar()

      • requestUserAttention

        public void requestUserAttention​(boolean enabled,
                                 boolean critical)
        このアプリケーションへのユーザーの注意をリクエストします。 プラットフォームによっては、タスク領域内のバウンスまたは点滅のアイコンによって視覚的に示されます。 既にアクティブなアプリケーションには影響しません。 いくつかのプラットフォーム(例えばMac OS)では、この効果はアプリの起動時に消えてしまい、enabledをfalseに設定することで解消することはできません。 他のプラットフォームでは、enabledパラメータをfalseに設定してこのリクエストを破棄するには、追加のrequestUserAttention(boolean, boolean)コールが必要な場合があります。
        パラメータ:
        enabled - falseの場合はこのリクエストを無効にします
        critical - これが重要なリクエストであれば
        例外:
        SecurityException - セキュリティ・マネージャが存在し、RuntimePermission("canProcessApplicationEvents")許可を拒否した場合。
        UnsupportedOperationException - 現在のプラットフォームがTaskbar.Feature.USER_ATTENTION機能をサポートしていない場合

      • requestWindowUserAttention

        public void requestWindowUserAttention​(Window w)
        指定されたウィンドウへのユーザーの注意をリクエストします。 タスク領域にウィンドウ表現が表示されない場合は効果がありません。 表示可能かどうかは、ウィンドウのタイプ、プラットフォーム、実装のすべてに依存します。
        パラメータ:
        w - window
        例外:
        SecurityException - セキュリティ・マネージャが存在し、RuntimePermission("canProcessApplicationEvents")許可を拒否した場合。
        UnsupportedOperationException - 現在のプラットフォームがTaskbar.Feature.USER_ATTENTION_WINDOW機能をサポートしていない場合

      • setMenu

        public void setMenu​(PopupMenu menu)
        提供されたPopupMenuの内容をタスク領域のアプリケーション・アイコンにアタッチします。
        パラメータ:
        menu - このアプリケーションにアタッチするPopupMenu
        例外:
        SecurityException - セキュリティ・マネージャが存在し、RuntimePermission("canProcessApplicationEvents")許可を拒否した場合。
        UnsupportedOperationException - 現在のプラットフォームがTaskbar.Feature.MENU機能をサポートしていない場合

      • getMenu

        public PopupMenu getMenu​()
        システム・タスク領域のこのアプリケーション・アイコンにアイテムを追加するために使用されるPopupMenuを取得します。
        戻り値:
        PopupMenu
        例外:
        SecurityException - セキュリティ・マネージャが存在し、RuntimePermission("canProcessApplicationEvents")許可を拒否した場合。
        UnsupportedOperationException - 現在のプラットフォームがTaskbar.Feature.MENU機能をサポートしていない場合

      • setIconImage

        public void setIconImage​(Image image)
        このアプリケーション・アイコンを提供されたイメージに変更します。
        パラメータ:
        image - 変更
        例外:
        SecurityException - セキュリティ・マネージャが存在し、RuntimePermission("canProcessApplicationEvents")許可を拒否した場合。
        UnsupportedOperationException - 現在のプラットフォームがTaskbar.Feature.ICON_IMAGE機能をサポートしていない場合

      • getIconImage

        public Image getIconImage​()
        このアプリケーション・アイコンのイメージを取得します。
        戻り値:
        このアプリケーション・アイコンのイメージ
        例外:
        SecurityException - セキュリティ・マネージャが存在し、RuntimePermission("canProcessApplicationEvents")許可を拒否した場合。
        UnsupportedOperationException - 現在のプラットフォームがTaskbar.Feature.ICON_IMAGE機能をサポートしていない場合

      • setIconBadge

        public void setIconBadge​(String badge)
        システムの小さなバッジをこのアプリケーション・アイコンに貼り付けます。 通常は数字です。 一部のプラットフォームでは、文字列値をサポートせず、整数値のみを受け入れます。 この場合、文字列として表される整数をパラメータとして渡します。 これはFeature.ICON_BADGE_TEXTとFeature.ICON_BADGE_NUMBERでテストできます。 パラメータとしてnullを渡すと、バッジが隠されます。
        パラメータ:
        badge - アイコンに付けるラベル
        例外:
        SecurityException - セキュリティ・マネージャが存在し、RuntimePermission("canProcessApplicationEvents")許可を拒否した場合。
        UnsupportedOperationException - 現在のプラットフォームがTaskbar.Feature.ICON_BADGE_NUMBERまたはTaskbar.Feature.ICON_BADGE_TEXT機能をサポートしていない場合

      • setWindowIconBadge

        public void setWindowIconBadge​(Window w,
                               Image badge)
        指定したウィンドウのタスク領域のこのアプリケーション・アイコンに小さいバッジを貼り付けます。 システム設定によって無効になっている可能性があります。 タスク領域にウィンドウ表現が表示されない場合は効果がありません。 表示可能かどうかは、ウィンドウのタイプ、プラットフォーム、実装のすべてに依存します。
        パラメータ:
        w - 更新するウィンドウ
        badge - アイコンに貼り付けるイメージ
        例外:
        SecurityException - セキュリティ・マネージャが存在し、RuntimePermission("canProcessApplicationEvents")許可を拒否した場合。
        UnsupportedOperationException - 現在のプラットフォームがTaskbar.Feature.ICON_BADGE_IMAGE_WINDOW機能をサポートしていない場合

      • setProgressValue

        public void setProgressValue​(int value)
        システムの小さなプログレス・バーをこのアプリケーション・アイコンに貼り付けます。
        パラメータ:
        value - 0から100、進行状況表示を無効にするその他
        例外:
        SecurityException - セキュリティ・マネージャが存在し、RuntimePermission("canProcessApplicationEvents")許可を拒否した場合。
        UnsupportedOperationException - 現在のプラットフォームがTaskbar.Feature.PROGRESS_VALUE機能をサポートしていない場合

      • setWindowProgressValue

        public void setWindowProgressValue​(Window w,
                                   int value)
        指定されたウィンドウのタスク領域に確定バーを表示します。 タスク領域にウィンドウ表現が表示されない場合は効果がありません。 表示可能かどうかは、ウィンドウのタイプ、プラットフォーム、実装のすべてに依存します。
        視覚的な振る舞いはplatformとTaskbar.Stateに依存します。
        この呼び出しは、ウィンドウのINDETERMINATE状態を取り消します。
        タスク領域に複数のウィンドウがグループ化されている場合、その動作はプラットフォーム固有です。
        パラメータ:
        w - 更新するウィンドウ
        value - 0から100までの他、Taskbar.State.OFF状態に切り替えて進捗表示を無効にします
        例外:
        SecurityException - セキュリティ・マネージャが存在し、RuntimePermission("canProcessApplicationEvents")許可を拒否した場合。
        UnsupportedOperationException - 現在のプラットフォームがTaskbar.Feature.PROGRESS_VALUE_WINDOW機能をサポートしていない場合
        関連項目:
        setWindowProgressState(java.awt.Window, State)