TrayIcon (Платформа Java SE 7)

java.lang. Объект
- java.awt. TrayIcon

```
public class TrayIcon
extends Object
```
A TrayIcon объект представляет значок лотка, который может быть добавлен к system tray. A TrayIcon может иметь подсказку (текст), изображение, раскрывающееся меню, и ряд слушателей, связанных с этим.
A TrayIcon может генерировать различный MouseEvents и поддерживает добавляющих соответствующих слушателей, чтобы получить уведомление об этих событиях. TrayIcon процессы некоторые из событий отдельно. Например, по умолчанию, когда правильный щелчок мышью выполняется на TrayIcon это выводит на экран указанное раскрывающееся меню. Когда мышь нависает над TrayIcon подсказка выводится на экран.
Отметьте: Когда MouseEvent диспетчеризируется его зарегистрированным слушателям его component свойство будет установлено в null. (См. ComponentEvent.getComponent()) source свойство будет установлено в это TrayIcon. (См. EventObject.getSource())
Отметьте: хорошего поведения TrayIcon реализация присвоит различные жесты показу раскрывающегося меню и выбору значка лотка.
A TrayIcon может генерировать ActionEvent. На некоторых платформах это происходит, когда пользователь выбирает значок лотка, используя или мышь или клавиатуру.
Если SecurityManager устанавливается, AWTPermission accessSystemTray должен быть предоставлен, чтобы создать a TrayIcon. Иначе конструктор бросит SecurityException.
См. SystemTray краткий обзор класса для примера на том, как использовать TrayIcon API.

С тех пор:

1.6

См. Также:
SystemTray.add(java.awt.TrayIcon), ComponentEvent.getComponent(), EventObject.getSource()

Вложенная Сводка Класса

Вложенные Классы
Модификатор и Тип	Класс и Описание
`static class`	`TrayIcon. MessageType` Тип сообщения определяет, какой значок будет выведен на экран в заголовке сообщения, и возможная система звучит, сообщение может генерировать после показа.

Сводка конструктора

Конструкторы
Конструктор и Описание
`TrayIcon(Image image)` Создает a `TrayIcon` с указанным изображением.
`TrayIcon(Image image, String tooltip)` Создает a `TrayIcon` с указанным изображением и текстом подсказки.
`TrayIcon(Image image, String tooltip, PopupMenu popup)` Создает a `TrayIcon` с указанным изображением, подсказкой и раскрывающимся меню.

Сводка метода

Методы
Модификатор и Тип	Метод и Описание
`void`	`addActionListener(ActionListener listener)` Добавляет указанный слушатель действия, чтобы получить `ActionEvent`s от этого `TrayIcon`.
`void`	`addMouseListener(MouseListener listener)` Добавляет указанный слушатель мыши, чтобы получить события от нажатия мыши от этого `TrayIcon`.
`void`	`addMouseMotionListener(MouseMotionListener listener)` Добавляет указанный слушатель мыши, чтобы получить события движения мыши от этого `TrayIcon`.
`void`	`displayMessage(String caption, String text, TrayIcon.MessageType messageType)` Выводит на экран всплывающее сообщение около значка лотка.
`Строка`	`getActionCommand()` Возвращает название команды события действия, запущенного этим значком лотка.
`ActionListener[]`	`getActionListeners()` Возвращает массив всех слушателей действия, зарегистрированных на этом `TrayIcon`.
`Изображение`	`getImage()` Возвращает текущее изображение, используемое для этого `TrayIcon`.
`MouseListener[]`	`getMouseListeners()` Возвращает массив всех слушателей мыши, зарегистрированных на этом `TrayIcon`.
`MouseMotionListener[]`	`getMouseMotionListeners()` Возвращает массив всех слушателей движения мыши, зарегистрированных на этом `TrayIcon`.
`PopupMenu`	`getPopupMenu()` Возвращает раскрывающееся меню, связанное с этим `TrayIcon`.
`Размерность`	`getSize()` Возвращает размер, в пикселях, места, которое значок лотка занимает в системном лотке.
`Строка`	`getToolTip()` Возвращает строку подсказки, связанную с этим `TrayIcon`.
`boolean`	`isImageAutoSize()` Возвращает значение свойства авторазмера.
`void`	`removeActionListener(ActionListener listener)` Удаляет указанного слушателя действия.
`void`	`removeMouseListener(MouseListener listener)` Удаляет указанного слушателя мыши.
`void`	`removeMouseMotionListener(MouseMotionListener listener)` Удаляет указанного слушателя движения мыши.
`void`	`setActionCommand(String command)` Устанавливает название команды для события действия, запущенного этим значком лотка.
`void`	`setImage(Image image)` Устанавливает изображение для этого `TrayIcon`.
`void`	`setImageAutoSize(boolean autosize)` Устанавливает свойство авторазмера.
`void`	`setPopupMenu(PopupMenu popup)` Устанавливает раскрывающееся меню для этого `TrayIcon`.
`void`	`setToolTip(String tooltip)` Устанавливает строку подсказки для этого `TrayIcon`.

