com.partnersoft.formats.google

Class GoogleMapWriter

java.lang.Object

com.partnersoft.formats.xml.XmlBuilder

com.partnersoft.formats.xml.HtmlBuilder

com.partnersoft.formats.google.GoogleMapWriter

public class GoogleMapWriter
extends HtmlBuilder

A writer for creating both html and javascript for a google map page. All method calls result in direct output to output stream.

See also com.partnersoft.formats.google.GoogleMapBuilder.

Note, the order items are added to the GMap2 object will have an affect on the page. It seems controls must be added after all items have been overlaid, and no methods can be called on the map object until setCenter has been called.

Reference at: http://code.google.com/apis/maps/documentation/

Copyright 2009 Partner Software, Inc.

Author:

Rich Stepanski

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DOCTYPE Standard html doctype
static java.lang.String	GOOGLESOURCE URL pointing to Google source for java script.
static java.lang.String	XMLNS Standard XML namespace

Fields inherited from class com.partnersoft.formats.xml.HtmlBuilder

embeddedcss

Fields inherited from class com.partnersoft.formats.xml.XmlBuilder

droppingElementsWithoutContent, emptyingElementsWithoutContent, indention, indentSpace, outie, stack

Constructor Summary

Constructors

Constructor and Description
GoogleMapWriter(java.io.OutputStream out) Creates a new GoogleMapWriter outputting to the passed stream.
GoogleMapWriter(VfsFile dest) Creates a new GoogleMapWriter outputting to the passed writer.
GoogleMapWriter(java.io.Writer writer) Creates a new GoogleMapWriter outputting to the passed writer.

Method Summary

Methods

Modifier and Type	Method and Description
void	addIcon(java.lang.String iconName, java.lang.String iconUrl) Defines a new GIcon to be used later.
void	addMapControls(java.util.List<GoogleMapLib.MapComponents> components) Adds all passed MapComponents to the GMap2 object in javascript.
void	addMarker(GoogleMapMarker marker) Adds a new GMarker to the map.
void	addPolygon(GoogleMapPolygon polygon) Adds a new GPolygon to the map.
void	addPolyline(GoogleMapPolyline polyline) Adds a new GPolyline to the map.
void	createMap() Creates Google Map (GMap2 javascript) object with document id 'map'.
void	createMap(java.lang.String mapName) Creates Google Map object (GMap2 javascript) with using passed document id.
void	endBody() Closes body tag
void	setMapCenter(double longitude, double latitude, int zoom) Sets center of map.
void	setMapOption(GoogleMapLib.MapOptions option, boolean isEnabled) Writes javascript for enabling or disabling the passed Google Map Option.
void	setZoom(int zoom) Sets initial zoom.
void	startBody() Writes a body tag with onload, onunload properties set.
void	startBody(java.lang.String hexBgColor) Writes a body tag with onload, onunload, and bgcolor properties set.
void	startDocument(java.lang.Object documentName) Sets up intial html tags for GoogleMap generation.
void	writeGoogleKey(java.lang.String googleKey) Writes Script tag containing GoogleMap key.

Methods inherited from class com.partnersoft.formats.xml.HtmlBuilder

endBulletedList, endDocument, endListItem, endNumberedList, endTable, endTableData, endTableRow, h1, h2, h3, h4, h5, hr, p, startBulletedList, startListItem, startNumberedList, startTable, startTableData, startTableRow, tableContents, tableHeader, writeBulletedList, writeLink, writeListItem, writeMapAsTable, writeParagraph, writeStackTrace

Methods inherited from class com.partnersoft.formats.xml.XmlBuilder

beginStartTag, close, endElement, endElement, endElement, endElement, endStartTag, indent, isDroppingElementsWithoutContent, isEmptyingElementsWithoutContent, newLine, setDroppingElementsWithoutContent, setEmptyingElementsWithoutContent, startElement, startElement, startElement, startElement, undent, writeAttribute, writeContent, writeContent, writeElement, writeElement, writeElement, writeEmptyElement, writeEmptyElement, writeIterableContent, writeRaw

Methods inherited from class java.lang.Object

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

Field Detail

DOCTYPE

public static final java.lang.String DOCTYPE

Standard html doctype

See Also:

Constant Field Values

XMLNS

public static final java.lang.String XMLNS

Standard XML namespace

See Also:

Constant Field Values

GOOGLESOURCE

public static final java.lang.String GOOGLESOURCE

URL pointing to Google source for java script. Leaves hanging = for Google key to be appended.

See Also:

Constant Field Values

Constructor Detail

GoogleMapWriter

public GoogleMapWriter(java.io.OutputStream out)
                throws java.io.IOException

Creates a new GoogleMapWriter outputting to the passed stream.

Parameters:

out - - where to write.

Throws:

java.io.IOException - - if a problem occurs creating writers on passed OutputStream

GoogleMapWriter

public GoogleMapWriter(java.io.Writer writer)
                throws java.io.IOException

Creates a new GoogleMapWriter outputting to the passed writer.

Parameters:

