Класс Desktop

java.lang.Object

java.awt.Desktop

public class Desktop extends Object

Класс Desktop позволяет взаимодействовать с различными возможностями рабочего стола.

Поддерживаемые операции включают:

запуск пользовательского браузера для отображения указанного URI;
запуск пользовательского почтового клиента с необязательным mailto URI;
запуск зарегистрированного приложения для открытия, редактирования или печати указанного файла.

Этот класс предоставляет методы, соответствующие этим операциям. Методы ищут связанное приложение, зарегистрированное в текущей платформе, и запускают его для обработки URI или файла. Если связанного приложения нет или связанное приложение не может быть запущено, генерируется исключение. Полный список поддерживаемых операций и возможностей см. в Desktop.Action.

Приложение регистрируется для URI или типа файла. Механизм регистрации, доступа и запуска связанного приложения зависит от платформы.

Каждая операция — это тип действия, представленный классом Desktop.Action.

Примечание: когда вызывается некоторая операция и связанное приложение выполняется, оно будет выполнено на той же системе, на которой запущено приложение Java.

Since:

1.6

See Also:

Desktop.Action

Краткое описание вложенных классов

Модификатор и тип	Класс	Описание
`static enum`	`Desktop.Action`	Представляет тип действия.

Краткое описание методов

Модификатор и тип	Метод	Описание
`void`	`addAppEventListener(SystemEventListener listener)`	Добавляет подтипы `SystemEventListener` для прослушивания уведомлений из родной системы.
`void`	`browse(URI uri)`	Запускает браузер по умолчанию для отображения `URI`.
`void`	`browseFileDirectory(File file)`	Открывает папку, содержащую `file` и выбирает ее в стандартном файловом менеджере системы.
`void`	`disableSuddenTermination()`	Предотвращает внезапное завершение работы этого приложения.
`void`	`edit(File file)`	Запускает связанное приложение-редактор и открывает файл для редактирования.
`void`	`enableSuddenTermination()`	Включает возможность внезапного завершения работы этого приложения.
`static Desktop`	`getDesktop()`	Возвращает экземпляр `Desktop` текущего контекста рабочего стола.
`static boolean`	`isDesktopSupported()`	Проверяет, поддерживается ли этот класс в текущей платформе.
`boolean`	`isSupported(Desktop.Action action)`	Проверяет, поддерживается ли действие в текущей платформе.
`void`	`mail()`	Запускает окно составления письма почтового клиента по умолчанию.
`void`	`mail(URI mailtoURI)`	Запускает окно составления письма почтового клиента по умолчанию, заполнив поля сообщения, указанные в `mailto:` URI.
`boolean`	`moveToTrash(File file)`	Перемещает указанный файл в корзину.
`void`	`open(File file)`	Запускает связанное приложение для открытия файла.
`void`	`openHelpViewer()`	Открывает родное приложение просмотра справки.
`void`	`print(File file)`	Печатает файл с помощью родной системы печати рабочего стола, используя команду печати связанного приложения.
`void`	`removeAppEventListener(SystemEventListener listener)`	Удаляет подтипы `SystemEventListener` для прослушивания уведомлений из родной системы.
`void`	`requestForeground(boolean allWindows)`	Запросить перемещение этого приложения на передний план.
`void`	`setAboutHandler(AboutHandler aboutHandler)`	Устанавливает обработчик для отображения пользовательского окна "О программе" для вашего приложения.
`void`	`setDefaultMenuBar(JMenuBar menuBar)`	Устанавливает основное меню для использования в случае отсутствия активных фреймов.
`void`	`setOpenFileHandler(OpenFilesHandler openFileHandler)`	Устанавливает обработчик, который уведомляется, когда приложение запрошено открыть список файлов.
`void`	`setOpenURIHandler(OpenURIHandler openURIHandler)`	Устанавливает обработчик, который уведомляется, когда приложение запрошено открыть URL.
`void`	`setPreferencesHandler(PreferencesHandler preferencesHandler)`	Устанавливает обработчик для отображения пользовательского окна "Настройки" для вашего приложения.
`void`	`setPrintFileHandler(PrintFilesHandler printFileHandler)`	Устанавливает обработчик, который уведомляется, когда приложение запрошено распечатать список файлов.
`void`	`setQuitHandler(QuitHandler quitHandler)`	Устанавливает обработчик, определяющий, следует ли завершить приложение.
`void`	`setQuitStrategy(QuitStrategy strategy)`	Устанавливает стратегию по умолчанию для завершения работы этого приложения.

