Spec-Zone.ru › OpenJDK 17

Класс 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()
Создаёт peer-объект кнопки.
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.

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

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()
Получает контекст доступности, связанный с этой кнопкой. Для кнопок контекст доступности представлен в виде объекта AccessibleAWTButton. Новый объект AccessibleAWTButton создаётся при необходимости.
Указывается в:
getAccessibleContext в интерфейсе Accessible
Переопределяет:
getAccessibleContext в классе Component
Возвращает:
объект AccessibleAWTButton, который служит контекстом доступности для этой кнопки
С тех пор как:
1.3

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

Spec-Zone.ru

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