com.sencha.gxt.widget.core.client

Class ColorPalette

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.sencha.gxt.widget.core.client.Component

com.sencha.gxt.widget.core.client.cell.CellComponent<String>

com.sencha.gxt.widget.core.client.ColorPalette

All Implemented Interfaces:

Editor<String>, LeafValueEditor<String>, HasAttachHandlers, HasResizeHandlers, HasSelectionHandlers<String>, HasValueChangeHandlers<String>, HasHandlers, EventListener, TakesValue<String>, HasEnabled, HasValue<String>, HasVisibility, IsWidget, HasKeyProvider<String>, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasItemId

public class ColorPalette
extends CellComponent<String>
implements HasSelectionHandlers<String>

A cell component that displays a palette of colors and allows the user to select one.

To be notified when the user selects a color, add a value change handler. See CellComponent.addValueChangeHandler(ValueChangeHandler) for more information.

To set the currently selected color, see CellComponent.setValue(Object).

To get the currently selected color, see CellComponent.getValue().

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.editor.client.Editor

Editor.Ignore, Editor.Path

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
ColorPalette() Creates a new color palette with default colors.
ColorPalette(ColorPaletteCell cell) Creates a new color palette CellComponent with the specified color palette Cell.
ColorPalette(String[] colors, String[] labels) Creates a new color palette with the specified colors.

Method Summary

Methods

Modifier and Type	Method and Description
HandlerRegistration	addSelectionHandler(SelectionHandler<String> handler)

Methods inherited from class com.sencha.gxt.widget.core.client.cell.CellComponent

addValueChangeHandler, getCell, getElement, getKeyProvider, getValue, onBrowserEvent, redraw, setValue, setValue, setValue

Methods inherited from class com.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleOnOver, clearSizeCache, disable, disableEvents, enable, enableEvents, fireEvent, focus, getData, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isRendered, isStateful, isVisible, isVisible, mask, mask, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setTabIndex, setToolTip, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, getLayoutData, getParent, isAttached, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, removeStyleName, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

ColorPalette

public ColorPalette()

Creates a new color palette with default colors.

ColorPalette

public ColorPalette(ColorPaletteCell cell)

Creates a new color palette CellComponent with the specified color palette Cell.

Parameters:

cell - the color palette appearance

ColorPalette

public ColorPalette(String[] colors,
            String[] labels)

Creates a new color palette with the specified colors.

Parameters:

colors - the colors, each consisting of a six digit hex value in RRGGBB format

labels - the color names, in the same order as colors

Method Detail

addSelectionHandler

public HandlerRegistration addSelectionHandler(SelectionHandler<String> handler)

Specified by:

addSelectionHandler in interface HasSelectionHandlers<String>