Editores Internos e Externos

org.eclipse.ui.editors

Este ponto de extensão é utilizado para adicionar novos editores à área de trabalho. Um editor é um componente visual dentro de uma página da área de trabalho. Normalmente é utilizado para editar ou procurar um documento ou um objecto de entrada. Para abrir um editor, o utilizador irá normalmente invocar "Abrir" (Open) num IFile. Quando esta acção é executada é consultado o registo da área de trabalho para determinar um editor apropriado para o tipo de ficheiro e então é criada uma nova instância do tipo de editor. O verdadeiro resultado depende do tipo de editor. A área de trabalho fornece suporte para a criação do editores internos, que estão fortemente integrados na área de trabalho, e editores externos, que são iniciados numa janela de estrutura separada. Existem também vários níveis de integração entre estes extremos.

No caso de um editor interno, a forte integração pode ser conseguida entre a janela da área de trabalho e do editor. O menu e a barra de ferramentas da área de trabalho são pré-carregados com um número de acções comuns como cortar, copiar e colar. Espera-se que a parte activa, a visualização ou o editor, melhorem a implementação destas acções. Um editor interno pode ainda definir novas acções que aparecem na janela da área de trabalho. Estas acções apenas aparecem quando o editor está activo.

A integração entre a área de trabalho e os editores externos é mais ténue. Neste caso, a área de trabalho poderá lançar um editor, mas depois não tem qualquer maneira de determinar o estado do editor externo ou sequer de colaborar com este por qualquer meio, excepto o sistema de ficheiros.

<!ELEMENT extension (editor*)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT editor (contentTypeBinding*)>

<!ATTLIST editor

id               CDATA #REQUIRED

name             CDATA #REQUIRED

icon             CDATA #IMPLIED

extensions       CDATA #IMPLIED

class            CDATA #IMPLIED

command          CDATA #IMPLIED

launcher         CDATA #IMPLIED

contributorClass CDATA #IMPLIED

default          (true | false) "false"

filenames        CDATA #IMPLIED

symbolicFontName CDATA #IMPLIED

matchingStrategy CDATA #IMPLIED>


<!ELEMENT contentTypeBinding EMPTY>

<!ATTLIST contentTypeBinding

contentTypeId CDATA #REQUIRED>

Mostra que o editor de contenção compreende o tipo de conteúdo fornecido e adequa-se à edição de ficheiros desse tipo.



A seguir encontra-se um exemplo de uma definição de extensão de editor interno:

   

<extension point=

"org.eclipse.ui.editors"

>

<editor id=

"com.xyz.XMLEditor"

name=

"Fancy XYZ XML editor"

icon=

"./icons/XMLEditor.gif"

extensions=

"xml"

class=

"com.xyz.XMLEditor"

contributorClass=

"com.xyz.XMLEditorContributor"

symbolicFontName=

"org.eclipse.jface.textfont"

default=

"false"

>

</editor>

</extension>

Se o atributo command for utilizado, será tratado como um linha de comandos de programa externo que irá ser executada numa forma dependente da plataforma.

Se o atributo launcher for utilizado com o editor também será tratado como um programa externo. Neste caso, a classe especificado tem de implementar org.eclipse.ui.IEditorLauncher. O lançador será dividido em instâncias e, em seguida, será invocado open(IFile file) para lançar o editor.

Se o atributo class for utilizado, a área de trabalho irá partir do princípio que é um editor interno e que a classe especificada tem de implementar org.eclipse.ui.IEditorPart. É comum utilizar subclass org.eclipse.ui.EditorPart quando se define um novo tipo de editor. Também é necessário definir um atributo contributorClass. A classe especificada tem de implementar org.eclipse.ui.IEditorActionBarContributor, e é utilizada para adicionar novas acções ao menu e à barra de ferramentas da área de trabalho, que reflectem as funções do tipo de editor.

Dentro da área de trabalho poderá existir mais do que um editor aberto de um tipo específico. Por exemplo, podem existir um ou mais Editores Java abertos. Para evitar a criação de acções e imagens de acções duplicadas, o conceito do editor foi dividido em dois. Um IEditorActionBarContributor é responsável pela criação de acções. O editor é responsável pela implementação de acções. Além disso, o contribuidor é partilhado por cada editor aberto. Como resultado desta concepção, existe apenas um conjunto de acções para um ou mais editores abertos.

O contribuidor irá adicionar novas acções ao menu e à barra de ferramentas da área de trabalho, que irão reflectir o tipo de editor. Estas acções são partilhadas e, quando invocadas, actuam sobre o editor activo. O editor activo é passado para o contribuidor invocando IEditorActionBarContributor.setActiveEditor. Os identificadores para acções e grupos principais dentro da janela da área de trabalho estão definidos em org.eclipse.ui.IWorkbenchActionConstants. Estes devem ser utilizados como um ponto de referência para a adição de novas acções. Os menus de nível superior são criadas utilizando os valores seguintes para o atributo path:

As acções e os menus adicionados nestes caminhos serão apenas mostrados enquanto o editor associado estiver activo. Quando o editor está fechado, os menus e as acções serão removidos.

A área de trabalho fornece um "Editor de Texto Predefinido". O produto do utilizador final poderá conter outros editores como parte do conjunto comercializado. Nesse caso, os editores serão registados como extensões utilizando a sintaxe descrita anteriormente.