org.eclipse.datatools.sqltools.routineeditor.ui
Class RoutineEditor

java.lang.Object
  extended by org.eclipse.core.commands.common.EventManager
      extended by org.eclipse.ui.part.WorkbenchPart
          extended by org.eclipse.ui.part.EditorPart
              extended by org.eclipse.ui.texteditor.AbstractTextEditor
                  extended by org.eclipse.ui.texteditor.StatusTextEditor
                      extended by org.eclipse.ui.texteditor.AbstractDecoratedTextEditor
                          extended by org.eclipse.ui.editors.text.TextEditor
                              extended by org.eclipse.datatools.sqltools.sqleditor.SQLEditor
                                  extended by org.eclipse.datatools.sqltools.routineeditor.ui.RoutineEditor
All Implemented Interfaces:
java.util.EventListener, org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, org.eclipse.jface.util.IPropertyChangeListener, org.eclipse.ui.IEditorPart, org.eclipse.ui.INavigationLocationProvider, org.eclipse.ui.IPersistable, org.eclipse.ui.IPersistableEditor, org.eclipse.ui.IReusableEditor, org.eclipse.ui.ISaveablePart, org.eclipse.ui.ISaveablesSource, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.IWorkbenchPartOrientation, org.eclipse.ui.texteditor.ITextEditor, org.eclipse.ui.texteditor.ITextEditorExtension, org.eclipse.ui.texteditor.ITextEditorExtension2, org.eclipse.ui.texteditor.ITextEditorExtension3, org.eclipse.ui.texteditor.ITextEditorExtension4
Direct Known Subclasses:
ASARoutineSourceEditor

public class RoutineEditor
extends SQLEditor

A SQL Editor handles routine objects including stored procedure, function, trigger, and event.

Author:
Hui Cao
See Also:
Routine

Nested Class Summary
 
Nested classes/interfaces inherited from class org.eclipse.datatools.sqltools.sqleditor.SQLEditor
SQLEditor.AdaptedSourceViewer
 
Nested classes/interfaces inherited from interface org.eclipse.ui.texteditor.ITextEditorExtension3
org.eclipse.ui.texteditor.ITextEditorExtension3.InsertMode
 
Field Summary
static java.lang.String EDITOR_ID
           
 
Fields inherited from class org.eclipse.datatools.sqltools.sqleditor.SQLEditor
HELP_CONTEXT_ID, PLUGIN_NAME
 
Fields inherited from class org.eclipse.ui.texteditor.AbstractDecoratedTextEditor
DEFAULT_OVERVIEW_RULER_CONTEXT_MENU_ID
 
Fields inherited from class org.eclipse.ui.texteditor.AbstractTextEditor
DEFAULT_EDITOR_CONTEXT_MENU_ID, DEFAULT_RULER_CONTEXT_MENU_ID, PREFERENCE_COLOR_BACKGROUND, PREFERENCE_COLOR_BACKGROUND_SYSTEM_DEFAULT, PREFERENCE_COLOR_FIND_SCOPE, PREFERENCE_COLOR_FOREGROUND, PREFERENCE_COLOR_FOREGROUND_SYSTEM_DEFAULT, PREFERENCE_COLOR_SELECTION_BACKGROUND, PREFERENCE_COLOR_SELECTION_BACKGROUND_SYSTEM_DEFAULT, PREFERENCE_COLOR_SELECTION_FOREGROUND, PREFERENCE_COLOR_SELECTION_FOREGROUND_SYSTEM_DEFAULT, PREFERENCE_FONT, PREFERENCE_HOVER_ENRICH_MODE, PREFERENCE_HYPERLINK_KEY_MODIFIER, PREFERENCE_HYPERLINK_KEY_MODIFIER_MASK, PREFERENCE_HYPERLINKS_ENABLED, PREFERENCE_NAVIGATION_SMART_HOME_END, PREFERENCE_RULER_CONTRIBUTIONS, PREFERENCE_SHOW_WHITESPACE_CHARACTERS, PREFERENCE_TEXT_DRAG_AND_DROP_ENABLED, PREFERENCE_USE_CUSTOM_CARETS, PREFERENCE_WIDE_CARET
 
Fields inherited from interface org.eclipse.ui.IEditorPart
PROP_DIRTY, PROP_INPUT
 
Fields inherited from interface org.eclipse.ui.IWorkbenchPart
PROP_TITLE
 
Fields inherited from interface org.eclipse.ui.IEditorPart
PROP_DIRTY, PROP_INPUT
 
Fields inherited from interface org.eclipse.ui.IWorkbenchPart
PROP_TITLE
 
Fields inherited from interface org.eclipse.ui.texteditor.ITextEditorExtension3
INSERT, SMART_INSERT
 
Constructor Summary
RoutineEditor()
           
 
Method Summary
 void dispose()
          Dispose of resources held by this editor.
 void doSave(org.eclipse.core.runtime.IProgressMonitor monitor)
          Saves the content of this editor.
 void doSaveAs()
          Saves the contents of this editor to another object.
 java.util.ResourceBundle getConstructedResourceBundle()
          Gets the resource bundle associated with this editor.
 org.eclipse.datatools.sqltools.core.ProcIdentifier getCurrProcIdentifier()
           
 int getSQLType()
          Returns the outmost sql statement type that's allowed in this editor.
 void init(org.eclipse.ui.IEditorSite site, org.eclipse.ui.IEditorInput input)
           
 void setConnectionInfo(ISQLEditorConnectionInfo connInfo)
          Sets the connection info object of the editor input of this editor.
 
