Класс JColorChooser

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JColorChooser

Все реализованные интерфейсы:: ImageObserver, MenuContainer, Serializable, Accessible

public class JColorChooser
extends JComponent
implements Accessible

JColorChooser предоставляет панель управления, предназначенную для того, чтобы пользователь мог манипулировать и выбирать цвет. Сведения о работе с цветовыми выбирателями см. в Как использовать цветовые выбиратели, разделе учебника Java.

Этот класс предоставляет три уровня API:

Статический вспомогательный метод, который отображает модальное диалоговое окно выбора цвета и возвращает выбранный пользователем цвет.
Статический вспомогательный метод для создания диалогового окна выбора цвета, где ActionListeners можно указать, чтобы он был вызван, когда пользователь нажмёт одну из кнопок диалогового окна.
Возможность создавать экземпляры панелей JColorChooser непосредственно (в любом контейнере). PropertyChange слушатели могут быть добавлены для обнаружения изменения текущего свойства "цвета".

Предупреждение: Swing не является потокобезопасным. Дополнительную информацию см. в Политика потоков Swing.

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

Вложенные классы

Модификатор и тип	Класс и описание
`protected class`	`JColorChooser.AccessibleJColorChooser` Этот класс реализует поддержку доступности для класса `JColorChooser`.

Вложенные классы/интерфейсы, унаследованные от класса javax.swing.JComponent

JComponent.AccessibleJComponent

Вложенные классы/интерфейсы, унаследованные от класса java.awt.Container

Container.AccessibleAWTContainer

Вложенные классы/интерфейсы, унаследованные от класса java.awt.Component

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

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

Модификатор и тип	Поле и описание
`protected AccessibleContext`	`accessibleContext`
`static String`	`CHOOSER_PANELS_PROPERTY` Имя свойства массива chooserPanel.
`static String`	`PREVIEW_PANEL_PROPERTY` Имя свойства панели предварительного просмотра.
`static String`	`SELECTION_MODEL_PROPERTY` Имя свойства модели выбора.

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

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

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

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

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

Конструктор и описание
`JColorChooser()` Создаёт панель выбора цвета с начальным цветом белого.
`JColorChooser(Color initialColor)` Создаёт панель выбора цвета с заданным начальным цветом.
`JColorChooser(ColorSelectionModel model)` Создаёт панель выбора цвета с заданной `ColorSelectionModel`.

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

Модификатор и тип	Метод и описание
`void`	`addChooserPanel(AbstractColorChooserPanel panel)` Добавляет панель выбора цвета к цветовому выбирателю.
`static JDialog`	`createDialog(Component c, String title, boolean modal, JColorChooser chooserPane, ActionListener okListener, ActionListener cancelListener)` Создаёт и возвращает новое диалоговое окно, содержащее заданную панель `ColorChooser` наряду с кнопками "ОК", "Отмена" и "Сброс".
`AccessibleContext`	`getAccessibleContext()` Получает AccessibleContext, связанный с этим JColorChooser.
`AbstractColorChooserPanel[]`	`getChooserPanels()` Возвращает указанные панели цветов.
`Color`	`getColor()` Получает текущее значение цвета из цветового выбирателя.
`boolean`	`getDragEnabled()` Получает значение свойства `dragEnabled`.
`JComponent`	`getPreviewPanel()` Возвращает панель предварительного просмотра, показывающую выбранный цвет.
`ColorSelectionModel`	`getSelectionModel()` Возвращает модель данных, обрабатывающую выбор цветов.
`ColorChooserUI`	`getUI()` Возвращает объект L&F, отображающий этот компонент.
`String`	`getUIClassID()` Возвращает имя класса L&F, отображающего этот компонент.
`protected String`	`paramString()` Возвращает строковое представление этого `JColorChooser`.
`AbstractColorChooserPanel`	`removeChooserPanel(AbstractColorChooserPanel panel)` Удаляет указанную панель цвета.
`void`	`setChooserPanels(AbstractColorChooserPanel[] panels)` Задаёт панели цветов, используемые для выбора значения цвета.
`void`	`setColor(Color color)` Устанавливает текущий цвет цветового выбирателя на указанный цвет.
`void`	`setColor(int c)` Устанавливает текущий цвет цветового выбирателя на указанный цвет.
`void`	`setColor(int r, int g, int b)` Устанавливает текущий цвет цветового выбирателя на указанный цвет RGB.
`void`	`setDragEnabled(boolean b)` Устанавливает свойство `dragEnabled`, которое должно быть `true`, чтобы включить автоматическое управление перетаскиванием (первая часть перетаскивания и перемещения) на этом компоненте.
`void`	`setPreviewPanel(JComponent preview)` Устанавливает текущую панель предварительного просмотра.
`void`	`setSelectionModel(ColorSelectionModel newModel)` Устанавливает модель, содержащую выбранный цвет.
`void`	`setUI(ColorChooserUI ui)` Устанавливает объект L&F, отображающий этот компонент.
`static Color`	`showDialog(Component component, String title, Color initialColor)` Отображает модальное диалоговое окно выбора цвета и блокирует, пока диалоговое окно не будет скрыто.
`void`	`updateUI()` Уведомление от `UIManager`, что 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, paintBorder, 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, 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, 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, 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

