com.vaadin.ui

Class ColorPickerArea

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractField<Color>

com.vaadin.ui.AbstractColorPicker

com.vaadin.ui.ColorPickerArea

All Implemented Interfaces:

HasValue<Color>, ContextClickEvent.ContextClickNotifier, MethodEventSource, ClientConnector, Sizeable, Connector, Component, Component.Focusable, Serializable

public class ColorPickerArea
extends AbstractColorPicker

A class that defines area-like implementation for a color picker component.

Since:

7.0.0

See Also:

ColorPicker, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.ui.AbstractColorPicker

AbstractColorPicker.Coordinates2Color, AbstractColorPicker.PopupStyle

Nested classes/interfaces inherited from interface com.vaadin.data.HasValue

HasValue.ValueChangeEvent<V>, HasValue.ValueChangeListener<V>

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

Component.ErrorEvent, Component.Event, Component.Focusable, Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

Sizeable.Unit

Field Summary

Fields inherited from class com.vaadin.ui.AbstractColorPicker

color, historyVisible, hsvVisible, popupStyle, rgbVisible, STYLENAME_AREA, STYLENAME_BUTTON, STYLENAME_DEFAULT, swatchesVisible, textfieldVisible

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor and Description
ColorPickerArea() Instantiates a new color picker.
ColorPickerArea(String popupCaption) Instantiates a new color picker.
ColorPickerArea(String popupCaption, Color initialColor) Instantiates a new color picker.

Method Summary

Modifier and Type	Method and Description
void	beforeClientResponse(boolean initial) Called before the shared state and RPC invocations are sent to the client.
protected ColorPickerAreaState	getState() Returns the shared state bean with information to be sent from the server to the client.
protected ColorPickerAreaState	getState(boolean markAsDirty) Returns the shared state for this connector.
protected void	setDefaultStyles() Sets the default styles of the component.

Methods inherited from class com.vaadin.ui.AbstractColorPicker

doSetValue, getCustomAttributes, getEmptyValue, getHistoryVisibility, getHSVVisibility, getPopupStyle, getRGBVisibility, getSwatchesVisibility, getTextfieldVisibility, getValue, hidePopup, isDefaultCaptionEnabled, readDesign, setDefaultCaptionEnabled, setHistoryVisibility, setHSVVisibility, setPopupStyle, setPosition, setRGBVisibility, setSwatchesVisibility, setTextfieldVisibility, setValue, showPopup, showPopup, writeDesign

Methods inherited from class com.vaadin.ui.AbstractField

addValueChangeListener, createValueChange, focus, getTabIndex, isDifferentValue, isReadOnly, isRequiredIndicatorVisible, setReadOnly, setRequiredIndicatorVisible, setTabIndex, setValue

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, attach, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeight, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setStyleName, setVisible, setWidth, setWidth, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.data.HasValue

clear, getDefaultValidator, getOptionalValue, isEmpty

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setVisible

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Constructor Detail

ColorPickerArea

public ColorPickerArea()

Instantiates a new color picker.

ColorPickerArea

public ColorPickerArea(String popupCaption)

Instantiates a new color picker.

Parameters:

popupCaption - caption of the color select popup

ColorPickerArea

public ColorPickerArea(String popupCaption,
                       Color initialColor)

Instantiates a new color picker.

Parameters:

popupCaption - caption of the color select popup

initialColor - the initial color

Method Detail

setDefaultStyles

protected void setDefaultStyles()

Description copied from class: AbstractColorPicker

Sets the default styles of the component.

Specified by:

setDefaultStyles in class AbstractColorPicker

beforeClientResponse

public void beforeClientResponse(boolean initial)

Description copied from interface: ClientConnector

Called before the shared state and RPC invocations are sent to the client. Gives the connector an opportunity to set computed/dynamic state values or to invoke last minute RPC methods depending on other component features.

Specified by:

beforeClientResponse in interface ClientConnector

Overrides:

beforeClientResponse in class AbstractComponent

Parameters:

initial - true if the client-side connector will be created and initialized after this method has been invoked. false if there is already an initialized client-side connector.

getState

protected ColorPickerAreaState getState()

Description copied from class: AbstractComponent

Returns the shared state bean with information to be sent from the server to the client. Subclasses should override this method and set any relevant fields of the state returned by super.getState().

Overrides:

getState in class AbstractColorPicker

Returns:

updated component shared state

getState

protected ColorPickerAreaState getState(boolean markAsDirty)

Description copied from class: AbstractClientConnector

Returns the shared state for this connector.

Overrides:

getState in class AbstractColorPicker

Parameters:

markAsDirty - true if the connector should automatically be marked dirty, false otherwise

Returns:

The shared state for this connector. Never null.

See Also:

AbstractClientConnector.getState()