com.sencha.gxt.widget.core.client

Class ColorPaletteCell

java.lang.Object

<any>

com.sencha.gxt.widget.core.client.ColorPaletteCell

All Implemented Interfaces:

DisableCell

public class ColorPaletteCell
extends <any>
implements DisableCell

A Cell Widget representing a palette of colors.

Note: the word Cell in the class name refers to a GWT cell, not an individual cell in a color palette.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ColorPaletteCell.ColorPaletteAppearance The appearance of a color palette.

Constructor Summary

Constructors

Constructor and Description
ColorPaletteCell() Creates a color palette cell with a default set of colors.
ColorPaletteCell(ColorPaletteCell.ColorPaletteAppearance appearance) Creates a color palette cell with the specified appearance.
ColorPaletteCell(ColorPaletteCell.ColorPaletteAppearance appearance, String[] colors, String[] labels) Creates a color palette cell with the specified appearance, colors and labels.
ColorPaletteCell(String[] colors, String[] labels) Creates a new color palette.

Method Summary

Modifier and Type	Method and Description
HandlerRegistration	addSelectionHandler(<any> handler)
protected HandlerManager	createHandlerManager() Creates the HandlerManager used by this Widget.
void	disable(Context context, Element parent)
void	enable(Context context, Element parent)
protected HandlerManager	ensureHandlers() Ensures the existence of the handler manager.
void	fireEvent(<any> event)
ColorPaletteCell.ColorPaletteAppearance	getAppearance()
String[]	getColors() Returns the colors.
Set<String>	getConsumedEvents()
String[]	getLabels() Returns the labels.
boolean	isEditing(Context context, Element parent, String value)
protected void	onBlur(Context context, XElement parent, String currentValue, NativeEvent event, <any> valueUpdater)
void	onBrowserEvent(Context context, Element parent, String value, NativeEvent event, <any> valueUpdater)
protected void	onClick(Context context, XElement parent, String currentValue, NativeEvent event, <any> valueUpdater)
protected void	onFocus(Context context, XElement parent, String currentValue, NativeEvent event, <any> valueUpdater)
protected void	onKeyDown(Context context, XElement parent, String currentValue, NativeEvent event, <any> valueUpdater)
protected void	onKeyLeft(Context context, XElement parent, String currentValue, NativeEvent event, <any> valueUpdater)
protected void	onKeyRight(Context context, XElement parent, String currentValue, NativeEvent event, <any> valueUpdater)
protected void	onKeyUp(Context context, XElement parent, String currentValue, NativeEvent event, <any> valueUpdater)
protected void	onMouseOut(Context context, XElement parent, String currentValue, NativeEvent event, <any> valueUpdater)
protected void	onMouseOver(Context context, XElement parent, String currentValue, NativeEvent event, <any> valueUpdater)
void	render(Context context, String value, SafeHtmlBuilder sb)
void	select(XElement parent, Context context, String color, String value, <any> valueUpdater) Selects the color.
void	select(XElement parent, Context context, String newValue, String currentValue, <any> valueUpdater, boolean suppressEvent) Selects the color.

Methods inherited from class java.lang.Object

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

Constructor Detail

ColorPaletteCell

public ColorPaletteCell()

Creates a color palette cell with a default set of colors.

ColorPaletteCell

public ColorPaletteCell(ColorPaletteCell.ColorPaletteAppearance appearance)

Creates a color palette cell with the specified appearance.

Parameters:

appearance - the color palette appearance

ColorPaletteCell

public ColorPaletteCell(ColorPaletteCell.ColorPaletteAppearance appearance,
                        String[] colors,
                        String[] labels)

Creates a color palette cell with the specified appearance, colors and labels.

Parameters:

appearance - the color palette appearance

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

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

ColorPaletteCell

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

Creates a new color palette.

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(<any> handler)

disable

public void disable(Context context,
                    Element parent)

Specified by:

disable in interface DisableCell

enable

public void enable(Context context,
                   Element parent)

Specified by:

enable in interface DisableCell

fireEvent

public void fireEvent(<any> event)

getAppearance

public ColorPaletteCell.ColorPaletteAppearance getAppearance()

getColors

public String[] getColors()

Returns the colors.

Returns:

the colors

getConsumedEvents

public Set<String> getConsumedEvents()

getLabels

public String[] getLabels()

Returns the labels.

Returns:

the labels

isEditing

public boolean isEditing(Context context,
                         Element parent,
                         String value)

onBrowserEvent

public void onBrowserEvent(Context context,
                           Element parent,
                           String value,
                           NativeEvent event,
                           <any> valueUpdater)

render

public void render(Context context,
                   String value,
                   SafeHtmlBuilder sb)

select

public void select(XElement parent,
                   Context context,
                   String color,
                   String value,
                   <any> valueUpdater)

Selects the color.

Parameters:

parent - the parent of the color element to select

context - information about the context of the cell

color - the color of the element to select

value - the currently selected value

valueUpdater - the cell's value updater which will receive the new value

select

public void select(XElement parent,
                   Context context,
                   String newValue,
                   String currentValue,
                   <any> valueUpdater,
                   boolean suppressEvent)

Selects the color.

Parameters:

parent - the parent of the color element to select

context - information about the context of the cell

newValue - the color of the element to select

currentValue - the current cell value

valueUpdater - the cell's value updater which will receive the new value

suppressEvent - true to suppress the select event

createHandlerManager

protected HandlerManager createHandlerManager()

Creates the HandlerManager used by this Widget. You can override this method to create a custom HandlerManager.

Returns:

the HandlerManager you want to use

onBlur

protected void onBlur(Context context,
                      XElement parent,
                      String currentValue,
                      NativeEvent event,
                      <any> valueUpdater)

onClick

protected void onClick(Context context,
                       XElement parent,
                       String currentValue,
                       NativeEvent event,
                       <any> valueUpdater)

onFocus

protected void onFocus(Context context,
                       XElement parent,
                       String currentValue,
                       NativeEvent event,
                       <any> valueUpdater)

onKeyDown

protected void onKeyDown(Context context,
                         XElement parent,
                         String currentValue,
                         NativeEvent event,
                         <any> valueUpdater)

onKeyLeft

protected void onKeyLeft(Context context,
                         XElement parent,
                         String currentValue,
                         NativeEvent event,
                         <any> valueUpdater)

onKeyRight

protected void onKeyRight(Context context,
                          XElement parent,
                          String currentValue,
                          NativeEvent event,
                          <any> valueUpdater)

onKeyUp

protected void onKeyUp(Context context,
                       XElement parent,
                       String currentValue,
                       NativeEvent event,
                       <any> valueUpdater)

onMouseOut

protected void onMouseOut(Context context,
                          XElement parent,
                          String currentValue,
                          NativeEvent event,
                          <any> valueUpdater)

onMouseOver

protected void onMouseOver(Context context,
                           XElement parent,
                           String currentValue,
                           NativeEvent event,
                           <any> valueUpdater)

ensureHandlers

protected HandlerManager ensureHandlers()

Ensures the existence of the handler manager.

Returns:

the handler manager