English | Site Directory

gadgets.views

 SUMMARY     DETAIL

Static Class gadgets.views

Provides operations for dealing with Views.

Method Summary

<static>  gadgets.views.View getCurrentView()
Returns the current view.
<static>  Map.<String, String> getParams()
Returns the parameters passed into this gadget for this view.
<static>  Map<gadgets.views.ViewType, String, gadgets.views.View> getSupportedViews()
Returns a map of all the supported views.
<static> requestNavigateTo(view, opt_params)
Attempts to navigate to this gadget in a different view.
 

Method Detail

getCurrentView

<static> gadgets.views.View getCurrentView()
    Returns the current view.
    Returns:
      gadgets.views.View The current view

getParams

<static> Map.<String, String> getParams()
    Returns the parameters passed into this gadget for this view. Does not include all url parameters, only the ones passed into gadgets.views.requestNavigateTo
    Returns:
      Map.<String, String> The parameter map

getSupportedViews

<static> Map<gadgets.views.ViewType, String, gadgets.views.View> getSupportedViews()
    Returns a map of all the supported views. Keys each gadgets.view.View by its name.
    Returns:
      Map<gadgets.views.ViewType, String, gadgets.views.View> All supported views, keyed by their name attribute.

requestNavigateTo

<static> requestNavigateTo(view, opt_params)
    Attempts to navigate to this gadget in a different view. If the container supports parameters will pass the optional parameters along to the gadget in the new view.
    Parameters:
      gadgets.views.View view - The view to navigate to
      Map.<String, String> opt_params - Parameters to pass to the gadget after it has been navigated to on the surface

Documentation generated by JsDoc Toolkit 1.3.3