Java Doc for TreeSearchable.java in  » Swing-Library » jide-common » com » jidesoft » swing » 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 » Swing Library » jide common » com.jidesoft.swing 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.jidesoft.swing.Searchable
      com.jidesoft.swing.TreeSearchable

TreeSearchable
public class TreeSearchable extends Searchable implements TreeModelListener,PropertyChangeListener(Code)
TreeSearchable is an concrete implementation of Searchable that enables the search function in JTree.

It's very simple to use it. Assuming you have a JTree, all you need to do is to call

 JTree tree = ....;
 TreeSearchable searchable = new TreeSearchable(tree);
 
Now the JTree will have the search function.

There is very little customization you need to do to TreeSearchable. The only thing you might need is when the element in the JTree needs a special conversion to convert to string. If so, you can overide convertElementToString() to provide you own algorithm to do the conversion.

 JTree tree = ....;
 TreeSearchable searchable = new TreeSearchable(tree) {
 protected String convertElementToString(Object object) {
 ...
 }
 };
 

Additional customization can be done on the base Searchable class such as background and foreground color, keystrokes, case sensitivity,




Constructor Summary
public  TreeSearchable(JTree tree)
    

Method Summary
protected  StringconvertElementToString(Object object)
     Converts the element in JTree to string.
protected  ObjectgetElementAt(int index)
    
protected  intgetElementCount()
    
protected  intgetSelectedIndex()
    
protected  List<TreePath>getTreePathes()
     Gets the cached tree pathes list.
public  booleanisRecursive()
     Checks if the searchable is recursive.
protected  voidpopulateTreePathes()
    
protected  voidpopulateTreePaths()
     Recursively go through the tree to populate the tree pathes into a list and cache them.
public  voidpropertyChange(PropertyChangeEvent evt)
    
protected  voidresetTreePathes()
     Reset the cached tree pathes list.
public  voidsetRecursive(boolean recursive)
     Sets the recursive attribute.

If TreeSearchable is recursive, it will all tree nodes including those which are not visible to find the matching node.

protected  voidsetSelectedIndex(int index, boolean incremental)
    
public  voidtreeNodesChanged(TreeModelEvent e)
    
public  voidtreeNodesInserted(TreeModelEvent e)
    
public  voidtreeNodesRemoved(TreeModelEvent e)
    
public  voidtreeStructureChanged(TreeModelEvent e)
    
public  voiduninstallListeners()
    


Constructor Detail
TreeSearchable
public TreeSearchable(JTree tree)(Code)




Method Detail
convertElementToString
protected String convertElementToString(Object object)(Code)
Converts the element in JTree to string. The element by default is TreePath. The returned value will be toString() of the last path component in the TreePath.
Parameters:
  object - the string representing the TreePath in the JTree.



getElementAt
protected Object getElementAt(int index)(Code)



getElementCount
protected int getElementCount()(Code)



getSelectedIndex
protected int getSelectedIndex()(Code)



getTreePathes
protected List<TreePath> getTreePathes()(Code)
Gets the cached tree pathes list. If it has never been cached before, this method will create the cache.

Tree pathes list is only used when recursive attriubute is true. the tree pathes list.




isRecursive
public boolean isRecursive()(Code)
Checks if the searchable is recursive. true if searchabe is recursive.



populateTreePathes
protected void populateTreePathes()(Code)
TreeSearchable.populateTreePaths()



populateTreePaths
protected void populateTreePaths()(Code)
Recursively go through the tree to populate the tree pathes into a list and cache them.

Tree pathes list is only used when recursive attriubute is true.




propertyChange
public void propertyChange(PropertyChangeEvent evt)(Code)



resetTreePathes
protected void resetTreePathes()(Code)
Reset the cached tree pathes list.

Tree pathes list is only used when recursive attriubute is true.




setRecursive
public void setRecursive(boolean recursive)(Code)
Sets the recursive attribute.

If TreeSearchable is recursive, it will all tree nodes including those which are not visible to find the matching node. Obviously, if your tree has unlimited number of tree nodes or a potential huge number of tree nodes (such as a tree to represent file system), the recursive attribute should be false. To avoid this potential problem in this case, we default it to false.
Parameters:
  recursive -




setSelectedIndex
protected void setSelectedIndex(int index, boolean incremental)(Code)



treeNodesChanged
public void treeNodesChanged(TreeModelEvent e)(Code)



treeNodesInserted
public void treeNodesInserted(TreeModelEvent e)(Code)



treeNodesRemoved
public void treeNodesRemoved(TreeModelEvent e)(Code)



treeStructureChanged
public void treeStructureChanged(TreeModelEvent e)(Code)



uninstallListeners
public void uninstallListeners()(Code)



Fields inherited from com.jidesoft.swing.Searchable
final public static String PROPERTY_SEARCH_TEXT(Code)(Java Doc)
final protected JComponent _component(Code)(Java Doc)
protected ComponentAdapter _componentListener(Code)(Java Doc)
protected EventListenerList listenerList(Code)(Java Doc)

