Spec-Zone.ru › OpenJDK 21

Класс Button

java.lang.Object
java.awt.Component
java.awt.Button
Все реализованные интерфейсы:
ImageObserver, MenuContainer, Serializable, Accessible
public class Button extends Component implements Accessible
Этот класс создаёт кнопку с меткой. При нажатии на кнопку может быть выполнено какое-либо действие. На изображении показаны три варианта отображения кнопки "Quit" в операционной системе Solaris:

The following context describes the
 graphic

Первый вариант отображает кнопку в обычном режиме. Второй вариант показывает кнопку, когда у неё фокус ввода. Контур кнопки затемнён, чтобы пользователь понимал, что это активный объект. Третий вариант показывает кнопку, когда пользователь наводит курсор мыши на кнопку, и, таким образом, запрашивает выполнение действия.

Действие нажатия кнопки мышью связано с одним экземпляром ActionEvent, который отправляется, когда кнопка мыши нажимается и отпускается над кнопкой. Если приложение хочет узнать, когда кнопка была нажата, но не отпущена, как отдельное действие, оно может специализировать processMouseEvent, или зарегистрировать себя как слушатель событий мыши, вызвав addMouseListener. Оба этих метода определены в Component, абстрактном суперклассе всех компонентов.

Когда кнопка нажимается и отпускается, AWT отправляет экземпляр ActionEvent в кнопку, вызвав processEvent в кнопке. Метод processEvent кнопки получает все события для кнопки; он передаёт событие действия, вызвав свой собственный метод processActionEvent. Последний метод передаёт событие действия любым обработчикам событий действия, которые зарегистрировали интерес к событиям действия, генерируемым этой кнопкой.

Если приложение хочет выполнить какое-либо действие, основанное на нажатии и отпускании кнопки, оно должно реализовать ActionListener и зарегистрировать нового слушателя для получения событий от этой кнопки, вызвав метод addActionListener кнопки. Приложение может использовать команду действия кнопки в качестве протокола обмена сообщениями.

С:
1.0
См. также:
  • ActionEvent
  • ActionListener
  • Component.processMouseEvent(java.awt.event.MouseEvent)
  • Component.addMouseListener(java.awt.event.MouseListener)
  • Сериализованная форма

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

Модификатор и тип Класс Описание
protected class  Button.AccessibleAWTButton
Этот класс реализует поддержку доступности для класса Button.

Вложенные классы/интерфейсы, объявленные в классе java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

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

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

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Поля, объявленные в интерфейсе java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

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

Конструктор Описание
Button()
Создаёт кнопку с пустой строкой в качестве метки.
Button(String label)
Создаёт кнопку с заданной меткой.

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

Модификатор и тип Метод Описание
void addActionListener(ActionListener l)
Добавляет указанного обработчика событий действия для получения событий действия от этой кнопки.
void addNotify()
Создаёт виджет-представитель кнопки.
AccessibleContext getAccessibleContext()
Возвращает AccessibleContext, связанную с этим Button.
String getActionCommand()
Возвращает имя команды события действия, сгенерированного этой кнопкой.
ActionListener[] getActionListeners()
Возвращает массив всех обработчиков событий действия, зарегистрированных на этой кнопке.
String getLabel()
Возвращает метку этой кнопки.
<T extends EventListener>
T[]
getListeners(Class<T> listenerType)
Возвращает массив всех объектов, в настоящее время зарегистрированных как FooListener на этой Button.
protected String paramString()
Возвращает строку, представляющую состояние этого Button.
protected void processActionEvent(ActionEvent e)
Обрабатывает события действия, возникающие на этой кнопке, рассылая их любым зарегистрированным объектам ActionListener.
protected void processEvent(AWTEvent e)
Обрабатывает события на этой кнопке.
void removeActionListener(ActionListener l)
Удаляет указанного обработчика событий действия, чтобы он больше не получал события действия от этой кнопки.
void setActionCommand(String command)
Устанавливает имя команды для события действия, генерируемого этой кнопкой.
void setLabel(String label)
Устанавливает метку кнопки в указанную строку.

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

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setMixingCutoutShape, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate

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

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

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

Кнопка

public Button() throws HeadlessException
Создаёт кнопку с пустой строкой в качестве метки.
Исключение:
HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true
См. также:
  • GraphicsEnvironment.isHeadless()

Кнопка

public Button(String label) throws HeadlessException
Создаёт кнопку с заданной меткой.
Параметры:
label - строковая метка для кнопки, или null для отсутствия метки
Исключение:
HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true
См. также:
  • GraphicsEnvironment.isHeadless()

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

addNotify

public void addNotify()
Создаёт виджет-представитель кнопки. Представитель кнопки позволяет приложению изменять внешний вид кнопки без изменения её функциональности.
Переопределяет:
addNotify в классе Component
См. также:
  • Component.getToolkit()

getLabel

public String getLabel()
Возвращает метку этой кнопки.
Возвращает:
метку кнопки, или null если у кнопки нет метки.
См. также:
  • setLabel(java.lang.String)

setLabel

public void setLabel(String label)
Устанавливает метку кнопки на указанную строку.
Параметры:
label - новая метка, или null если у кнопки нет метки.
См. также:
  • getLabel()

setActionCommand

