IEditionService (Modelio 3.5 API)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`activateEditor(IMDATextEditor editor)` Set the focus on a specific editor.
`void`	`closeEditor(IMDATextEditor editor)` Close the given text editor.
`boolean`	`createDocumentContent(ExternDocument doc)` Create a document content for the given document.
`Path`	`editRichNote(ExternDocument doc, IExternDocumentChangeListener listener)` Get a copy of the file for a given external document.
`List<String>`	`getSupportedMimeTypes()` Indicates which mime type are supported in the current instance of Modelio.
`String`	`html2text(String s)`
`void`	`openEditor(AbstractDiagram diagram)` Open a diagram editor from an absract diagram.
`void`	`openEditor(Artifact artifact)` Open an editor from an artifact. The file declared by the artifact must be part of the supported mime type list.
`void`	`openEditor(ExternDocument document)` Open an editor from an extern document. The type of the document's file must be part of the supported mime type list.
`IMDATextEditor`	`openEditor(ModelElement modelElement, File file, EditorType editorTypeID, boolean readonly)` Open a new text editor, making the correspondence between a model element and a file.
`IMDATextEditor`	`openEditor(ModelElement modelElement, File file, EditorType editorTypeID, boolean readonly, String charsetName)` Open a new text editor, making the correspondence between a model element and a file.
`void`	`registerDiagramContributor(ContributorCategory category, IWizardContributor contributor)` Register creation wizard contributor
`void`	`saveRichNote(ExternDocument doc, Path fileToSave)` Save the external document.
`void`	`setDocumentContent(ExternDocument doc, Path content)` Set a document content for the given document.
`void`	`unregisterDiagramContributor(ContributorCategory category, IWizardContributor contributor)` Unregister creation wizard contributor
`void`	`unregisterListener(IExternDocumentChangeListener editor)` To call when an listener is not used anymore.

- Method Detail
  - closeEditor
```
void closeEditor(IMDATextEditor editor)
```
    Close the given text editor.
    
    Parameters:
    
    editor - The text editor to close.
  - activateEditor
```
void activateEditor(IMDATextEditor editor)
```
    Set the focus on a specific editor.
    
    Parameters:
    
    editor - the editor to focus.
  - getSupportedMimeTypes
```
List<String> getSupportedMimeTypes()
```
    Indicates which mime type are supported in the current instance of Modelio.
    
    Returns:
    
    the supported mime type list.
    
    Since:
    
    2.1
  - openEditor
```
IMDATextEditor openEditor(ModelElement modelElement,
                          File file,
                          EditorType editorTypeID,
                          boolean readonly)
```
    Open a new text editor, making the correspondence between a model element and a file. Use default UTF-8 charset.
    
    Parameters:
    
    modelElement - the model element to edit.
    
    file - the file to display in the editor.
    
    editorTypeID - the type of the editor to open.
    
    readonly - true if the editor is in read only mode.
    
    Returns:
    
    the opened editor.
  - openEditor
```
IMDATextEditor openEditor(ModelElement modelElement,
                          File file,
                          EditorType editorTypeID,
                          boolean readonly,
                          String charsetName)
```
    Open a new text editor, making the correspondence between a model element and a file.
    
    Parameters:
    
    modelElement - the model element to edit.
    
    file - the file to display in the editor.
    
    editorTypeID - the type of the editor to open.
    
    readonly - true if the editor is in read only mode.
    
    charsetName - The name of a supported charset.
    
    Returns:
    
    the opened editor.
    
    Since:
    
    3.3.0
  - openEditor
```
void openEditor(AbstractDiagram diagram)
```
    Open a diagram editor from an absract diagram.
    
    Parameters:
    
    diagram - the diagram to edit.
    
    Since:
    
    2.1
  - openEditor
```
void openEditor(Artifact artifact)
```
    Open an editor from an artifact.
    The file declared by the artifact must be part of the supported mime type list.
    
    Parameters:
    
    artifact - the artifact to edit.
    
    Since:
    
    2.1
  - createDocumentContent
```
boolean createDocumentContent(ExternDocument doc)
                       throws IOException
```
    Create a document content for the given document.
    A default content is found by 2 ways:
    1. Look for a document named "default" under the ExternDocumentType with the same MIME type.
    2. Look in .projectdata/admin/documents for a file named:
      
      role_name.mime_type.dat like file
      role_name.dat like file.
      All invalid characters for a file name in the document type and MIME type are replaced by '_' when looked for the file.
    3. If everything failed then an empty content valid for the MIME type is created.
    Parameters:
    
    doc - The document to initialize
    
    Returns:
    
    true if the file was created, false if no default content could be found.
    
    Throws:
    
    IOException - in case of error trying to create the file.
    
    Since:
    
    2.1
  - setDocumentContent
```
void setDocumentContent(ExternDocument doc,
                        Path content)
                 throws IOException
```
    Set a document content for the given document.
    
    Parameters:
    
    doc - The document to update.
    
    content - the content to set.
    
    Throws:
    
    IOException - in case of error trying to set the file.
    
    Since:
    
    3.1
  - editRichNote
```
Path editRichNote(ExternDocument doc,
                  IExternDocumentChangeListener listener)
           throws IOException
```
    Get a copy of the file for a given external document.
    
    Parameters:
    
    doc - an external document.
    
    listener - A listener fired if the original note is modified externally, by SVN for example. null means no edition.
    
    Returns:
    
    its file.
    
    Throws:
    
    IOException - in case of failure.
    
    Since:
    
    3.1
  - saveRichNote
```
void saveRichNote(ExternDocument doc,
                  Path fileToSave)
           throws IOException
```
    Save the external document.
    
    Parameters:
    
    doc - the external document model object.
    
    fileToSave - the external document content
    
    Throws:
    
    IOException - in case of failure.
    
    Since:
    
    3.1
  - unregisterListener
```
void unregisterListener(IExternDocumentChangeListener editor)
```
    To call when an listener is not used anymore.
    
    Parameters:
    
    editor - the listener to unregister.
    
    Since:
    
    3.1
  - html2text
```
String html2text(String s)
```
  - openEditor
```
void openEditor(ExternDocument document)
```
    Open an editor from an extern document.
    The type of the document's file must be part of the supported mime type list.
    
    Parameters:
    
    document - the extern document to edit.
    
    Since:
    
    2.1
  - registerDiagramContributor
```
void registerDiagramContributor(ContributorCategory category,
                                IWizardContributor contributor)
```
    Register creation wizard contributor
    
    Parameters:
    
    contributor -
    
    category - of the diagram contributor
    
    Since:
    
    3.4
  - unregisterDiagramContributor
```
void unregisterDiagramContributor(ContributorCategory category,
                                  IWizardContributor contributor)
```
    Unregister creation wizard contributor
    
    Parameters:
    
    contributor -
    
    category - of the diagram contributor
    
    Since:
    
    3.4

Interface IEditionService

Method Summary

Method Detail

closeEditor

activateEditor

getSupportedMimeTypes

openEditor

openEditor

openEditor

openEditor

createDocumentContent

setDocumentContent

editRichNote

saveRichNote

unregisterListener

html2text

openEditor

registerDiagramContributor

unregisterDiagramContributor