Методы, унаследованные от класса java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание методов

getDesktop

public static Desktop getDesktop()

Возвращает экземпляр Desktop текущего контекста рабочего стола. На некоторых платформах API рабочего стола может быть не поддерживается; используйте метод isDesktopSupported(), чтобы определить, поддерживается ли текущий рабочий стол.

Возвращает:

экземпляр Desktop

Исключения:

HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true

UnsupportedOperationException - если этот класс не поддерживается на текущей платформе

См. также:

isDesktopSupported

public static boolean isDesktopSupported()

Проверяет, поддерживается ли этот класс на текущей платформе. Если он поддерживается, используйте getDesktop() для получения экземпляра.

Возвращает:

true если этот класс поддерживается на текущей платформе; false в противном случае

См. также:

getDesktop()

isSupported

public boolean isSupported(Desktop.Action action)

Проверяет, поддерживается ли действие на текущей платформе.

Даже если платформа поддерживает действие, файл или URI может не иметь зарегистрированного приложения для этого действия. Например, большинство платформ поддерживают действие Desktop.Action.OPEN. Но для конкретного файла может не быть зарегистрированного приложения для его открытия. В этом случае, isSupported(Action) может вернуть true, но соответствующий метод действия выбросит IOException.

Параметры:

action - указанное Desktop.Action

Возвращает:

true если указанное действие поддерживается на текущей платформе; false в противном случае

См. также:

Desktop.Action

open

public void open(File file) throws IOException

Запускает связанное приложение для открытия файла.

Если указанный файл является каталогом, запускается файловый менеджер текущей платформы для его открытия.

Параметры:

file - файл, который необходимо открыть с помощью связанного приложения

Исключения:

NullPointerException - если file является null

IllegalArgumentException - если указанный файл не существует

UnsupportedOperationException - если текущая платформа не поддерживает действие Desktop.Action.OPEN

IOException - если у указанного файла нет связанного приложения или связанное приложение не удалось запустить

SecurityException - если существует менеджер безопасности и его метод SecurityManager.checkRead(java.lang.String) отклоняет доступ для чтения к файлу, или он отклоняет разрешение AWTPermission("showWindowWithoutWarningBanner"), или вызывающая нить не разрешает создание дочернего процесса

См. также:

AWTPermission

edit

public void edit(File file) throws IOException

Запускает связанное приложение-редактор и открывает файл для редактирования.

Параметры:

file - файл, который необходимо открыть для редактирования

Исключения:

NullPointerException - если указанный файл null

IllegalArgumentException - если указанный файл не существует

UnsupportedOperationException - если текущая платформа не поддерживает действие Desktop.Action.EDIT

IOException - если у указанного файла нет связанного редактора или связанное приложение не удалось запустить

SecurityException - если менеджер безопасности существует и его метод SecurityManager.checkRead(java.lang.String) отклоняет доступ для чтения к файлу, или метод SecurityManager.checkWrite(java.lang.String) отклоняет доступ для записи к файлу, или он отклоняет разрешение AWTPermission("showWindowWithoutWarningBanner"), или вызывающая нить не разрешает создание дочернего процесса

См. также:

AWTPermission

print

public void print(File file) throws IOException

Печатает файл с помощью стандартных средств печати рабочего стола, используя команду печати связанного приложения.

Параметры:: file - файл, который необходимо распечатать
Исключения:: NullPointerException - если указанный файл null; IllegalArgumentException - если указанный файл не существует; UnsupportedOperationException - если текущая платформа не поддерживает действие Desktop.Action.PRINT; IOException - если у указанного файла нет связанного приложения, которое может быть использовано для печати; SecurityException - если существует менеджер безопасности и его метод SecurityManager.checkRead(java.lang.String) отклоняет доступ для чтения к файлу, или его метод SecurityManager.checkPrintJobAccess() отклоняет разрешение на печать файла, или вызывающая нить не разрешает создание дочернего процесса

