com.haulmont.cuba.gui.components

Interface ColorPicker

All Superinterfaces:

Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasContextHelp, Component.HasIcon, Component.HasValue, Component.Validatable, DatasourceComponent, Field

public interface ColorPicker
extends Field, Component.Focusable

Nested Class Summary

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Field

Field.Validator

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.ContextHelpIconClickEvent, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasContextHelp, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasOptionsStyleProvider, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OptionsStyleProvider, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener, Component.Wrapper

Field Summary

Fields

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

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

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

Methods inherited from interface com.haulmont.cuba.gui.components.Field

addValidator, getRequiredMessage, getValidators, isRequired, removeValidator, setRequired, setRequiredMessage

Methods inherited from interface com.haulmont.cuba.gui.components.DatasourceComponent

getDatasource, getMetaProperty, getMetaPropertyPath, setDatasource

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasValue

addListener, addValueChangeListener, removeListener, removeValueChangeListener, setValue

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, getDescription, setCaption, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Validatable

isValid, isValidateOnCommit, validate

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Focusable

getTabIndex, isFocusable, setFocusable, setTabIndex

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

setPopupCaption

void setPopupCaption(java.lang.String popupCaption)

Set caption for the popup window.

Parameters:

popupCaption - caption text.

getPopupCaption

java.lang.String getPopupCaption()

Return caption of the popup window.

Returns:

caption text.

setConfirmButtonCaption

void setConfirmButtonCaption(java.lang.String confirmButtonCaption)

Set caption for the confirm button.

Parameters:

confirmButtonCaption - caption text.

getConfirmButtonCaption

java.lang.String getConfirmButtonCaption()

Return caption of the confirm button.

Returns:

caption text.

setCancelButtonCaption

void setCancelButtonCaption(java.lang.String cancelButtonCaption)

Set caption for the cancel button.

Parameters:

cancelButtonCaption - caption text.

getCancelButtonCaption

java.lang.String getCancelButtonCaption()

Return caption of the cancel button.

Returns:

caption text.

setSwatchesTabCaption

void setSwatchesTabCaption(java.lang.String swatchesTabCaption)

Set caption for the swatches tab.

Parameters:

swatchesTabCaption - caption text.

getSwatchesTabCaption

java.lang.String getSwatchesTabCaption()

Return caption of the swatches tab.

Returns:

caption text.

setLookupAllCaption

void setLookupAllCaption(java.lang.String lookupAllCaption)

Set caption for the all colors in lookup.

Parameters:

lookupAllCaption - caption text.

getLookupAllCaption

java.lang.String getLookupAllCaption()

Return caption of the all colors in lookup.

Returns:

caption text.

setLookupRedCaption

void setLookupRedCaption(java.lang.String lookupRedCaption)

Set caption for the red colors in lookup.

Parameters:

lookupRedCaption - caption text.

getLookupRedCaption

java.lang.String getLookupRedCaption()

Return caption of the red colors in lookup.

Returns:

caption text.

setLookupGreenCaption

void setLookupGreenCaption(java.lang.String lookupGreenCaption)

Set caption for the green colors in lookup.

Parameters:

lookupGreenCaption - caption text.

getLookupGreenCaption

java.lang.String getLookupGreenCaption()

Return caption of the green colors in lookup.

Returns:

caption text.

setLookupBlueCaption

void setLookupBlueCaption(java.lang.String lookupBlueCaption)

Set caption for the blue colors in lookup.

Parameters:

lookupBlueCaption - caption text.

getLookupBlueCaption

java.lang.String getLookupBlueCaption()

Return caption of the blue colors in lookup.

Returns:

caption text.

setRedSliderCaption

void setRedSliderCaption(java.lang.String redSliderCaption)

Set caption for the slider of red color.

Parameters:

redSliderCaption - caption text.

getRedSliderCaption

java.lang.String getRedSliderCaption()

Return caption of the slider for red color.

Returns:

caption text.

setGreenSliderCaption

void setGreenSliderCaption(java.lang.String greenSliderCaption)

Set caption for the slider of green color.

Parameters:

greenSliderCaption - caption text.

getGreenSliderCaption

java.lang.String getGreenSliderCaption()

Return caption of the slider for green color.

Returns:

caption text.

setBlueSliderCaption

void setBlueSliderCaption(java.lang.String blueSliderCaption)

Set caption for the slider of blue color.

Parameters:

blueSliderCaption - caption text.

getBlueSliderCaption

java.lang.String getBlueSliderCaption()

Return caption of the slider for blue color.

Returns:

caption text.

setHueSliderCaption

void setHueSliderCaption(java.lang.String hueSliderCaption)

Set caption for the HUE slider.

Parameters:

hueSliderCaption - caption text.

getHueSliderCaption

java.lang.String getHueSliderCaption()

Return caption of the slider for HUE.

Returns:

caption text.

setSaturationSliderCaption

void setSaturationSliderCaption(java.lang.String saturationSliderCaption)

Set caption for the saturation slider.

Parameters:

saturationSliderCaption - caption text.

getSaturationSliderCaption

java.lang.String getSaturationSliderCaption()

Return caption of the slider for saturation.

Returns:

caption text.

setValueSliderCaption

void setValueSliderCaption(java.lang.String valueSliderCaption)

Set caption for the value slider.

Parameters:

valueSliderCaption - caption text.

getValueSliderCaption

java.lang.String getValueSliderCaption()

Return caption of the slider for value.

Returns:

caption text.

setHistoryVisible

void setHistoryVisible(boolean historyVisible)

Set visibility for history pane

Parameters:

historyVisible - pane visibility.

isHistoryVisible

boolean isHistoryVisible()

Returns:

true if history pane is visibile.

setSwatchesVisible

void setSwatchesVisible(boolean swatchesVisible)

Set visibility for swatches tab

Parameters:

swatchesVisible - tab visibility.

isSwatchesVisible

boolean isSwatchesVisible()

Returns:

true if swatches tab is visibile.

setRGBVisible

void setRGBVisible(boolean rgbVisible)

Set visibility for RGB tab

Parameters:

rgbVisible - tab visibility.

isRGBVisible

boolean isRGBVisible()

Returns:

true if RGB tab is visible.

setHSVVisible

void setHSVVisible(boolean hsvVisible)

Set visibility for HSV tab

Parameters:

hsvVisible - tab visibility.

isHSVVisible

boolean isHSVVisible()

Returns:

true if HSV tab is visible.

setDefaultCaptionEnabled

void setDefaultCaptionEnabled(boolean defaultCaptionEnabled)

Set 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

void setButtonCaption(java.lang.String buttonCaption)

Set caption for color picker button.

Parameters:

buttonCaption - caption text.

getButtonCaption

java.lang.String getButtonCaption()

Return caption of color picker button.

Returns:

caption text.

getValue

java.lang.String getValue()

Specified by:

getValue in interface Component.HasValue