Класс JToolBar

javax.swing.JToolBar

Все реализованные интерфейсы:: ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants

@JavaBean(defaultProperty="UI", description="A component which displays commonly used controls or Actions.") public class JToolBar extends JComponent implements SwingConstants, Accessible

JToolBar предоставляет компонент, полезный для отображения часто используемых Action или элементов управления. Примеры и информацию об использовании панелей инструментов см. в Руководстве по использованию панелей инструментов в Руководстве по Java.

При большинстве визуальных стилей пользователь может перетащить панель инструментов в отдельное окно (если свойство floatable не установлено в значение false). Для корректной работы перетаскивания рекомендуется добавлять экземпляры JToolBar на одну из четырёх «сторон» контейнера, менеджер компоновки которого является BorderLayout, и не добавлять потомков на другие четыре «стороны».

Предупреждение: Swing не потокобезопасен. Дополнительную информацию см. в Политике потоков Swing.

Предупреждение: Сериализованные объекты этого класса не будут совместимы с будущими версиями Swing. Текущая поддержка сериализации подходит для краткосрочного хранения или RMI между приложениями, использующими одну и ту же версию Swing. Начиная с версии 1.4, поддержка долгосрочного хранения всех JavaBeans добавлена в пакет java.beans. См. XMLEncoder.

С момента:

1.2

См. также:

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

Модификатор и тип	Класс	Описание
`protected class`	`JToolBar.AccessibleJToolBar`	Этот класс реализует поддержку доступности для класса `JToolBar`.
`static class`	`JToolBar.Separator`	Разделитель, специфичный для панели инструментов.

Вложенные классы/интерфейсы, объявленные в классе javax.swing.JComponent

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

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

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

Поля, объявленные в классе javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

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

Поля, объявленные в интерфейсе javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

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

Конструктор	Описание
`JToolBar()`	Создаёт новую панель инструментов; ориентация по умолчанию — `HORIZONTAL`.
`JToolBar(int orientation)`	Создаёт новую панель инструментов со заданной `orientation`.
`JToolBar(String name)`	Создаёт новую панель инструментов со заданной `name`.
`JToolBar(String name, int orientation)`	Создаёт новую панель инструментов со заданной `name` и `orientation`.

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

Модификатор и тип	Метод	Описание
`JButton`	`add(Action a)`	Добавляет новый `JButton`, который обрабатывает действие.
`protected void`	`addImpl(Component comp, Object constraints, int index)`	Если добавляется `JButton`, он изначально устанавливается в состояние отключения.
`void`	`addSeparator()`	Добавляет разделитель стандартного размера в конец панели инструментов.
`void`	`addSeparator(Dimension size)`	Добавляет разделитель заданного размера в конец панели инструментов.
`protected PropertyChangeListener`	`createActionChangeListener(JButton b)`	Возвращает правильно настроенного `PropertyChangeListener`, который обновляет элемент управления по мере изменения `Action`, или `null` если требуется обработчик изменения свойства по умолчанию для элемента управления.
`protected JButton`	`createActionComponent(Action a)`	Метод-фабрика, который создает `JButton` для `Action` добавленных в `JToolBar`.
`AccessibleContext`	`getAccessibleContext()`	Возвращает AccessibleContext, связанный с этим JToolBar.
`Component`	`getComponentAtIndex(int i)`	Возвращает компонент по заданному индексу.
`int`	`getComponentIndex(Component c)`	Возвращает индекс заданного компонента.
`Insets`	`getMargin()`	Возвращает отступ между границей панели инструментов и ее кнопками.
`int`	`getOrientation()`	Возвращает текущую ориентацию панели инструментов.
`ToolBarUI`	`getUI()`	Возвращает текущую UI-компоновку панели инструментов.
`String`	`getUIClassID()`	Возвращает имя класса L&F, который отображает этот компонент.
`boolean`	`isBorderPainted()`	Получает свойство `borderPainted`.
`boolean`	`isFloatable()`	Получает свойство `floatable`.
`boolean`	`isRollover()`	Возвращает состояние наведения.
`protected void`	`paintBorder(Graphics g)`	Рисует границу панели инструментов, если свойство `borderPainted` равно `true`.
`protected String`	`paramString()`	Возвращает строковое представление этого `JToolBar`.
`void`	`setBorderPainted(boolean b)`	Устанавливает свойство `borderPainted`, которое равно `true`, если граница должна быть нарисована.
`void`	`setFloatable(boolean b)`	Устанавливает свойство `floatable`, которое должно быть `true` для того, чтобы пользователь мог переместить панель инструментов.
`void`	`setMargin(Insets m)`	Устанавливает отступ между границей панели инструментов и ее кнопками.
`void`	`setOrientation(int o)`	Устанавливает ориентацию панели инструментов.
`void`	`setRollover(boolean rollover)`	Устанавливает состояние наведения для этой панели инструментов.
`void`	`setUI(ToolBarUI ui)`	Устанавливает объект L&F, который отображает этот компонент.
`void`	`updateUI()`	Уведомление от `UIFactory` о том, что изменился L&F.

