edu.ucdavis.cstars.client

Class InfoWindowBase

java.lang.Object

edu.ucdavis.cstars.client.InfoWindowBase

public abstract class InfoWindowBase
extends java.lang.Object

The base class for the out-of-the-box InfoWindow. To create a custom info window, extend this class and adhere to the following requirements: - Provide implementation for the listed methods - Expose listed properties - Fire listed events It is necessary to provide a base implementation so that the custom info window provides a minimum level of functionality and works as expected. Custom info windows can define additional properties, methods and events to enhance the info window and provide a richer user experience. GWT NOTES: - currently ignoring dijit startup/destory... use gwt not dijit ;) - The root element is a SimplePanel (div) called 'panel'. In the extended class you need to define your title widget and content window, as well as attach them the panel in the init() method. Call getPanel() to access this root panel.

Author:

Justin Merz

Constructor Summary

Constructors

Constructor and Description
InfoWindowBase()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	assertLoaded() Check that the esri.InfoWindowBase has been loaded
Point	getCurrentPoint()
com.google.gwt.dom.client.Element	getDomNode() The reference to a DOM node where the info window is constructed.
com.google.gwt.core.client.JavaScriptObject	getInfoWindowBaseObject()
void	hide() Hide the info window.
abstract void	init()
boolean	isShowing() Indicates if the info window is visible.
void	load() Call this method in the constructor of your inheriting child class.
abstract void	onHide() Fires after the info window is hidden.
abstract void	onShow() Fires after the info window becomes visible.
void	resize(int width, int height) Resize the info window to the specified width and height (in pixels).
abstract void	setContent(java.lang.String content)
void	setMap(MapWidget map) This method is called by the map when the object is set as its info window.
abstract void	setTitle(java.lang.String title)
void	show(Point loc) Display the info window at the specified location.
void	update()

Methods inherited from class java.lang.Object

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

Constructor Detail

InfoWindowBase

public InfoWindowBase()

Method Detail

load

public void load()

Call this method in the constructor of your inheriting child class.

init

public abstract void init()

setContent

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

setTitle

public abstract void setTitle(java.lang.String title)

assertLoaded

public static boolean assertLoaded()

Check that the esri.InfoWindowBase has been loaded

Returns:

boolean

getInfoWindowBaseObject

public com.google.gwt.core.client.JavaScriptObject getInfoWindowBaseObject()

getDomNode

public final com.google.gwt.dom.client.Element getDomNode()

The reference to a DOM node where the info window is constructed.

Returns:

Element

isShowing

public boolean isShowing()

Indicates if the info window is visible. When true the window is visible. Sub-classes should define this property.

Returns:

boolean

hide

public final void hide()

Hide the info window. Fire the onHide event at the end of your implementation of this method to hide the info window.

resize

public final void resize(int width,
          int height)

Resize the info window to the specified width and height (in pixels).

Parameters:

width - - width of window.

height - - height of window.

setMap

public void setMap(MapWidget map)

This method is called by the map when the object is set as its info window.

Parameters:

map - - MapWidget

show

public void show(Point loc)

Display the info window at the specified location.

Parameters:

location - - location window will be shown at

update

public void update()

getCurrentPoint

public Point getCurrentPoint()

onHide

public abstract void onHide()

Fires after the info window is hidden.

onShow

public abstract void onShow()

Fires after the info window becomes visible.