Spec-Zone.ru › OpenJDK 17

Класс HierarchyEvent

java.lang.Object
java.util.EventObject
java.awt.AWTEvent
java.awt.event.HierarchyEvent
Все реализованные интерфейсы:
Serializable
public class HierarchyEvent extends AWTEvent
Событие, которое указывает на изменение Component иерархии, к которой принадлежит Component.
  • События изменения иерархии (HierarchyListener)
    • добавление предка
    • удаление предка
    • иерархия сделана отображаемой
    • иерархия сделана неотображаемой
    • иерархия показана на экране (как видимая, так и отображаемая)
    • иерархия скрыта на экране (либо невидимая, либо неотображаемая)
  • События изменения формы предков (HierarchyBoundsListener)
    • предок был изменен
    • предок был перемещен

События иерархии предоставляются ТОЛЬКО для уведомлений. AWT автоматически обрабатывает изменения в иерархии внутри себя, чтобы обеспечить правильную работу макета и отображения GUI независимо от того, получает ли программа эти события или нет.

Это событие генерируется объектом Container (например, Panel), когда Container добавляется, удаляется, перемещается или изменяется, и передается вниз по иерархии. Оно также генерируется объектом Component, когда вызывается метод addNotify, removeNotify, show, или hide. События ANCESTOR_MOVED и ANCESTOR_RESIZED рассылаются каждому объекту HierarchyBoundsListener или HierarchyBoundsAdapter, который зарегистрирован для получения таких событий с помощью метода Component addHierarchyBoundsListener. (Объекты HierarchyBoundsAdapter реализуют интерфейс HierarchyBoundsListener.) События HIERARCHY_CHANGED рассылаются каждому объекту HierarchyListener, который зарегистрирован для получения таких событий с помощью метода Component addHierarchyListener. Каждый такой объект-слушатель получает это событие HierarchyEvent при возникновении события.

Неопределенное поведение произойдет, если параметр id любого экземпляра HierarchyEvent не находится в диапазоне от HIERARCHY_FIRST до HIERARCHY_LAST.
Параметр changeFlags любого экземпляра HierarchyEvent принимает одно из следующих значений:

  • HierarchyEvent.PARENT_CHANGED
  • HierarchyEvent.DISPLAYABILITY_CHANGED
  • HierarchyEvent.SHOWING_CHANGED
Присвоение значения, отличного от указанных выше, приведет к неопределенному поведению.
С момента:
1.3
См. также:
  • HierarchyListener
  • HierarchyBoundsAdapter
  • HierarchyBoundsListener
  • Сериализованная форма

Краткое описание полей

Модификатор и тип Поле Описание
static final int ANCESTOR_MOVED
Идентификатор события, указывающий, что предок-Container был перемещен.
static final int ANCESTOR_RESIZED
Идентификатор события, указывающий, что предок-Container был изменен.
static final int DISPLAYABILITY_CHANGED
Флаг изменения, указывающий, что событие HIERARCHY_CHANGED было сгенерировано из-за изменения отображаемости иерархии.
static final int HIERARCHY_CHANGED
Идентификатор события, указывающий, что изменения были внесены в всю дерево иерархии.
static final int HIERARCHY_FIRST
Обозначает первый целочисленный идентификатор для диапазона идентификаторов событий иерархии.
static final int HIERARCHY_LAST
Обозначает последний целочисленный идентификатор для диапазона идентификаторов событий предков.
static final int PARENT_CHANGED
Флаг изменения, указывающий, что событие HIERARCHY_CHANGED было сгенерировано операцией изменения родителя.
static final int SHOWING_CHANGED
Флаг изменения, указывающий, что событие HIERARCHY_CHANGED было сгенерировано из-за изменения состояния отображения иерархии.

Поля, объявленные в классе java.awt.AWTEvent

ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK

Поля, объявленные в классе java.util.EventObject

source

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

Конструктор Описание
HierarchyEvent(Component source, int id, Component changed, Container changedParent)
Создает объект HierarchyEvent для идентификации изменения в Component иерархии.
HierarchyEvent(Component source, int id, Component changed, Container changedParent, long changeFlags)
Создает объект HierarchyEvent для идентификации изменения в Component иерархии.

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

Модификатор и тип Метод Описание
Component getChanged()
Возвращает Component в верхней части иерархии, которая была изменена.
Container getChangedParent()
Возвращает родителя Component, возвращенного методом getChanged().
long getChangeFlags()
Возвращает битовую маску, которая указывает тип(ы) событий HIERARCHY_CHANGED, представленных в этом объекте события.
Component getComponent()
Возвращает источник события.
String paramString()
Возвращает строку-параметр, идентифицирующую это событие.

Методы, объявленные в классе java.awt.AWTEvent

consume, getID, isConsumed, setSource, toString

Методы, объявленные в классе java.util.EventObject

getSource

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

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

Подробное описание полей

HIERARCHY_FIRST

public static final int HIERARCHY_FIRST
Указывает первый целочисленный идентификатор для диапазона идентификаторов событий иерархии.
См. также:
  • Значения постоянных полей

HIERARCHY_CHANGED