Методы java.lang унаследованный от класса. Объект
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Деталь конструктора
  - TrayIcon
```
public TrayIcon(Image image)
```
    Создает a TrayIcon с указанным изображением.
    
    Параметры:
    image - Image использоваться
    
    Броски:
    
    IllegalArgumentException - если image null
    
    UnsupportedOperationException - если системный лоток не поддерживается текущей платформой
    
    HeadlessException - если GraphicsEnvironment.isHeadless() возвраты true
    
    SecurityException - если accessSystemTray разрешение не предоставляют
    См. Также:
    SystemTray.add(TrayIcon), TrayIcon(Image, String, PopupMenu), TrayIcon(Image, String), SecurityManager.checkPermission(java.security.Permission), AWTPermission
  - TrayIcon
```
public TrayIcon(Image image,
        String tooltip)
```
    Создает a TrayIcon с указанным изображением и текстом подсказки.
    
    Параметры:
    image - Image использоваться
    tooltip - строка, которая будет использоваться в качестве текста подсказки; если значение null никакую подсказку не показывают
    
    Броски:
    
    IllegalArgumentException - если image null
    
    UnsupportedOperationException - если системный лоток не поддерживается текущей платформой
    
    HeadlessException - если GraphicsEnvironment.isHeadless() возвраты true
    
    SecurityException - если accessSystemTray разрешение не предоставляют
    См. Также:
    SystemTray.add(TrayIcon), TrayIcon(Image), TrayIcon(Image, String, PopupMenu), SecurityManager.checkPermission(java.security.Permission), AWTPermission
  - TrayIcon
```
public TrayIcon(Image image,
        String tooltip,
        PopupMenu popup)
```
    Создает a TrayIcon с указанным изображением, подсказкой и раскрывающимся меню.
    
    Параметры:
    image - Image использоваться
    tooltip - строка, которая будет использоваться в качестве текста подсказки; если значение null никакую подсказку не показывают
    popup - меню, которое будет использоваться для раскрывающегося меню значка лотка; если значение null нет раскрывающееся меню не показывают
    
    Броски:
    
    IllegalArgumentException - если image null
    
    UnsupportedOperationException - если системный лоток не поддерживается текущей платформой
    
    HeadlessException - если GraphicsEnvironment.isHeadless() возвраты true
    
    SecurityException - если accessSystemTray разрешение не предоставляют
    См. Также:
    SystemTray.add(TrayIcon), TrayIcon(Image, String), TrayIcon(Image), PopupMenu, MouseListener, addMouseListener(MouseListener), SecurityManager.checkPermission(java.security.Permission), AWTPermission
- Деталь метода
  - setImage