Methods inherited from com.jidesoft.swing.Searchable
public void addPropertyChangeListener(PropertyChangeListener propertychangelistener)(Code)(Java Doc)
public void addSearchableListener(SearchableListener l)(Code)(Java Doc)
protected boolean compare(Object element, String searchingText)(Code)(Java Doc)
protected boolean compare(String text, String searchingText)(Code)(Java Doc)
abstract protected String convertElementToString(Object element)(Code)(Java Doc)
protected SearchPopup createSearchPopup(String searchingText)(Code)(Java Doc)
public int findFirst(String s)(Code)(Java Doc)
public int findFromCursor(String s)(Code)(Java Doc)
public int findLast(String s)(Code)(Java Doc)
public int findNext(String s)(Code)(Java Doc)
public int findPrevious(String s)(Code)(Java Doc)
public void firePropertyChangeEvent(String searchingText)(Code)(Java Doc)
protected void fireSearchableEvent(SearchableEvent e)(Code)(Java Doc)
public Color getBackground()(Code)(Java Doc)
public Component getComponent()(Code)(Java Doc)
public int getCursor()(Code)(Java Doc)
abstract protected Object getElementAt(int index)(Code)(Java Doc)
abstract protected int getElementCount()(Code)(Java Doc)
public Color getForeground()(Code)(Java Doc)
public Color getMismatchForeground()(Code)(Java Doc)
public int getPopupLocation()(Code)(Java Doc)
public Component getPopupLocationRelativeTo()(Code)(Java Doc)
protected String getResourceString(String key)(Code)(Java Doc)
public String getSearchLabel()(Code)(Java Doc)
public SearchableListener[] getSearchableListeners()(Code)(Java Doc)
public SearchableProvider getSearchableProvider()(Code)(Java Doc)
public int getSearchingDelay()(Code)(Java Doc)
public String getSearchingText()(Code)(Java Doc)
abstract protected int getSelectedIndex()(Code)(Java Doc)
public void hidePopup()(Code)(Java Doc)
public void installListeners()(Code)(Java Doc)
protected boolean isActivateKey(KeyEvent e)(Code)(Java Doc)
public boolean isCaseSensitive()(Code)(Java Doc)
protected boolean isDeactivateKey(KeyEvent e)(Code)(Java Doc)
protected boolean isFindFirstKey(KeyEvent e)(Code)(Java Doc)
protected boolean isFindLastKey(KeyEvent e)(Code)(Java Doc)
protected boolean isFindNextKey(KeyEvent e)(Code)(Java Doc)
protected boolean isFindPreviousKey(KeyEvent e)(Code)(Java Doc)
public boolean isHeavyweightComponentEnabled()(Code)(Java Doc)
protected boolean isIncrementalSelectKey(KeyEvent e)(Code)(Java Doc)
protected boolean isNavigationKey(KeyEvent e)(Code)(Java Doc)
public boolean isPopupVisible()(Code)(Java Doc)
public boolean isRepeats()(Code)(Java Doc)
public boolean isReverseOrder()(Code)(Java Doc)
protected boolean isSelectAllKey(KeyEvent e)(Code)(Java Doc)
public boolean isWildcardEnabled()(Code)(Java Doc)
protected void keyTypedOrPressed(KeyEvent e)(Code)(Java Doc)
public void removePropertyChangeListener(PropertyChangeListener propertychangelistener)(Code)(Java Doc)
public void removeSearchableListener(SearchableListener l)(Code)(Java Doc)
public int reverseFindFromCursor(String s)(Code)(Java Doc)
public void setBackground(Color background)(Code)(Java Doc)
public void setCaseSensitive(boolean caseSensitive)(Code)(Java Doc)
public void setCursor(int cursor)(Code)(Java Doc)
public void setForeground(Color foreground)(Code)(Java Doc)
public void setHeavyweightComponentEnabled(boolean heavyweightComponentEnabled)(Code)(Java Doc)
public void setMismatchForeground(Color mismatchForeground)(Code)(Java Doc)
public void setPopupLocation(int popupLocation)(Code)(Java Doc)
public void setPopupLocationRelativeTo(Component popupLocationRelativeTo)(Code)(Java Doc)
public void setRepeats(boolean repeats)(Code)(Java Doc)
public void setReverseOrder(boolean reverseOrder)(Code)(Java Doc)
public void setSearchLabel(String searchLabel)(Code)(Java Doc)
public void setSearchableProvider(SearchableProvider searchableProvider)(Code)(Java Doc)
public void setSearchingDelay(int searchingDelay)(Code)(Java Doc)
abstract protected void setSelectedIndex(int index, boolean incremental)(Code)(Java Doc)
public void setWildcardEnabled(boolean wildcardEnabled)(Code)(Java Doc)
public void showPopup(String searchingText)(Code)(Java Doc)
public void uninstallListeners()(Code)(Java Doc)

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.