Java Doc for SearchPart.java in  » GIS » udig-1.1 » net » refractions » udig » ui » 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 » GIS » udig 1.1 » net.refractions.udig.ui 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


net.refractions.udig.ui.SearchPart

All known Subclasses:   net.refractions.udig.tool.info.internal.InfoView2,  net.refractions.udig.location.ui.LocationView,  net.refractions.udig.catalog.ui.search.SearchView,
SearchPart
public class SearchPart extends ViewPart implements ISetSelectionTarget(Code)
A ViewPart with support for a background "search" process.

The part will automatically show the "progress" when the monitored Job(s) are running.


author:
   jgarnett
since:
   1.0.0

Inner Class :protected enum Orientation
Inner Class :static class ToggleOrientationAction extends Action
Inner Class :public static class ResultSet

Field Summary
protected  IActioncancel
     Used to cancel current searchMonitor

Usually available in the toolbar.

 OrientationcurrentOrientation
    
 Objectfilter
    
 Joblooking
    
protected  Orientationorientation
    
protected  Compositeparent
    
protected  IMementosave
    
protected  IProgressMonitorsearchMonitor
     Used to control search jobs.
 IDialogSettingssettings
    
protected  SashFormsplitter
    
protected  StructuredViewerviewer
     Viewer for search results List/Tree/Table ...

Constructor Summary
protected  SearchPart(IDialogSettings dialogSettings)
    

Method Summary
 voidcomputeOrientation()
    
protected  IStructuredContentProvidercreateContentProvider()
     Default implementation will work for lists, please overide if you are into the whole tree thing.
protected  CompositecreateDetails(SashForm splitter)
     Subclass should override to provide custom details display.
protected  IBaseLabelProvidercreateLabelProvider()
    
public  voidcreatePartControl(Composite aParent)
     Creates the SWT controls for this workbench part.
protected  ISelectionChangedListenercreateSelectionListener()
     Default implementation calls showDetail( IStructuredSelection ).