```
public void setImage(Image image)
```
    Устанавливает изображение для этого TrayIcon. Предыдущее изображение значка лотка отбрасывается, не вызывая Image.flush() метод — Вы должны будете вызвать это вручную.
    Если изображение представит изображение с анимацией, то оно будет анимировано автоматически.
    См. setImageAutoSize(boolean) свойство для деталей о размере выведенного на экран изображения.
    Вызов этого метода с тем же самым изображением, которое в настоящий момент используется, не имеет никакого эффекта.
    
    Параметры:
    image - ненуль Image использоваться
    
    Броски:
    
    NullPointerException - если image null
    См. Также:
    getImage(), Image, SystemTray.add(TrayIcon), TrayIcon(Image, String)
  - getImage
```
public Image getImage()
```
    Возвращает текущее изображение, используемое для этого TrayIcon.
    
    Возвраты:
    изображение
    См. Также:
    setImage(Image), Image
  - setPopupMenu
```
public void setPopupMenu(PopupMenu popup)
```
    Устанавливает раскрывающееся меню для этого TrayIcon. Если popup null, нет раскрывающееся меню не будет связано с этим TrayIcon.
    Отметьте что это popup не должен быть добавлен ни к какому родителю прежде или после того, как он устанавливается на значке лотка. Если Вы добавляете это к некоторому родителю, popup может быть удален из того родителя.
    popup может быть установлен на одном TrayIcon только. Установка того же самого раскрывается на многократном TrayIcons вызовет IllegalArgumentException.
    Отметьте: Некоторые платформы, возможно, не поддерживают показ определенного пользователем раскрывающегося компонента меню, когда пользователь щелкает правой кнопкой по значку лотка. В этой ситуации или никакое меню не будет выведено на экран или на некоторых системах, собственная версия меню может быть выведена на экран.
    
    Параметры:
    popup - a PopupMenu или null чтобы удалить любого открывают меню
    
    Броски:
    
    IllegalArgumentException - если popup уже устанавливается для другого TrayIcon
    См. Также:
    getPopupMenu()
  - getPopupMenu
```
public PopupMenu getPopupMenu()
```
    Возвращает раскрывающееся меню, связанное с этим TrayIcon.
    
    Возвраты:
    раскрывающееся меню или null если ни один не существует
    См. Также:
    setPopupMenu(PopupMenu)
  - setToolTip
```
public void setToolTip(String tooltip)
```
    Устанавливает строку подсказки для этого TrayIcon. Подсказка выводится на экран автоматически, когда мышь нависает над значком. Установка подсказки к null удаляет любой текст подсказки. Когда выведено на экран, строка подсказки может быть усеченной на некоторых платформах; число символов, которые могут быть выведены на экран, зависимо от платформы.
    
    Параметры:
    tooltip - строка для подсказки; если значение null никакую подсказку не показывают
    См. Также:
    getToolTip()
  - getToolTip
```
public String getToolTip()
```
    Возвращает строку подсказки, связанную с этим TrayIcon.
    
    Возвраты:
    строка подсказки или null если ни один не существует
    См. Также:
    setToolTip(String)
  - setImageAutoSize
```
public void setImageAutoSize(boolean autosize)
```
    Устанавливает свойство авторазмера. Авторазмер определяет, измеряется ли изображение лотка автоматически, чтобы соответствовать месту, выделенному для изображения на лотке. По умолчанию свойство авторазмера устанавливается в false.
    Если авторазмер false, и размер изображения не соответствует пространство значка лотка, изображение красится как есть в том пространстве — если больше чем выделенное место, это будет обрезано.
    Если авторазмер true, изображение расширяется или уменьшается, чтобы соответствовать пространству значка лотка.
    
    Параметры:
    autosize - true автоизмерять изображение, false иначе
    См. Также:
    isImageAutoSize()
  - isImageAutoSize
```
public boolean isImageAutoSize()
```
    Возвращает значение свойства авторазмера.
    
    Возвраты:
    true если изображение будет автоизмерено, false иначе
    См. Также:
    setImageAutoSize(boolean)
  - addMouseListener
