io.jmix.ui.component

Interface ColorPicker

All Superinterfaces:

Buffered, Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Field<java.lang.String>, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasValidator<java.lang.String>, HasValue<java.lang.String>, HasValueSource<java.lang.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%/backoffice-ui/vcl/components/color-picker.html")
public interface ColorPicker
extends Field<java.lang.String>, Component.Focusable, Buffered

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasValue

HasValue.ValueChangeEvent<V>

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBlueSliderCaption() Returns caption of the slider for blue color.
java.lang.String	getButtonCaption() Returns caption of color picker button.
java.lang.String	getCancelButtonCaption() Returns caption of the cancel button.
java.lang.String	getConfirmButtonCaption() Returns caption of the confirm button.
java.lang.String	getGreenSliderCaption() Returns caption of the slider for green color.
java.lang.String	getHueSliderCaption() Returns caption of the slider for HUE.
java.lang.String	getLookupAllCaption() Returns caption of the all colors in lookup.
java.lang.String	getLookupBlueCaption() Returns caption of the blue colors in lookup.
java.lang.String	getLookupGreenCaption() Returns caption of the green colors in lookup.
java.lang.String	getLookupRedCaption() Returns caption of the red colors in lookup.
java.lang.String	getPopupCaption() Returns caption of the popup window.
java.lang.String	getRedSliderCaption() Returns caption of the slider for red color.
java.lang.String	getSaturationSliderCaption() Returns caption of the slider for saturation.
java.lang.String	getSwatchesTabCaption() Returns caption of the swatches tab.
java.lang.String	getValueSliderCaption() Returns caption of the slider for value.
boolean	isDefaultCaptionEnabled()
boolean	isHistoryVisible()
boolean	isHSVVisible()
boolean	isRGBVisible()
boolean	isSwatchesVisible()
void	setBlueSliderCaption(java.lang.String blueSliderCaption) Sets caption for the slider of blue color.
void	setButtonCaption(java.lang.String buttonCaption) Sets caption for color picker button.
void	setCancelButtonCaption(java.lang.String cancelButtonCaption) Sets caption for the cancel button.
void	setConfirmButtonCaption(java.lang.String confirmButtonCaption) Sets caption for the confirm button.
void	setDefaultCaptionEnabled(boolean defaultCaptionEnabled) Sets HEX value as button caption.
void	setGreenSliderCaption(java.lang.String greenSliderCaption) Sets caption for the slider of green color.
void	setHistoryVisible(boolean historyVisible) Sets visibility for history pane
void	setHSVVisible(boolean hsvVisible) Sets visibility for HSV tab
void	setHueSliderCaption(java.lang.String hueSliderCaption) Sets caption for the HUE slider.
void	setLookupAllCaption(java.lang.String lookupAllCaption) Sets caption for the all colors in lookup.
void	setLookupBlueCaption(java.lang.String lookupBlueCaption) Sets caption for the blue colors in lookup.
void	setLookupGreenCaption(java.lang.String lookupGreenCaption) Sets caption for the green colors in lookup.
void	setLookupRedCaption(java.lang.String lookupRedCaption) Sets caption for the red colors in lookup.
void	setPopupCaption(java.lang.String popupCaption) Sets caption for the popup window.
void	setRedSliderCaption(java.lang.String redSliderCaption) Sets caption for the slider of red color.
void	setRGBVisible(boolean rgbVisible) Sets visibility for RGB tab
void	setSaturationSliderCaption(java.lang.String saturationSliderCaption) Sets caption for the saturation slider.
void	setSwatchesTabCaption(java.lang.String swatchesTabCaption) Sets caption for the swatches tab.
void	setSwatchesVisible(boolean swatchesVisible) Sets visibility for swatches tab
void	setValueSliderCaption(java.lang.String valueSliderCaption) Sets caption for the value slider.

Methods inherited from interface io.jmix.ui.component.data.HasValueSource

getValueSource, setValueSource

Methods inherited from interface io.jmix.ui.component.HasValue

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, setValue

Methods inherited from interface io.jmix.ui.component.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Validatable

isValid, isValidateOnCommit, validate

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface io.jmix.ui.component.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Methods inherited from interface io.jmix.ui.component.HasValidator

addValidator, addValidators, getValidators, removeValidator

Methods inherited from interface io.jmix.ui.component.Requirable

getRequiredMessage, isRequired, setRequired, setRequiredMessage

Methods inherited from interface io.jmix.ui.component.Component.Focusable

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

Methods inherited from interface io.jmix.ui.component.Buffered

commit, discard, isBuffered, isModified, setBuffered

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

setPopupCaption

@StudioProperty(type=LOCALIZED_STRING,
                defaultValue="msg:///colorPicker.popupCaption")
void setPopupCaption(@Nullable
                                                                                                                            java.lang.String popupCaption)

