Package io.jmix.ui.component

Interface ColorPicker

All Superinterfaces:
Buffered, Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Field<String>, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasValidator<String>, HasValue<String>, HasValueSource<String>, Requirable, Validatable
All Known Implementing Classes:
ColorPickerImpl
@StudioComponent(caption="ColorPicker", category="Components", xmlElement="colorPicker", icon="io/jmix/ui/icon/component/colorPicker.svg", canvasBehaviour=COLOR_PICKER, unsupportedProperties="buffered", documentationURL="https://docs.jmix.io/jmix/%VERSION%/ui/vcl/components/color-picker.html") public interface ColorPicker extends Field<String>, Component.Focusable, Buffered

  • Field Details

  • Method Details

    • setPopupCaption

      @StudioProperty(type=LOCALIZED_STRING, defaultValue="msg:///colorPicker.popupCaption") void setPopupCaption(@Nullable String popupCaption)
      Sets caption for the popup window.
      Parameters:
      popupCaption - caption text.

    • getPopupCaption

      @Nullable String getPopupCaption()
      Returns caption of the popup window.
      Returns:
      caption text.

    • setConfirmButtonCaption

      @StudioProperty(type=LOCALIZED_STRING, defaultValue="msg:///colorPicker.confirmButtonCaption") void setConfirmButtonCaption(@Nullable String confirmButtonCaption)
      Sets caption for the confirm button.
      Parameters:
      confirmButtonCaption - caption text.

    • getConfirmButtonCaption

      @Nullable String getConfirmButtonCaption()
      Returns caption of the confirm button.
      Returns:
      caption text.

    • setCancelButtonCaption

      @StudioProperty(type=LOCALIZED_STRING, defaultValue="msg:///colorPicker.cancelButtonCaption") void setCancelButtonCaption(@Nullable String cancelButtonCaption)
      Sets caption for the cancel button.
      Parameters:
      cancelButtonCaption - caption text.

    • getCancelButtonCaption

      @Nullable String getCancelButtonCaption()
      Returns caption of the cancel button.
      Returns:
      caption text.

    • setSwatchesTabCaption

      @StudioProperty(type=LOCALIZED_STRING, defaultValue="msg:///colorPicker.swatchesTabCaption") void setSwatchesTabCaption(@Nullable String swatchesTabCaption)
      Sets caption for the swatches tab.
      Parameters:
      swatchesTabCaption - caption text.

    • getSwatchesTabCaption

      @Nullable String getSwatchesTabCaption()
      Returns caption of the swatches tab.
      Returns:
      caption text.

    • setLookupAllCaption

      @StudioProperty(type=LOCALIZED_STRING, defaultValue="msg:///colorPicker.lookupAll") void setLookupAllCaption(@Nullable String lookupAllCaption)
      Sets caption for the all colors in lookup.
      Parameters:
      lookupAllCaption - caption text.

    • getLookupAllCaption

      @Nullable String getLookupAllCaption()
      Returns caption of the all colors in lookup.
      Returns:
      caption text.

    • setLookupRedCaption

      @StudioProperty(type=LOCALIZED_STRING, defaultValue="msg:///colorPicker.lookupRed") void setLookupRedCaption(@Nullable String lookupRedCaption)
      Sets caption for the red colors in lookup.
      Parameters:
      lookupRedCaption - caption text.

    • getLookupRedCaption

      @Nullable String getLookupRedCaption()
      Returns caption of the red colors in lookup.
      Returns:
      caption text.

    • setLookupGreenCaption

      @StudioProperty(type=LOCALIZED_STRING, defaultValue="msg:///colorPicker.lookupGreen") void setLookupGreenCaption(@Nullable String lookupGreenCaption)
      Sets caption for the green colors in lookup.
      Parameters:
      lookupGreenCaption - caption text.

    • getLookupGreenCaption

      @Nullable String getLookupGreenCaption()
      Returns caption of the green colors in lookup.
      Returns:
      caption text.

    • setLookupBlueCaption

      @StudioProperty(type=LOCALIZED_STRING, defaultValue="msg:///colorPicker.lookupBlue") void setLookupBlueCaption(@Nullable String lookupBlueCaption)
      Sets caption for the blue colors in lookup.
      Parameters:
      lookupBlueCaption - caption text.

    • getLookupBlueCaption

      @Nullable String getLookupBlueCaption()
      Returns caption of the blue colors in lookup.
      Returns:
      caption text.

    • setRedSliderCaption

      @StudioProperty(type=LOCALIZED_STRING, defaultValue="msg:///colorPicker.redSliderCaption") void setRedSliderCaption(@Nullable String redSliderCaption)
      Sets caption for the slider of red color.
      Parameters:
      redSliderCaption - caption text.

    • getRedSliderCaption

      @Nullable String getRedSliderCaption()
      Returns caption of the slider for red color.
      Returns:
      caption text.

    • setGreenSliderCaption

      @StudioProperty(type=LOCALIZED_STRING, defaultValue="msg:///colorPicker.greenSliderCaption") void setGreenSliderCaption(@Nullable String greenSliderCaption)
      Sets caption for the slider of green color.
      Parameters:
      greenSliderCaption - caption text.

    • getGreenSliderCaption

      @Nullable String getGreenSliderCaption()
      Returns caption of the slider for green color.
      Returns:
      caption text.

    • setBlueSliderCaption

      @StudioProperty(type=LOCALIZED_STRING, defaultValue="msg:///colorPicker.blueSliderCaption") void setBlueSliderCaption(@Nullable String blueSliderCaption)
      Sets caption for the slider of blue color.
      Parameters:
      blueSliderCaption - caption text.

    • getBlueSliderCaption

      @Nullable String getBlueSliderCaption()
      Returns caption of the slider for blue color.
      Returns:
      caption text.

    • setHueSliderCaption

      @StudioProperty(type=LOCALIZED_STRING, defaultValue="msg:///colorPicker.hueSliderCaption") void setHueSliderCaption(@Nullable String hueSliderCaption)
      Sets caption for the HUE slider.
      Parameters:
      hueSliderCaption - caption text.

    • getHueSliderCaption

      @Nullable String getHueSliderCaption()
      Returns caption of the slider for HUE.
      Returns:
      caption text.

    • setSaturationSliderCaption

      @StudioProperty(type=LOCALIZED_STRING, defaultValue="msg:///colorPicker.saturationSliderCaption") void setSaturationSliderCaption(@Nullable String saturationSliderCaption)
      Sets caption for the saturation slider.
      Parameters:
      saturationSliderCaption - caption text.

    • getSaturationSliderCaption

      @Nullable String getSaturationSliderCaption()
      Returns caption of the slider for saturation.
      Returns:
      caption text.

    • setValueSliderCaption

      @StudioProperty(type=LOCALIZED_STRING, defaultValue="msg:///valueSliderCaption") void setValueSliderCaption(@Nullable String valueSliderCaption)
      Sets caption for the value slider.
      Parameters:
      valueSliderCaption - caption text.

    • getValueSliderCaption

      @Nullable String getValueSliderCaption()
      Returns caption of the slider for value.
      Returns:
      caption text.

    • setHistoryVisible

      @StudioProperty(defaultValue="false") void setHistoryVisible(boolean historyVisible)
      Sets visibility for history pane
      Parameters:
      historyVisible - pane visibility.

    • isHistoryVisible

      boolean isHistoryVisible()
      Returns:
      true if history pane is visible.

    • setSwatchesVisible

      @StudioProperty(defaultValue="false") void setSwatchesVisible(boolean swatchesVisible)
      Sets visibility for swatches tab
      Parameters:
      swatchesVisible - tab visibility.

    • isSwatchesVisible

      boolean isSwatchesVisible()
      Returns:
      true if swatches tab is visible.

    • setRGBVisible

      @StudioProperty(name="rgbVisible", defaultValue="true") void setRGBVisible(boolean rgbVisible)
      Sets visibility for RGB tab
      Parameters:
      rgbVisible - tab visibility.

    • isRGBVisible

      boolean isRGBVisible()
      Returns:
      true if RGB tab is visible.

    • setHSVVisible

      @StudioProperty(name="hsvVisible", defaultValue="false") void setHSVVisible(boolean hsvVisible)
      Sets visibility for HSV tab
      Parameters:
      hsvVisible - tab visibility.

    • isHSVVisible

      boolean isHSVVisible()
      Returns:
      true if HSV tab is visible.

    • setDefaultCaptionEnabled

      @StudioProperty(defaultValue="false") void setDefaultCaptionEnabled(boolean defaultCaptionEnabled)
      Sets HEX value as button caption.
      Parameters:
      defaultCaptionEnabled - true if HEX color is shown as button caption.

    • isDefaultCaptionEnabled

      boolean isDefaultCaptionEnabled()
      Returns:
      true if caption is shown as HTML.

    • setButtonCaption

      @StudioProperty(type=LOCALIZED_STRING) void setButtonCaption(String buttonCaption)
      Sets caption for color picker button.
      Parameters:
      buttonCaption - caption text.

    • getButtonCaption

      String getButtonCaption()
      Returns caption of color picker button.
      Returns:
      caption text.