edu.ucdavis.cstars.client.layers

Class GraphicsLayer

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.layers.Layer

edu.ucdavis.cstars.client.layers.GraphicsLayer

Direct Known Subclasses:

FeatureLayer

public class GraphicsLayer
extends Layer

A layer that contains one or more Graphic features. Each map contains a GraphicsLayer by default, accessible using the Map.Graphics property. Beginning with v1.4, you can create your own graphics layers and add them to the map. Graphics layers can be reordered within the group of graphics layers. However, the graphics layer in Map.Graphics is always on top. Also, all graphics layers are always on top of TiledMapServiceLayers and DynamicMapServiceLayers.

Author:

lsimone, Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphicsLayer.Options

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Graphic graphic) Adds a graphic.
void	addClickHandler(ClickHandler handler) Fires when a graphic has been clicked.
void	addDblClickHandler(DblClickHandler handler) Fires when a graphic has been double clicked.
void	addGraphicAddHandler(GraphicsLayerGraphicAddHandler handler) Fires when a graphic is added to the GraphicsLayer.
void	addGraphicRemoveHandler(GraphicsLayerGraphicRemoveHandler handler) Fires when a graphic is removed from the GraphicsLayer.
void	addGraphicsClearHandler(GraphicsLayerGaphicsClearHandler handler) Fires when all graphics in the GraphicsLayer are cleared.
void	addMouseDownHandler(MouseDownHandler handler) Fires when a mouse button is pressed down and the mouse cursor is on a graphic.
void	addMouseDragHandler(MouseDragHandler handler) Fires while the mouse is being dragged until the mouse button is released.
void	addMouseMoveHandler(MouseMoveHandler handler) Fires as the mouse moves through a graphic on the GraphicsLayer.
void	addMouseOutHandler(MouseOutHandler handler) Fires as the mouse exits a graphic on the GraphicsLayer.
void	addMouseOverHandler(MouseOverHandler handler) Fires when the mouse first enters into a graphic on the GraphicsLayer.
void	addMouseUpHandler(MouseUpHandler handler) Fires when a mouse button is released and the mouse cursor is on a graphic.
void	clear() Clears all graphics.
static GraphicsLayer	create() Creates a new graphics layer.
static GraphicsLayer	create(GraphicsLayer.Options options) Creates a new GraphicsLayer object with parameters.
void	disableMouseEvents() Disables all mouse events on the graphics layer.
void	enableMouseEvents() Enables all mouse events on the graphics layer.
com.google.gwt.core.client.JsArray<Graphic>	getGraphics() The array of graphics that make up the layer.
Renderer	getRenderer() Renderer assigned to the GraphicsLayer.
void	remove(Graphic graphic) Removes a graphic.
void	setInfoTemplate(InfoTemplate infoTemplate) Specify or change the info template for a layer.
void	setOpacity(float opacity) Initial opacity or transparency of layer.
void	setRenderer(Renderer renderer) Sets the renderer for the graphics layer.

Methods inherited from class edu.ucdavis.cstars.client.layers.Layer

addErrorHandler, addLoadHandler, addOpacityChangeHandler, addUpdateEndHandler, addUpdateHandler, addUpdateStartHandler, addVisibilityChangeHandler, getCredential, getId, getOpacity, getUrl, hide, isloaded, isVisible, setOpacity, setVisibility, show

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 GraphicsLayer create()

Creates a new graphics layer.

Returns:

GraphicsLayer

create

public static GraphicsLayer create(GraphicsLayer.Options options)

Creates a new GraphicsLayer object with parameters.

Parameters:

options - - see options class

Returns:

GaphicsLayer

getGraphics

public final com.google.gwt.core.client.JsArray<Graphic> getGraphics()

The array of graphics that make up the layer.

Returns:

JsArray

getRenderer

public final Renderer getRenderer()

Renderer assigned to the GraphicsLayer.

Returns:

Renderer

add

public final void add(Graphic graphic)

Adds a graphic.

Parameters:

graphic - - The graphic to add.

clear

public final void clear()

Clears all graphics.

disableMouseEvents

public final void disableMouseEvents()

Disables all mouse events on the graphics layer.

enableMouseEvents

public final void enableMouseEvents()

Enables all mouse events on the graphics layer.

remove

public final void remove(Graphic graphic)

Removes a graphic.

Parameters:

graphic - - Removes a graphic.

setInfoTemplate

public final void setInfoTemplate(InfoTemplate infoTemplate)

Specify or change the info template for a layer.

Parameters:

infoTemplate - - The new info template.

setOpacity

public final void setOpacity(float opacity)

Initial opacity or transparency of layer. Not supported in Internet Explorer.

Parameters:

opacity - - Value from 0 to 1, where 0 is 100% transparent and 1 has no transparency. The default value is 1.

setRenderer

public final void setRenderer(Renderer renderer)

Sets the renderer for the graphics layer.

Parameters:

renderer - - The renderer used for the graphic.

addClickHandler

public final void addClickHandler(ClickHandler handler)

Fires when a graphic has been clicked.

Parameters:

handler -

addDblClickHandler

public final void addDblClickHandler(DblClickHandler handler)

Fires when a graphic has been double clicked.

Parameters:

handler -

addGraphicAddHandler

public final void addGraphicAddHandler(GraphicsLayerGraphicAddHandler handler)

Fires when a graphic is added to the GraphicsLayer.

Parameters:

handler -

addGraphicRemoveHandler

public final void addGraphicRemoveHandler(GraphicsLayerGraphicRemoveHandler handler)

Fires when a graphic is removed from the GraphicsLayer.

Parameters:

handler -

addGraphicsClearHandler

public final void addGraphicsClearHandler(GraphicsLayerGaphicsClearHandler handler)

Fires when all graphics in the GraphicsLayer are cleared.

Parameters:

handler -

addMouseDownHandler

public final void addMouseDownHandler(MouseDownHandler handler)

Fires when a mouse button is pressed down and the mouse cursor is on a graphic.

Parameters:

handler -

addMouseDragHandler

public final void addMouseDragHandler(MouseDragHandler handler)

Fires while the mouse is being dragged until the mouse button is released.

Parameters:

handler -

addMouseMoveHandler

public final void addMouseMoveHandler(MouseMoveHandler handler)

Fires as the mouse moves through a graphic on the GraphicsLayer.

Parameters:

handler -

addMouseOutHandler

public final void addMouseOutHandler(MouseOutHandler handler)

Fires as the mouse exits a graphic on the GraphicsLayer.

Parameters:

handler -

addMouseOverHandler

public final void addMouseOverHandler(MouseOverHandler handler)

Fires when the mouse first enters into a graphic on the GraphicsLayer.

Parameters:

handler -

addMouseUpHandler

public final void addMouseUpHandler(MouseUpHandler handler)

Fires when a mouse button is released and the mouse cursor is on a graphic.

Parameters:

handler -