Методы, объявленные в классе javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

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

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

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

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

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

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

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

JToolBar

public JToolBar()

Создаёт новую панель инструментов; ориентация по умолчанию — HORIZONTAL.

JToolBar

public JToolBar(int orientation)

Создаёт новую панель инструментов с указанной orientation. orientation должна быть либо HORIZONTAL, либо VERTICAL.

Параметры:: orientation - желаемая ориентация

JToolBar

public JToolBar(String name)

Создаёт новую панель инструментов с указанным name. Имя используется в качестве заголовка недостыкованной панели инструментов. Ориентация по умолчанию — HORIZONTAL.

Параметры:: name - имя панели инструментов
С версии:: 1.3

JToolBar

public JToolBar(String name, int orientation)

Создаёт новую панель инструментов с заданным name и orientation. Все остальные конструкторы вызывают этот конструктор. Если значение orientation является недопустимым, будет выброшено исключение.

Параметры:: name - имя панели инструментов; orientation - начальная ориентация — должна быть либо HORIZONTAL, либо VERTICAL
Исключения:: IllegalArgumentException - если ориентация не является ни HORIZONTAL, ни VERTICAL
С версии:: 1.3

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

getUI

public ToolBarUI getUI()

Возвращает текущий интерфейс пользователя (UI) панели инструментов.

Переопределяет:

getUI в классе JComponent

Возвращает:

текущий интерфейс пользователя (UI) панели инструментов.

См. также:

setUI

@BeanProperty(hidden=true, visualUpdate=true, description="The UI object that implements the Component\'s LookAndFeel.") public void setUI(ToolBarUI ui)

Устанавливает объект L&F, который отображает этот компонент.

Параметры:

ui - объект L&F ToolBarUI

См. также:

updateUI

public void updateUI()

Уведомление от UIFactory о том, что изменился L&F. Вызывается для замены UI на последнюю версию от UIFactory.

Переопределяет:

updateUI в классе JComponent

См. также:

getUIClassID

@BeanProperty(bound=false) public String getUIClassID()

Возвращает имя класса L&F, который отображает этот компонент.

Переопределяет:

getUIClassID в классе JComponent

Возвращает:

строку "ToolBarUI"

См. также:

getComponentIndex

public int getComponentIndex(Component c)

Возвращает индекс указанного компонента. (Примечание: разделители занимают позиции индексов.)

Параметры:: c - искомый Component
Возвращает:: целое число, указывающее положение компонента, где 0 — первый

getComponentAtIndex

public Component getComponentAtIndex(int i)

Возвращает компонент по указанному индексу.

Параметры:: i - положение компонента, где 0 — первый
Возвращает:: Component в этом положении или null для неверного индекса

setMargin

@BeanProperty(expert=true, description="The margin between the tool bar\'s border and contents") public void setMargin(Insets m)

Устанавливает отступ между границей панели инструментов и её кнопками. Установка в null приводит к использованию стандартных отступов. Стандартный объект Border панели инструментов использует это значение для создания соответствующего отступа. Однако, если для панели инструментов установлен нестандартный вид границы, это обязанность объекта Border создавать соответствующее отступовое пространство (в противном случае это свойство фактически будет игнорироваться).

Параметры:

m - объект Insets, определяющий расстояние между границей и кнопками

См. также:

getMargin

public Insets getMargin()

Возвращает отступ между границей панели инструментов и её кнопками.

Возвращает:

объект Insets, содержащий значения отступа

См. также:

isBorderPainted

public boolean isBorderPainted()

Получает свойство borderPainted.

Возвращает:

значение свойства borderPainted

См. также:

setBorderPainted

@BeanProperty(expert=true, description="Does the tool bar paint its borders?") public void setBorderPainted(boolean b)

Устанавливает свойство borderPainted, которое равно true, если граница должна быть нарисована. Значение по умолчанию для этого свойства — true. Некоторые стили отображения могут не реализовывать нарисованные границы; они проигнорируют это свойство.

Параметры:

b - true, если граница должна быть нарисована

См. также:

paintBorder

protected void paintBorder(Graphics g)

Рисует границу панели инструментов, если свойство borderPainted имеет значение true.

Переопределяет:

paintBorder в классе JComponent

Параметры:

g - контекст Graphics, в котором выполняется рисование

