com.telerik.widget.palettes

Class PaletteEntry

java.lang.Object

com.telerik.widget.palettes.PaletteEntry

public class PaletteEntry
extends Object

A combination of colors for a given chart element.

Constructor Summary

Constructors

Constructor and Description
PaletteEntry() Creates an instance of PaletteEntry with transparent colors.
PaletteEntry(int fill) Creates an instance of PaletteEntry with transparent colors and the specified fill.
PaletteEntry(int fill, int stroke) Creates an instance of PaletteEntry with transparent colors and the specified fill and stroke.
PaletteEntry(int fill, int stroke, int additionalFill) Creates an instance of PaletteEntry with transparent colors and the specified fill, stroke and additional fill.
PaletteEntry(int fill, int stroke, int additionalFill, int additionalStroke) Creates an instance of PaletteEntry with the specified colors.
PaletteEntry(int fill, int stroke, int additionalFill, int additionalStroke, float strokeWidth) Creates an instance of PaletteEntry with the specified colors.
PaletteEntry(PaletteEntry entry) Copy constructor.

Method Summary

Modifier and Type	Method and Description
PaletteEntry	clone()
int	getAdditionalFill() Gets the additional fill color.
int	getAdditionalStroke() Gets the additional stroke color.
String	getCustomValue(String keyName) Gets a value for the provided key in the current PaletteEntry.
String	getCustomValue(String keyName, Object defaultValue) Gets a value for the provided key in the current PaletteEntry.
String	getCustomValue(String keyName, String defaultValue) Gets a value for the provided key in the current PaletteEntry.
int	getFill() Gets the fill color.
int	getStroke() Gets the stroke color.
float	getStrokeWidth() Gets the width of the stroke.
void	setAdditionalFill(int value) Sets the additional fill color.
void	setAdditionalStroke(int value) Sets the additional stroke color.
void	setCustomValue(String keyName, Object value) Sets a value for the provided key in the current PaletteEntry.
void	setCustomValue(String keyName, String value) Sets a value for the provided key in the current PaletteEntry.
void	setFill(int value) Sets the fill color.
void	setStroke(int value) Sets the stroke color.
void	setStrokeWidth(float value) Sets the width of the stroke.

Methods inherited from class java.lang.Object

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

Constructor Detail

PaletteEntry

public PaletteEntry()

Creates an instance of PaletteEntry with transparent colors.

PaletteEntry

public PaletteEntry(int fill)

Creates an instance of PaletteEntry with transparent colors and the specified fill.

PaletteEntry

public PaletteEntry(int fill,
                    int stroke)

Creates an instance of PaletteEntry with transparent colors and the specified fill and stroke.

PaletteEntry

public PaletteEntry(int fill,
                    int stroke,
                    int additionalFill)

Creates an instance of PaletteEntry with transparent colors and the specified fill, stroke and additional fill.

PaletteEntry

public PaletteEntry(int fill,
                    int stroke,
                    int additionalFill,
                    int additionalStroke)

Creates an instance of PaletteEntry with the specified colors.

PaletteEntry

public PaletteEntry(int fill,
                    int stroke,
                    int additionalFill,
                    int additionalStroke,
                    float strokeWidth)

Creates an instance of PaletteEntry with the specified colors.

PaletteEntry

public PaletteEntry(PaletteEntry entry)

Copy constructor.

Method Detail

getStrokeWidth

public float getStrokeWidth()

Gets the width of the stroke.

Returns:

the stroke width.

setStrokeWidth

public void setStrokeWidth(float value)

Sets the width of the stroke.

Parameters:

value - the stroke width.

getFill

public int getFill()

Gets the fill color.

setFill

public void setFill(int value)

Sets the fill color.

getStroke

public int getStroke()

Gets the stroke color.

setStroke

public void setStroke(int value)

Sets the stroke color.

getAdditionalFill

public int getAdditionalFill()

Gets the additional fill color.

setAdditionalFill

public void setAdditionalFill(int value)

Sets the additional fill color.

getAdditionalStroke

public int getAdditionalStroke()

Gets the additional stroke color.

setAdditionalStroke

public void setAdditionalStroke(int value)

Sets the additional stroke color.

getCustomValue

public String getCustomValue(String keyName)

Gets a value for the provided key in the current PaletteEntry. This method can be used by Chart elements that do not rely on the standard PaletteEntry API for retrieving values.

Parameters:

keyName - the name of the key for which to retrieve the provided value.

Returns:

the value stored for the provided key. null if there is no value present for the key.

getCustomValue

public String getCustomValue(String keyName,
                             String defaultValue)

Gets a value for the provided key in the current PaletteEntry. This method can be used by Chart elements that do not rely on the standard PaletteEntry API for retrieving values.

Parameters:

keyName - the name of the key for which to retrieve the provided value.

defaultValue - the default value that will be returned if no custom value is present for the provided key.

Returns:

the value stored for the provided key. null if there is no value present for the key.

getCustomValue

public String getCustomValue(String keyName,
                             Object defaultValue)

Gets a value for the provided key in the current PaletteEntry. This method can be used by Chart elements that do not rely on the standard PaletteEntry API for retrieving values.

Parameters:

keyName - the name of the key for which to retrieve the provided value.

defaultValue - the default value that will be returned if no custom value is present for the provided key.

Returns:

the value stored for the provided key. null if there is no value present for the key.

setCustomValue

public void setCustomValue(String keyName,
                           String value)

Sets a value for the provided key in the current PaletteEntry. This method can be used by Chart elements that do not rely on the standard PaletteEntry API for storing values.

Parameters:

keyName - the name of the key for which to store the provided value.

value - the string value to store.

setCustomValue

public void setCustomValue(String keyName,
                           Object value)

Sets a value for the provided key in the current PaletteEntry. This method can be used by Chart elements that do not rely on the standard PaletteEntry API for storing values.

Parameters:

keyName - the name of the key for which to store the provided value.

value - the value to store.

clone

public PaletteEntry clone()

Overrides:

clone in class Object