IEditionService (Modelio 4.1 API (commercial))

Method Summary

All Methods Instance Methods Abstract Methods Deprecated 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(Document doc)` Create a document content for the given document.
`java.nio.file.Path`	`editRichNote(Document doc, IExternDocumentChangeListener listener)` Get a copy of the file for a given external document.
`java.util.List<java.lang.String>`	`getSupportedMimeTypes()` Indicates which mime type are supported in the current instance of Modelio.
`java.lang.String`	`html2text(java.lang.String s)`
`void`	`openEditor(AbstractDiagram diagram)` Open a diagram editor from an `AbstractDiagram`.
`void`	`openEditor(Artifact artifact)` Open an editor from an artifact.
`void`	`openEditor(Document document)` Open an editor from an extern document.
`void`	`openEditor(MatrixDefinition document)` Open an editor from a matrix.
`IMDATextEditor`	`openEditor(ModelElement modelElement, java.io.File file, EditorType editorTypeID, boolean readonly)` Deprecated. use `openEditor(ModelElement, File, EditorType, boolean, String, String, String)` instead.
`IMDATextEditor`	`openEditor(ModelElement modelElement, java.io.File file, EditorType editorTypeID, boolean readonly, java.lang.String charsetName)` Deprecated. use `openEditor(ModelElement, File, EditorType, boolean, String, String, String)` instead.
`IMDATextEditor`	`openEditor(ModelElement modelElement, java.io.File file, EditorType editorTypeID, boolean readonly, java.lang.String charsetName, java.lang.String askedTitle, java.lang.String askedTooltip)` 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(Document doc, java.nio.file.Path fileToSave)` Save the external document.
`void`	`setDocumentContent(Document doc, java.nio.file.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
  - activateEditor
```
void activateEditor(IMDATextEditor editor)
```
    Set the focus on a specific editor.
    
    Parameters:
    
    editor - the editor to focus.
  - closeEditor
```
void closeEditor(IMDATextEditor editor)
```
    Close the given text editor.
    
    Parameters:
    
    editor - The text editor to close.
  - createDocumentContent
```
boolean createDocumentContent(Document doc)
                       throws java.io.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:
    
    java.io.IOException - in case of error trying to create the file.
    
    Since:
    
    2.1
  - editRichNote
```
java.nio.file.Path editRichNote(Document doc,
                                IExternDocumentChangeListener listener)
                         throws java.io.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:
    
    java.io.IOException - in case of failure.
    
    Since:
    
    3.1
  - getSupportedMimeTypes
```
java.util.List<java.lang.String> getSupportedMimeTypes()
```
    Indicates which mime type are supported in the current instance of Modelio.
    
    Returns:
    
    the supported mime type list.
    
    Since:
    
    2.1
  - html2text
```
java.lang.String html2text(java.lang.String s)
```
  - openEditor
```
@Deprecated
IMDATextEditor openEditor(ModelElement modelElement,
                                      java.io.File file,
                                      EditorType editorTypeID,
                                      boolean readonly)
```
    Deprecated. use openEditor(ModelElement, File, EditorType, boolean, String, String, String) instead.
    
    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
```
@Deprecated
IMDATextEditor openEditor(ModelElement modelElement,
                                      java.io.File file,
                                      EditorType editorTypeID,
                                      boolean readonly,
                                      java.lang.String charsetName)
```
    Deprecated. use openEditor(ModelElement, File, EditorType, boolean, String, String, String) instead.
    
    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. If null it will be the UTF-8 charset.
    
    Returns:
    
    the opened editor.
    
    Since:
    
    3.3.0
  - openEditor
```
void openEditor(AbstractDiagram diagram)
```
    Open a diagram editor from an AbstractDiagram.
    
    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
  - openEditor
```
void openEditor(Document 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
  - openEditor
```
IMDATextEditor openEditor(ModelElement modelElement,
                          java.io.File file,
                          EditorType editorTypeID,
                          boolean readonly,
                          java.lang.String charsetName,
                          java.lang.String askedTitle,
                          java.lang.String askedTooltip)
```
    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. If null it will be the UTF-8 charset.
    
    askedTitle - the tab title. If null it will be the model element name.
    
    askedTooltip - the tab tooltip. If null it will be the file absolute path.
    
    Returns:
    
    the opened editor.
    
    Since:
    
    3.6.1
  - openEditor
```
void openEditor(MatrixDefinition document)
```
    Open an editor from a matrix.
    The type of the document's file must be part of the supported mime type list.
    
    Parameters:
    
    document - the matrix to edit.
    
    Since:
    
    3.8.0 Valkyrie
  - registerDiagramContributor
```
void registerDiagramContributor(ContributorCategory category,
                                IWizardContributor contributor)
```
    Register creation wizard contributor
    
    Parameters:
    
    category - of the diagram contributor
    
    contributor - the diagram contributor
    
    Since:
    
    3.4
  - saveRichNote
```
void saveRichNote(Document doc,
                  java.nio.file.Path fileToSave)
           throws java.io.IOException
```
    Save the external document.
    
    Parameters:
    
    doc - the external document model object.
    
    fileToSave - the external document content
    
    Throws:
    
    java.io.IOException - in case of failure.
    
    Since:
    
    3.1
  - setDocumentContent
```
void setDocumentContent(Document doc,
                        java.nio.file.Path content)
                 throws java.io.IOException
```
    Set a document content for the given document.
    
    Parameters:
    
    doc - The document to update.
    
    content - the content to set.
    
    Throws:
    
    java.io.IOException - in case of error trying to set the file.
    
    Since:
    
    3.1
  - unregisterDiagramContributor
```
void unregisterDiagramContributor(ContributorCategory category,
                                  IWizardContributor contributor)
```
    Unregister creation wizard contributor
    
    Parameters:
    
    category - of the diagram contributor
    
    contributor - the diagram contributor
    
    Since:
    
    3.4
  - unregisterListener
```
void unregisterListener(IExternDocumentChangeListener editor)
```
    To call when an listener is not used anymore.
    
    Parameters:
    
    editor - the listener to unregister.
    
    Since:
    
    3.1

Interface IEditionService

Method Summary

Method Detail

activateEditor

closeEditor

createDocumentContent

editRichNote

getSupportedMimeTypes

html2text

openEditor

openEditor

openEditor

openEditor

openEditor

openEditor

openEditor

registerDiagramContributor

saveRichNote

setDocumentContent

unregisterDiagramContributor

unregisterListener