```
public void addMouseListener(MouseListener listener)
```
    Добавляет указанный слушатель мыши, чтобы получить события от нажатия мыши от этого TrayIcon. Вызов этого метода с a null значение не имеет никакого эффекта.
    Отметьте: MouseEvent's координаты (полученный из TrayIcon) относительно экрана, не TrayIcon.
    Отметьте: MOUSE_ENTERED и MOUSE_EXITED события от нажатия мыши не поддерживаются.
    Отошлите к AWT Распараллеливающие Проблемы для деталей о модели потоков AWT.
    
    Параметры:
    listener - слушатель мыши
    См. Также:
    MouseEvent, MouseListener, removeMouseListener(MouseListener), getMouseListeners()
  - removeMouseListener
```
public void removeMouseListener(MouseListener listener)
```
    Удаляет указанного слушателя мыши. Вызов этого метода с null или недопустимое значение не имеет никакого эффекта.
    Отошлите к AWT Распараллеливающие Проблемы для деталей о модели потоков AWT.
    
    Параметры:
    listener - слушатель мыши
    См. Также:
    MouseEvent, MouseListener, addMouseListener(MouseListener), getMouseListeners()
  - getMouseListeners
```
public MouseListener[] getMouseListeners()
```
    Возвращает массив всех слушателей мыши, зарегистрированных на этом TrayIcon.
    
    Возвраты:
    весь из MouseListeners зарегистрированный на этом TrayIcon или пустой массив, если никакие слушатели мыши в настоящий момент не регистрируются
    См. Также:
    addMouseListener(MouseListener), removeMouseListener(MouseListener), MouseListener
  - addMouseMotionListener
```
public void addMouseMotionListener(MouseMotionListener listener)
```
    Добавляет указанный слушатель мыши, чтобы получить события движения мыши от этого TrayIcon. Вызов этого метода с a null значение не имеет никакого эффекта.
    Отметьте: MouseEvent's координаты (полученный из TrayIcon) относительно экрана, не TrayIcon.
    Отметьте: MOUSE_DRAGGED событие от нажатия мыши не поддерживается.
    Отошлите к AWT Распараллеливающие Проблемы для деталей о модели потоков AWT.
    
    Параметры:
    listener - слушатель мыши
    См. Также:
    MouseEvent, MouseMotionListener, removeMouseMotionListener(MouseMotionListener), getMouseMotionListeners()
  - removeMouseMotionListener
```
public void removeMouseMotionListener(MouseMotionListener listener)
```
    Удаляет указанного слушателя движения мыши. Вызов этого метода с null или недопустимое значение не имеет никакого эффекта.
    Отошлите к AWT Распараллеливающие Проблемы для деталей о модели потоков AWT.
    
    Параметры:
    listener - слушатель мыши
    См. Также:
    MouseEvent, MouseMotionListener, addMouseMotionListener(MouseMotionListener), getMouseMotionListeners()
  - getMouseMotionListeners
```
public MouseMotionListener[] getMouseMotionListeners()
```
    Возвращает массив всех слушателей движения мыши, зарегистрированных на этом TrayIcon.
    
    Возвраты:
    весь из MouseInputListeners зарегистрированный на этом TrayIcon или пустой массив, если никакие слушатели мыши в настоящий момент не регистрируются
    См. Также:
    addMouseMotionListener(MouseMotionListener), removeMouseMotionListener(MouseMotionListener), MouseMotionListener
  - getActionCommand
```
public String getActionCommand()
```
    Возвращает название команды события действия, запущенного этим значком лотка.
    
    Возвраты:
    название команды действия, или null если ни один не существует
    См. Также:
    addActionListener(ActionListener), setActionCommand(String)
  - setActionCommand
```
public void setActionCommand(String command)
```
    Устанавливает название команды для события действия, запущенного этим значком лотка. По умолчанию эта команда действия устанавливается в null.
    
    Параметры:
    command - строка, используемая, чтобы установить команду действия значка лотка.
    См. Также:
    ActionEvent, addActionListener(ActionListener), getActionCommand()
  - addActionListener
