blob: 831136e9e5591fac4e8ee2699a63cab14c700b1d [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>SQL Editor Document Provider</title>
<style>@import url("file:/c:/V3/3.1/eclipse/plugins/org.eclipse.sdk_3.1.0/book.css");</style>
<style>@import url("file:/c:/V3/3.1/eclipse/plugins/org.eclipse.platform.doc.isv_3.1.0/schema.css");</style>
</HEAD>
<BODY>
<H1><CENTER>SQL Editor Document Provider</CENTER></H1>
<p></p>
<h6 class=CaptionFigColumn id=header>Identifier: </h6>com.sybase.stf.dmp.editor.documentprovider<p></p>
<h6 class=CaptionFigColumn id=header>Since: </h6>0.7.0
<p></p>
<p>
<h6 class=CaptionFigColumn id=header>Description: </h6>This extension point allows a document provider to be contributed for SQL Routine editor. Extensions register a <code>org.eclipse.datatools.sqltools.routineeditor.IRoutineEditorDocumentProvider</code> class which will provide additional functions beyond the original document provider. Note: this extension point is intended to be used by DTP SQL debugger only for now.</p>
<p><h6 class=CaptionFigColumn id=header>Configuration Markup:</h6></p>
<p class=code id=dtd>&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.provider">provider</a>)&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST extension</p>
<p class=code id=dtdAttlist>point&nbsp;CDATA #REQUIRED<p class=code id=dtdAttlist>id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class=code id=dtdAttlist>name&nbsp;&nbsp;CDATA #IMPLIED&gt;</p>
<p></p>
<p class=ConfigMarkup id=elementDesc>
This extension point should be used by debugger only.</p>
<br>
<ul class=ConfigMarkup id=attlistDesc>
</ul>
<br><p class=code id=dtd>&lt;!ELEMENT <a name="e.provider">provider</a> EMPTY&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST provider</p>
<p class=code id=dtdAttlist>id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class=code id=dtdAttlist>class&nbsp;CDATA #REQUIRED&gt;</p>
<p></p>
<ul class=ConfigMarkup id=attlistDesc>
<li><b>id</b> - optional id</li>
<li><b>class</b> - a fully qualified name of the Java class implementing org.eclipse.datatools.sqltools.routineeditor.IRoutineEditorDocumentProvider.</li>
</ul>
<br><h6 class=CaptionFigColumn id=header>Examples: </h6><p><pre>
<p class=code id=tag>&lt;extension
point=<p class=code id=cstring>&quot;org.eclipse.datatools.sqltools.routineeditor.documentprovider&quot;</p><p class=code id=tag>&gt;</p>
<p class=code id=tag>&lt;provider class=<p class=code id=cstring>&quot;org.eclipse.datatools.sqltools.debugger.editorextension.SQLDebuggerDocumentProvider&quot;</p><p class=code id=tag>/&gt;</p>
<p class=code id=tag>&lt;/extension&gt;</p>
</pre></p>
SQLDebuggerDocumentProvider will be used by SQLEditorDocumentProvider to manage breakpoint positions.
<p></p>
<h6 class=CaptionFigColumn id=header>API Information: </h6>The class attribute must be a fully qualified name of the Java class implementing org.eclipse.datatools.sqltools.routineeditor.IRoutineEditorDocumentProvider.
public interface IRoutineEditorDocumentProvider extends IDocumentProvider, IDocumentProviderExtension2, IDocumentProviderExtension3
{
/**
* Refreshs the routine object from database.
* @param element the routine object
* @param controlCon control connection that's used by the routine editor
* @param proc the routine identifier
*/
public void refreshFromDatabase(Object element, IControlConnection controlCon, ProcIdentifier proc) throws CoreException, SQLException;
}
<p></p>
<h6 class=CaptionFigColumn id=header>Supplied Implementation: </h6>[Enter information about supplied implementation of this extension point.]
<p></p>
<br>
<p class=note id=copyright>
Copyright (c) 2005 Sybase, Inc.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License 2.0
which accompanies this distribution, and is available at
https://www.eclipse.org/legal/epl-2.0/
Contributors:
Sybase, Inc. - initial API and implementation
<p></p>
</p>
</BODY>
</HTML>