Spec-Zone.ru › OpenJDK 8

Класс JToolBar

  • java.lang.Object
    • java.awt.Component
      • java.awt.Container
        • javax.swing.JComponent
          • javax.swing.JToolBar
Все реализованные интерфейсы:
ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants

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.

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

Поля, унаследованные от интерфейса 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

Поля, унаследованные от интерфейса java.awt.image.ImageObserver

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

Сводка по конструкторам

Конструктор и описание
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 setLayout(LayoutManager mgr)

Устанавливает менеджер компоновки для этого контейнера.

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, 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, 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, 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, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, 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()

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

См. также:
setUI(javax.swing.plaf.ToolBarUI)

setUI

public void setUI(ToolBarUI ui)

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

Параметры:
ui - объект L&F
См. также:
UIDefaults.getUI(javax.swing.JComponent)

updateUI

public void updateUI()

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

Переопределяет:
updateUI в классе JComponent
См. также:
JComponent.updateUI()

getUIClassID

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

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

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

public void setFloatable(boolean b)

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

Параметры:
b - если true, панель инструментов можно перемещать; false в противном случае
См. также:
isFloatable()

getOrientation

public int getOrientation()

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

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

setOrientation

public void setOrientation(int o)

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

Параметры:
o - новая ориентация — либо HORIZONTAL, либо VERTICAL
Исключения:
IllegalArgumentException - если ориентация не HORIZONTAL и не VERTICAL
См. также:
getOrientation()

setRollover

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 action.

Параметры:
a - Action кнопки для добавления
Возвращает:
созданную кнопку
С:
1.3
См. также:
Action

createActionChangeListener

protected PropertyChangeListener createActionChangeListener(JButton b)

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

Возвращает:
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.

setLayout

public void setLayout(LayoutManager mgr)

Описание скопировано из класса: Container

Устанавливает менеджер компоновки для этого контейнера.

Этот метод изменяет информацию, связанную с компоновкой, и поэтому делает иерархию компонентов недействительной.

Переопределяет:
setLayout в классе Container
Параметры:
mgr - указанный менеджер компоновки
См. также:
Container.doLayout(), Container.getLayout(), Container.invalidate()

getAccessibleContext

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.

Spec-Zone.ru

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