edu.ucdavis.cstars.client.renderer

Class UniqueValueRenderer

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.renderer.Renderer

edu.ucdavis.cstars.client.renderer.UniqueValueRenderer

public class UniqueValueRenderer
extends Renderer

A unique value renderer symbolizes groups of graphics that have matching attributes.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UniqueValueRenderer.Info

Method Summary

Methods

Modifier and Type	Method and Description
void	addValue(java.lang.String value, Symbol symbol) Adds a unique value and symbol.
void	addValue(UniqueValueRenderer.Info info) Adds a unique value and symbol.You can provide the value and its associated symbol as an info object.
static UniqueValueRenderer	create(Symbol defaultSymbol, java.lang.String attributeField) Creates a new UniqueValueRenderer object.
static UniqueValueRenderer	create(Symbol defaultSymbol, java.lang.String attributeField, java.lang.String attributeField2, java.lang.String attributeField3, java.lang.String fieldDelimeter) Creates a new UniqueValueRenderer object.
java.lang.String	getAttributeField() The name of the attribute field the renderer uses to match values against.
java.lang.String	getAttributeField2() If needed, specify an additional attribute field the renderer uses to match values.
java.lang.String	getAttributeField3() If needed, specify an additional attribute field the renderer uses to match values.
java.lang.String	getDefaultLabel() Label for the default symbol used to draw unspecified values.
java.lang.String	getFieldDelimiter() String inserted between the values if multiple attribute fields are specified.
com.google.gwt.core.client.JsArray<UniqueValueRenderer.Info>	getInfos() Each element in the array is an object that provides information about the unique values associated with the renderer.
com.google.gwt.core.client.JsArrayString	getValues() Deprecated. at v2.0, use infos instead.
void	removeValue(java.lang.String value) Removes a unique value.

Methods inherited from class edu.ucdavis.cstars.client.renderer.Renderer

fromJson, getDefaultSymbol, getSymbol, toJson

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static final UniqueValueRenderer create(Symbol defaultSymbol,
                         java.lang.String attributeField)

Creates a new UniqueValueRenderer object. Typically features are rendered based on the unique values of one attribute field. However up to three fields can be combined to generate a unique value. For example, if two fields are used which store the values A and B; and X, Y, and Z respectively, then the unique values for the renderer can be A:X, A:Y, A:Z, B:X, B:Y and B:Z, assuming ":" is the field delimiter.

Parameters:

defaultSymbol - - Default symbol for the renderer. This symbol is used for unmatched values.

attributeField - - Attribute field renderer uses to match values.

Returns:

UniqueValueRenderer

create

public static final UniqueValueRenderer create(Symbol defaultSymbol,
                         java.lang.String attributeField,
                         java.lang.String attributeField2,
                         java.lang.String attributeField3,
                         java.lang.String fieldDelimeter)

Creates a new UniqueValueRenderer object. Typically features are rendered based on the unique values of one attribute field. However up to three fields can be combined to generate a unique value. For example, if two fields are used which store the values A and B; and X, Y, and Z respectively, then the unique values for the renderer can be A:X, A:Y, A:Z, B:X, B:Y and B:Z, assuming ":" is the field delimiter.

Parameters:

defaultSymbol - - Default symbol for the renderer. This symbol is used for unmatched values.

attributeField - - Attribute field renderer uses to match values.

attributeField2 - - If needed, specify an additional attribute field the renderer uses to match values.

attributeField3 - - If needed, specify an additional attribute field the renderer uses to match values.

fieldDelimeter - - String inserted between the values of different fields. Applicable only when more than one attribute field is specifed for the renderer.

Returns:

UniqueValueRenderer

getAttributeField

public final java.lang.String getAttributeField()

The name of the attribute field the renderer uses to match values against.

Returns:

String

getAttributeField2

public final java.lang.String getAttributeField2()

If needed, specify an additional attribute field the renderer uses to match values.

Returns:

String

getAttributeField3

public final java.lang.String getAttributeField3()

If needed, specify an additional attribute field the renderer uses to match values.

Returns:

String

getDefaultLabel

public final java.lang.String getDefaultLabel()

Label for the default symbol used to draw unspecified values.

Returns:

String

getFieldDelimiter

public final java.lang.String getFieldDelimiter()

String inserted between the values if multiple attribute fields are specified.

Returns:

String

getInfos

public final com.google.gwt.core.client.JsArray<UniqueValueRenderer.Info> getInfos()

Each element in the array is an object that provides information about the unique values associated with the renderer.

Returns:

JsArray

getValues

@Deprecated
public final com.google.gwt.core.client.JsArrayString getValues()

Deprecated. at v2.0, use infos instead.

An array of values defined for the renderer.

Returns:

JsArrayString

addValue

public final void addValue(java.lang.String value,
            Symbol symbol)

Adds a unique value and symbol. You can provide the value and its associated symbol as individual arguments.

Parameters:

value - - Value to match with.

symbol - - Symbol used for the value.

addValue

public final void addValue(UniqueValueRenderer.Info info)

Adds a unique value and symbol.You can provide the value and its associated symbol as an info object.

Parameters:

info - - object to be added.

removeValue

public final void removeValue(java.lang.String value)

Removes a unique value. After making changes, you must refresh the graphic.

Parameters:

value - - Value to remove.