protected  StructuredViewercreateViewer(Composite parent)
     Create viewer (default is a ListViewer please override if you want a Tree or Table Viewer.
protected  voidfillActionBars()
     Create toolbar with cancel.
protected  voidfillViewMenu()
    
protected  CompositegetDetails()
     Subclass can override to return its kind of details, example a PageBook.
protected  ISelectiongetSelection(List<Object> input)
     Called to determine what object(s) in the input should be the selection in the viewer.
public  voidinit(IViewSite site, IMemento memento)
    
protected  voidinitDragAndDrop()
     Subclass should override to support DnD.
protected  voidmakeActions()
    
protected  voidnotifyChange(ResultSet set, Collection<? extends Object> newObjects)
     Called each time data is added to the result set by the search.
public  voidquick(String pattern)
    
public  voidsaveState(IMemento memento)
    
protected  voidsaveViewSettings()
    
public  voidsearch(Object newFilter)
    
protected  voidsearchImplementation(Object filter, IProgressMonitor monitor, ResultSet results)
    
public  voidselectReveal(ISelection selection)
    
public  voidsetFocus()
    
protected  voidsetOrientation(Orientation orientation)
     called from ToggleOrientationAction (or compute).
public  voidsetShowDetails(boolean show)
    
protected  voidshowDetail(Object selection)
    
protected  booleanshowSelection()
     Returns true if the selection returned by SearchPart.getNewSelection(List) should be shown in the viewer.
synchronized  voidstopSearch()
    

Field Detail
cancel
protected IAction cancel(Code)
Used to cancel current searchMonitor

Usually available in the toolbar.




currentOrientation
Orientation currentOrientation(Code)



filter
Object filter(Code)



looking
Job looking(Code)



orientation
protected Orientation orientation(Code)



parent
protected Composite parent(Code)



save
protected IMemento save(Code)
Save state here



searchMonitor
protected IProgressMonitor searchMonitor(Code)
Used to control search jobs.

Only one "batch" of search jobs is outstanding at anyone time.




settings
IDialogSettings settings(Code)



splitter
protected SashForm splitter(Code)



viewer
protected StructuredViewer viewer(Code)
Viewer for search results List/Tree/Table ...




Constructor Detail
SearchPart
protected SearchPart(IDialogSettings dialogSettings)(Code)
We need dialog settings for persistence




Method Detail
computeOrientation
void computeOrientation()(Code)



createContentProvider
protected IStructuredContentProvider createContentProvider()(Code)
Default implementation will work for lists, please overide if you are into the whole tree thing.



createDetails
protected Composite createDetails(SashForm splitter)(Code)
Subclass should override to provide custom details display.

Many subclasses use PageBook with page selection based on the selection in the viewer.


Parameters:
  splitter - Composite to use for details display



createLabelProvider
protected IBaseLabelProvider createLabelProvider()(Code)



createPartControl
public void createPartControl(Composite aParent)(Code)
Creates the SWT controls for this workbench part.

The details (from IWorkbenchPart.createPartControl( Composite ))

Multi-step process:

  1. Create one or more controls within the parent.
  2. Set the parent layout as needed.
  3. Register any global actions with the IActionService.
  4. Register any popup menus with the IActionService.
  5. Register a selection provider with the ISelectionService (optional).


See Also:   org.eclipse.ui.part.WorkbenchPart.createPartControl(org.eclipse.swt.widgets.Composite)
Parameters:
  parent -



createSelectionListener
protected ISelectionChangedListener createSelectionListener()(Code)
Default implementation calls showDetail( IStructuredSelection ).

Override if you want to do something else.




createViewer
protected StructuredViewer createViewer(Composite parent)(Code)
Create viewer (default is a ListViewer please override if you want a Tree or Table Viewer.

Note the following will be called after creation:

  • setContentProvider( createContentProvider() );
  • viewer.setLabelProvider( createLableProvider() );
This allows people who subclass you to do their own thing.


Parameters:
  page -



fillActionBars
protected void fillActionBars()(Code)
Create toolbar with cancel.



fillViewMenu
protected void fillViewMenu()(Code)



getDetails
protected Composite getDetails()(Code)
Subclass can override to return its kind of details, example a PageBook.



getSelection
protected ISelection getSelection(List<Object> input)(Code)
Called to determine what object(s) in the input should be the selection in the viewer. This method is called when the search is complete. The default selection is the first object in the list.
Parameters:
  the - complete list of objects in the viewer. the selection that will be set in the viewer. may be null.



init
public void init(IViewSite site, IMemento memento) throws PartInitException(Code)



initDragAndDrop
protected void initDragAndDrop()(Code)
Subclass should override to support DnD.



makeActions
protected void makeActions()(Code)



notifyChange
protected void notifyChange(ResultSet set, Collection<? extends Object> newObjects)(Code)
Called each time data is added to the result set by the search. Note: Many items or a single item could have been added.
Parameters:
  set - the results of the search at the current point.
Parameters:
  newObjects - the objects that have been added this time.



quick
public void quick(String pattern)(Code)



saveState
public void saveState(IMemento memento)(Code)



saveViewSettings
protected void saveViewSettings()(Code)



search
public void search(Object newFilter)(Code)
Search the catalog for text and update view contents
Parameters:
  pattern -



searchImplementation
protected void searchImplementation(Object filter, IProgressMonitor monitor, ResultSet results)(Code)



selectReveal
public void selectReveal(ISelection selection)(Code)



setFocus
public void setFocus()(Code)



setOrientation
protected void setOrientation(Orientation orientation)(Code)
called from ToggleOrientationAction (or compute).
Parameters:
  orientation - Orientation.HORIZONTAL or Orientation.VERTICAL



setShowDetails
public void setShowDetails(boolean show)(Code)



showDetail
protected void showDetail(Object selection)(Code)
Allows subclass to focus the detail on this selection



showSelection
protected boolean showSelection()(Code)
Returns true if the selection returned by SearchPart.getNewSelection(List) should be shown in the viewer. true if the selection returned by SearchPart.getNewSelection(List) should be shown in the viewer.



stopSearch
synchronized void stopSearch()(Code)
Will cancel any outstanding search



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