Java Doc for IObjectTreeAPI.java in  » Database-Client » squirrel-sql-2.6.5a » net » sourceforge » squirrel_sql » client » session » 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 » Database Client » squirrel sql 2.6.5a » net.sourceforge.squirrel_sql.client.session 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


net.sourceforge.squirrel_sql.client.session.IObjectTreeAPI

All known Subclasses:   net.sourceforge.squirrel_sql.client.session.mainpanel.objecttree.ObjectTreePanel,
IObjectTreeAPI
public interface IObjectTreeAPI extends IHasIdentifier(Code)
This interface defines the API through which plugins can work with the object tree.
author:
   Colin Bell




Method Summary
 voidaddDetailTab(DatabaseObjectType dboType, IObjectTab tab)
     Add a tab to be displayed in the detail panel for the passed database object type.
 voidaddExpander(DatabaseObjectType dboType, INodeExpander expander)
     Add an expander for the specified object tree node type.
 voidaddKnownDatabaseObjectType(DatabaseObjectType dboType)
     Add a known database object type to the object tree.
 voidaddObjectTreeListener(IObjectTreeListener lis)
     Add a listener to the object tree.
 voidaddToPopup(DatabaseObjectType dboType, Action action)
     Add an Action to the popup menu for the specified database object type.
 voidaddToPopup(Action action)
     Add an Action to the popup menu for all node types.
 voidaddToPopup(DatabaseObjectType dboType, JMenu menu)
     Add an hierarchical menu to the popup menu for the specified database object type.
 voidaddToPopup(JMenu menu)
     Add an hierarchical menu to the popup menu for all node types.
 voidaddTreeModelListener(TreeModelListener lis)
     Add a listener to the object tree for structure changes.
 voidaddTreeSelectionListener(TreeSelectionListener lis)
     Add a listener to the object tree for selection changes.
 voidexpandNode(ObjectTreeNode node)
     Expands the specified tree node.
 DatabaseObjectType[]getDatabaseObjectTypes()
     Retrieve details about all object types that can be in this tree.
 IDatabaseObjectInfo[]getSelectedDatabaseObjects()
     Return an array of the currently selected database objects.
 ObjectTreeNode[]getSelectedNodes()
     Return an array of the selected nodes in the tree.
 List<ITableInfo>getSelectedTables()
    
 ISessiongetSession()
     Retrieves the session of associated with the tree.
 IObjectTabgetTabbedPaneIfSelected(DatabaseObjectType dbObjectType, String title)
    
 voidrefreshSelectedNodes()
     Refresh the nodes currently selected in the object tree.
 voidrefreshSelectedTab()
     Calls refreshComponent on the selected tab in the current ObjectTreeTabbedPane, if the selected tab happens to be a BaseDataSetTab type.
 voidrefreshTree()
     Refresh the object tree.
 voidrefreshTree(boolean reloadSchemaInfo)
     Refresh the object tree.
 voidremoveNodes(ObjectTreeNode[] nodes)
     Remove one or more nodes from the tree.
 voidremoveObjectTreeListener(IObjectTreeListener lis)
     Remove a listener from the object tree.
 voidremoveTreeModelListener(TreeModelListener lis)
     Remove a structure changes listener from the object tree.
 voidremoveTreeSelectionListener(TreeSelectionListener lis)
     Remove a listener from the object tree for selection changes.
 booleanselectInObjectTree(String catalog, String schema, String object)
     Tries to locate the object given by the paramteres in the Object tree. The first matching object found is selected.
Parameters:
  catalog - null means any catalog
Parameters:
  schema - null means any schema table, view, ...
 voidselectRoot()
     Selects the root node of the tree.



Method Detail
addDetailTab
void addDetailTab(DatabaseObjectType dboType, IObjectTab tab)(Code)
Add a tab to be displayed in the detail panel for the passed database object type.
Parameters:
  dboType - Database object type.
Parameters:
  tab - Tab to be displayed.
throws:
  IllegalArgumentException - Thrown when a null DatabaseObjectType orIObjectTab passed.



addExpander
void addExpander(DatabaseObjectType dboType, INodeExpander expander)(Code)
Add an expander for the specified object tree node type.
Parameters:
  dboType - Database object type.
Parameters:
  expander - Expander called to add children to a parent node.
throws:
  IllegalArgumentException - Thrown if a null DatabaseObjectType orINodeExpander thrown.



addKnownDatabaseObjectType
void addKnownDatabaseObjectType(DatabaseObjectType dboType)(Code)
Add a known database object type to the object tree.
Parameters:
  dboType - The new database object type.



addObjectTreeListener
void addObjectTreeListener(IObjectTreeListener lis)(Code)
Add a listener to the object tree.
Parameters:
  lis - The ObjectTreeListener you want added.
throws:
  IllegalArgumentException - Thrown if null ObjectTreeListener passed.



