com.sencha.gxt.widget.core.client

Class ColorPaletteCell

java.lang.Object

com.google.gwt.cell.client.AbstractCell<C>

com.google.gwt.cell.client.AbstractEditableCell<String,String>

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

All Implemented Interfaces:

Cell<String>, HasSelectionHandlers<String>, HasHandlers, DisableCell

public class ColorPaletteCell
extends AbstractEditableCell<String,String>
implements HasSelectionHandlers<String>, 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.

Nested classes/interfaces inherited from interface com.google.gwt.cell.client.Cell

Cell.Context

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

Methods

Modifier and Type	Method and Description
HandlerRegistration	addSelectionHandler(SelectionHandler<String> handler)
void	disable(Cell.Context context, Element parent)
void	enable(Cell.Context context, Element parent)
void	fireEvent(GwtEvent<?> event)
ColorPaletteCell.ColorPaletteAppearance	getAppearance()
String[]	getColors() Returns the colors.
String[]	getLabels() Returns the labels.
boolean	isEditing(Cell.Context context, Element parent, String value)
void	onBrowserEvent(Cell.Context context, Element parent, String value, NativeEvent event, ValueUpdater<String> valueUpdater)
void	render(Cell.Context context, String value, SafeHtmlBuilder sb)
void	select(XElement parent, Cell.Context context, String color, String value, ValueUpdater<String> valueUpdater) Selects the color.
void	select(XElement parent, Cell.Context context, String newValue, String currentValue, ValueUpdater<String> valueUpdater, boolean suppressEvent) Selects the color.

Methods inherited from class com.google.gwt.cell.client.AbstractEditableCell

clearViewData, getViewData, setViewData

Methods inherited from class com.google.gwt.cell.client.AbstractCell

dependsOnSelection, getConsumedEvents, handlesSelection, resetFocus, setValue

Methods inherited from class java.lang.Object

equals, 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(SelectionHandler<String> handler)

Specified by:

addSelectionHandler in interface HasSelectionHandlers<String>

disable

public void disable(Cell.Context context,
           Element parent)

Specified by:

disable in interface DisableCell

enable

public void enable(Cell.Context context,
          Element parent)

Specified by:

enable in interface DisableCell

fireEvent

public void fireEvent(GwtEvent<?> event)

Specified by:

fireEvent in interface HasHandlers

getAppearance

public ColorPaletteCell.ColorPaletteAppearance getAppearance()

getColors

public String[] getColors()

Returns the colors.

Returns:

the colors

getLabels

public String[] getLabels()

Returns the labels.

Returns:

the labels

isEditing

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

Specified by:

isEditing in interface Cell<String>

Specified by:

isEditing in class AbstractEditableCell<String,String>

onBrowserEvent

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

Specified by:

onBrowserEvent in interface Cell<String>

Overrides:

onBrowserEvent in class AbstractCell<String>

render

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

Specified by:

render in interface Cell<String>

Specified by:

render in class AbstractCell<String>

select

public void select(XElement parent,
          Cell.Context context,
          String color,
          String value,
          ValueUpdater<String> 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,
          Cell.Context context,
          String newValue,
          String currentValue,
          ValueUpdater<String> 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