Methods inherited from class org.eclipse.datatools.sqltools.sqleditor.SQLEditor
addConnectionProfileAttachListener, createPartControl, doRevertToSaved, doSetInput, fireConnectionProfileAttached, getAdapter, getConnectionInfo, getDatabase, getDatabaseIdentifier, getDBProposalsService, getDBType, getDefaultSchemaName, getDocumentSetupParticipant, getOrientation, getParentEditor, getParsingResult, getResourceBundle, getSelectedText, getSQLColorProvider, getSV, getTargetText, getText, gotoMatchingToken, insert, isConnected, outlinePageClosed, propertyChange, refreshConnectionStatus, removeConnectionProfileAttachListener, requestConnection, requestConnectionFromUser, setDocumentSetupParticipant, setFocus, setParentEditor, setParsingResult, updatePartControl
 
Methods inherited from class org.eclipse.ui.editors.text.TextEditor
isSaveAsAllowed
 
Methods inherited from class org.eclipse.ui.texteditor.AbstractDecoratedTextEditor
getDocumentProvider, gotoAnnotation, gotoMarker, isChangeInformationShowing, isEditable, showChangeInformation, showRevisionInformation, validateEditorInputState
 
Methods inherited from class org.eclipse.ui.texteditor.AbstractTextEditor
addRulerContextMenuListener, close, createEmptyNavigationLocation, createNavigationLocation, getAction, getActiveSaveables, getHighlightRange, getInsertMode, getSaveables, getSelectionProvider, isDirty, isEditorInputModifiable, isEditorInputReadOnly, markAsContentDependentAction, markAsPropertyDependentAction, markAsSelectionDependentAction, markAsStateDependentAction, removeActionActivationCode, removeRulerContextMenuListener, resetHighlightRange, restoreState, saveState, selectAndReveal, setAction, setActionActivationCode, setHighlightRange, setInput, setInsertMode, setStatusField, showHighlightRangeOnly, showsHighlightRangeOnly
 
Methods inherited from class org.eclipse.ui.part.EditorPart
getEditorInput, getEditorSite, getTitleToolTip, isSaveOnCloseNeeded, setInitializationData
 
Methods inherited from class org.eclipse.ui.part.WorkbenchPart
addPartPropertyListener, addPropertyListener, getContentDescription, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, removePartPropertyListener, removePropertyListener, setPartProperty, showBusy
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.ui.IEditorPart
getEditorInput, getEditorSite
 
Methods inherited from interface org.eclipse.ui.IWorkbenchPart
addPropertyListener, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener
 
Methods inherited from interface org.eclipse.ui.ISaveablePart
isSaveOnCloseNeeded
 
Methods inherited from interface org.eclipse.ui.IEditorPart
getEditorInput, getEditorSite
 
Methods inherited from interface org.eclipse.ui.IWorkbenchPart
addPropertyListener, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener
 
Methods inherited from interface org.eclipse.ui.ISaveablePart
isSaveOnCloseNeeded
 

Field Detail

EDITOR_ID

public static final java.lang.String EDITOR_ID
See Also:
Constant Field Values
Constructor Detail

RoutineEditor

public RoutineEditor()
Method Detail

init

public void init(org.eclipse.ui.IEditorSite site,
                 org.eclipse.ui.IEditorInput input)
          throws org.eclipse.ui.PartInitException
Specified by:
init in interface org.eclipse.ui.IEditorPart
Overrides:
init in class SQLEditor
Throws:
org.eclipse.ui.PartInitException

doSave

public void doSave(org.eclipse.core.runtime.IProgressMonitor monitor)
Description copied from class: SQLEditor
Saves the content of this editor.

Specified by:
doSave in interface org.eclipse.ui.ISaveablePart
Overrides:
doSave in class SQLEditor
See Also:
ISaveablePart.doSave(org.eclipse.core.runtime.IProgressMonitor)

doSaveAs

public void doSaveAs()
Description copied from class: SQLEditor
Saves the contents of this editor to another object.

Specified by:
doSaveAs in interface org.eclipse.ui.ISaveablePart
Overrides:
doSaveAs in class SQLEditor
See Also:
ISaveablePart.doSaveAs()

getSQLType

public int getSQLType()
Description copied from class: SQLEditor
Returns the outmost sql statement type that's allowed in this editor. The default sqlType is SQLParserConstants.TYPE_SQL_ROOT, which means any sql statements can occur.

Overrides:
getSQLType in class SQLEditor
Returns:

dispose

public void dispose()
Description copied from class: SQLEditor
Dispose of resources held by this editor.

Specified by:
dispose in interface org.eclipse.ui.IWorkbenchPart
Overrides:
dispose in class SQLEditor
See Also:
IWorkbenchPart.dispose()

getConstructedResourceBundle

public java.util.ResourceBundle getConstructedResourceBundle()
Gets the resource bundle associated with this editor.

Returns:
the resource bundle associated with this editor.

getCurrProcIdentifier

public org.eclipse.datatools.sqltools.core.ProcIdentifier getCurrProcIdentifier()

setConnectionInfo

public void setConnectionInfo(ISQLEditorConnectionInfo connInfo)
Description copied from class: SQLEditor
Sets the connection info object of the editor input of this editor. Also updates connection related features such as actions, status line, syntax highlighting, and syntax validation, etc.

Overrides:
setConnectionInfo in class SQLEditor
Parameters:
connInfo - the new connection info object