addToPopup
void addToPopup(DatabaseObjectType dboType, Action action)(Code)
Add an Action to the popup menu for the specified database object type.
Parameters:
  dboType - Database object type.
Parameters:
  action - Action to add to menu.
throws:
  IllegalArgumentException - Thrown if a null DatabaseObjectType orAction thrown.



addToPopup
void addToPopup(Action action)(Code)
Add an Action to the popup menu for all node types.
Parameters:
  action - Action to add to menu.
throws:
  IllegalArgumentException - Thrown if a null Action thrown.



addToPopup
void addToPopup(DatabaseObjectType dboType, JMenu menu)(Code)
Add an hierarchical menu to the popup menu for the specified database object type.
Parameters:
  dboType - Database object type.
Parameters:
  menu - JMenu to add to menu.
throws:
  IllegalArgumentException - Thrown if a null DatabaseObjectType orJMenu thrown.



addToPopup
void addToPopup(JMenu menu)(Code)
Add an hierarchical menu to the popup menu for all node types.
Parameters:
  menu - JMenu to add to menu.
throws:
  IllegalArgumentException - Thrown if a null JMenu thrown.



addTreeModelListener
void addTreeModelListener(TreeModelListener lis)(Code)
Add a listener to the object tree for structure changes. I.E nodes added/removed.
Parameters:
  lis - The TreeModelListener you want added.
throws:
  IllegalArgumentException - Thrown if null TreeModelListener passed.



addTreeSelectionListener
void addTreeSelectionListener(TreeSelectionListener lis)(Code)
Add a listener to the object tree for selection changes.
Parameters:
  lis - The TreeSelectionListener you want added.
throws:
  IllegalArgumentException - Thrown if null TreeSelectionListener passed.



expandNode
void expandNode(ObjectTreeNode node)(Code)
Expands the specified tree node.
Parameters:
  node - the tree node to expand



getDatabaseObjectTypes
DatabaseObjectType[] getDatabaseObjectTypes()(Code)
Retrieve details about all object types that can be in this tree. DatabaseObjectType[] Array of object type info objects.



getSelectedDatabaseObjects
IDatabaseObjectInfo[] getSelectedDatabaseObjects()(Code)
Return an array of the currently selected database objects. This is guaranteed to be non-null. array of ObjectTreeNode objects.



getSelectedNodes
ObjectTreeNode[] getSelectedNodes()(Code)
Return an array of the selected nodes in the tree. This is guaranteed to be non-null. Array of nodes in the tree.



getSelectedTables
List<ITableInfo> getSelectedTables()(Code)
Return a type-safe list of the currently selected database tables list of ITableInfo objects.



getSession
ISession getSession()(Code)
Retrieves the session of associated with the tree. Session associated with the tree.



getTabbedPaneIfSelected
IObjectTab getTabbedPaneIfSelected(DatabaseObjectType dbObjectType, String title)(Code)



refreshSelectedNodes
void refreshSelectedNodes()(Code)
Refresh the nodes currently selected in the object tree.



refreshSelectedTab
void refreshSelectedTab() throws DataSetException(Code)
Calls refreshComponent on the selected tab in the current ObjectTreeTabbedPane, if the selected tab happens to be a BaseDataSetTab type.
throws:
  DataSetException - if there was a problem refreshing the component.



refreshTree
void refreshTree()(Code)
Refresh the object tree.



refreshTree
void refreshTree(boolean reloadSchemaInfo)(Code)
Refresh the object tree.



removeNodes
void removeNodes(ObjectTreeNode[] nodes)(Code)
Remove one or more nodes from the tree.
Parameters:
  nodes - Array of nodes to be removed.
throws:
  IllegalArgumentException - Thrown if a null ObjectTreeNode[] thrown.



removeObjectTreeListener
void removeObjectTreeListener(IObjectTreeListener lis)(Code)
Remove a listener from the object tree.
Parameters:
  lis - The ObjectTreeListener you want removed.
throws:
  IllegalArgumentException - Thrown if null ObjectTreeListener passed.



removeTreeModelListener
void removeTreeModelListener(TreeModelListener lis)(Code)
Remove a structure changes listener from the object tree.
Parameters:
  lis - The TreeModelListener you want removed.
throws:
  IllegalArgumentException - Thrown if null TreeModelListener passed.



removeTreeSelectionListener
void removeTreeSelectionListener(TreeSelectionListener lis)(Code)
Remove a listener from the object tree for selection changes.
Parameters:
  lis - The TreeSelectionListener you want removed.
throws:
  IllegalArgumentException - Thrown if null TreeSelectionListener passed.



selectInObjectTree
boolean selectInObjectTree(String catalog, String schema, String object)(Code)
Tries to locate the object given by the paramteres in the Object tree. The first matching object found is selected.
Parameters:
  catalog - null means any catalog
Parameters:
  schema - null means any schema table, view, ... but not a table or view column true if the Object was found and selected.



selectRoot
void selectRoot()(Code)
Selects the root node of the tree.



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