public class ColorPicker extends ComboBoxBase<Color>
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 value is the currently selected 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 getCustomColors
returns the list of saved custom colors.
The 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 STYLE_CLASS_BUTTON
and for SplitMenuButton appearance and behavior, the style class to use is
STYLE_CLASS_SPLIT_BUTTON.
colorPicker.getStyleClass().add("button");
colorPicker.getStyleClass().add("split-button");
armedProperty, editableProperty, onActionProperty, onHiddenProperty, onHidingProperty, onShowingProperty, onShownProperty, promptTextProperty, showingProperty, valuePropertycontextMenuProperty, skinClassNameProperty, skinProperty, tooltipProperty| Modifier and Type | Field and Description |
|---|---|
private <any> |
customColors
The custom colors added to the Color Palette by the user.
|
private static java.lang.String |
DEFAULT_STYLE_CLASS
*
Stylesheet Handling *
*
|
static java.lang.String |
STYLE_CLASS_BUTTON
The style class to specify a Button like appearance of ColorPicker control.
|
static java.lang.String |
STYLE_CLASS_SPLIT_BUTTON
The style class to specify a SplitMenuButton like appearance of ColorPicker control.
|
ON_HIDDEN, ON_HIDING, ON_SHOWING, ON_SHOWN| Constructor and Description |
|---|
ColorPicker()
Creates a default ColorPicker instance with a selected color set to white.
|
ColorPicker(Color color)
Creates a ColorPicker instance and sets the selected color to the given color.
|
| Modifier and Type | Method and Description |
|---|---|
protected Skin<?> |
createDefaultSkin()
Create a new instance of the default skin for this control.
|
<any> |
getCustomColors()
Gets the list of custom colors added to the Color Palette by the user.
|
arm, armedProperty, disarm, editableProperty, executeAccessibleAction, getOnAction, getOnHidden, getOnHiding, getOnShowing, getOnShown, getPromptText, getValue, hide, isArmed, isEditable, isShowing, onActionProperty, onHiddenProperty, onHidingProperty, onShowingProperty, onShownProperty, promptTextProperty, queryAccessibleAttribute, setEditable, setOnAction, setOnHidden, setOnHiding, setOnShowing, setOnShown, setPromptText, setValue, show, showingProperty, valuePropertycomputeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlChildren, getControlCssMetaData, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, loadSkinClass, setContextMenu, setSkin, setTooltip, skinClassNameProperty, skinProperty, tooltipPropertypublic static final java.lang.String STYLE_CLASS_BUTTON
public static final java.lang.String STYLE_CLASS_SPLIT_BUTTON
private <any> customColors
private static final java.lang.String DEFAULT_STYLE_CLASS
public ColorPicker()
public ColorPicker(Color color)
color - to be set as the currently selected color of the ColorPicker.public final <any> getCustomColors()
protected Skin<?> createDefaultSkin()
-fx-skin or set explicitly in a sub-class with setSkin(...).createDefaultSkin in class Control