Spec-Zone.ru › OpenJDK 17

Класс JColorChooser

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JColorChooser
Все реализуемые интерфейсы:
ImageObserver, MenuContainer, Serializable, Accessible
@JavaBean(defaultProperty="UI", description="A component that supports selecting a Color.") public class JColorChooser extends JComponent implements Accessible
JColorChooser предоставляет панель управления, предназначенную для того, чтобы пользователь мог управлять и выбирать цвет. Сведения об использовании цветовых диалогов см. в Как использовать цветовые диалоги, разделе руководства The Java Tutorial.

Этот класс предоставляет три уровня 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 final String CHOOSER_PANELS_PROPERTY
Имя свойства массива chooserPanel.
static final String PREVIEW_PANEL_PROPERTY
Имя свойства панели предварительного просмотра.
static final 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, 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, 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

Подробное описание полей

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
Отображает модальное диалоговое окно выбора цвета и блокируется до тех пор, пока диалоговое окно не будет скрыто. Если пользователь нажимает кнопку «OK», этот метод скрывает/удаляет диалоговое окно и возвращает выбранный цвет. Если пользователь нажимает кнопку «Отмена» или закрывает диалоговое окно без нажатия «OK», этот метод скрывает/удаляет диалоговое окно и возвращает 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
Отображает модальное диалоговое окно выбора цвета и блокируется до тех пор, пока диалоговое окно не будет скрыто. Если пользователь нажимает кнопку «OK», этот метод скрывает/удаляет диалоговое окно и возвращает выбранный цвет. Если пользователь нажимает кнопку «Отмена» или закрывает диалоговое окно без нажатия «OK», этот метод скрывает/удаляет диалоговое окно и возвращает 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 вместе с кнопками «OK», «Отмена» и «Сброс». Если нажаты кнопки «OK» или «Отмена», диалоговое окно автоматически скрывается (но не удаляется). Если нажата кнопка «Сброс», цвет выбора цвета будет сброшен до цвета, который был установлен в последний раз, когда show был вызван в диалоговом окне, и диалоговое окно останется видимым.
Параметры:
c - родительский компонент для диалогового окна
title - заголовок диалогового окна
modal - логическое значение. Если true, остальная часть программы будет неактивной до закрытия диалогового окна.
chooserPane - окно выбора цвета, которое будет размещено внутри диалогового окна
okListener - обработчик событий, вызываемый при нажатии «OK»
cancelListener - обработчик событий, вызываемый при нажатии «Отмена»
Возвращает:
новое диалоговое окно, содержащее панель выбора цвета
Исключения:
HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true.
См. также:
  • GraphicsEnvironment.isHeadless()

getUI

public ColorChooserUI getUI()
Возвращает объект L&F, который отображает этот компонент.
Переопределяет:
getUI в классе JComponent
Возвращает:
объект L&F, который отображает этот компонент

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
См. также:
  • UIDefaults.getUI(javax.swing.JComponent)

updateUI

public void updateUI()
Уведомление от UIManager о том, что внешний вид изменился. Заменяет текущий объект 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 должно быть установлено в ненулевое null значение, чтобы перетаскивание работало. Значение свойства dragEnabled по умолчанию равно false.

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

Parameters:
b - значение, на которое должно быть установлено свойство dragEnabled
Throws:
HeadlessException - если b имеет значение true и GraphicsEnvironment.isHeadless() возвращает true
Since:
1.4
See Also:
  • GraphicsEnvironment.isHeadless()
  • getDragEnabled()
  • JComponent.setTransferHandler(javax.swing.TransferHandler)
  • TransferHandler

getDragEnabled

public boolean getDragEnabled()
Возвращает значение свойства dragEnabled.
Returns:
значение свойства dragEnabled
Since:
1.4
See Also:
  • setDragEnabled(boolean)

setPreviewPanel

@BeanProperty(hidden=true, description="The UI component which displays the current color.") public void setPreviewPanel(JComponent preview)
Устанавливает текущую панель предварительного просмотра. Это вызовет событие PropertyChangeEvent для свойства с именем "previewPanel".
Parameters:
preview - JComponent, отображающая текущий цвет
See Also:
  • Container.addPropertyChangeListener(java.beans.PropertyChangeListener)

getPreviewPanel

public JComponent getPreviewPanel()
Возвращает панель предварительного просмотра, отображающую выбранный цвет.
Returns:
объект JComponent - панель предварительного просмотра

addChooserPanel

public void addChooserPanel(AbstractColorChooserPanel panel)
Добавляет панель выбора цвета в диалог выбора цвета.
Parameters:
panel - добавляемая AbstractColorChooserPanel

removeChooserPanel

public AbstractColorChooserPanel removeChooserPanel(AbstractColorChooserPanel panel)
Удаляет указанную панель цвета.
Parameters:
panel - строка, определяющая удаляемую панель
Returns:
панель цвета
Throws:
IllegalArgumentException - если панель не найдена в списке известных панелей выбора

setChooserPanels

@BeanProperty(hidden=true, description="An array of different chooser types.") public void setChooserPanels(AbstractColorChooserPanel[] panels)
Определяет панели цветов, используемые для выбора значения цвета.
Parameters:
panels - массив объектов AbstractColorChooserPanel

getChooserPanels

public AbstractColorChooserPanel[] getChooserPanels()
Возвращает указанные панели цветов.
Returns:
массив объектов AbstractColorChooserPanel

getSelectionModel

public ColorSelectionModel getSelectionModel()
Возвращает модель данных, обрабатывающую выбор цветов.
Returns:
объект ColorSelectionModel

setSelectionModel

@BeanProperty(hidden=true, description="The model which contains the currently selected color.") public void setSelectionModel(ColorSelectionModel newModel)
Устанавливает модель, содержащую выбранный цвет.
Parameters:
newModel - новый объект ColorSelectionModel

paramString

protected String paramString()
Возвращает строковое представление этого объекта JColorChooser. Этот метод предназначен только для отладки, и содержание и формат возвращаемой строки могут различаться в разных реализациях. Возвращаемая строка может быть пустой, но не null.
Overrides:
paramString в классе JComponent
Returns:
строковое представление этого объекта JColorChooser

getAccessibleContext

@BeanProperty(bound=false) public AccessibleContext getAccessibleContext()
Получает AccessibleContext, связанный с этим JColorChooser. Для диалогов выбора цвета AccessibleContext представлен как AccessibleJColorChooser. Новый экземпляр AccessibleJColorChooser создаётся при необходимости.
Specified by:
getAccessibleContext в интерфейсе Accessible
Overrides:
getAccessibleContext в классе Component
Returns:
AccessibleJColorChooser, служащий AccessibleContext для этого JColorChooser

© 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/JColorChooser.html

Spec-Zone.ru

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