См. также:

isFloatable

public boolean isFloatable()

Получает свойство floatable.

Возвращает:

значение свойства floatable

См. также:

setFloatable

@BeanProperty(preferred=true, description="Can the tool bar be made to float by the user?") public void setFloatable(boolean b)

Устанавливает свойство floatable, которое должно иметь значение true для перемещения панели инструментов пользователем. Обычно, плавающая панель инструментов может перетаскиваться в другое положение в том же контейнере или в отдельное окно. Значение по умолчанию для этого свойства — true. Некоторые стили отображения могут не реализовывать плавающие панели инструментов; они проигнорируют это свойство.

Параметры:

b - если true, панель инструментов может перемещаться; false в противном случае

См. также:

getOrientation

public int getOrientation()

Возвращает текущую ориентацию панели инструментов. Значение может быть либо HORIZONTAL, либо VERTICAL.

Возвращает:

целое число, представляющее текущую ориентацию — либо HORIZONTAL, либо VERTICAL

См. также:

setOrientation

@BeanProperty(preferred=true, enumerationValues={"SwingConstants.HORIZONTAL","SwingConstants.VERTICAL"}, description="The current orientation of the tool bar") public void setOrientation(int o)

Устанавливает ориентацию панели инструментов. Ориентация должна иметь значение HORIZONTAL или VERTICAL. Если orientation — неверное значение, будет выброшено исключение.

Параметры:

o - новая ориентация — либо HORIZONTAL, либо VERTICAL

Исключения:

IllegalArgumentException - если ориентация не является ни HORIZONTAL, ни VERTICAL

См. также:

setRollover

@BeanProperty(preferred=true, visualUpdate=true, description="Will draw rollover button borders in the toolbar.") public void setRollover(boolean rollover)

Устанавливает состояние перехода (rollover) для этой панели инструментов. Если состояние перехода истинно, то граница кнопок панели инструментов будет отображаться только при наведении на них курсора мыши. Значение по умолчанию для этого свойства — ложь.

Реализация внешнего вида может игнорировать это свойство.

Параметры:: rollover - true для кнопок перехода; в противном случае false
С версии:: 1.4

isRollover

public boolean isRollover()

Возвращает состояние перехода.

Возвращает:

true, если кнопки перехода должны быть нарисованы; в противном случае false

С версии:

1.4

См. также:

addSeparator

public void addSeparator()

Добавляет разделитель стандартного размера в конец панели инструментов. Стандартный размер определяется текущей внешностью.

addSeparator

public void addSeparator(Dimension size)

Добавляет разделитель заданного размера в конец панели инструментов.

Parameters:: size - размер разделителя

add

public JButton add(Action a)

Добавляет новую команду, которая выполняет действие.

Parameters:: a - объект команды, добавляемый в качестве новой записи меню
Returns:: новая кнопка, выполняющая действие

createActionComponent

protected JButton createActionComponent(Action a)

Метод-фабрика, создающий компонент для команд, добавленных к панели инструментов. По умолчанию имя пустое, если передана команда без имени.

Parameters:

a - команда для добавления кнопки

Returns:

созданная кнопка

Since:

1.3

See Also:

createActionChangeListener

protected PropertyChangeListener createActionChangeListener(JButton b)

Возвращает правильно настроенного слушателя изменений, который обновляет элемент управления при изменении свойств команды, или null, если нужен стандартный слушатель изменений элемента управления.

Parameters:: b - кнопка
Returns:: null

addImpl

protected void addImpl(Component comp, Object constraints, int index)

Если добавляется элемент управления, он изначально устанавливается в состояние неактивности.

Overrides:

addImpl в классе Container

Parameters:

comp - элемент управления для улучшения

constraints - ограничения, применяемые к элементу управления

index - индекс элемента управления

See Also:

paramString

protected String paramString()

Возвращает строковое представление этого объекта. Этот метод предназначен только для отладки, и содержимое и формат возвращаемой строки могут отличаться в различных реализациях. Возвращаемая строка может быть пустой, но не null.

Overrides:: paramString в классе JComponent
Returns:: строковое представление этого объекта.

getAccessibleContext

@BeanProperty(bound=false) public AccessibleContext getAccessibleContext()

Получает AccessibleContext, связанный с этой панелью инструментов JToolBar. Для панелей инструментов AccessibleContext принимает форму AccessibleJToolBar. Новый AccessibleJToolBar создаётся при необходимости.

Specified by:: getAccessibleContext в интерфейсе Accessible
Overrides:: getAccessibleContext в классе Component
Returns:: AccessibleJToolBar, служащий AccessibleContext этой JToolBar

© 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/javax/swing/JToolBar.html