ColorPicker

ColorPicker allows a user to preview and select a color. The component is a button that opens the color panel when clicked. The button is painted in the color selected by the user. ColorPicker returns a hexadecimal (HEX) value of the color as a String.

color picker basic

Data-aware ColorPicker

To create a color picker connected to data, use dataContainer and property attributes.

@JmixEntity
@Table(name = "UIEX1_CAR")
@Entity(name = "uiex1_Car")
public class Car {
    @JmixGeneratedValue
    @Column(name = "ID", nullable = false)
    @Id
    private UUID id;

    @Column(name = "BRAND")
    private String brand;

    @Column(name = "MODEL")
    private String model;

    @Column(name = "COLOR_HEX")
    private String colorHex;
}
<data>
    <instance id="carDc"
              class="ui.ex1.entity.Car">
        <fetchPlan extends="_base"/>
        <loader/>
    </instance>
</data>
<layout>
    <colorPicker caption="Color of the car"
                 dataContainer="carDc"
                 property="colorHex"/>
</layout>

Attributes

Tabs Visibility

By default, only the RGB tab is visible. You can also determine the visibility of the HSV and swatches tabs.

<colorPicker caption="Choose a color"
             hsvVisible="true"
             rgbVisible="true"
             swatchesVisible="true"/>

You can open only one tab at a time.

color picker tabs

Captions

There are the following attributes to define corresponding captions:

  • blueSliderCaption

  • buttonCaption

  • cancelButtonCaption

  • confirmButtonCaption

  • greenSliderCaption

  • hueSliderCaption

  • lookupAllCaption

  • lookupBlueCaption

  • lookupGreenCaption

  • lookupRedCaption

  • popupCaption

  • redSliderCaption

  • saturationSliderCaption

  • swatchesTabCaption

  • valueSliderCaption

defaultCaptionEnabled

This attribute allows you to display the HEX value of the selected color as a button caption. To achieve this result, set this attribute to true and do not specify a value for the attribute buttonCaption.

<colorPicker id="colorPicker"
             defaultCaptionEnabled="true"/>
color picker hex caption

historyVisible

This attribute allows you to display the colors previously selected by the user at the bottom of the panel.

<colorPicker caption="Choose a color"
             historyVisible="true"/>
color picker history

Events and Handlers

To generate handler method stubs in Jmix Studio, use the Generate Handler button in the top panel of the screen controller code. Or you can select the component in the screen descriptor layout and use the Handlers tab of the Component Inspector panel.

ContextHelpIconClickEvent

ValueChangeEvent

Validator

Validator is designed to check values entered into visual components.