public static final int HIERARCHY_CHANGED
Идентификатор события, указывающий на то, что произведены изменения во всей иерархической древовидной структуре.
См. также:
  • Значения постоянных полей

ANCESTOR_MOVED

public static final int ANCESTOR_MOVED
Идентификатор события, указывающий на перемещение предкового контейнера.
См. также:
  • Значения постоянных полей

ANCESTOR_RESIZED

public static final int ANCESTOR_RESIZED
Идентификатор события, указывающий на изменение размера предкового контейнера.
См. также:
  • Значения постоянных полей

HIERARCHY_LAST

public static final int HIERARCHY_LAST
Указывает последний целочисленный идентификатор для диапазона идентификаторов событий предков.
См. также:
  • Значения постоянных полей

PARENT_CHANGED

public static final int PARENT_CHANGED
Флаг изменения указывает, что событие HIERARCHY_CHANGED было сгенерировано операцией изменения родителя.
См. также:
  • Значения постоянных полей

DISPLAYABILITY_CHANGED

public static final int DISPLAYABILITY_CHANGED
Флаг изменения указывает, что событие HIERARCHY_CHANGED было сгенерировано из-за изменения отображаемости иерархии. Для определения текущей отображаемости иерархии вызовите метод Component.isDisplayable. Изменения отображаемости происходят в ответ на явные или неявные вызовы методов Component.addNotify и Component.removeNotify.
См. также:
  • Component.isDisplayable()
  • Component.addNotify()
  • Component.removeNotify()
  • Значения постоянных полей

SHOWING_CHANGED

public static final int SHOWING_CHANGED
Флаг изменения указывает, что событие HIERARCHY_CHANGED было сгенерировано из-за изменения состояния отображения иерархии. Для определения текущего состояния отображения иерархии вызовите метод Component.isShowing. Изменения состояния отображения происходят при изменении отображаемости или видимости иерархии. Изменения видимости происходят в ответ на явные или неявные вызовы методов Component.show и Component.hide.
См. также:
  • Component.isShowing()
  • Component.addNotify()
  • Component.removeNotify()
  • Component.show()
  • Component.hide()
  • Значения постоянных полей

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

HierarchyEvent

public HierarchyEvent(Component source, int id, Component changed, Container changedParent)
Создает объект HierarchyEvent для идентификации изменения в иерархии Component.

Этот метод выбрасывает IllegalArgumentException, если source равно null.

Параметры:
source - Объект Component, который породил событие
id - Целое число, указывающее тип события. Сведения о допустимых значениях см. в описании класса HierarchyEvent
changed - Component вверху иерархии, который был изменён
changedParent - Родитель компонента changed. Может быть родителем до или после изменения, в зависимости от типа изменения
Исключения:
IllegalArgumentException - если source равно null
См. также:
  • EventObject.getSource()
  • AWTEvent.getID()
  • getChanged()
  • getChangedParent()

HierarchyEvent

public HierarchyEvent(Component source, int id, Component changed, Container changedParent, long changeFlags)
Создает объект HierarchyEvent для идентификации изменения в иерархии Component.

Этот метод выбрасывает IllegalArgumentException, если source равно null.

Параметры:
source - Объект Component, который породил событие
id - Целое число, указывающее тип события. Сведения о допустимых значениях см. в описании класса HierarchyEvent
changed - Component вверху иерархии, который был изменён
changedParent - Родитель компонента changed. Может быть родителем до или после изменения, в зависимости от типа изменения
changeFlags - Маска битов, указывающая тип(ы) события HIERARCHY_CHANGED, представленных в объекте события. Сведения о допустимых значениях см. в описании класса HierarchyEvent
Исключения:
IllegalArgumentException - если source равно null
См. также:
  • EventObject.getSource()
  • AWTEvent.getID()
  • getChanged()
  • getChangedParent()
  • getChangeFlags()

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

getComponent

public Component getComponent()
Возвращает источник события.
Возвращает:
объект Component, который породил событие, или null, если объект не является Component.

getChanged

public Component getChanged()
Возвращает компонент вверху иерархии, который был изменён.
Возвращает:
изменённый компонент

getChangedParent

public Container getChangedParent()
Возвращает родителя компонента, возвращаемого методом getChanged(). Для события HIERARCHY_CHANGED, где изменение было типа PARENT_CHANGED через вызов Container.add, возвращаемый родитель — это родитель после операции добавления. Для события HIERARCHY_CHANGED, где изменение было типа PARENT_CHANGED через вызов Container.remove, возвращаемый родитель — это родитель до операции удаления. Для всех других событий и типов возвращаемый родитель — родитель во время операции.
Возвращает:
родитель изменённого компонента

getChangeFlags

public long getChangeFlags()
Возвращает битовую маску, которая указывает тип(ы) событий HIERARCHY_CHANGED, представленных в этом объекте события. Бит(ы) объединены с помощью побитового ИЛИ.
Возвращает:
маску битов или 0, если это не событие HIERARCHY_CHANGED

paramString

public String paramString()
Возвращает строку параметров, идентифицирующую это событие. Этот метод полезен для ведения журнала событий и для отладки.
Переопределяет:
paramString в классе AWTEvent
Возвращает:
строку, идентифицирующую событие и его атрибуты

© 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/event/HierarchyEvent.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API