Поля

SELECTION_MODEL_PROPERTY

public static final String SELECTION_MODEL_PROPERTY

Имя свойства модели выбора.

См. также:: Значения константных полей

PREVIEW_PANEL_PROPERTY

public static final String PREVIEW_PANEL_PROPERTY

Имя свойства панели предварительного просмотра.

См. также:: Значения константных полей

CHOOSER_PANELS_PROPERTY

public static final String CHOOSER_PANELS_PROPERTY

Имя свойства массива панелей выбора.

См. также:: Значения константных полей

accessibleContext

protected AccessibleContext accessibleContext

Конструкторы

JColorChooser

public JColorChooser()

Создаёт панель выбора цвета с начальным цветом — белый.

JColorChooser

public JColorChooser(Color initialColor)

Создаёт панель выбора цвета с указанным начальным цветом.

Параметры:: initialColor — начальный цвет, установленный в выборе

JColorChooser

public JColorChooser(ColorSelectionModel model)

Создаёт панель выбора цвета с указанной ColorSelectionModel.

Параметры:: model — используемая ColorSelectionModel

Методы

showDialog

public static Color showDialog(Component component,
                               String title,
                               Color initialColor)
                        throws HeadlessException

Отображает модальное диалоговое окно выбора цвета и ожидает, пока оно не будет скрыто. Если пользователь нажимает кнопку «ОК», метод скрывает/удаляет диалоговое окно и возвращает выбранный цвет. Если пользователь нажимает кнопку «Отмена» или закрывает диалоговое окно без нажатия «ОК», метод скрывает/удаляет диалоговое окно и возвращает null.

Параметры:: component — родительский Component для диалогового окна; title — строка, содержащая заголовок диалогового окна; initialColor — начальный цвет, установленный при отображении окна выбора цвета
Возвращает:: выбранный цвет или null если пользователь отказался
Исключения:: HeadlessException — если GraphicsEnvironment.isHeadless() возвращает true.
См. также:: GraphicsEnvironment.isHeadless()

createDialog

public static JDialog createDialog(Component c,
                                   String title,
                                   boolean modal,
                                   JColorChooser chooserPane,
                                   ActionListener okListener,
                                   ActionListener cancelListener)
                            throws HeadlessException

Создаёт и возвращает новое диалоговое окно, содержащее указанную панель выбора цвета вместе с кнопками «ОК», «Отмена» и «Сброс». При нажатии кнопок «ОК» или «Отмена» диалоговое окно автоматически скрывается (но не удаляется). При нажатии кнопки «Сброс» цвет выбора цвета будет сброшен до цвета, который был установлен в последний раз при вызове show в диалоговом окне, и диалоговое окно останется видимым.

Параметры:: c — родительский компонент для диалогового окна; title — заголовок диалогового окна; modal — логическое значение. При значении true, оставшаяся часть программы бездействует, пока диалоговое окно не будет закрыто.; chooserPane — окно выбора цвета, которое будет размещено внутри диалогового окна; okListener — ActionListener, вызываемый при нажатии «ОК»; cancelListener — ActionListener, вызываемый при нажатии «Отмена»
Возвращает:: новое диалоговое окно, содержащее панель выбора цвета
Исключения:: HeadlessException — если GraphicsEnvironment.isHeadless() возвращает true.
См. также:: GraphicsEnvironment.isHeadless()

getUI

public ColorChooserUI getUI()

Возвращает объект L&F, который отображает этот компонент.

Возвращает:: объект ColorChooserUI, отображающий этот компонент

setUI

public void setUI(ColorChooserUI ui)

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

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

updateUI

public void updateUI()

Уведомление от UIManager, что изменился L&F. Заменяет текущий объект UI на последнюю версию из UIManager.

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

getUIClassID

public String getUIClassID()

Возвращает имя класса L&F, который отображает этот компонент.

Переопределяет:: getUIClassID в классе JComponent
Возвращает:: строку "ColorChooserUI"
См. также:: JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

getColor

public Color getColor()

Получает текущее значение цвета из выбора цвета. По умолчанию делегирует модели.

Возвращает:: текущее значение цвета из выбора цвета

setColor

public void setColor(Color color)

Устанавливает текущий цвет выбора цвета на указанный цвет. ColorSelectionModel будет отправлять ChangeEvent

Параметры:: color — цвет, который нужно установить в выборе цвета
См. также:: Container.addPropertyChangeListener(java.beans.PropertyChangeListener)

setColor

public void setColor(int r,
                     int g,
                     int b)