browse

public void browse(URI uri) throws IOException

Запускает стандартный браузер для отображения URI. Если стандартный браузер не может обработать указанный URI, вызывается приложение, зарегистрированное для обработки URIs указанного типа. Приложение определяется из протокола и пути URI, как определено классом URI.

Параметры:

uri - URI, который должен быть отображён в стандартном браузере пользователя

Исключения:

NullPointerException - если uri является null

UnsupportedOperationException - если текущая платформа не поддерживает действие Desktop.Action.BROWSE

IOException - если стандартный браузер пользователя не найден или не удалось запустить, или приложение по умолчанию не удалось запустить

SecurityException - если существует менеджер безопасности и он отклоняет разрешение AWTPermission("showWindowWithoutWarningBanner"), или вызывающая нить не разрешает создание дочернего процесса

См. также:

mail

public void mail() throws IOException

Запускает окно создания письма почтового клиента по умолчанию.

Исключения:

UnsupportedOperationException - если текущая платформа не поддерживает действие Desktop.Action.MAIL

IOException - если почтовый клиент по умолчанию не найден или не удалось запустить

См. также:

AWTPermission

mail

public void mail(URI mailtoURI) throws IOException

Запускает окно создания письма почтового клиента по умолчанию, заполняя поля сообщения, указанные в


 mailto:

URI.

mailto: URI может указывать поля сообщения, включая "to", "cc", "subject", "body" и т. д. См. Схема URL mailto (RFC 2368) для подробностей спецификации mailto: URI.

Параметры:

mailtoURI - указанный mailto: URI

Исключения:

NullPointerException - если указанный URI


 null

IllegalArgumentException - если схема URI не "mailto"

UnsupportedOperationException - если текущая платформа не поддерживает действие Desktop.Action.MAIL

IOException - если почтовый клиент по умолчанию не найден или не удалось запустить

SecurityException - если менеджер безопасности существует и отклоняет разрешение AWTPermission("showWindowWithoutWarningBanner"), или вызывающая нить не разрешает создание дочернего процесса

См. также:

addAppEventListener

public void addAppEventListener(SystemEventListener listener)

Добавляет подтипы SystemEventListener для прослушивания уведомлений от родной системы. Не оказывает никакого действия, если подтип SystemEventListener не поддерживается на текущей платформе.

Parameters:

listener - listener

Throws:

SecurityException - если существует менеджер безопасности и он запрещает RuntimePermission("canProcessApplicationEvents") разрешение

Since:

See Also:

removeAppEventListener

public void removeAppEventListener(SystemEventListener listener)

Удаляет подтипы SystemEventListener для прослушивания уведомлений от родной системы. Не оказывает никакого действия, если подтип SystemEventListener не поддерживается на текущей платформе.

Parameters:

listener - listener

Throws:

SecurityException - если существует менеджер безопасности и он запрещает RuntimePermission("canProcessApplicationEvents") разрешение

Since:

See Also:

setAboutHandler

public void setAboutHandler(AboutHandler aboutHandler)

Устанавливает обработчик для отображения пользовательского окна About для вашего приложения.

Установка AboutHandler в null возвращает к поведению по умолчанию.

Parameters:: aboutHandler - обработчик для ответа на сообщение AboutHandler.handleAbout(AboutEvent)
Throws:: SecurityException - если существует менеджер безопасности и он запрещает RuntimePermission("canProcessApplicationEvents") разрешение; UnsupportedOperationException - если текущая платформа не поддерживает действие Desktop.Action.APP_ABOUT
Since:: 9

setPreferencesHandler

public void setPreferencesHandler(PreferencesHandler preferencesHandler)

Устанавливает обработчик для отображения пользовательского окна Preferences для вашего приложения.

Установка PreferencesHandler в null возвращает к поведению по умолчанию

Parameters:: preferencesHandler - обработчик для ответа на сообщение PreferencesHandler.handlePreferences(PreferencesEvent)
Throws:: SecurityException - если существует менеджер безопасности и он запрещает RuntimePermission("canProcessApplicationEvents") разрешение; UnsupportedOperationException - если текущая платформа не поддерживает действие Desktop.Action.APP_PREFERENCES
Since:: 9

