Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Results View Control
← Back to SQL Development Tools page
Contents
Introduction
The DTP Results View now provides a ResultsViewControl component for displaying SQL execution results. The ResultsViewControl can be consumed by other UI components such as editors, dialogs and wizards, enabling them to show SQL execution results in their own user-interface.
ResultsViewControl
Location
The ResultsViewControl is in the plugin
- org.eclipse.datatools.sqltools.result
in the package
- org.eclipse.datatools.sqltools.result.ui.view.
API
The ResultsViewControl should be instantiated using the constructor
- ResultsViewControl(ResultsView)
passing null as the ResultsView parameter.
After instantiation, the ResultsViewControl should be initialized by calling:
- init(IViewSite, IMemento) throws PartInitException
passing two null parameters.
The final part of ResultsViewControl creation is to call
- void createPartControl(Composite parent)
The client can request the ResultsViewControl to use the Preferences defined for the SQL Results View or not, using the method
- setUsePreferences(boolean)
If setUsePreferences(true) is called, the preferences for SQL Results View relating to the user-interface will be used. These control, for example, whether results are shown in a single window or multiple windows, in text mode or grid mode.
If setUsePreferences(false) is called, the preferences defaults for the SQL Results View are used.
For example code, see Example Usage
Filtering Results
Example Usage
/* * Add the results view */ _resultsViewControl = new ResultsViewControl(null); /* * Tell the results view to use preferences */ _resultsViewControl.setUsePreferences(true); try { _resultsViewControl.init(null, null); } catch (PartInitException e) { e.printStackTrace(); } _resultsViewControl.createPartControl(resultsComposite);