edu.ucdavis.cstars.client.dijits

Class InfoWindow

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.dijits.InfoWindow

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

An InfoWindow is an HTML popup. It often contains the attributes of a Graphic. The default behavior on a Graphic is to show the InfoWindow after a click on the Graphic. An InfoTemplate is required for this default behavior. In addition, the InfoWindow can be used to display custom content on the map.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InfoWindow.FixedAnchor

Method Summary

Methods

Modifier and Type	Method and Description
void	addHideHandler(HideHandler handler) Fires when an infoWindow is hidden.
void	addShowHandler(ShowHandler handler) Fires when an InfoWindow is visible.
InfoWindow.FixedAnchor	getAnchor() Placement of the InfoWindow with respect to the graphic.
Point	getCoords() The anchor point of the InfoWindow in screen coordinates.
InfoWindow.FixedAnchor	getFixedAnchor() InfoWindow always show with the specified anchor.
void	hide() Hides the InfoWindow.
boolean	isShowing() Determines whether the InfoWindow is currently shown on the map.
void	move(Point point) Moves the InfoWindow to the specified screen point.
void	resize(int width, int height) Resizes the InfoWindow to the specified height and width in pixels.
void	setContent(com.google.gwt.dom.client.Element element) Sets the content in the InfoWindow.
void	setContent(java.lang.String content) Sets the content in the InfoWindow.
void	setContent(com.google.gwt.user.client.ui.Widget widget) Sets the content in the InfoWindow.
void	setFixedAnchor(InfoWindow.FixedAnchor fixedAnchor) Sets the fixed location of the InfoWindow anchor.
InfoWindow	setTitle(java.lang.String title) Sets the title for the InfoWindow.
void	show(Point point, java.lang.String anchor) Shows the InfoWindow to the specified screen point and anchor.

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

getAnchor

public final InfoWindow.FixedAnchor getAnchor()

Placement of the InfoWindow with respect to the graphic. See the Constants table for values.

Returns:

FixedAnchor

getCoords

public final Point getCoords()

The anchor point of the InfoWindow in screen coordinates.

Returns:

Point

getFixedAnchor

public final InfoWindow.FixedAnchor getFixedAnchor()

InfoWindow always show with the specified anchor. See the Constants table for values.

Returns:

FixedAnchor

isShowing

public final boolean isShowing()

Determines whether the InfoWindow is currently shown on the map.

Returns:

boolean

hide

public final void hide()

Hides the InfoWindow.

move

public final void move(Point point)

Moves the InfoWindow to the specified screen point.

Parameters:

point - - The new anchor point when moving the InfoWindow.

resize

public final void resize(int width,
          int height)

Resizes the InfoWindow to the specified height and width in pixels.

Parameters:

width -

height -

setContent

public final void setContent(java.lang.String content)

Sets the content in the InfoWindow.

Parameters:

content - - The content for the InfoWindow. Can be any valid HTML.

setContent

public final void setContent(com.google.gwt.dom.client.Element element)

Sets the content in the InfoWindow.

Parameters:

element - - The content for the InfoWindow. Valid DOM element.

setContent

public final void setContent(com.google.gwt.user.client.ui.Widget widget)

Sets the content in the InfoWindow.

Parameters:

widget - - The content for the InfoWindow

setFixedAnchor

public final void setFixedAnchor(InfoWindow.FixedAnchor fixedAnchor)

Sets the fixed location of the InfoWindow anchor. Valid values are listed in FixedAnchor.

Parameters:

fixedAnchor -

setTitle

public final InfoWindow setTitle(java.lang.String title)

Sets the title for the InfoWindow.

Parameters:

title - - The title for the InfoWindow. Can be any valid HTML.

Returns:

InfoWindow

show

public final void show(Point point,
        java.lang.String anchor)

Shows the InfoWindow to the specified screen point and anchor.

Parameters:

point - - The new anchor point when moving the InfoWindow.

anchor - - Placement of the InfoWindow with respect to the graphic

addHideHandler

public final void addHideHandler(HideHandler handler)

Fires when an infoWindow is hidden.

Parameters:

handler -

addShowHandler

public final void addShowHandler(ShowHandler handler)

Fires when an InfoWindow is visible.

Parameters:

handler -