```
public void addActionListener(ActionListener listener)
```
    Добавляет указанный слушатель действия, чтобы получить ActionEvents от этого TrayIcon. События действия обычно имеют место, когда пользователь выбирает значок лотка, используя или мышь или клавиатуру. Условия, в которых сгенерированы события действия, зависимы от платформы.
    Вызов этого метода с a null значение не имеет никакого эффекта.
    Отошлите к AWT Распараллеливающие Проблемы для деталей о модели потоков AWT.
    
    Параметры:
    listener - слушатель действия
    См. Также:
    removeActionListener(java.awt.event.ActionListener), getActionListeners(), ActionListener, setActionCommand(String)
  - removeActionListener
```
public void removeActionListener(ActionListener listener)
```
    Удаляет указанного слушателя действия. Вызов этого метода с null или недопустимое значение не имеет никакого эффекта.
    Отошлите к AWT Распараллеливающие Проблемы для деталей о модели потоков AWT.
    
    Параметры:
    listener - слушатель действия
    См. Также:
    ActionEvent, ActionListener, addActionListener(ActionListener), getActionListeners(), setActionCommand(String)
  - getActionListeners
```
public ActionListener[] getActionListeners()
```
    Возвращает массив всех слушателей действия, зарегистрированных на этом TrayIcon.
    
    Возвраты:
    весь из ActionListeners зарегистрированный на этом TrayIcon или пустой массив, если никакие слушатели действия в настоящий момент не регистрируются
    См. Также:
    addActionListener(ActionListener), removeActionListener(ActionListener), ActionListener
  - displayMessage
```
public void displayMessage(String caption,
                  String text,
                  TrayIcon.MessageType messageType)
```
    Выводит на экран всплывающее сообщение около значка лотка. Сообщение исчезнет через некоторое время или если пользователь щелкает по нему. Щелчок по сообщению может инициировать ActionEvent.
    Или заголовок или текст могут быть null, но NullPointerException бросается, если оба null. Когда выведено на экран, заголовок или текстовые строки могут быть усеченными на некоторых платформах; число символов, которые могут быть выведены на экран, зависимо от платформы.
    Отметьте: Некоторые платформы, возможно, не поддерживают показ сообщения.
    
    Параметры:
    caption - заголовок, выведенный на экран выше текста, обычно полужирным; может быть null
    text - текст выводится на экран для определенного сообщения; может быть null
    messageType - перечисление, указывающее на тип сообщения
    
    Броски:
    
    NullPointerException - если оба caption и text null
  - getSize
```
public Dimension getSize()
```
    Возвращает размер, в пикселях, места, которое значок лотка занимает в системном лотке. Для значка лотка, который еще не добавляется к системному лотку, возвращенный размер равен результату SystemTray.getTrayIconSize().
    
    Возвраты:
    размер значка лотка, в пикселях
    См. Также:
    setImageAutoSize(boolean), Image, getSize()

Представьте ошибку или функцию
Для дальнейшей ссылки API и документации разработчика, см. Java Документация SE. Та документация содержит более подробные, предназначенные разработчиком описания, с концептуальными краткими обзорами, определениями сроков, обходных решений, и рабочих примеров кода.
Авторское право © 1993, 2011, Oracle и/или его филиалы. Все права защищены.

Класс TrayIcon

Вложенная Сводка Класса

Сводка конструктора

Сводка метода

Методы java.lang унаследованный от класса. Объект

Деталь конструктора

TrayIcon

TrayIcon

TrayIcon

Деталь метода

setImage

getImage

setPopupMenu

getPopupMenu

setToolTip

getToolTip

setImageAutoSize

isImageAutoSize

addMouseListener

removeMouseListener

getMouseListeners

addMouseMotionListener

removeMouseMotionListener

getMouseMotionListeners

getActionCommand

setActionCommand

addActionListener

removeActionListener

getActionListeners

displayMessage

getSize