Sets caption for the popup window.

Parameters:

popupCaption - caption text.

getPopupCaption

@Nullable
java.lang.String getPopupCaption()

Returns caption of the popup window.

Returns:

caption text.

setConfirmButtonCaption

@StudioProperty(type=LOCALIZED_STRING,
                defaultValue="msg:///colorPicker.confirmButtonCaption")
void setConfirmButtonCaption(@Nullable
                                                                                                                                            java.lang.String confirmButtonCaption)

Sets caption for the confirm button.

Parameters:

confirmButtonCaption - caption text.

getConfirmButtonCaption

@Nullable
java.lang.String getConfirmButtonCaption()

Returns caption of the confirm button.

Returns:

caption text.

setCancelButtonCaption

@StudioProperty(type=LOCALIZED_STRING,
                defaultValue="msg:///colorPicker.cancelButtonCaption")
void setCancelButtonCaption(@Nullable
                                                                                                                                          java.lang.String cancelButtonCaption)

Sets caption for the cancel button.

Parameters:

cancelButtonCaption - caption text.

getCancelButtonCaption

@Nullable
java.lang.String getCancelButtonCaption()

Returns caption of the cancel button.

Returns:

caption text.

setSwatchesTabCaption

@StudioProperty(type=LOCALIZED_STRING,
                defaultValue="msg:///colorPicker.swatchesTabCaption")
void setSwatchesTabCaption(@Nullable
                                                                                                                                        java.lang.String swatchesTabCaption)

Sets caption for the swatches tab.

Parameters:

swatchesTabCaption - caption text.

getSwatchesTabCaption

@Nullable
java.lang.String getSwatchesTabCaption()

Returns caption of the swatches tab.

Returns:

caption text.

setLookupAllCaption

@StudioProperty(type=LOCALIZED_STRING,
                defaultValue="msg:///colorPicker.lookupAll")
void setLookupAllCaption(@Nullable
                                                                                                                             java.lang.String lookupAllCaption)

Sets caption for the all colors in lookup.

Parameters:

lookupAllCaption - caption text.

getLookupAllCaption

@Nullable
java.lang.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
                                                                                                                             java.lang.String lookupRedCaption)

Sets caption for the red colors in lookup.

Parameters:

lookupRedCaption - caption text.

getLookupRedCaption

@Nullable
java.lang.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
                                                                                                                                 java.lang.String lookupGreenCaption)

Sets caption for the green colors in lookup.

Parameters:

lookupGreenCaption - caption text.

getLookupGreenCaption

@Nullable
java.lang.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
                                                                                                                               java.lang.String lookupBlueCaption)

Sets caption for the blue colors in lookup.

Parameters:

lookupBlueCaption - caption text.

getLookupBlueCaption

@Nullable
java.lang.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
                                                                                                                                    java.lang.String redSliderCaption)

Sets caption for the slider of red color.

Parameters:

redSliderCaption - caption text.

getRedSliderCaption

@Nullable
java.lang.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
                                                                                                                                        java.lang.String greenSliderCaption)

Sets caption for the slider of green color.

Parameters:

greenSliderCaption - caption text.

getGreenSliderCaption

@Nullable
java.lang.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
                                                                                                                                      java.lang.String blueSliderCaption)

Sets caption for the slider of blue color.

Parameters:

blueSliderCaption - caption text.

getBlueSliderCaption

@Nullable
java.lang.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
                                                                                                                                    java.lang.String hueSliderCaption)

Sets caption for the HUE slider.

Parameters:

hueSliderCaption - caption text.

getHueSliderCaption

@Nullable
java.lang.String getHueSliderCaption()

Returns caption of the slider for HUE.

Returns:

caption text.

setSaturationSliderCaption

@StudioProperty(type=LOCALIZED_STRING,
                defaultValue="msg:///colorPicker.saturationSliderCaption")
void setSaturationSliderCaption(@Nullable
                                                                                                                                                  java.lang.String saturationSliderCaption)

Sets caption for the saturation slider.

Parameters:

saturationSliderCaption - caption text.

getSaturationSliderCaption

@Nullable
java.lang.String getSaturationSliderCaption()

Returns caption of the slider for saturation.

Returns:

caption text.

setValueSliderCaption

@StudioProperty(type=LOCALIZED_STRING,
                defaultValue="msg:///valueSliderCaption")
void setValueSliderCaption(@Nullable
                                                                                                                            java.lang.String valueSliderCaption)

Sets caption for the value slider.

Parameters:

valueSliderCaption - caption text.

getValueSliderCaption

@Nullable
java.lang.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(java.lang.String buttonCaption)

Sets caption for color picker button.

Parameters:

buttonCaption - caption text.

getButtonCaption

java.lang.String getButtonCaption()

Returns caption of color picker button.

Returns:

caption text.