writer - - Where to write.

Throws:

java.io.IOException - - if problem occurs interacting with Writer

GoogleMapWriter

public GoogleMapWriter(VfsFile dest)
                throws java.io.IOException

Creates a new GoogleMapWriter outputting to the passed writer.

Parameters:

dest - - where to write.

Throws:

java.io.IOException - - If a problem occurs during write

Method Detail

startDocument

public void startDocument(java.lang.Object documentName)
                   throws java.io.IOException

Sets up intial html tags for GoogleMap generation.

Sets doctype. Opens html and sets xmlns. Sets head and sets meta (content-type) Sets title.

End result, unclosed html tag with unclosed head tag.

Overrides:

startDocument in class HtmlBuilder

Throws:

java.io.IOException

writeGoogleKey

public void writeGoogleKey(java.lang.String googleKey)
                    throws java.io.IOException

Writes Script tag containing GoogleMap key. This is required if file is to be used in a non-local way.

Parameters:

googleKey - - Key generated by Google for domain

Throws:

java.io.IOException - - If a problem occurs during write

startBody

public void startBody()
               throws java.io.IOException

Writes a body tag with onload, onunload properties set. onload = load() and onunload = GUnload.

Throws:

java.io.IOException - - If a problem occurs during write

startBody

public void startBody(java.lang.String hexBgColor)
               throws java.io.IOException

Writes a body tag with onload, onunload, and bgcolor properties set. onload = load() and onunload = GUnload.

Parameters:

hexBgColor - - Hexadecimal background color to be used for body. Does not need quotes.

Throws:

java.io.IOException - - If a problem occurs during write

endBody

public void endBody()
             throws java.io.IOException

Closes body tag

Throws:

java.io.IOException - - If a problem occurs during write

createMap

public void createMap(java.lang.String mapName)
               throws java.io.IOException

Creates Google Map object (GMap2 javascript) with using passed document id. Note, before the map can be used in anyway - setMapCenter must be called.

Parameters:

mapName - - id of map in html.

Throws:

java.io.IOException - - If a problem occurs during write

createMap

public void createMap()
               throws java.io.IOException

Creates Google Map (GMap2 javascript) object with document id 'map'. Note, before the map can be used in anyway - setMapCenter must be called.

Throws:

java.io.IOException - - If a problem occurs during write

setMapOption

public void setMapOption(GoogleMapLib.MapOptions option,
                boolean isEnabled)
                  throws java.io.IOException

Writes javascript for enabling or disabling the passed Google Map Option. Note, the GMap2 object must already have been defined in the javascript.

Parameters:

option - - GoogleMapLib.MapOptions to alter

isEnabled - - true if passed option should be enabled, false for disabled.

Throws:

java.io.IOException - - If a problem occurs during write

addMapControls

public void addMapControls(java.util.List<GoogleMapLib.MapComponents> components)
                    throws java.io.IOException

Adds all passed MapComponents to the GMap2 object in javascript. The map must of already been created.

Default map controls are LARGE_MAP_CONTROL and MAP_TYPE_CONTROL Controls must be added after any overlays are added.

Parameters:

components - - List of map components to add

Throws:

java.io.IOException - - If a problem occurs during write

setMapCenter

public void setMapCenter(double longitude,
                double latitude,
                int zoom)
                  throws java.io.IOException

Sets center of map. Must be called after createMap() before any map can be used for anything else. (ie, adding controls etc)

Parameters:

longitude - - initial longitude of center

latitude - - initial latitude of center

zoom - - initial zoom

Throws:

java.io.IOException - - If a problem occurs during write

setZoom

public void setZoom(int zoom)
             throws java.io.IOException

Sets initial zoom.

Parameters:

zoom - - initial zoom level

Throws:

java.io.IOException - - If a problem occurs during write

addIcon

public void addIcon(java.lang.String iconName,
           java.lang.String iconUrl)
             throws java.io.IOException

Defines a new GIcon to be used later. Assigns the icon's image to the passed url image. (javascript)

Parameters:

iconName - - var name.

iconUrl - - icon url.

Throws:

java.io.IOException - - If a problem occurs during write

addMarker

public void addMarker(GoogleMapMarker marker)
               throws java.io.IOException

Adds a new GMarker to the map. The GMap2 object must already be defined in javascript.

Parameters:

marker - - GoogleMapMarker to add to map

Throws:

java.io.IOException - - If a problem occurs during write

addPolygon

public void addPolygon(GoogleMapPolygon polygon)
                throws java.io.IOException

Adds a new GPolygon to the map. The GMap2 object must already be defined in javascript.

Parameters:

polygon - - GoogleMapPolygon to add to map

Throws:

java.io.IOException - - If a problem occurs during write

addPolyline

public void addPolyline(GoogleMapPolyline polyline)
                 throws java.io.IOException

Adds a new GPolyline to the map. The GMap2 object must already be defined in javascript.

Parameters:

polyline - - GoogleMapPolyline to add to map

Throws:

java.io.IOException - - If a problem occurs during write