/* * Copyright (c) 2012, 2015, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package javafx.scene.control; import javafx.collections.FXCollections; import javafx.collections.ObservableList; import javafx.scene.paint.Color; import javafx.scene.control.skin.ColorPickerSkin; /** *
ColorPicker control allows the user to select a color from either a standard * palette of colors with a simple one click selection OR define their own custom color. * *
The {@link #valueProperty() value} is the currently selected {@link javafx.scene.paint.Color}. * An initial color can be set by calling setColor or via the constructor. If nothing * is specified, a default initial color is used. * *
The ColorPicker control provides a color palette with a predefined set of colors. If * the user does not want to choose from the predefined set, they can create a custom * color by interacting with a custom color dialog. This dialog provides RGB, * HSB and Web modes of interaction, to create new colors. It also lets the opacity * of the color to be modified. * *
Once a new color is defined, users can choose whether they want to save it * or just use it. If the new color is saved, this color will then appear in the * custom colors area on the color palette. Also {@link #getCustomColors() getCustomColors} * returns the list of saved custom colors. * *
The {@link #promptTextProperty() promptText} is not supported and hence is a no-op. * But it may be supported in the future. * *
* final ColorPicker colorPicker = new ColorPicker();
* colorPicker.setOnAction(new EventHandler() {
* public void handle(Event t) {
* Color c = colorPicker.getValue();
* System.out.println("New Color's RGB = "+c.getRed()+" "+c.getGreen()+" "+c.getBlue());
* }
* });
*
*
* The ColorPicker control's appearance can be styled in three ways: a simple Button mode, * MenuButton mode or SplitMenuButton mode. The default is MenuButton mode. * For a Button like appearance the style class to use is {@link #STYLE_CLASS_BUTTON STYLE_CLASS_BUTTON} * and for SplitMenuButton appearance and behavior, the style class to use is * {@link #STYLE_CLASS_SPLIT_BUTTON STYLE_CLASS_SPLIT_BUTTON}. * *
* colorPicker.getStyleClass().add("button");
*
* or
*
* colorPicker.getStyleClass().add("split-button");
*
* @since JavaFX 2.2
*/
public class ColorPicker extends ComboBoxBase