edu.ucdavis.cstars.client

Class Graphic

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.Graphic

public class Graphic
extends com.google.gwt.core.client.JavaScriptObject

A Graphic can contain geometry, a symbol, attributes, or an infoTemplate. A Graphic is displayed in the GraphicsLayer. The GraphicsLayer allows you to listen for events on Graphics.

Author:

lsimone, Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Graphic.Attributes

Method Summary

Methods

Modifier and Type	Method and Description
static Graphic	create(Geometry geometry, Symbol symbol) Creates a new Graphic object.
static Graphic	create(Geometry geometry, Symbol symbol, Graphic.Attributes attrs, InfoTemplate infoTemplate) Creates a new Graphic object.
static Graphic	create(com.google.gwt.core.client.JavaScriptObject json) Creates a new Graphic object using a JSON object.
Graphic.Attributes	getAttributes() Name value pairs of fields and field values associated with the graphic.
java.lang.String	getContent() Returns the content string based on attributes and infoTemplate values.
Shape	getDojoShape() Returns the Dojo gfx shape of the ESRI graphic.
Geometry	getGeometry() The geometry that defines the graphic.
InfoTemplate	getInfoTemplate() The content for display in an InfoWindow.
GraphicsLayer	getLayer() Returns the graphics layer that contains the graphic.
Symbol	getSymbol() The symbol for the graphic.
java.lang.String	getTitle() Returns the title string based on attributes and infoTemplate values.
void	hide() Hides the graphic.
boolean	isVisible() Indicate the visiblity of the graphic.
Graphic	setAttributes(Graphic.Attributes attrs) Defines the attributes of the graphic.
Graphic	setGeometry(Geometry geometry) Defines the geometry of the graphic.
Graphic	setInfoTemplate(InfoTemplate infoTemplate) Defines the InfoTemplate for the InfoWindow of the graphic.
Graphic	setSymbol(Symbol symbol) Sets the symbol of the graphic.
void	show() Shows the graphic.
com.google.gwt.core.client.JavaScriptObject	toJson() Converts object to its ArcGIS Server JSON representation.

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 Graphic create(Geometry geometry,
             Symbol symbol)

Creates a new Graphic object. All parameters are required and must be specified in the order given.

Parameters:

geometry - - The geometry that defines the graphic.

symbol - - Symbol used for drawing the graphic.

Returns:

Graphic

create

public static Graphic create(Geometry geometry,
             Symbol symbol,
             Graphic.Attributes attrs,
             InfoTemplate infoTemplate)

Creates a new Graphic object. All parameters are required and must be specified in the order given.

Parameters:

geometry - - The geometry that defines the graphic.

symbol - - Symbol used for drawing the graphic.

attrs - - Name value pairs of fields and field values associated with the graphic.

infoTemplate - - The content for display in an InfoWindow.

Returns:

Graphic

create

public static Graphic create(com.google.gwt.core.client.JavaScriptObject json)

Creates a new Graphic object using a JSON object.

Parameters:

json - - JSON object representing the graphic.

Returns:

Graphic

getAttributes

public final Graphic.Attributes getAttributes()

Name value pairs of fields and field values associated with the graphic.

Returns:

Attributes

getGeometry

public final Geometry getGeometry()

The geometry that defines the graphic.

Returns:

Geometry

getInfoTemplate

public final InfoTemplate getInfoTemplate()

The content for display in an InfoWindow.

Returns:

InfoTemplate

getSymbol

public final Symbol getSymbol()

The symbol for the graphic.

Returns:

Symbol

isVisible

public final boolean isVisible()

Indicate the visiblity of the graphic. The default value is true.

Returns:

boolean

getContent

public final java.lang.String getContent()

Returns the content string based on attributes and infoTemplate values.

Returns:

String

getDojoShape

public final Shape getDojoShape()

Returns the Dojo gfx shape of the ESRI graphic.

Returns:

Shape

getLayer

public final GraphicsLayer getLayer()

Returns the graphics layer that contains the graphic. Returns null if the graphic is not added to a layer.

Returns:

GraphicsLayer

getTitle

public final java.lang.String getTitle()

Returns the title string based on attributes and infoTemplate values.

Returns:

String

hide

public final void hide()

Hides the graphic.

setAttributes

public final Graphic setAttributes(Graphic.Attributes attrs)

Defines the attributes of the graphic.

Parameters:

attrs -

Returns:

Graphic

setGeometry

public final Graphic setGeometry(Geometry geometry)

Defines the geometry of the graphic.

Parameters:

geometry -

Returns:

Graphic

setInfoTemplate

public final Graphic setInfoTemplate(InfoTemplate infoTemplate)

Defines the InfoTemplate for the InfoWindow of the graphic. When a user clicks a graphic, the InfoWindow opens with this template.

Parameters:

infoTemplate -

Returns:

Graphic

setSymbol

public final Graphic setSymbol(Symbol symbol)

Sets the symbol of the graphic.

Parameters:

symbol -

Returns:

Graphic

show

public final void show()

Shows the graphic.

toJson

public final com.google.gwt.core.client.JavaScriptObject toJson()

Converts object to its ArcGIS Server JSON representation.

Returns:

JavaScriptObject