Java Doc for CompletionResultSet.java in  » IDE-Netbeans » editor » org » netbeans » spi » editor » completion » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » IDE Netbeans » editor » org.netbeans.spi.editor.completion 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.netbeans.spi.editor.completion.CompletionResultSet

CompletionResultSet
final public class CompletionResultSet (Code)
Listener interface for passing the query results.
See Also:   CompletionProvider.createTask
author:
   Miloslav Metelka, Dusan Balek
version:
   1.01


Field Summary
final public static  intPRIORITY_SORT_TYPE
     Sort type returned from CompletionResultSet.getSortType() that prefers priority of the item ( CompletionItem.getSortPriority ) over the text of the item ( CompletionItem.getSortText ).
final public static  intTEXT_SORT_TYPE
     Sort type returned from CompletionResultSet.getSortType() that prefers text of the item ( CompletionItem.getSortText ).

Constructor Summary
 CompletionResultSet(CompletionResultSetImpl impl)
    

Method Summary
public  booleanaddAllItems(Collection<? extends CompletionItem> items)
     Add the collection of the completion items to this result set.
This method can be called multiple times until all the items have been added to ths result set.
After the adding is completed @link #finish()} must be called to confirm that the result set will no longer be modified.
Parameters:
  items - collection of items to be added.
public  booleanaddItem(CompletionItem item)
     Add the completion item to this result set.
This method can be called multiple times until all the items have been added to ths result set.
After the adding is completed @link #finish()} must be called to confirm that the result set will no longer be modified.
Parameters:
  item - non-null completion item.
public  voidestimateItems(int estimatedItemCount, int estimatedItemWidth)
     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.
public  voidfinish()
     Mark that this result set is finished and there will be no more modifications done to it.
public  intgetSortType()
     Get the sort type currently used by the code completion.
public  booleanisFinished()
     Check whether this result set is finished.
public  voidsetAnchorOffset(int anchorOffset)
     Set the document offset to which the returned completion items or documentation or tooltip should be anchored.
public  voidsetDocumentation(CompletionDocumentation documentation)
     Set the documentation to this result set.
public  voidsetHasAdditionalItems(boolean value)
     Indicate that additional items could be added to this result set.
public  voidsetHasAdditionalItemsText(String text)
     Set the text to be displayed in a completion popup whenever a CompletionProvider indicates that additional items could be added to this result set by passing true to CompletionResultSet.setHasAdditionalItems(boolean) .
Parameters:
  text - the text that will be directly prepend to the "Press 'Ctrl-Space' Again for All Items"message in the completion popup.
public  voidsetTitle(String title)
     Set title that will be assigned to the completion popup window.
public  voidsetToolTip(JToolTip toolTip)
     Set the tooltip to this result set.
