COSMOS ${releaseVersion} resource-modeling Project
Internal API Specification

org.eclipse.cosmos.rm.smlif.internal.editor
Class SMLIFEditor

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.part.MultiPageEditorPart
                  extended by org.eclipse.ui.forms.editor.FormEditor
                      extended by org.eclipse.cosmos.rm.smlif.internal.editor.SMLIFEditor
All Implemented Interfaces:
java.util.EventListener, org.eclipse.core.resources.IResourceChangeListener, org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, org.eclipse.jface.dialogs.IPageChangeProvider, org.eclipse.ui.IEditorPart, org.eclipse.ui.ISaveablePart, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.IWorkbenchPartOrientation

public class SMLIFEditor
extends org.eclipse.ui.forms.editor.FormEditor
implements org.eclipse.core.resources.IResourceChangeListener

The SML-IF editor part used to create three sub-pages: overview, documents, and sml-if


Field Summary
static int TYPE_IDENTITY
           
 
Fields inherited from class org.eclipse.ui.forms.editor.FormEditor
pages
 
Fields inherited from interface org.eclipse.ui.IEditorPart
PROP_DIRTY, PROP_INPUT
 
Fields inherited from interface org.eclipse.ui.IWorkbenchPart
PROP_TITLE
 
Constructor Summary
SMLIFEditor()
          Create the multi-page editor for SML-IF documents
 
Method Summary
protected  void addPages()
           
 void dispose()
           
 void doSave(org.eclipse.core.runtime.IProgressMonitor monitor)
           
 void doSaveAs()
           
 org.w3c.dom.Document getDocument()
           
protected  org.w3c.dom.Node getDocumentNode()
          Parse and return the DOM document of the SML-IF document
 SMLFormToolkit getExtendedToolkit()
           
 SMLIFFormPart getSmlifFormPart()
           
 void init(org.eclipse.ui.IEditorSite site, org.eclipse.ui.IEditorInput input)
           
 boolean isSaveAsAllowed()
           
 void markDirty()
          Marks this editor as dirty
protected  void pageChange(int newPageIndex)
           
 void resourceChanged(org.eclipse.core.resources.IResourceChangeEvent event)
          Closes all project files on project close.
 org.w3c.dom.Node retrieveChildNode(java.lang.String uri, java.lang.String localName)
          Equivalent to calling retrieveChildNode(Node parent, String uri, String localName), where parent is the root node of the associated document
 java.lang.String retrieveField(int type, java.lang.String name)
           
 
Methods inherited from class org.eclipse.ui.forms.editor.FormEditor
addPage, addPage, addPage, addPage, addPage, addPage, addPageChangedListener, close, commitPages, configurePage, createPageContainer, createPages, createToolkit, editorDirtyStateChanged, findPage, getActiveEditor, getActivePageInstance, getCurrentPage, getSelectedPage, getToolkit, isDirty, removePage, removePageChangedListener, selectReveal, setActivePage, setActivePage, setActivePage, updateActionBarContributor
 
Methods inherited from class org.eclipse.ui.part.MultiPageEditorPart
createPartControl, createSite, findEditors, getActivePage, getAdapter, getContainer, getControl, getEditor, getPageCount, getPageImage, getPageText, handlePropertyChange, setActiveEditor, setControl, setFocus, setPageImage, setPageText
 
Methods inherited from class org.eclipse.ui.part.EditorPart
checkSite, getEditorInput, getEditorSite, getTitleToolTip, isSaveOnCloseNeeded, setContentDescription, setInitializationData, setInput, setInputWithNotify, setPartName
 
Methods inherited from class org.eclipse.ui.part.WorkbenchPart
addPartPropertyListener, addPropertyListener, firePartPropertyChanged, firePropertyChange, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, removePartPropertyListener, removePropertyListener, setPartProperty, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy
 
Methods inherited from class org.eclipse.core.commands.common.EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.ui.IWorkbenchPart
addPropertyListener, getSite, getTitle, getTitleImage, removePropertyListener
 

Field Detail

TYPE_IDENTITY

public static final int TYPE_IDENTITY
See Also:
Constant Field Values
Constructor Detail

SMLIFEditor

public SMLIFEditor()
Create the multi-page editor for SML-IF documents

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 org.eclipse.ui.forms.editor.FormEditor
Throws:
org.eclipse.ui.PartInitException
See Also:
MultiPageEditorPart.init(org.eclipse.ui.IEditorSite, org.eclipse.ui.IEditorInput)

addPages

protected void addPages()
Specified by:
addPages in class org.eclipse.ui.forms.editor.FormEditor
See Also:
FormEditor.addPages()

pageChange

protected void pageChange(int newPageIndex)
Overrides:
pageChange in class org.eclipse.ui.forms.editor.FormEditor

dispose

public void dispose()
Specified by:
dispose in interface org.eclipse.ui.IWorkbenchPart
Overrides:
dispose in class org.eclipse.ui.forms.editor.FormEditor
See Also:
MultiPageEditorPart.dispose()

doSave

public void doSave(org.eclipse.core.runtime.IProgressMonitor monitor)
Specified by:
doSave in interface org.eclipse.ui.ISaveablePart
Specified by:
doSave in class org.eclipse.ui.part.EditorPart
See Also:
EditorPart.doSave(org.eclipse.core.runtime.IProgressMonitor)

doSaveAs

public void doSaveAs()
Specified by:
doSaveAs in interface org.eclipse.ui.ISaveablePart
Specified by:
doSaveAs in class org.eclipse.ui.part.EditorPart
See Also:
EditorPart.doSaveAs()

isSaveAsAllowed

public boolean isSaveAsAllowed()
Specified by:
isSaveAsAllowed in interface org.eclipse.ui.ISaveablePart
Specified by:
isSaveAsAllowed in class org.eclipse.ui.part.EditorPart
See Also:
EditorPart.isSaveAsAllowed()

resourceChanged

public void resourceChanged(org.eclipse.core.resources.IResourceChangeEvent event)
Closes all project files on project close.

Specified by:
resourceChanged in interface org.eclipse.core.resources.IResourceChangeListener

retrieveField

public java.lang.String retrieveField(int type,
                                      java.lang.String name)

retrieveChildNode

public org.w3c.dom.Node retrieveChildNode(java.lang.String uri,
                                          java.lang.String localName)
Equivalent to calling retrieveChildNode(Node parent, String uri, String localName), where parent is the root node of the associated document

Parameters:
uri - The URI
localName - The localName of the element to be retrieved

getDocumentNode

protected org.w3c.dom.Node getDocumentNode()
Parse and return the DOM document of the SML-IF document

Returns:
The DOM document node of the SML-IF file

getDocument

public org.w3c.dom.Document getDocument()

getExtendedToolkit

public SMLFormToolkit getExtendedToolkit()
Returns:
the extendedToolkit

getSmlifFormPart

public SMLIFFormPart getSmlifFormPart()
Returns:
the smlifFormPart

markDirty

public void markDirty()
Marks this editor as dirty


COSMOS ${releaseVersion} resource-modeling Project
Internal API Specification