Google Code 学习笔记

GdrawOptions

.setDrawMode(drawMode)


此方法用于指示搜索控件在“标签式”或“线性”模式中绘制搜索结果。

• drawMode - GSearchControlgoogle.search.SearchControl.DRAW_MODE_LINEAR. 值被用于指定线性绘制模式。GSearchControlgoogle.search.SearchControl.DRAW_MODE_TABBED. 值用于指定标签式绘制模式。
• 返回 - n/a

// create a drawOptions object

var drawOptions = new GdrawOptionsgoogle.search.DrawOptions();
drawOptions.setDrawMode(GSearchControlgoogle.search.SearchControl.DRAW_MODE_TABBED);
searchControl.draw(element, drawOptions);

.setSearchFormRoot(element)


此方法用于表示您希望将“搜索窗体”放置在由“element”指定的 DOM 容器（而不是搜索结果附近的默认位置）中。

查看实例 (searchformroot.html)

• element - 提供将在其中放置“搜索窗体”的容器。
• 返回 - n/a

        // create a draw options object so that we
   // can position the search form root
   var options = new google.search.DrawOptions();
   options.setSearchFormRoot(document.getElementById("searchForm"));

GSearchControl

.setResultSetSize(switchTo)

调用此方法以选择由每个搜索器返回的结果数。请注意，这不是一个标量。它是表示少数结果或大量结果的枚举。将来可能会改进此方法以支持中型的以及超大型结果集。通过示例应用程序，您或许已经看到了在搜索控件顶部较多/较少的旋转控件。通过该旋转控件来使用此方法。

• switchTo - 提供了一个枚举，该枚举表示为每个已配置的搜索器返回所需的搜索结果数。有效的值包括：
  • GSearchgoogle.search.Search.LARGE_RESULTSET - 请求大量结果（通常 8 个结果）
  • GSearchgoogle.search.Search.SMALL_RESULTSET - 请求少数结果（通常 4 个结果）
• 返回 - n/a

.setOnKeepCallback(object, method, opt_keepLabel?)


此方法用于通知搜索控件，当用户已选择了复制内容（由此控件管理的搜索结果之一）时要通知的调用程序。如果没有调用此方法，将不会为用户提供复制搜索结果 的机会。如果调用了此方法，则每个搜索结果均带有文本链接（在搜索结果下面）的注释。单击此链接将使指定的方法在指定的对象上被调用，从而传递一个与搜索 结果相关联的GResultgoogle.search.Result 对象。此方法允许调用程序指定一个内置系统定义的文本标签值，此系统使用户可以复制结果，或者指定一个对调用应用程序更具意义的标签。当使用系统定义的标签时，将自动把值翻译为正在运行的控件其余部分所用的语言。

• object - 提供了一个应用程序级别对象，此对象定义了将在其中调用指定方法的环境。
• method - 提供了要调用的方法。例如，如果此方法作为 .setOnKeepCallback(foo, MyObject.prototype.myKeephandler) 被调用，则当用户单击保持标签时，将调用 foo.myKeephandler()。
• opt_keepLabel - 提供了一个位于每个搜索结果下面的可选文本标签，当单击此标签时将在指定的对象/方法中触发回调。有效的值包括：
  • GSearchControlgoogle.search.SearchControl.KEEP_LABEL_SAVE - 一个为“保存”的标签值
  • GSearchControlgoogle.search.SearchControl.KEEP_LABEL_KEEP - 一个为“保持”的标签值
  • GSearchControlgoogle.search.SearchControl.KEEP_LABEL_INCLUDE - 一个为“包括”的标签值
  • GSearchControlgoogle.search.SearchControl.KEEP_LABEL_COPY - 一个为“复制”的标签值（默认）
  • GSearchControlgoogle.search.SearchControl.KEEP_LABEL_BLANK - 使用一个空白标签值，当您只想复制图片（通过 css 可选）时适合使用此值
  • 其他任意值 - 传递的值将成为标签。调用程序负责本地化。
• 返回 - n/a

        // establish a keep callback
    searchControl.setOnKeepCallback(this, MyKeepHandler);

  function MyKeepHandler(result) {

    // clone the result html node
    var node = result.html.cloneNode(true);

    // attach it
    var savedResults = document.getElementById("saved_results");
    savedResults.appendChild(node);
  }

     // establish a keep callback
     searchControl.setOnKeepCallback(this, MyKeepHandler, "add to spreadsheet");

Eg:Basic Clipping 基本筛选 Blog Comment Form 博客评论框 Phone List 电话清单

• 基本筛选
  本例演示了基本筛选。本例中使用的重要方法是搜索控件对象的 setOnKeepHandler() 方法。将在每个搜索结果下面显示一个可单击的链接，单击该链接时将调用目标处理程序。在本例中，目标处理程序将完全复制结果的 .html 属性，然后将其附加到当前网页上。
• 博客评论框
  本例演示的方法与先前示例演示的方法相同，但是在这种情况下，本例演示了博客样式评论框环境中的筛选概念。其目的在于演示如何使用特定的、用户选择的搜索结果改善用户生成的内容（如博客帖子和评论）。
• 电话清单
  本例通过演示如何使用结果属性（而不只是 .html 属性）基于基本筛选构建。在这种情况下，每次用户筛选搜索结果时，都将向电子表格添加一“行”，并使用 .title、.streetAddress 等属性设置列的格式。本例还演示了在地图上绘制“筛选后”的搜索结果，在上述章节中也进行了演示。

GsearcherOptions

.setExpandMode(expandMode)


该方法用于在搜索完成时将结果所需的扩展模式传达给搜索器。

• expandMode - 为相关联的搜索器结果部分提供扩展模式。有效的值包括：
  • GSearchControlgoogle.search.SearchControl.EXPAND_MODE_CLOSED - 结果部分被关闭且不显示结果。单击旋钮使用户用户可以“打开”结果部分，以查看当前搜索返回的所有结果。
  • GSearchControlgoogle.search.SearchControl.EXPAND_MODE_OPEN - 结果部分被打开且显示所有结果。
  • GSearchControlgoogle.search.SearchControl.EXPAND_MODE_PARTIAL - 结果部分打开一部分且显示结果的一小部分。通常情况下，这意味着只显示了一个结果。
• 返回 - n/a

// create a searcher options object
// set up for open expansion mode
// load a searcher with these options
var options = new GsearcherOptionsgoogle.search.SearcherOptions();
options.setExpandMode(GSearchControlgoogle.search.SearchControl.EXPAND_MODE_OPEN);
searchControl.addSearcher(new GwebSearchgoogle.search.WebSearch(), options);

.setRoot(element)

此方法用于指示搜索空间为提供的容器（而不是在执行搜索控件的 .draw() 方法期间分配的默认容器）元素中相关联的搜索器绘制搜索结果。

• element - 提供了一个 html 容器元素，该容器元素通常是一个 div 元素，搜索控件要用作相关联的搜索器的结果的容器。
• 返回 - n/a

        var options = new google.search.SearcherOptions();
    options.setExpandMode(google.search.SearchControl.EXPAND_MODE_OPEN);
    options.setRoot(document.getElementById("somewhere_else"));
    searchControl.addSearcher(new google.search.WebSearch(), options);
Eg: Search Result Placement Control 搜索结果放置控件