com.google.gwt.maps.client
Class MapUIOptions

java.lang.Object
  extended by com.google.gwt.core.client.JavaScriptObject
      extended by com.google.gwt.maps.client.MapUIOptions

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

Wrapper for GMapUIOptions.


Constructor Summary
protected MapUIOptions()
           
 
Method Summary
 boolean getDoubleClick()
          Returns whether zooming with double-clicks should be enabled.
 boolean getHybridMapType()
          Returns whether the satellite MapType (G_HYBRID_MAP) should be added to the map.
 boolean getKeyboard()
          Returns whether the KeyboardHandler should be enabled for the Map.
 boolean getLargeMapControl3d()
          Returns whether the LargeMapControl3D should be added to the Map.
 boolean getMapTypeControl()
          Returns whether a MapTypeControl should be added to the Map.
 boolean getMenuMapTypeControl()
          Returns whether a MenuMapTypeControl should be added to the Map.
 boolean getNormalMapType()
          Returns whether the normal MapType (G_NORMAL_MAP) should be added to the map.
 boolean getPhysicalMapType()
          Returns whether the physical MapType (G_PHYSICAL_MAP) should be added to the map.
 boolean getSatelliteMapType()
          Returns whether the satellite MapType (G_SATELLITE_MAP) should be added to the map.
 boolean getScaleControl()
          Returns whether a ScaleControl should be added to the Map.
 boolean getScrollwheel()
          Returns whether zooming with the scrollwheel should be enabled.
 boolean getSmallZoomControl3d()
          Returns whether a SmallZoomControl3D should be added to the Map.
static MapUIOptions newInstance(Size optSize)
          Returns a new instance of GMapUIOptions with values set to defaults suitable for a map of the given size.
 MapUIOptions setDoubleClick(boolean value)
          When set to true, this method specifies that zooming with double-clicks should be enabled.
 MapUIOptions setHybridMapType(boolean value)
          When set to true, this method specifies that the hybrid MapType (G_HYBRID_MAP) should be added to the Map.
 MapUIOptions setKeyboard(boolean value)
          When set to true, this method specifies that KeyboardHandler should be enabled for the Map.
 MapUIOptions setLargeMapControl3d(boolean value)
          When set to true, this property specifies that a LargeMapControl3D should be added to the Map.
 MapUIOptions setMapTypeControl(boolean value)
          When set to true, this method specifies that a MapTypeControl should be added to the Map.
 MapUIOptions setMenuMapTypeControl(boolean value)
          When set to true, this method specifies that a MenuMapTypeControl should be added to the Map.
 MapUIOptions setNormalMapType(boolean value)
          When set to true, this method specifies that the normal MapType (G_NORMAL_MAP) should be added to the Map.
 MapUIOptions setPhysicalMapType(boolean value)
          When set to true, this method specifies that the physical MapType (G_PHYSICAL_MAP) should be added to the Map.
 MapUIOptions setSatelliteMapType(boolean value)
          When set to true, this method specifies that the satellite MapType (G_SATELLITE_MAP) should be added to the Map.
 MapUIOptions setScaleControl(boolean value)
          When set to true, this method specifies that a ScaleControl should be added to the Map.
 MapUIOptions setScrollwheel(boolean value)
          When set to true, this method specifies that zooming with the scrollwheel should be enabled.
 MapUIOptions setSmallZoomControl3d(boolean value)
          When set to true, this method specifies that a SmallZoomControl3D should be added to the Map.
 
Methods inherited from class com.google.gwt.core.client.JavaScriptObject
cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MapUIOptions

protected MapUIOptions()
Method Detail

newInstance

public static final MapUIOptions newInstance(Size optSize)
Returns a new instance of GMapUIOptions with values set to defaults suitable for a map of the given size. A "small" map is one which is smaller than 400 pixels wide or 300 pixels high. A "large" map is any map 400x300 or larger.

Returns:
a new instance of GMapUIOptions.

getDoubleClick

public final boolean getDoubleClick()
Returns whether zooming with double-clicks should be enabled.

Returns:
whether zooming with double-clicks should be enabled.

getHybridMapType

public final boolean getHybridMapType()
Returns whether the satellite MapType (G_HYBRID_MAP) should be added to the map.

Returns:
true if the hybrid MapType should be added to the map.

getKeyboard

public final boolean getKeyboard()
Returns whether the KeyboardHandler should be enabled for the Map.

Returns:
whether the KeyboardHandler should be enabled for the Map.

getLargeMapControl3d

public final boolean getLargeMapControl3d()
Returns whether the LargeMapControl3D should be added to the Map.

