com.google.gwt.maps.client
Class GoogleBarOptions

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

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

Wrapper for GGoogleBarOptions, passed as an argument to construct MapOptions.


Constructor Summary
protected GoogleBarOptions()
           
 
Method Summary
static GoogleBarOptions newInstance()
          Returns a new instance of GoogleBarOptions.
 GoogleBarOptions setAdsOptions(GoogleBarAdsOptions adsOptions)
          Indicates the parameters to use for the display of advertising when using the GoogleBar.
 GoogleBarOptions setLinkTargetBlank()
          Allows you to specify the target for links embedded within the search results of the GoogleBar.
 GoogleBarOptions setLinkTargetParent()
          Allows you to specify the target for links embedded within the search results of the GoogleBar.
 GoogleBarOptions setLinkTargetSelf()
          Allows you to specify the target for links embedded within the search results of the GoogleBar.
 GoogleBarOptions setLinkTargetTop()
          Allows you to specify the target for links embedded within the search results of the GoogleBar.
 GoogleBarOptions setListingTypeBlended()
          Indicates that searches from the map's GGoogleBar should return all types of results (KML, businesses, geocodes, etc).
 GoogleBarOptions setListingTypeKmlOnly()
          Indicates that searches from the map's GGoogleBar should return only results from indexed KML/KMZ/GeoRSS files.
 GoogleBarOptions setListingTypeLocalOnly()
          Indicates that searches from the map's GGoogleBar should return only business and geocode results.
 GoogleBarOptions setResultListElement(com.google.gwt.dom.client.Element resultList)
          Lets you specify the style of the search result list for the GoogleBar, passing a block-level DOM Element which places the list within a container of your choice (typically a
element).
 GoogleBarOptions setResultListInline()
          Lets you specify the style of the search result list for the GoogleBar as inline, meaning the result list is displayed in tabular form on the map.
 GoogleBarOptions setResultListSuppress()
          Lets you specify the style of the search result list for the GoogleBar as the default style, where the result list is hidden and replaced with next/previous buttons..
 GoogleBarOptions setShowOnLoad(boolean showOnLoad)
          When set to true, displays the GoogleBar text search box (provided the control is enabled and the map is loaded).
 GoogleBarOptions setStyle(java.lang.String style)
          Indicates the style in use by the GGoogleBar.
 GoogleBarOptions setSuppressInitialResultSelection(boolean value)
          Suppresses displaying the first result within its own info window upon completion of a search in the GoogleBar (which is the default behavior).
 GoogleBarOptions setSuppressZoomToBounds(boolean value)
          This property suppresses automatic panning and zooming to the set of results upon completion of a search in the GoogleBar.
 
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

GoogleBarOptions

protected GoogleBarOptions()
Method Detail

newInstance

public static GoogleBarOptions newInstance()
Returns a new instance of GoogleBarOptions.

Returns:
a new instance of GoogleBarOptions.

setAdsOptions

public final GoogleBarOptions setAdsOptions(GoogleBarAdsOptions adsOptions)
Indicates the parameters to use for the display of advertising when using the GoogleBar. Advertising is enabled in the GoogleBar by default. Configure these options to add information on how this advertising should be displayed and to what AdSense accounts it should be linked (to gain revenue).

Parameters:
adsOptions - options for how advertising should be displayed.

setLinkTargetBlank

public final GoogleBarOptions setLinkTargetBlank()
Allows you to specify the target for links embedded within the search results of the GoogleBar. Blank is the default value, which specifies that links will open within a new window. This method will override other settings of the link target.


setLinkTargetParent

public final GoogleBarOptions setLinkTargetParent()
Allows you to specify the target for links embedded within the search results of the GoogleBar. Blank is the default value, which specifies that links will open within a new window. This method will override other settings of the link target.


setLinkTargetSelf

public final GoogleBarOptions setLinkTargetSelf()
Allows you to specify the target for links embedded within the search results of the GoogleBar. This method will override other settings of the link target.


setLinkTargetTop

public final GoogleBarOptions setLinkTargetTop()
Allows you to specify the target for links embedded within the search results of the GoogleBar. This method will override other settings of the link target.


setListingTypeBlended

public final GoogleBarOptions setListingTypeBlended()
Indicates that searches from the map's GGoogleBar should return all types of results (KML, businesses, geocodes, etc). This will override any other setting of the listing type.


setListingTypeKmlOnly

public final GoogleBarOptions setListingTypeKmlOnly()
Indicates that searches from the map's GGoogleBar should return only results from indexed KML/KMZ/GeoRSS files. This will override any other setting of the listing type.


setListingTypeLocalOnly

public final GoogleBarOptions setListingTypeLocalOnly()
Indicates that searches from the map's GGoogleBar should return only business and geocode results. This will override any other setting of the listing type.


setResultListElement

public final GoogleBarOptions setResultListElement(com.google.gwt.dom.client.Element resultList)
Lets you specify the style of the search result list for the GoogleBar, passing a block-level DOM Element which places the list within a container of your choice (typically a
element). This will override any other setting of the result list.

Parameters:
resultList - a DOM element of your choice to display the results.

setResultListInline

public final GoogleBarOptions setResultListInline()
Lets you specify the style of the search result list for the GoogleBar as inline, meaning the result list is displayed in tabular form on the map. This will override any other setting of the result list.


setResultListSuppress

public final GoogleBarOptions setResultListSuppress()
Lets you specify the style of the search result list for the GoogleBar as the default style, where the result list is hidden and replaced with next/previous buttons..


setShowOnLoad

public final GoogleBarOptions setShowOnLoad(boolean showOnLoad)
When set to true, displays the GoogleBar text search box (provided the control is enabled and the map is loaded). By default, the text search box within the control is hidden and only expanded upon clicking the control's magnifying glass. Note: when setting the style property to "new", the GoogleBar text search box is always shown and this setting is ignored.

Parameters:
showOnLoad - pass true to display the GoogleBar text search box.

setStyle

public final GoogleBarOptions setStyle(java.lang.String style)
Indicates the style in use by the GGoogleBar. Setting style to "new" enables the GoogleBar's revamped look and feel. (This style will become the default in the near future.)

Parameters:
style - set to "new" to enable GoogleBar's revamped look and feel.

setSuppressInitialResultSelection

public final GoogleBarOptions setSuppressInitialResultSelection(boolean value)
Suppresses displaying the first result within its own info window upon completion of a search in the GoogleBar (which is the default behavior).

Parameters:
value - pass true to suppress display of the first result immediately upon return of the search results.

setSuppressZoomToBounds

public final GoogleBarOptions setSuppressZoomToBounds(boolean value)
This property suppresses automatic panning and zooming to the set of results upon completion of a search in the GoogleBar. (This setting suppresses the default behavior.)

Parameters:
value - pass true to suppress automatic panning and zooming to the first set of results.