com.sencha.gxt.widget.core.client

Interface ColorPaletteCell.ColorPaletteAppearance

All Known Implementing Classes:

BlueColorPaletteAppearance, ColorPaletteBaseAppearance, GrayColorPaletteAppearance

Enclosing class:

ColorPaletteCell

public static interface ColorPaletteCell.ColorPaletteAppearance

The appearance of a color palette. The color palette consists of elements that are arranged in a grid and can be selected using the keyboard or mouse.

Method Summary

Modifier and Type	Method and Description
String	getAboveColor(XElement parent, String value) Gets the color of the element above the specified element.
String	getBelowColor(XElement parent, String value) Gets the color of the element below the specified element.
XElement	getChildElement(XElement parent, String color) Gets the child element with the specified color.
String	getClickedColor(XElement parent, Element target) Gets the color associated with the specified child element.
Element	getColorElement(XElement parent, Element target) Gets the color element associated with the specified child element.
<any>	getColorElements(XElement parent) Gets the list of color elements for the specified parent.
String	getLeftColor(XElement parent, String value) Gets the color of the element to the left of the specified element.
String	getRightColor(XElement parent, String value) Gets the color of the element to the right of the specified element.
void	hover(XElement parent, Element target, boolean entering) Modifies the appearance to indicate whether the specified child color element is being hovered over.
void	onMouseOut(XElement parent, Element target) Modifies the appearance to indicate that the mouse has moved off the specified child color element.
void	onMouseOver(XElement parent, Element target) Modifies the appearance to indicate that the mouse has moved over the specified child color element.
void	render(Context context, String value, String[] colors, String[] labels, SafeHtmlBuilder builder) Renders the appearance of a color palette cell as HTML into a SafeHtmlBuilder, suitable for passing to Element#setInnerHTML(String) on a container element.

Method Detail

getAboveColor

String getAboveColor(XElement parent,
                     String value)

Gets the color of the element above the specified element. The element is specified by its parent and color.

Parameters:

parent - the parent of the specified element

value - the color of the specified element

Returns:

the color of the element above the specified element

getBelowColor

String getBelowColor(XElement parent,
                     String value)

Gets the color of the element below the specified element. The element is specified by its parent and color.

Parameters:

parent - the parent of the specified element

value - the color of the specified element

Returns:

the color of the element below the specified element

getChildElement

XElement getChildElement(XElement parent,
                         String color)

Gets the child element with the specified color.

Parameters:

parent - the parent of the child element

color - the color

Returns:

the child element with the specified color

getClickedColor

String getClickedColor(XElement parent,
                       Element target)

Gets the color associated with the specified child element.

Parameters:

parent - the parent

target - the child

Returns:

the color of the child element

getColorElement

Element getColorElement(XElement parent,
                        Element target)

Gets the color element associated with the specified child element.

Parameters:

parent - the parent

target - the child

Returns:

the color element of the child element

getColorElements

<any> getColorElements(XElement parent)

Gets the list of color elements for the specified parent.

Parameters:

parent - the parent

Returns:

a list of color elements for the parent

getLeftColor

String getLeftColor(XElement parent,
                    String value)

Gets the color of the element to the left of the specified element. The element is specified by its parent and color.

Parameters:

parent - the parent of the specified element

value - the color of the specified element

Returns:

the color of the element to the left of the specified element

getRightColor

String getRightColor(XElement parent,
                     String value)

Gets the color of the element to the right of the specified element. The element is specified by its parent and color.

Parameters:

parent - the parent of the specified element

value - the color of the specified element

Returns:

the color of the element to the right of the specified element

hover

void hover(XElement parent,
           Element target,
           boolean entering)

Modifies the appearance to indicate whether the specified child color element is being hovered over.

Parameters:

parent - the parent

target - the child

entering - true to indicate the hover has just started

onMouseOut

void onMouseOut(XElement parent,
                Element target)

Modifies the appearance to indicate that the mouse has moved off the specified child color element.

Parameters:

parent - the parent

target - the child

onMouseOver

void onMouseOver(XElement parent,
                 Element target)

Modifies the appearance to indicate that the mouse has moved over the specified child color element.

Parameters:

parent - the parent

target - the child

render

void render(Context context,
            String value,
            String[] colors,
            String[] labels,
            SafeHtmlBuilder builder)

Renders the appearance of a color palette cell as HTML into a SafeHtmlBuilder, suitable for passing to Element#setInnerHTML(String) on a container element.

Parameters:

context - contains information about context of the element

value - the color of the currently selected element

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

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

builder - receives the rendered appearance