public  voidsetWaitText(String waitText)
     Set the explicit value displayed in a label when the completion results do not get computed during a certain timeout (e.g.

Field Detail
PRIORITY_SORT_TYPE
final public static int PRIORITY_SORT_TYPE(Code)
Sort type returned from CompletionResultSet.getSortType() that prefers priority of the item ( CompletionItem.getSortPriority ) over the text of the item ( CompletionItem.getSortText ).



TEXT_SORT_TYPE
final public static int TEXT_SORT_TYPE(Code)
Sort type returned from CompletionResultSet.getSortType() that prefers text of the item ( CompletionItem.getSortText ). over the priority of the item ( CompletionItem.getSortPriority )




Constructor Detail
CompletionResultSet
CompletionResultSet(CompletionResultSetImpl impl)(Code)




Method Detail
addAllItems
public boolean addAllItems(Collection<? extends CompletionItem> items)(Code)
Add the collection of the completion items to this result set.
This method can be called multiple times until all the items have been added to ths result set.
After the adding is completed @link #finish()} must be called to confirm that the result set will no longer be modified.
Parameters:
  items - collection of items to be added. true if adding of the items can continueor false if there is already too many itemsto be practical to display in the listbox so subsequentadding should preferably be discontinued.



addItem
public boolean addItem(CompletionItem item)(Code)
Add the completion item to this result set.
This method can be called multiple times until all the items have been added to ths result set.
After the adding is completed @link #finish()} must be called to confirm that the result set will no longer be modified.
Parameters:
  item - non-null completion item. true if adding of the items can continueor false if there is already too many itemsto be practical to display in the listbox so subsequentadding should preferably be discontinued.



estimateItems
public void estimateItems(int estimatedItemCount, int estimatedItemWidth)(Code)
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.
Without calling of this method the completion infrastructure will wait until CompletionResultSet.finish() gets called on this result set before displaying any of the items added to this result set.

By calling of this method the task also confirms that the items added by CompletionResultSet.addItem(CompletionItem) subsequently are already in the order corresponding to the CompletionResultSet.getSortType() .
Parameters:
  estimatedItemCount - estimated number of the items that willbe added to this result set by CompletionResultSet.addItem(CompletionItem).If the estimate is significantly lower than the reality thenthe vertical scrollbar granularity may be decreased or the verticalscrollbar can be removed completely once the result set is finished.If the estimate is significantly higher than the reality thenthe vertical scrollbar granularity may be increasedonce the result set is finished.
Parameters:
  estimatedItemWidth - estimated maximum visual width of a completion item.




finish
public void finish()(Code)
Mark that this result set is finished and there will be no more modifications done to it.



getSortType
public int getSortType()(Code)
Get the sort type currently used by the code completion.
It's one of the CompletionResultSet.PRIORITY_SORT_TYPE or CompletionResultSet.TEXT_SORT_TYPE .



isFinished
public boolean isFinished()(Code)
Check whether this result set is finished. true if the result set is already finished by previous callto CompletionResultSet.finish().



setAnchorOffset
public void setAnchorOffset(int anchorOffset)(Code)
Set the document offset to which the returned completion items or documentation or tooltip should be anchored.
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.



setDocumentation
public void setDocumentation(CompletionDocumentation documentation)(Code)
Set the documentation to this result set.
Calling this method is only relevant for tasks created by CompletionProvider.createTask(intjavax.swing.text.JTextComponent) with CompletionProvider.DOCUMENTATION_QUERY_TYPE or for CompletionItem.createDocumentationTask .



setHasAdditionalItems
public void setHasAdditionalItems(boolean value)(Code)
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 CompletionProvider.COMPLETION_ALL_QUERY_TYPE .
Calling this method is relevant only for tasks created by CompletionProvider.createTask(intjavax.swing.text.JTextComponent) with CompletionProvider.COMPLETION_QUERY_TYPE .



setHasAdditionalItemsText
public void setHasAdditionalItemsText(String text)(Code)
Set the text to be displayed in a completion popup whenever a CompletionProvider indicates that additional items could be added to this result set by passing true to CompletionResultSet.setHasAdditionalItems(boolean) .
Parameters:
  text - the text that will be directly prepend to the "Press 'Ctrl-Space' Again for All Items"message in the completion popup. The text should end with a separator (e.g. space, semicolon and space, etc.)that will separate it from the rest of the displayed message. null can be passedto revert any previous setting of the text.
since:
   1.11



setTitle
public void setTitle(String title)(Code)
Set title that will be assigned to the completion popup window.
It's only relevant to set the title when providing completion items for CompletionProvider.COMPLETION_QUERY_TYPE .
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.



setToolTip
public void setToolTip(JToolTip toolTip)(Code)
Set the tooltip to this result set.
Calling this method is only relevant for tasks created by CompletionProvider.createTask(intjavax.swing.text.JTextComponent) with CompletionProvider.TOOLTIP_QUERY_TYPE or for CompletionItem.createToolTipTask .



setWaitText
public void setWaitText(String waitText)(Code)
Set the explicit value displayed in a label when the completion results do not get computed during a certain timeout (e.g. 250ms).
If not set explicitly the completion infrastructure will use the default text.
Parameters:
  waitText - description of what the query copmutationis currently (doing or waiting for).
After previous explicit setting null can be passedto restore using of the default text.
since:
   1.5



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.