setOpenFileHandler

public void setOpenFileHandler(OpenFilesHandler openFileHandler)

Устанавливает обработчик, который уведомляется, когда приложение должно открыть список файлов.

Implementation Note:: Обратите внимание, что для macOS уведомления отправляются только если Java-приложение является приложением в пакете, с массивом CFBundleDocumentTypes в его Info.plist. См. документацию Apple Developer для получения дополнительной информации о Info.plist.
Parameters:: openFileHandler - handler
Throws:: SecurityException - если существует менеджер безопасности и его метод SecurityManager.checkRead(java.lang.String) запрещает чтение файлов, или он запрещает RuntimePermission("canProcessApplicationEvents") разрешение, или вызывающей потоку запрещено создавать дочерний процесс; UnsupportedOperationException - если текущая платформа не поддерживает действие Desktop.Action.APP_OPEN_FILE
Since:: 9

setPrintFileHandler

public void setPrintFileHandler(PrintFilesHandler printFileHandler)

Устанавливает обработчик, который уведомляется, когда приложение должно распечатать список файлов.

Implementation Note:: Обратите внимание, что для macOS уведомления отправляются только если Java-приложение является приложением в пакете, с массивом CFBundleDocumentTypes в его Info.plist. См. документацию Apple Developer для получения дополнительной информации о Info.plist.
Parameters:: printFileHandler - handler
Throws:: SecurityException - если существует менеджер безопасности и его метод SecurityManager.checkPrintJobAccess() запрещает печать или запрещает RuntimePermission("canProcessApplicationEvents") разрешение; UnsupportedOperationException - если текущая платформа не поддерживает действие Desktop.Action.APP_PRINT_FILE
Since:: 9

setOpenURIHandler

public void setOpenURIHandler(OpenURIHandler openURIHandler)

Устанавливает обработчик, который уведомляется, когда приложение должно открыть URL. Установка обработчика в null приводит к тому, что все запросы OpenURIHandler.openURI(OpenURIEvent) будут помещены в очередь до тех пор, пока не будет установлен другой обработчик.

Implementation Note:: Обратите внимание, что для macOS уведомления отправляются только если Java-приложение является приложением в пакете, с массивом CFBundleDocumentTypes в его Info.plist. См. документацию Apple Developer для получения дополнительной информации о Info.plist.
Parameters:: openURIHandler - handler RuntimePermission("canProcessApplicationEvents") разрешение, или вызывающему потоку запрещено создавать дочерний процесс
Throws:: UnsupportedOperationException - если текущая платформа не поддерживает действие Desktop.Action.APP_OPEN_URI
Since:: 9

setQuitHandler

public void setQuitHandler(QuitHandler quitHandler)

Устанавливает обработчик, который определяет, должен ли выйти из приложения. Обработчику передается одноразовый QuitResponse, который может отменить или продолжить выход. Установка обработчика в null приводит к тому, что все запросы на выход выполняют по умолчанию QuitStrategy.

Parameters:: quitHandler - обработчик, вызываемый при запросе выхода из приложения
Throws:: SecurityException - если существует менеджер безопасности и он не позволит вызывающему выполнить System.exit или запрещает RuntimePermission("canProcessApplicationEvents") разрешение; UnsupportedOperationException - если текущая платформа не поддерживает действие Desktop.Action.APP_QUIT_HANDLER
Since:: 9

setQuitStrategy

public void setQuitStrategy(QuitStrategy strategy)

Устанавливает стратегию по умолчанию для выхода из приложения. По умолчанию используется SYSTEM_EXIT_0.

Parameters:

strategy - способ завершения работы приложения

Throws:

SecurityException - если существует менеджер безопасности и он не позволит вызывающему выполнить System.exit или запрещает RuntimePermission("canProcessApplicationEvents") разрешение

UnsupportedOperationException - если текущая платформа не поддерживает действие Desktop.Action.APP_QUIT_STRATEGY

Since:

See Also:

QuitStrategy

enableSuddenTermination

public void enableSuddenTermination()

