Spec-Zone.ru › OpenJDK 21

Класс Box

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.Box
Все реализованные интерфейсы:
ImageObserver, MenuContainer, Serializable, Accessible
@JavaBean(defaultProperty="accessibleContext") public class Box extends JComponent implements Accessible
Лёгкий контейнер, использующий объект BoxLayout в качестве менеджера компоновки. Box предоставляет несколько методов класса, полезных для контейнеров, использующих BoxLayout — даже для не-Box контейнеров.

Класс Box может создавать несколько видов невидимых компонентов, влияющих на компоновку: glue (клей), struts (стержни) и жёсткие области. Если у всех компонентов, содержащихся в вашем Box контейнере, фиксированный размер, вы можете использовать компонент glue (возвращаемый методом createGlue) для управления позициями компонентов. Если вам нужен фиксированный размер промежутка между двумя компонентами, используйте strut (createHorizontalStrut или createVerticalStrut). Если вам нужен невидимый компонент, всегда занимающий одинаковый размер, вызовите createRigidArea.

Если вы реализуете BoxLayout, вы можете найти дополнительную информацию и примеры в Руководстве по использованию BoxLayout, разделе учебника по Java.

Предупреждение: Сериализованные объекты этого класса не будут совместимы с будущими версиями Swing. Текущая поддержка сериализации подходит для краткосрочного хранения или RMI между приложениями, использующими одну и ту же версию Swing. Начиная с версии 1.4, добавлена поддержка долгосрочного хранения всех JavaBeans в пакете java.beans. Пожалуйста, обратитесь к XMLEncoder.

С:
1.2
См. также:
  • BoxLayout

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

Модификатор и тип Класс Описание
protected class  Box.AccessibleBox
Этот класс реализует поддержку доступности для класса Box.
static class  Box.Filler
Реализация лёгкого компонента, участвующего в компоновке, но не имеющего представления.

Вложенные классы/интерфейсы, объявленные в классе 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

Краткое описание конструкторов

Конструктор Описание
Box(int axis)
Создаёт Box, отображающий свои компоненты вдоль указанной оси.

Краткое описание методов

Модификатор и тип Метод Описание
static Component createGlue()
Создаёт невидимый компонент "glue", полезный в Box, чьи видимые компоненты имеют максимальную ширину (для горизонтального бокса) или высоту (для вертикального бокса).
static Box createHorizontalBox()
Создаёт Box, отображающий свои компоненты слева направо.
static Component createHorizontalGlue()
Создаёт горизонтальный компонент glue.
static Component createHorizontalStrut(int width)
Создаёт невидимый компонент с фиксированной шириной.
static Component createRigidArea(Dimension d)
Создаёт невидимый компонент, всегда имеющий указанный размер.
static Box createVerticalBox()
Создаёт Box, отображающий свои компоненты сверху вниз.
static Component createVerticalGlue()
Создаёт вертикальный компонент glue.
static Component createVerticalStrut(int height)
Создаёт невидимый компонент с фиксированной высотой.
AccessibleContext getAccessibleContext()
Возвращает AccessibleContext, связанный с этим Box.
protected void paintComponent(Graphics g)
Отображает этот Box.
void setLayout(LayoutManager l)
Выбрасывает AWTError, так как Box может использовать только BoxLayout.

Методы, объявленные в классе 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, getUI, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, 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, updateUI

Методы, объявленные в классе java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, 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, 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

Подробное описание конструкторов

Box

public Box(int axis)
Создаёт Box, который отображает свои компоненты вдоль указанной оси.
Параметры:
axis - может быть BoxLayout.X_AXIS, BoxLayout.Y_AXIS, BoxLayout.LINE_AXIS или BoxLayout.PAGE_AXIS.
Исключения:
AWTError - если axis неверна
См. также:
  • createHorizontalBox()
  • createVerticalBox()

Подробное описание методов

createHorizontalBox

public static Box createHorizontalBox()
Создаёт Box, который отображает свои компоненты слева направо. Если вам нужен Box, учитывающий ориентацию компонентов, вы должны создать Box с помощью конструктора и передать BoxLayout.LINE_AXIS, например:
   Box lineBox = new Box(BoxLayout.LINE_AXIS);
 
Возвращает:
коробку

createVerticalBox

public static Box createVerticalBox()
Создаёт Box, который отображает свои компоненты сверху вниз. Если вам нужен Box, учитывающий ориентацию компонентов, вы должны создать Box с помощью конструктора и передать BoxLayout.PAGE_AXIS, например:
   Box lineBox = new Box(BoxLayout.PAGE_AXIS);
 