Устанавливает текущий цвет выбора цвета на указанный цвет RGB. Обратите внимание, что значения красного, зеленого и синего должны быть в диапазоне от 0 до 255 включительно.

Параметры:: r — целое число, определяющее количество красного; g — целое число, определяющее количество зеленого; b — целое число, определяющее количество синего
Исключения:: IllegalArgumentException — если значения r, g, b выходят за пределы диапазона
См. также:: Color

setColor

public void setColor(int c)

Устанавливает текущий цвет выбора цвета на указанный цвет.

Параметры:: c — целочисленное значение, устанавливающее текущий цвет в выборе, где младшие 8 бит задают значение синего, следующие 8 бит — значение зелёного, а 8 бит выше этого — значение красного.

setDragEnabled

public void setDragEnabled(boolean b)

Устанавливает свойство dragEnabled, которое должно быть true, чтобы включить автоматическую обработку перетаскивания (первая часть перетаскивания и перемещения) на этом компоненте. Свойство transferHandler должно быть установлено на ненулевое значение, чтобы перетаскивание работало. Значение свойства dragEnabled по умолчанию равно false.

При включенной автоматической обработке перетаскивания большинство стилей и внешнего вида запускают операцию перетаскивания и перемещения, когда пользователь нажимает кнопку мыши над панелью предварительного просмотра. Некоторые стили и внешние виды могут не поддерживать автоматическое перетаскивание и перемещение; они проигнорируют это свойство. Вы можете обойти такие стили и внешние виды, изменив компонент так, чтобы он напрямую вызывал метод exportAsDrag объекта TransferHandler.

Параметры:: b — значение, которое нужно установить для свойства dragEnabled
Исключения:: HeadlessException — если b равно true и GraphicsEnvironment.isHeadless() возвращает true
С тех пор:: 1.4
См. также:: GraphicsEnvironment.isHeadless(), getDragEnabled(), JComponent.setTransferHandler(javax.swing.TransferHandler), TransferHandler

getDragEnabled

public boolean getDragEnabled()

Возвращает значение свойства dragEnabled.

Возвращает:: значение свойства dragEnabled
С тех пор:: 1.4
См. также:: setDragEnabled(boolean)

setPreviewPanel

public void setPreviewPanel(JComponent preview)

Устанавливает текущую панель предварительного просмотра. Это вызовет PropertyChangeEvent для свойства с именем "previewPanel".

Параметры:: preview — JComponent, отображающая текущий цвет
См. также:: Container.addPropertyChangeListener(java.beans.PropertyChangeListener)

getPreviewPanel

public JComponent getPreviewPanel()

Возвращает панель предварительного просмотра, отображающую выбранный цвет.

Возвращает:: объект JComponent — панель предварительного просмотра

addChooserPanel

public void addChooserPanel(AbstractColorChooserPanel panel)

Добавляет панель выбора цвета в выбор цвета.

Параметры:: panel — добавляемая AbstractColorChooserPanel

removeChooserPanel

public AbstractColorChooserPanel removeChooserPanel(AbstractColorChooserPanel panel)

Удаляет указанную панель цвета.

Параметры:: panel — строка, определяющая удаляемую панель
Возвращает:: панель цвета
Исключения:: IllegalArgumentException — если панель не находится в списке известных панелей выбора

setChooserPanels

public void setChooserPanels(AbstractColorChooserPanel[] panels)

Устанавливает панели цветов, используемые для выбора значения цвета.

Параметры:: panels — массив объектов AbstractColorChooserPanel

getChooserPanels

public AbstractColorChooserPanel[] getChooserPanels()

Возвращает указанные панели цветов.

Возвращает:: массив объектов AbstractColorChooserPanel

getSelectionModel

public ColorSelectionModel getSelectionModel()

Возвращает модель данных, которая обрабатывает выбор цветов.

Возвращает:: объект ColorSelectionModel

setSelectionModel

public void setSelectionModel(ColorSelectionModel newModel)

Устанавливает модель, содержащую выбранный цвет.

Параметры:: newModel - новый объект ColorSelectionModel

paramString

protected String paramString()

Возвращает строковое представление этого объекта JColorChooser. Данный метод предназначен только для отладки, и содержимое и формат возвращаемой строки могут варьироваться между реализациями. Возвращаемая строка может быть пустой, но не может быть null.

Переопределяет:: paramString в классе JComponent
Возвращает:: строковое представление этого объекта JColorChooser

getAccessibleContext

public AccessibleContext getAccessibleContext()

Получает AccessibleContext, связанный с данным JColorChooser. Для выбора цвета AccessibleContext принимает вид AccessibleJColorChooser. Новый экземпляр AccessibleJColorChooser создается при необходимости.

Определено в:: getAccessibleContext в интерфейсе Accessible
Переопределяет:: getAccessibleContext в классе Component
Возвращает:: AccessibleJColorChooser, который служит AccessibleContext для данного JColorChooser

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