モジュール java.desktop
パッケージ javax.swing

クラス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』の「How to Use Color Choosers」を参照してください。

このクラスは3つのレベルのAPIを提供します。

  1. モーダルなカラー・チューザ・ダイアログを表示し、ユーザーが選択した色を返すstatic簡易メソッド。
  2. カラー・チューザ・ダイアログを生成するためのstatic簡易メソッド。カラー・チューザ・ダイアログでは、ユーザーがダイアログのボタンの1つを押したときに呼び出されるActionListenersを指定できる。
  3. コンテナ内でJColorChooserペインのインスタンスを直接生成する機能。 現在の「color」プロパティが変更されたときにそれを検出するためのPropertyChangeリスナーを追加できる。

警告: Swingはスレッドに対して安全ではありません。 詳細は、「Swing's Threading Policy」を参照してください。

警告: このクラスの直列化されたオブジェクトは、今後のSwingリリースと互換ではなくなる予定です。 現在の直列化のサポートは、短期間の格納や、同じバージョンのSwingを実行するアプリケーション間のRMIに適しています。 1.4では、すべてのJavaBeansの長期ストレージのサポートがjava.beansパッケージに追加されました。 XMLEncoderを参照してください。

導入されたバージョン:
1.2

  • フィールド詳細

    • 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」ボタンを押すと、このメソッドはダイアログを隠すかまたは破棄し、選択された色を返します。 ユーザーが「Cancel」ボタンを押すか、あるいは「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」ボタンを押すと、このメソッドはダイアログを隠すかまたは破棄し、選択された色を返します。 ユーザーが「Cancel」ボタンを押すか、あるいは「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
      「OK」、「取消」、および「リセット」ボタンとともに指定されたColorChooserペインを含む新しいダイアログを作成して返します。 「OK」または「Cancel」ボタンが押されると、ダイアログは自動的に隠れます(破棄はされない)。 「Reset」ボタンが押されると、カラー・チューザの色は、前回にダイアログでshowが呼び出されたときに設定された色にリセットされ、ダイアログはそのまま表示されます。
      パラメータ:
      c - ダイアログの親Component
      title - ダイアログのタイトル
      modal - boolean。 trueの場合、ダイアログを閉じるまでプログラムの残りはアクティブでなくなる。
      chooserPane - ダイアログ内に配置されるカラー・チューザ
      okListener -「OK」が押されたときに呼び出されるActionListener
      cancelListener -「Cancel」が押されたときに呼び出されるActionListener
      戻り値:
      カラー・チューザ・ペインを持つ新しいダイアログ
      例外:
      HeadlessException - GraphicsEnvironment.isHeadless()がtrueを返した場合。
      関連項目:
      GraphicsEnvironment.isHeadless()

    • getUI

      public ColorChooserUI getUI()
      このコンポーネントをレンダリングするL&Fオブジェクトを返します。
      オーバーライド:
      クラスJComponentのgetUI
      戻り値:
      このコンポーネントをレンダリングするColorChooserUIオブジェクト

    • setUI

      @BeanProperty(hidden=true, description="The UI object that implements the color chooser\'s LookAndFeel.")public void setUI​(ColorChooserUI ui)
      このコンポーネントをレンダリングするL&Fオブジェクトを設定します。
      パラメータ:
      ui - ColorChooserUI L&Fオブジェクト
      関連項目:
      UIDefaults.getUI(javax.swing.JComponent)

    • updateUI

      public void updateUI()
      L&Fが変更されたことを示す、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 - Redの量を指定する整数値
      g - Greenの量を指定する整数値
      b - Blueの量を指定する整数値
      例外:
      IllegalArgumentException - r、g、およびbの値が範囲外の場合
      関連項目:
      Color

    • setColor

      public void setColor​(int c)
      カラー・チューザの現在の色を指定された色に設定します。
      パラメータ:
      c - チューザの現在の色を設定する整数値。下位8ビットはBlue値、次の8ビットはGreen値、上位8ビットはRed値を指定する。

    • setDragEnabled

      @BeanProperty(bound=false, description="Determines whether automatic drag handling is enabled.")public void setDragEnabled​(boolean b)
      dragEnabledプロパティを設定します。このプロパティは、このコンポーネントの自動ドラッグ処理(ドラッグ・アンド・ドロップの最初の処理)を有効にするためにtrueである必要があります。 transferHandlerプロパティは、ドラッグでなんでもできるようにnull以外の値に設定する必要があります。 dragEnabledプロパティのデフォルト値はfalseです。

      自動ドラッグ処理が使用可能な場合、プレビュー・パネル上でマウスボタンを押すと、ほとんどのルック・アンド・フィールでドラッグ・アンド・ドロップ操作が開始されます。 ルック・アンド・フィールによっては、自動ドラッグ・アンド・ドロップ操作がサポートされていない場合があります。その場合、このプロパティは無視されます。 TransferHandlerのexportAsDragメソッドを直接呼び出すようにコンポーネントを変更することにより、このようなルック・アンド・フィールを操作できます。

      パラメータ:
      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)
      現在のプレビュー・パネルを設定します。 このメソッドは、previewPanelという名前のプロパティに対してPropertyChangeEventをトリガーします。
      パラメータ:
      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()
      このJColorChooserに関連付けられたAccessibleContextを取得します。 カラー・チューザの場合、AccessibleContextはAccessibleJColorChooserの形式を取ります。 必要に応じて新規のAccessibleJColorChooserインスタンスが生成されます。
      定義:
      getAccessibleContext、インタフェース: Accessible
      オーバーライド:
      getAccessibleContext、クラス: Component
      戻り値:
      このJColorChooserのAccessibleContextとして機能するAccessibleJColorChooser