nextapp.echo2.extras.app
Class ColorSelect

java.lang.Object
  Component
      nextapp.echo2.extras.app.ColorSelect

public class ColorSelect
extends Component

A visual hue/saturation/value-based color selection component to select RGB colors.

Field Summary

static java.lang.String	COLOR_CHANGED_PROPERTY
static java.lang.String	PROPERTY_DISPLAY_VALUE
static java.lang.String	PROPERTY_HUE_WIDTH
static java.lang.String	PROPERTY_SATURATION_HEIGHT
static java.lang.String	PROPERTY_VALUE_WIDTH

Constructor Summary

ColorSelect()
Creates a new ColorSelect with an initially selected color of Color.WHITE.

ColorSelect(Color color)
Creates a new ColorSelect with the specified color initially selected.

Method Summary

Color	getColor() Retrieves the selected color.
Extent	getHueWidth() Retrieves the width of the hue selector (the spectrum gradient drawn on the right side of the ColorSelector).
Extent	getSaturationHeight() Retrieves the height of the saturation/value selector (the saturation axis is vertical).
Extent	getValueWidth() Retrieves the width of the saturation/value selector (the value axis is horizontal).
boolean	isDisplayValue() Sets whether the hex-triplet value, e.g., '#123abc' is displayed at the bottom of the ColorSelect.
void	processInput(java.lang.String inputName, java.lang.Object inputValue)
void	setColor(Color newValue) Sets the selected color.
void	setDisplayValue(boolean newValue) Sets whether the hex-triplet value, e.g., '#123abc' is displayed at the bottom of the ColorSelect.
void	setHueWidth(Extent newValue) Sets the width of the hue selector (the spectrum gradient drawn on the right side of the ColorSelector).
void	setSaturationHeight(Extent newValue) Sets the height of the saturation/value selector (the saturation axis is vertical).
void	setValueWidth(Extent newValue) Sets the width of the saturation/value selector (the value axis is horizontal).

Methods inherited from class java.lang.Object

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

Field Detail

COLOR_CHANGED_PROPERTY

public static final java.lang.String COLOR_CHANGED_PROPERTY

See Also:

Constant Field Values

PROPERTY_HUE_WIDTH

public static final java.lang.String PROPERTY_HUE_WIDTH

See Also:

Constant Field Values

PROPERTY_SATURATION_HEIGHT

public static final java.lang.String PROPERTY_SATURATION_HEIGHT

See Also:

Constant Field Values

PROPERTY_VALUE_WIDTH

public static final java.lang.String PROPERTY_VALUE_WIDTH

See Also:

Constant Field Values

PROPERTY_DISPLAY_VALUE

public static final java.lang.String PROPERTY_DISPLAY_VALUE

See Also:

Constant Field Values

Constructor Detail

ColorSelect

public ColorSelect()

Creates a new ColorSelect with an initially selected color of Color.WHITE.

ColorSelect

public ColorSelect(Color color)

Creates a new ColorSelect with the specified color initially selected.

Parameters:

color - the initially selected color

Method Detail

getColor

public Color getColor()

Retrieves the selected color.

Returns:

the selected color

getHueWidth

public Extent getHueWidth()

Retrieves the width of the hue selector (the spectrum gradient drawn on the right side of the ColorSelector). Note that the height of the hue selector is determined by the height of the value selector. Values may only be specified in pixels. The default value is 20 pixels.

Returns:

the width

getSaturationHeight

public Extent getSaturationHeight()

Retrieves the height of the saturation/value selector (the saturation axis is vertical). Values may only be specified in pixels. The default value is 150 pixels.

Returns:

the height

getValueWidth

public Extent getValueWidth()

Retrieves the width of the saturation/value selector (the value axis is horizontal). Values may only be specified in pixels. The default value is 150 pixels.

Returns:

the width

isDisplayValue

public boolean isDisplayValue()

Sets whether the hex-triplet value, e.g., '#123abc' is displayed at the bottom of the ColorSelect. Default value is true.

Returns:

true if the hex-triplet value should be displayed

processInput

public void processInput(java.lang.String inputName,
                         java.lang.Object inputValue)

See Also:

nextapp.echo2.app.Component#processInput(java.lang.String, java.lang.Object)

setColor

public void setColor(Color newValue)

Sets the selected color.

Parameters:

newValue - the new color

setDisplayValue

public void setDisplayValue(boolean newValue)

Sets whether the hex-triplet value, e.g., '#123abc' is displayed at the bottom of the ColorSelect. Default value is true.

Parameters:

newValue - true if the hex-triplet value should be displayed

setHueWidth

public void setHueWidth(Extent newValue)

Sets the width of the hue selector (the spectrum gradient drawn on the right side of the ColorSelector). Note that the height of the hue selector is determined by the height of the value selector. Values may only be specified in pixels. The default value is 20 pixels.

Parameters:

newValue - the new width

setSaturationHeight

public void setSaturationHeight(Extent newValue)

Sets the height of the saturation/value selector (the saturation axis is vertical). Values may only be specified in pixels. The default value is 150 pixels.

Parameters:

newValue - the new height

setValueWidth

public void setValueWidth(Extent newValue)

Sets the width of the saturation/value selector (the value axis is horizontal). Values may only be specified in pixels. The default value is 150 pixels.

Parameters:

newValue - the new width