Класс JColorChooser

Все реализованные интерфейсы:
ImageObserver, MenuContainer, Serializable, Accessible 
@JavaBean(defaultProperty="UI",
          description="A component that supports selecting a Color.")
public class JColorChooser
extends JComponent
implements Accessible

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

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

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

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

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

С тех пор:
1.2
См. также:
Сериализованная форма

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

Модификатор и тип Класс Описание
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​(int c)

Устанавливает текущий цвет выбора цвета на указанный цвет.
void setColor​(int r, int g, int b)

Устанавливает текущий цвет выбора цвета на указанный цвет RGB.
void setColor​(Color color)

Устанавливает текущий цвет выбора цвета на указанный цвет.
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)

Отображает модальный диалог выбора цвета и блокирует выполнение, пока диалог не будет скрыт.
static Color showDialog​(Component component, String title, Color initialColor, boolean colorTransparencySelectionEnabled)

Отображает модальный диалог выбора цвета и блокирует выполнение, пока диалог не будет скрыт.
void updateUI()

Уведомление от UIManager о том, что 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, 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, 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

Поля

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()

showDialog

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

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

Параметры:
component - родительский Component для диалогового окна
title - строка, содержащая заголовок диалогового окна
initialColor - начальный цвет, установленный при отображении выбора цвета
colorTransparencySelectionEnabled - true, если можно выбрать прозрачность цвета
Возвращает:
выбранный цвет или 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

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

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

getUI

public ColorChooserUI getUI()

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

Переопределяет:
getUI в классе JComponent
Возвращает:
объект ColorChooserUI , который отрисовывает этот компонент

setUI

@BeanProperty(hidden=true,
              description="The UI object that implements the color chooser\'s LookAndFeel.")
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

@BeanProperty(bound=false)
public String getUIClassID()

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

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

getColor

public Color getColor()

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

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

setColor

@BeanProperty(bound=false,
              description="The current color the chooser is to display.")
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

@BeanProperty(bound=false,
              description="Determines whether automatic drag handling is enabled.")
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

@BeanProperty(hidden=true,
              description="The UI component which displays the current color.")
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

@BeanProperty(hidden=true,
              description="An array of different chooser types.")
public void setChooserPanels(AbstractColorChooserPanel[] panels)

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

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

getChooserPanels

public AbstractColorChooserPanel[] getChooserPanels()

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

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

getSelectionModel

public ColorSelectionModel getSelectionModel()

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

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

setSelectionModel

@BeanProperty(hidden=true,
              description="The model which contains the currently selected color.")
public void setSelectionModel(ColorSelectionModel newModel)

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

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

paramString

protected String paramString()

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

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

getAccessibleContext

@BeanProperty(bound=false)
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.
https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/swing/JColorChooser.html

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