Spec-Zone.ru › OpenJDK 25

Класс 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, в пакет java.beans добавлена поддержка долговременного хранения всех JavaBeans. См. XMLEncoder.

Начиная с:
1.2
См. также:
  • Action

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

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

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

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

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

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

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

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

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

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

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

Поля, объявленные в интерфейсе 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()
Возвращает текущий пользовательский интерфейс панели инструментов.
String getUIClassID()
Возвращает имя класса L&F, который отображает этот компонент.
boolean isBorderPainted()
Получает свойство borderPainted.
boolean isFloatable()
Получает свойство floatable.
boolean isRollover()
Возвращает состояние rollover.
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)
Задаёт состояние rollover этой панели инструментов.
void setUI(ToolBarUI ui)
Задаёт объект L&F, который отображает этот компонент.
void updateUI()
Уведомление от UIFactory об изменении L&F.

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

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

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

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

updateUI

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

getUIClassID

@BeanProperty(bound=false) public String getUIClassID()
Возвращает имя класса L&F, который отображает этот компонент.
Переопределяет:
getUIClassID в классе JComponent
Возвращает:
строка "ToolBarUI"
См. также:
  • JComponent.getUIClassID()
  • UIDefaults.getUI(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 (в противном случае это свойство фактически будет проигнорировано).
Параметры:
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(Graphics)
  • JComponent.setBorder(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)
Задаёт состояние rollover этой панели инструментов. Если состояние rollover равно true, граница кнопок панели инструментов отображается только при наведении на них указателя мыши. Значение этого свойства по умолчанию — false.

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

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

isRollover

public boolean isRollover()
Возвращает состояние rollover.
Возвращает:
true, если следует отображать кнопки панели инструментов с rollover; иначе false
Начиная с:
1.4
См. также:
  • setRollover(boolean)

addSeparator

public void addSeparator()
Добавляет в конец панели инструментов разделитель размера по умолчанию. Размер по умолчанию определяется текущей темой оформления.

addSeparator

public void addSeparator(Dimension size)
Добавляет в конец панели инструментов разделитель указанного размера.
Параметры:
size — Dimension разделителя

add

public JButton add(Action a)
Добавляет новый JButton, который выполняет действие.
Параметры:
a — объект Action, который нужно добавить как новый элемент меню
Возвращает:
новую кнопку, выполняющую действие

createActionComponent

protected JButton createActionComponent(Action a)
Фабричный метод, создающий JButton для Actionов, добавляемых в JToolBar. Если передано действие null, имя по умолчанию — пустая строка.
Параметры:
a — Action для добавляемой кнопки
Возвращает:
созданную кнопку
Начиная с:
1.3
См. также:
  • Action

createActionChangeListener

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

addImpl

protected void addImpl(Component comp, Object constraints, int index)
Если добавляется JButton, он изначально отключается.
Переопределяет:
addImpl в классе Container
Параметры:
comp — компонент, который нужно дополнить
constraints — ограничения, накладываемые на компонент
index — индекс компонента
См. также:
  • Container.add(Component)
  • Container.add(Component, int)
  • Container.add(Component, java.lang.Object)
  • Container.invalidate()
  • LayoutManager
  • LayoutManager2

paramString

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

getAccessibleContext

@BeanProperty(bound=false) public AccessibleContext getAccessibleContext()
Получает AccessibleContext, связанный с этим JToolBar. Для панелей инструментов AccessibleContext имеет вид AccessibleJToolBar. При необходимости создаётся новый экземпляр AccessibleJToolBar.
Определён в:
getAccessibleContext в интерфейсе Accessible
Переопределяет:
getAccessibleContext в классе Component
Возвращает:
AccessibleJToolBar, выполняющий роль AccessibleContext этого JToolBar

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по 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/javax/swing/JToolBar.html

Spec-Zone.ru

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