public void setActionCommand(String command)
Устанавливает имя команды для события действия, генерируемого этой кнопкой. По умолчанию это имя команды совпадает с меткой кнопки.
Параметры:
command - строка, используемая для установки команды действия кнопки. Если строка равна null, команда действия устанавливается, чтобы соответствовать метке кнопки.
С:
1.1
См. также:
  • ActionEvent

getActionCommand

public String getActionCommand()
Возвращает имя команды события действия, генерируемого этой кнопкой. Если имя команды равно null (по умолчанию), этот метод возвращает метку кнопки.
Возвращает:
имя команды действия (или метка) для этой кнопки

addActionListener

public void addActionListener(ActionListener l)
Добавляет указанного обработчика событий действия для получения событий действия от этой кнопки. События действия происходят, когда пользователь нажимает или отпускает мышь над этой кнопкой. Если l равно null, исключение не генерируется, и никаких действий не выполняется.

См. Вопросы многопоточности AWT для получения подробной информации о модели многопоточности AWT.

Параметры:
l - обработчик событий действия
С:
1.1
См. также:
  • removeActionListener(java.awt.event.ActionListener)
  • getActionListeners()
  • ActionListener

removeActionListener

public void removeActionListener(ActionListener l)
Удаляет указанного обработчика событий действия, чтобы он больше не получал события действия от этой кнопки. События действия происходят, когда пользователь нажимает или отпускает мышь над этой кнопкой. Если l равно null, исключение не генерируется, и никаких действий не выполняется.

См. Вопросы многопоточности AWT для получения подробной информации о модели многопоточности AWT.

Параметры:
l - обработчик событий действия
С:
1.1
См. также:
  • addActionListener(java.awt.event.ActionListener)
  • getActionListeners()
  • ActionListener

getActionListeners

public ActionListener[] getActionListeners()
Возвращает массив всех обработчиков событий действия, зарегистрированных на этой кнопке.
Возвращает:
все обработчики событий действия этой кнопки или пустой массив, если обработчики событий действия в данный момент не зарегистрированы
С:
1.4
См. также:
  • addActionListener(java.awt.event.ActionListener)
  • removeActionListener(java.awt.event.ActionListener)
  • ActionListener

getListeners

public <T extends EventListener> T[] getListeners(Class<T> listenerType)
Возвращает массив всех объектов, в данный момент зарегистрированных в качестве обработчиков событий на данной кнопке. Обработчики событий регистрируются с помощью метода addFooListener.

Вы можете указать аргумент listenerType с помощью литерала класса, например FooListener.class. Например, вы можете запросить обработчики событий действия для Button b следующим кодом:

ActionListener[] als = (ActionListener[])(b.getListeners(ActionListener.class));
Если таких обработчиков нет, этот метод возвращает пустой массив.
Переопределяет:
getListeners в классе Component
Параметры типа:
T - тип обработчиков
Параметры:
listenerType - тип запрашиваемых обработчиков; этот параметр должен указать интерфейс, являющийся потомком java.util.EventListener
Возвращает:
массив всех объектов, зарегистрированных в качестве обработчиков событий на этой кнопке, или пустой массив, если такие обработчики не были добавлены
Исключение:
ClassCastException - если listenerType не указывает класс или интерфейс, реализующий java.util.EventListener
С:
1.3
См. также:
  • getActionListeners()

processEvent

protected void processEvent(AWTEvent e)
Обрабатывает события на этой кнопке. Если событие является экземпляром ActionEvent, этот метод вызывает метод processActionEvent. В противном случае он вызывает processEvent в суперклассе.

Обратите внимание, что если параметр события null, поведение не определено и может привести к исключению.

Переопределяет:
processEvent в классе Component
Параметры:
e - событие
С:
1.1
См. также:
  • ActionEvent
  • processActionEvent(java.awt.event.ActionEvent)

processActionEvent

protected void processActionEvent(ActionEvent e)
Обрабатывает события действия, происходящие на этой кнопке, рассылаемые всем зарегистрированным обработчикам событий.

Этот метод не вызывается, если события действия не разрешены для этой кнопки. События действия разрешены, когда происходит одно из следующих событий:

  • Объект типа ActionListener зарегистрирован через addActionListener.
  • События действия разрешены через enableEvents.

Обратите внимание, что если параметр события null, поведение не определено и может привести к исключению.

Параметры:
e - событие действия
С:
1.1
См. также:
  • ActionListener
  • addActionListener(java.awt.event.ActionListener)
  • Component.enableEvents(long)

paramString

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

getAccessibleContext

@BeanProperty(expert=true, description="The AccessibleContext associated with this Button.") public AccessibleContext getAccessibleContext()
Получает объект AccessibleContext , связанный с этим объектом. Для кнопок AccessibleContext принимает вид объекта AccessibleAWTButton. Новый экземпляр AccessibleAWTButton создаётся при необходимости.
Определено в:
getAccessibleContext в интерфейсе Accessible
Переопределяет:
getAccessibleContext в классе Component
Возвращает:
объект AccessibleAWTButton, который служит контекстом AccessibleContext этого Button
С:
1.3

© 1993, 2023, 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/21/docs/api/java.desktop/java/awt/Button.html

Spec-Zone.ru

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