Класс 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 или элементов управления. Примеры и информацию о работе с панелями инструментов см. в Как использовать панели инструментов, разделе учебника The Java Tutorial.

При большинстве стилей пользователь может перетащить панель инструментов в отдельное окно (если свойство 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, 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, hide, 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, что L&F изменился. Вызывается для замены пользовательского интерфейса последней версией из 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 - компонент, который нужно найти
Возвращает:
целое число, обозначающее положение компонента, где 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(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)

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

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

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

isRollover

public boolean isRollover()

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

Возвращает:
true, если кнопки панели инструментов с переходом должны быть отображены; иначе 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

© 1993, 2020, 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/11/docs/api/java.desktop/javax/swing/JToolBar.html

Spec-Zone .ru
спецификации, руководства, описания, API