Возвращает:
коробку

createRigidArea

public static Component createRigidArea(Dimension d)
Создаёт невидимый компонент, размер которого всегда задан.
Параметры:
d - размеры невидимого компонента
Возвращает:
компонент
См. также:
  • createGlue()
  • createHorizontalStrut(int)
  • createVerticalStrut(int)

createHorizontalStrut

public static Component createHorizontalStrut(int width)
Создаёт невидимый компонент с фиксированной шириной. В горизонтальной коробке этот метод обычно используется для создания определённого расстояния между двумя компонентами. В вертикальной коробке этот метод может быть использован для принудительного задания минимальной ширины коробки. Невидимый компонент не имеет высоты, если свободно место не доступно, в этом случае он берёт свою долю свободного места, как и любой другой компонент, у которого нет максимальной высоты.
Параметры:
width - ширина невидимого компонента в пикселях, >= 0
Возвращает:
компонент
См. также:
  • createVerticalStrut(int)
  • createGlue()
  • createRigidArea(java.awt.Dimension)

createVerticalStrut

public static Component createVerticalStrut(int height)
Создаёт невидимый компонент с фиксированной высотой. В вертикальной коробке этот метод обычно используется для создания определённого расстояния между двумя компонентами. В горизонтальной коробке этот метод может быть использован для принудительного задания минимальной высоты коробки. Невидимый компонент не имеет ширины, если свободно место не доступно, в этом случае он берёт свою долю свободного места, как и любой другой компонент, у которого нет максимальной ширины.
Параметры:
height - высота невидимого компонента в пикселях, >= 0
Возвращает:
компонент
См. также:
  • createHorizontalStrut(int)
  • createGlue()
  • createRigidArea(java.awt.Dimension)

createGlue

public static Component createGlue()
Создаёт невидимый компонент "липкость", который может быть полезен в коробке, видимые компоненты которой имеют максимальную ширину (для горизонтальной коробки) или высоту (для вертикальной коробки). Можно представить компонент липкости как тягучую субстанцию, которая расширяется настолько, насколько это необходимо, чтобы заполнить пространство между соседними компонентами.

Например, предположим, что у вас есть горизонтальная коробка, содержащая два компонента с фиксированным размером. Если коробка получает дополнительное пространство, компоненты с фиксированным размером не увеличатся, так куда же девается дополнительное пространство? Без липкости дополнительное пространство переходит вправо от второго компонента. Если вы поместите липкость между компонентами с фиксированным размером, дополнительное пространство займёт это место. Если вы поместите липкость перед первым компонентом с фиксированным размером, дополнительное пространство перейдёт туда, и компоненты с фиксированным размером будут придвинуты к правому краю коробки. Если вы поместите липкость перед первым компонентом с фиксированным размером и после второго компонента с фиксированным размером, компоненты с фиксированным размером будут центрированы в коробке.

Для использования липкости, вызовите Box.createGlue и добавьте возвращённый компонент в контейнер. Компонент липкости не имеет минимального или предпочтительного размера, поэтому он не занимает места, если не имеется свободного места. Если имеется свободное пространство, то компонент липкости берёт свою долю доступного горизонтального или вертикального пространства, как и любой другой компонент, у которого нет максимальной ширины или высоты.

Возвращает:
компонент

createHorizontalGlue

public static Component createHorizontalGlue()
Создаёт горизонтальный компонент липкости.
Возвращает:
компонент

createVerticalGlue

public static Component createVerticalGlue()
Создаёт вертикальный компонент липкости.
Возвращает:
компонент

setLayout

public void setLayout(LayoutManager l)
Выбрасывает AWTError, так как Box может использовать только BoxLayout.
Переопределяет:
setLayout в классе Container
Параметры:
l - менеджер компоновки для использования
См. также:
  • Container.doLayout()
  • Container.getLayout()
  • Container.invalidate()

paintComponent

protected void paintComponent(Graphics g)
Рисует этот Box. Если у этого Box есть UI, этот метод вызывает реализацию родительского класса, в противном случае, если этот Box непрозрачен, Graphics заполняется фоном.
Переопределяет:
paintComponent в классе JComponent
Параметры:
g - Graphics для рисования
Исключения:
NullPointerException - если g равно null
С:
1.6
См. также:
  • JComponent.paint(java.awt.Graphics)
  • ComponentUI

getAccessibleContext

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

© 1993, 2023, 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/21/docs/api/java.desktop/javax/swing/Box.html

Spec-Zone.ru

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