<h2>org.das2.jythoncompletion.support.CompletionResultSet</h2><p>Listener interface for passing the query results.</p>
<hr>
<a name="PRIORITY_SORT_TYPE"></a>
<h2>PRIORITY_SORT_TYPE</h2>
<p>Sort type returned from {@link #getSortType()}
 that prefers priority of the item ({@link CompletionItem#getSortPriority()})
 over the text of the item ({@link CompletionItem#getSortText()}).</p>

<hr>
<a name="TEXT_SORT_TYPE"></a>
<h2>TEXT_SORT_TYPE</h2>
<p>Sort type returned from {@link #getSortType()}
 that prefers text of the item ({@link CompletionItem#getSortText()}).
 over the priority of the item ({@link CompletionItem#getSortPriority()})</p>

<hr>
<a name="addAllItems"></a>
<h2>addAllItems</h2>
addAllItems( <a href='https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html'>java.util.Collection</a> items ) &rarr; boolean

<p>Add the collection of the completion items to this result set.
 <br>
 This method can be called multiple times until
 all the items have been added to ths result set.
 <br>
 After the adding is completed @link #finish()} must be called to confirm
 that the result set will no longer be modified.</p>

<h3>Parameters</h3>
items - collection of items to be added.

<h3>Returns:</h3>
true if adding of the items can continue
  or false if there is already too many items
  to be practical to display in the listbox so subsequent
  adding should preferably be discontinued.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=addAllItems&unscoped_q=addAllItems">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/jythoncompletion/support/CompletionResultSet.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/jythoncompletion/support/CompletionResultSet.html#addAllItems">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/jythoncompletion/support/CompletionResultSet.java">[view source]</a>
<br>
<br>
<hr>
<a name="addItem"></a>
<h2>addItem</h2>
addItem( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/jythoncompletion/support/CompletionItem.html'>org.das2.jythoncompletion.support.CompletionItem</a> item ) &rarr; boolean

<p>Add the completion item to this result set.
 <br>
 This method can be called multiple times until
 all the items have been added to ths result set.
 <br>
 After the adding is completed @link #finish()} must be called to confirm
 that the result set will no longer be modified.</p>

<h3>Parameters</h3>
item - non-null completion item.

<h3>Returns:</h3>
true if adding of the items can continue
  or false if there is already too many items
  to be practical to display in the listbox so subsequent
  adding should preferably be discontinued.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=addItem&unscoped_q=addItem">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/jythoncompletion/support/CompletionResultSet.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/jythoncompletion/support/CompletionResultSet.html#addItem">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/jythoncompletion/support/CompletionResultSet.java">[view source]</a>
<br>
<br>
<hr>
<a name="estimateItems"></a>
<h2>estimateItems</h2>
estimateItems( int estimatedItemCount, int estimatedItemWidth ) &rarr; void

<p>Indicate that adding of the items to this result set
 will likely need a long time so the resulting number of items
 and their visual size should be estimated so that
 the completion infrastructure can estimate the size
 of the popup window and display the items added subsequently
 without changing its bound extensively.
 <br>
 Without calling of this method the completion infrastructure
 will wait until {@link #finish()} gets called on this result set
 before displaying any of the items added to this result set.

 <p>
 By calling of this method the task also confirms
 that the items added by {@link #addItem(CompletionItem)} subsequently
 are already in the order corresponding to the {@link #getSortType()}.</p>

<h3>Parameters</h3>
estimatedItemCount - estimated number of the items that will
  be added to this result set by {@link #addItem(CompletionItem)}.
  If the estimate is significantly lower than the reality then
  the vertical scrollbar granularity may be decreased or the vertical
  scrollbar can be removed completely once the result set is finished.
  If the estimate is significantly higher than the reality then
  the vertical scrollbar granularity may be increased
  once the result set is finished.
<br>
estimatedItemWidth - estimated maximum visual width of a completion item.

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=estimateItems&unscoped_q=estimateItems">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/jythoncompletion/support/CompletionResultSet.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/jythoncompletion/support/CompletionResultSet.html#estimateItems">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/jythoncompletion/support/CompletionResultSet.java">[view source]</a>
<br>
<br>
<hr>
<a name="finish"></a>
<h2>finish</h2>
finish(  ) &rarr; void

<p>Mark that this result set is finished and there will be no more
 modifications done to it.</p>

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=finish&unscoped_q=finish">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/jythoncompletion/support/CompletionResultSet.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/jythoncompletion/support/CompletionResultSet.html#finish">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/jythoncompletion/support/CompletionResultSet.java">[view source]</a>
<br>
<br>
<hr>
<a name="getSortType"></a>
<h2>getSortType</h2>
getSortType(  ) &rarr; int

<p>Get the sort type currently used by the code completion.
 <br>
 It's one of the {@link #PRIORITY_SORT_TYPE} or {@link #TEXT_SORT_TYPE}.</p>

<h3>Returns:</h3>
int

<br><br>
<a href="https://github.com/autoplot/dev/search?q=getSortType&unscoped_q=getSortType">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/jythoncompletion/support/CompletionResultSet.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/jythoncompletion/support/CompletionResultSet.html#getSortType">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/jythoncompletion/support/CompletionResultSet.java">[view source]</a>
<br>
<br>
<hr>
<a name="isFinished"></a>
<h2>isFinished</h2>
isFinished(  ) &rarr; boolean

<p>Check whether this result set is finished.</p>

<h3>Returns:</h3>
true if the result set is already finished by previous call
  to {@link #finish()}.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=isFinished&unscoped_q=isFinished">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/jythoncompletion/support/CompletionResultSet.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/jythoncompletion/support/CompletionResultSet.html#isFinished">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/jythoncompletion/support/CompletionResultSet.java">[view source]</a>
<br>
<br>
<hr>
<a name="setAnchorOffset"></a>
<h2>setAnchorOffset</h2>
setAnchorOffset( int anchorOffset ) &rarr; void

<p>Set the document offset to which the returned completion items
 or documentation or tooltip should be anchored.
 <br>
 If there will be multiple completion providers setting this property
 for the given mime-type then only the first one
 (according to the xml-layer registration order)
 will be taken into account.</p>

<h3>Parameters</h3>
anchorOffset - an int

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=setAnchorOffset&unscoped_q=setAnchorOffset">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/jythoncompletion/support/CompletionResultSet.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/jythoncompletion/support/CompletionResultSet.html#setAnchorOffset">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/jythoncompletion/support/CompletionResultSet.java">[view source]</a>
<br>
<br>
<hr>
<a name="setDocumentation"></a>
<h2>setDocumentation</h2>
setDocumentation( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/jythoncompletion/support/CompletionDocumentation.html'>org.das2.jythoncompletion.support.CompletionDocumentation</a> documentation ) &rarr; void

<p>Set the documentation to this result set.
 <br>
 Calling this method is only relevant for tasks
 created by {@link CompletionProvider#createTask(int, javax.swing.text.JTextComponent)}
 with {@link CompletionProvider#DOCUMENTATION_QUERY_TYPE}
 or for {@link CompletionItem#createDocumentationTask()}.</p>

<h3>Parameters</h3>
documentation - a CompletionDocumentation

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=setDocumentation&unscoped_q=setDocumentation">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/jythoncompletion/support/CompletionResultSet.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/jythoncompletion/support/CompletionResultSet.html#setDocumentation">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/jythoncompletion/support/CompletionResultSet.java">[view source]</a>
<br>
<br>
<hr>
<a name="setHasAdditionalItems"></a>
<h2>setHasAdditionalItems</h2>
setHasAdditionalItems( boolean value ) &rarr; void

<p>Indicate that additional items could be added to this result set. However,
 adding of these items will likely need a long time to complete so it is
 preferred to add them only on the special code completion invocation
 denoted by {@link CompletionProvider#COMPLETION_ALL_QUERY_TYPE}.
 <br>
 Calling this method is relevant only for tasks
 created by {@link CompletionProvider#createTask(int, javax.swing.text.JTextComponent)}
 with {@link CompletionProvider#COMPLETION_QUERY_TYPE}.</p>

<h3>Parameters</h3>
value - a boolean

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=setHasAdditionalItems&unscoped_q=setHasAdditionalItems">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/jythoncompletion/support/CompletionResultSet.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/jythoncompletion/support/CompletionResultSet.html#setHasAdditionalItems">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/jythoncompletion/support/CompletionResultSet.java">[view source]</a>
<br>
<br>
<hr>
<a name="setTitle"></a>
<h2>setTitle</h2>
setTitle( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> title ) &rarr; void

<p>Set title that will be assigned to the completion popup window.
 <br>
 It's only relevant to set the title when providing completion items
 for {@link CompletionProvider#COMPLETION_QUERY_TYPE}.
 <br>
 If there will be multiple completion providers setting this property
 for the given mime-type then only the first one
 (according to the xml-layer registration order)
 will be taken into account.</p>

<h3>Parameters</h3>
title - a String

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=setTitle&unscoped_q=setTitle">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/jythoncompletion/support/CompletionResultSet.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/jythoncompletion/support/CompletionResultSet.html#setTitle">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/jythoncompletion/support/CompletionResultSet.java">[view source]</a>
<br>
<br>
<hr>
<a name="setToolTip"></a>
<h2>setToolTip</h2>
setToolTip( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/javax/swing/JToolTip.html'>javax.swing.JToolTip</a> toolTip ) &rarr; void

<p>Set the tooltip to this result set.
 <br>
 Calling this method is only relevant for tasks
 created by {@link CompletionProvider#createTask(int, javax.swing.text.JTextComponent)}
 with {@link CompletionProvider#TOOLTIP_QUERY_TYPE}
 or for {@link CompletionItem#createToolTipTask()}.</p>

<h3>Parameters</h3>
toolTip - a JToolTip

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=setToolTip&unscoped_q=setToolTip">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/jythoncompletion/support/CompletionResultSet.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/jythoncompletion/support/CompletionResultSet.html#setToolTip">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/jythoncompletion/support/CompletionResultSet.java">[view source]</a>
<br>
<br>
<hr>
<a name="setWaitText"></a>
<h2>setWaitText</h2>
setWaitText( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> waitText ) &rarr; void

<p>Set the explicit value displayed in a label when the completion results
 do not get computed during a certain timeout (e.g. 250ms).
 <br>
 If not set explicitly the completion infrastructure will use
 the default text.</p>

<h3>Parameters</h3>
waitText - description of what the query copmutation
  is currently (doing or waiting for).
  <br>
  After previous explicit setting <code>null</code> can be passed
  to restore using of the default text.

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=setWaitText&unscoped_q=setWaitText">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/jythoncompletion/support/CompletionResultSet.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/jythoncompletion/support/CompletionResultSet.html#setWaitText">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/jythoncompletion/support/CompletionResultSet.java">[view source]</a>
<br>
<br>
<hr>
<a name="toString"></a>
<h2>toString</h2>
toString(  ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a>

<p></p>

<h3>Returns:</h3>
java.lang.String

<br><br>
<a href="https://github.com/autoplot/dev/search?q=toString&unscoped_q=toString">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/jythoncompletion/support/CompletionResultSet.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/jythoncompletion/support/CompletionResultSet.html#toString">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/jythoncompletion/support/CompletionResultSet.java">[view source]</a>
<br>
<br>