Returns:
whether the LargeMapControl3D should be added to the Map.

getMapTypeControl

public final boolean getMapTypeControl()
Returns whether a MapTypeControl should be added to the Map.

Returns:
whether a MapTypeControl should be added to the Map.

getMenuMapTypeControl

public final boolean getMenuMapTypeControl()
Returns whether a MenuMapTypeControl should be added to the Map.

Returns:
whether a MenuMapTypeControl should be added to the Map.

getNormalMapType

public final boolean getNormalMapType()
Returns whether the normal MapType (G_NORMAL_MAP) should be added to the map.

Returns:
true if the Normal MapType should be added to the map.

getPhysicalMapType

public final boolean getPhysicalMapType()
Returns whether the physical MapType (G_PHYSICAL_MAP) should be added to the map.

Returns:
true if the physical MapType should be added to the map.

getSatelliteMapType

public final boolean getSatelliteMapType()
Returns whether the satellite MapType (G_SATELLITE_MAP) should be added to the map.

Returns:
true if the satellite MapType should be added to the map.

getScaleControl

public final boolean getScaleControl()
Returns whether a ScaleControl should be added to the Map.

Returns:
whether a ScaleControl should be added to the Map.

getScrollwheel

public final boolean getScrollwheel()
Returns whether zooming with the scrollwheel should be enabled.

Returns:
whether zooming with the scrollwheel should be enabled.

getSmallZoomControl3d

public final boolean getSmallZoomControl3d()
Returns whether a SmallZoomControl3D should be added to the Map.

Returns:
whether a SmallZoomControl3D should be added to the Map.

setDoubleClick

public final MapUIOptions setDoubleClick(boolean value)
When set to true, this method specifies that zooming with double-clicks should be enabled. True by default.

Parameters:
value - true to specify that zooming with double-clicks should be enabled.

setHybridMapType

public final MapUIOptions setHybridMapType(boolean value)
When set to true, this method specifies that the hybrid MapType (G_HYBRID_MAP) should be added to the Map. True by default.

Parameters:
value - true to specify the Hybrid MapType.

setKeyboard

public final MapUIOptions setKeyboard(boolean value)
When set to true, this method specifies that KeyboardHandler should be enabled for the Map. True by default.

Parameters:
value - true to specify that KeyboardHandler should be enabled for the Map.

setLargeMapControl3d

public final MapUIOptions setLargeMapControl3d(boolean value)
When set to true, this property specifies that a LargeMapControl3D should be added to the Map. True by default for "large" maps.

Parameters:
value - true to specify that a LargeMapControl3D should be added to the Map.

setMapTypeControl

public final MapUIOptions setMapTypeControl(boolean value)
When set to true, this method specifies that a MapTypeControl should be added to the Map. True by default for "large" maps.

Parameters:
value - true to specify that a MapTypeControl should be added to the Map.

setMenuMapTypeControl

public final MapUIOptions setMenuMapTypeControl(boolean value)
When set to true, this method specifies that a MenuMapTypeControl should be added to the Map. True by default for "small" maps.

Parameters:
value - true to specify that a MenuMapTypeControl should be added to the Map.

setNormalMapType

public final MapUIOptions setNormalMapType(boolean value)
When set to true, this method specifies that the normal MapType (G_NORMAL_MAP) should be added to the Map. True by default.

Parameters:
value - true to specify the normal MapType.

setPhysicalMapType

public final MapUIOptions setPhysicalMapType(boolean value)
When set to true, this method specifies that the physical MapType (G_PHYSICAL_MAP) should be added to the Map. True by default.

Parameters:
value - true to specify the Physical MapType.

setSatelliteMapType

public final MapUIOptions setSatelliteMapType(boolean value)
When set to true, this method specifies that the satellite MapType (G_SATELLITE_MAP) should be added to the Map. True by default.

Parameters:
value - true to specify the Satellite MapType.

setScaleControl

public final MapUIOptions setScaleControl(boolean value)
When set to true, this method specifies that a ScaleControl should be added to the Map. True by default for "large" maps.

Parameters:
value - true to specify that a ScaleControl should be added to the Map.

setScrollwheel

public final MapUIOptions setScrollwheel(boolean value)
When set to true, this method specifies that zooming with the scrollwheel should be enabled. True by default.

Parameters:
value - Pass true to enable the scrollwheel zoom.

setSmallZoomControl3d

public final MapUIOptions setSmallZoomControl3d(boolean value)
When set to true, this method specifies that a SmallZoomControl3D should be added to the Map. True by default for "small" maps.

Parameters:
value - true to specify that a SmallZoomControl3D should be added to the Map.