Spec-Zone.ru › OpenJDK 25

Класс 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(MouseEvent)
  • Component.addMouseListener(MouseListener)
  • Сериализованная форма

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

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

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

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

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

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

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

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

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

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

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

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

Модификатор и тип Метод Описание
void addActionListener(ActionListener l)
Добавляет указанный слушатель действий для получения событий действий от этой кнопки.
void addNotify()
Создает peer-объект кнопки.
AccessibleContext getAccessibleContext()
Получает AccessibleContext, связанный с этим Button.
String getActionCommand()
Возвращает имя команды события действия, инициируемого этой кнопкой.
ActionListener[] getActionListeners()
Возвращает массив всех слушателей действий, зарегистрированных для этой кнопки.
String getLabel()
Получает надпись этой кнопки.
<T extends EventListener>
T[]
getListeners(Class<T> listenerType)
Возвращает массив всех объектов, зарегистрированных в данный момент в качестве FooListeners для этого 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)
Задает для кнопки указанную строку в качестве надписи.

Методы, объявленные в классе 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

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

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

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

Button

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

Button

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

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

addNotify

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

getLabel

public String getLabel()
Получает надпись этой кнопки.
Возвращает:
надпись кнопки или null, если у кнопки нет надписи.
См. также:
  • setLabel(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(ActionListener)
  • getActionListeners()
  • ActionListener

removeActionListener

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

Подробнее о модели многопоточности AWT см. в разделе Проблемы многопоточности AWT.

Параметры:
l — слушатель действий
Начиная с:
1.1
См. также:
  • addActionListener(ActionListener)
  • getActionListeners()
  • ActionListener

getActionListeners

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

getListeners

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

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

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

processEvent

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

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

Переопределяет:
processEvent в классе Component
Параметры:
e — событие
Начиная с:
1.1
См. также:
  • ActionEvent
  • processActionEvent(ActionEvent)

processActionEvent

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

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

  • Зарегистрирован объект ActionListener с помощью метода addActionListener.
  • События действий включены с помощью метода enableEvents.

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

Параметры:
e — событие действия
Начиная с:
1.1
См. также:
  • ActionListener
  • addActionListener(ActionListener)
  • Component.enableEvents(long)

paramString

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

getAccessibleContext

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

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по API и документацию для разработчиков см. в документации Java SE, содержащей более подробные описания для разработчиков, обзор концепций, определения терминов, обходные решения и работающие примеры кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее аффилированных лиц в США и других странах.
Авторские права © 1993, 2025, Oracle и/или ее аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

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

Spec-Zone.ru

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