Включает возможность внезапного завершения работы этого приложения. Вызовите этот метод, чтобы указать, что состояние вашего приложения сохранено и оно не требует уведомления перед завершением. Возможность внезапного завершения работы приложения улучшает пользовательский опыт, избегая повторной загрузки приложения при его закрытии. Примечание: включение внезапного завершения позволит завершить работу приложения без уведомления вашего обработчика закрытия или выполнения каких-либо закрывающих процедур. Например, запросы пользователя Cmd-Q, выхода из системы, перезагрузки или выключения системы эффективно приведут к "kill -KILL" вашего приложения.

Throws:

SecurityException - если менеджер безопасности существует и не позволит вызывающей стороне вызвать System.exit или откажет в разрешении RuntimePermission("canProcessApplicationEvents")

UnsupportedOperationException - если текущая платформа не поддерживает действие Desktop.Action.APP_SUDDEN_TERMINATION

Since:

See Also:

disableSuddenTermination()

disableSuddenTermination

public void disableSuddenTermination()

Запрещает внезапное завершение работы этого приложения. Вызовите этот метод, чтобы указать, что в вашем приложении есть несохранённые данные и его нельзя завершить без уведомления.

Throws:

UnsupportedOperationException - если текущая платформа не поддерживает действие Desktop.Action.APP_SUDDEN_TERMINATION

Since:

See Also:

enableSuddenTermination()

requestForeground

public void requestForeground(boolean allWindows)

Запрашивает перемещение этого приложения на передний план.

Parameters:: allWindows - если все окна этого приложения должны быть выведены на передний план или только самое верхнее
Throws:: SecurityException - если менеджер безопасности существует и отказывает в разрешении RuntimePermission("canProcessApplicationEvents").; UnsupportedOperationException - если текущая платформа не поддерживает действие Desktop.Action.APP_REQUEST_FOREGROUND
Since:: 9

openHelpViewer

public void openHelpViewer()

Открывает приложение просмотра справки.

Implementation Note:: Обратите внимание, что для macOS оно открывает приложение просмотра справки, если книга справки добавлена в приложение и зарегистрирована в Info.plist с CFBundleHelpBookFolder
Throws:: SecurityException - если менеджер безопасности существует и отказывает в разрешении RuntimePermission("canProcessApplicationEvents") или отказывает в разрешении AWTPermission("showWindowWithoutWarningBanner") или вызывающей нити запрещено создание дочернего процесса; UnsupportedOperationException - если текущая платформа не поддерживает действие Desktop.Action.APP_HELP_VIEWER
Since:: 9

setDefaultMenuBar

public void setDefaultMenuBar(JMenuBar menuBar)

Устанавливает стандартную строку меню для использования, когда нет активных фреймов.

Parameters:: menuBar - для использования, когда другие фреймы неактивны
Throws:: SecurityException - если менеджер безопасности существует и отказывает в разрешении RuntimePermission("canProcessApplicationEvents").; UnsupportedOperationException - если текущая платформа не поддерживает действие Desktop.Action.APP_MENU_BAR
Since:: 9

browseFileDirectory

public void browseFileDirectory(File file)

Открывает папку, содержащую file и выбирает её в стандартном файловом менеджере системы.

Parameters:: file - файл
Throws:: SecurityException - Если менеджер безопасности существует и его метод SecurityManager.checkRead(java.lang.String) отказывает в доступе для чтения к файлу или к его родительскому элементу, или отказывает в разрешении AWTPermission("showWindowWithoutWarningBanner") , или вызывающей нити запрещено создание дочернего процесса; UnsupportedOperationException - если текущая платформа не поддерживает действие Desktop.Action.BROWSE_FILE_DIR; NullPointerException - если file является null; IllegalArgumentException - если указанный файл или его родительский элемент не существует
Since:: 9

moveToTrash

public boolean moveToTrash(File file)

Перемещает указанный файл в корзину.

Parameters:: file - файл
Returns:: возвращает true, если файл успешно перемещён в корзину.
Throws:: SecurityException - Если менеджер безопасности существует и его метод SecurityManager.checkDelete(java.lang.String) отказывает в удалении файла; UnsupportedOperationException - если текущая платформа не поддерживает действие Desktop.Action.MOVE_TO_TRASH; NullPointerException - если file является null; IllegalArgumentException - если указанный файл не существует
Since:: 9

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/java/awt/Desktop.html