Spec-Zone.ru › OpenJDK 24

Класс JToolBar

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
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
См. также:
  • Action

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

Модификатор и тип Класс Описание
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()
Возвращает текущий интерфейс пользователя панели инструментов.
Переопределяет:
getUI в классе JComponent
Возвращает:
текущий интерфейс пользователя панели инструментов.
См. также:
  • setUI(javax.swing.plaf.ToolBarUI)

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
См. также:
  • UIDefaults.getUI(javax.swing.JComponent)

updateUI

public void updateUI()
Уведомление от UIFactory о том, что внешний вид изменился. Вызывается для замены интерфейса пользователя последней версией из UIFactory.
Переопределяет:
updateUI в классе JComponent
См. также:
  • JComponent.updateUI()

getUIClassID

@BeanProperty(bound=false) public String getUIClassID()
Возвращает имя класса L&F, который отрисовывает этот компонент.
Переопределяет:
getUIClassID в классе JComponent
Возвращает:
строку "ToolBarUI"
См. также:
  • JComponent.getUIClassID()
  • UIDefaults.getUI(javax.swing.JComponent)

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, именно ответственность этого объекта Border создать соответствующее отступы (иначе эта свойство будет эффективно игнорироваться).
Параметры:
m - объект Insets, определяющий расстояние между границей и кнопками
См. также:
  • Insets

getMargin

public Insets getMargin()
Возвращает отступ между границей панели инструментов и её кнопками.
Возвращает:
объект Insets, содержащий значения отступа
См. также:
  • Insets

isBorderPainted

public boolean isBorderPainted()
Получает свойство borderPainted.
Возвращает:
значение свойства borderPainted
См. также:
  • setBorderPainted(boolean)

setBorderPainted

@BeanProperty(expert=true, description="Does the tool bar paint its borders?") public void setBorderPainted(boolean b)
Устанавливает свойство borderPainted, которое равно true, если граница должна быть нарисована. Значение по умолчанию для этого свойства равно true. Некоторые стили внешнего вида могут не реализовывать отрисовку границ; они проигнорируют это свойство.
Параметры:
b - если true, граница рисуется
См. также:
  • isBorderPainted()

paintBorder

protected void paintBorder(Graphics g)
Рисует границу панели инструментов, если свойство borderPainted равно true.
Переопределяет:
paintBorder в классе JComponent
Параметры:
g - контекст Graphics, в котором выполняется отрисовка
См. также:
  • JComponent.paint(java.awt.Graphics)
  • JComponent.setBorder(javax.swing.border.Border)

isFloatable

public boolean isFloatable()
Получает свойство floatable.
Возвращает:
значение свойства floatable
См. также:
  • setFloatable(boolean)

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 в противном случае
См. также:
  • isFloatable()

getOrientation

public int getOrientation()
Возвращает текущую ориентацию панели инструментов. Значение равно либо HORIZONTAL, либо VERTICAL.
Возвращает:
целое число, представляющее текущую ориентацию — либо HORIZONTAL, либо VERTICAL
См. также:
  • setOrientation(int)

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
См. также:
  • getOrientation()

setRollover

@BeanProperty(preferred=true, visualUpdate=true, description="Will draw rollover button borders in the toolbar.") public void setRollover(boolean rollover)
Устанавливает состояние переключения для этой панели инструментов. Если состояние переключения истинно, то граница кнопок панели инструментов будет отображаться только при наведении на них курсора мыши. Значение по умолчанию для этого свойства — ложь.

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

Parameters:
rollover - истина для кнопок панели инструментов с переключением; иначе ложь
Since:
1.4

isRollover

public boolean isRollover()
Возвращает состояние переключения.
Returns:
истина, если кнопки панели инструментов с переключением должны быть отображены; иначе ложь
Since:
1.4
See Also:
  • setRollover(boolean)

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:
  • Action

createActionChangeListener

protected PropertyChangeListener createActionChangeListener(JButton b)
Возвращает правильно настроенного слушателя изменений свойств, который обновляет элемент управления при изменении свойств команды, или слушателя изменений свойств по умолчанию, если это необходимо.
Parameters:
b - команда
Returns:
null

addImpl

protected void addImpl(Component comp, Object constraints, int index)
Если добавляется компонент, он первоначально устанавливается в состояние неактивности.
Overrides:
addImpl в классе Container
Parameters:
comp - компонент для улучшения
constraints - ограничения, которые необходимо применить к компоненту
index - индекс компонента
See Also:
  • Container.add(Component)
  • Container.add(Component, int)
  • Container.add(Component, java.lang.Object)
  • Container.invalidate()
  • LayoutManager
  • LayoutManager2

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, 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://download.java.net/java/early_access/jdk24/docs/api/java.desktop/javax/swing/JToolBar.html

Spec-Zone.ru

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