Spec-Zone.ru › OpenJDK 17

Класс 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()
Возвращает текущий интерфейс пользователя (UI) панели инструментов.
Переопределяет:
getUI в классе JComponent
Возвращает:
текущий UI панели инструментов.
См. также:
  • 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. Вызывается для замены UI на последнюю версию из 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 создать соответствующее отступом (в противном случае эта свойство будет эффективно проигнорировано).
Параметры:
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)
Устанавливает состояние "перехода мыши" для этой панели инструментов. Если состояние "перехода мыши" истинно, то граница кнопок панели инструментов будет отрисовываться только при наведении курсора мыши на них. Значение по умолчанию для этого свойства — ложь.

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

Параметры:
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)
Добавляет разделитель заданного размера в конец панели инструментов.
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)
Возвращает правильно сконфигурированный обработчик изменений действий, который обновляет элемент управления при изменении параметров, или null, если нужно использовать стандартный обработчик изменений для элемента управления.
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, 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/javax/swing/JToolBar.html

Spec-Zone.ru

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