Assistentes de Criação
Identificador:
org.eclipse.ui.newWizards
Descrição:
Este ponto de extensão é utilizado para registar extensões de assistentes de criação de recursos. Os assistentes de criação aparecem como opções dentro de "Caixa de Diálogo Novo", e são normalmente utilizados para criar pastas e ficheiros.
Na "Caixa de Diálogo Novo", os assistentes estão organizados em categorias que normalmente reflectem um domínio de problema específico. Por exemplo, um conector orientado por Java define uma categoria chamada "Java", que é apropriada para assistentes de criação de "Classe" ou "Pacote". As categorias definidas por um conector podem ser referenciadas por outros conectores utilizando o atributo category. Os assistentes que não pertencem a nenhum categoria, bem como os assistentes com caminhos de categoria inválidos, irão acabar numa categoria "Outro".
Os assistentes podem, opcionalmente, especificar um sub-elemento de descrição cujo corpo deve conter um texto breve sobre o assistente.
Marcação da Configuração:
<!ELEMENT extension (category | wizard | primaryWizard)*>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
- point - um identificador totalmente qualificado do ponto de extensão de destino
- id - um identificador opcional da instância de extensão
- name - um nome opcional da instância de extensão
<!ELEMENT category EMPTY>
<!ATTLIST category
id CDATA #REQUIRED
name CDATA #REQUIRED
parentCategory CDATA #IMPLIED>
- id - um nome exclusivo que pode ser utilizado para identificar esta categoria
- name - um nome traduzível da categoria que será utilizada na caixa de diálogo
- parentCategory - um caminho para outra categoria, se esta categoria for adicionada como um descendente
<!ELEMENT wizard (description? , selection*)>
<!ATTLIST wizard
id CDATA #REQUIRED
name CDATA #REQUIRED
icon CDATA #IMPLIED
category CDATA #IMPLIED
class CDATA #REQUIRED
project (true | false)
finalPerspective CDATA #IMPLIED
preferredPerspectives CDATA #IMPLIED
helpHref CDATA #IMPLIED
descriptionImage CDATA #IMPLIED
canFinishEarly (true | false)
hasPages (true | false) >
- id - um nome exclusivo que pode ser utilizado para identificar este assistente
- name - um nome traduzível do assistente que será utilizado na caixa de diálogo
- icon - um caminho relativo de um ícone que será utilizado em conjunto com o nome para representar o assistente como uma das opções na caixa de diálogo de criação
- category - um caminho definido por barra ('/') dos IDs de categoria. Cada símbolo no caminho
tem de representar um ID de categoria válido, definido previamente
por este ou por outro plug-in. Se for omitido, o assistente é
adicionado à categoria "Other".
- class - um nome totalmente qualificado da classe Java que implementa org.eclipse.ui.INewWizard.
- project - um atributo opcional que indica que o assistente irá criar um recurso IProject.
Faz também com que o assistente apareça como uma opção dentro da "Caixa de Diálogo Novo Projecto".
- finalPerspective - um atributo opcional que identificar uma perspectiva a activar quando termina a criação do recurso IProject.
- preferredPerspectives - um atributo opcional especificando uma lista separada por vírgulas dos IDs de perspectiva. Se a perspectiva actual estiver na lista, então não ocorre qualquer activação de perspectiva quando termina a criação do recurso IProject.
- helpHref - um URL de ajuda que pode descrever este assistente detalhadamente.
Desde 3.0
- descriptionImage - uma imagem maior que pode ajudar a descrever este assistente.
Desde 3.0
- canFinishEarly - indica se o assistente é capaz de terminar sem nunca mostrar as páginas ao utilizador.
- hasPages - indica se o assistente fornece quaisquer páginas.
<!ELEMENT description (#PCDATA)>
um sub-elemento opcional cujo corpo contém um texto breve a descrever o que o assistente fará quando for iniciado
<!ELEMENT selection EMPTY>
<!ATTLIST selection
class CDATA #REQUIRED
name CDATA #IMPLIED>
- class - um nome de classe totalmente qualificado. Se cada objecto na selecção da área de trabalho implementar esta interface, a selecção será passada para o assistente. Caso contrário, será passada uma selecção vazia.
- name - um filtro de nome opcional. Cada objecto na selecção da área de trabalho deve corresponder ao filtro de nome a passar ao assistente.
<!ELEMENT primaryWizard EMPTY>
<!ATTLIST primaryWizard
id CDATA #REQUIRED>
um meio de declarar que um assistente é "primary" na UI. Um assistente principal é enfatizado na caixa de diálogo novo assistente. Note que este elemento não se destina a ser utilizado por programadores de conectores! Este elemento existe para que os gestores de produto possam enfatizar um conjunto de assistentes para os produtos.
- id - o id de um assistente que deverá ser tornado primário.
Exemplos:
A seguir encontra-se um exemplo da configuração do assistente de criação:
<extension point=
"org.eclipse.ui.newWizards"
>
<category
id=
"com.xyz.XYZ"
name=
"XYZ Wizards"
>
</category>
<category
id=
"com.xyz.XYZ.Web"
name=
"Web Wizards"
parentCategory=
"com.xyz.XYZ"
>
</category>
<wizard
id=
"com.xyz.wizard1"
name=
"XYZ artifact"
category=
"com.xyz.XYZ/com.xyz.XYZ.Web"
icon=
"./icons/XYZwizard1.gif"
class=
"com.xyz.XYZWizard1"
>
<description>
Create a simple XYZ artifact and set initial content
</description>
<selection class=
"org.eclipse.core.resources.IResource"
/>
</wizard>
</extension>
Informações de API:
O valor do atributo classe deve representar uma classe que implementa org.eclipse.ui.INewWizard.
Se o assistente for criado a partir do Novo Assistente, será inserido no assistente existente.
Se o assistente for lançado como um atalho (a partir do menu Novo Ficheiro ou de um botão da barra de ferramentas) aparecerá como autónomo numa caixa de diálogo em separado.
Implementação Fornecida:
A área de trabalho já traz os assistentes para criar recursos vazios dos tipos seguintes: projecto, pasta e ficheiro. Estes assistentes são registados utilizando o mesmo mecanismo descrito anteriormente.
Podem também aparecer assistentes adicionais, sujeitos a uma instalação de plataforma específica.
Copyright (c) 2002, 2005 IBM Corporation e outros.
Todos os direitos reservados. Este programa e os materiais que o acompanham estão disponíveis
sob os termos da Eclipse Public License v1.0 que acompanha
esta distribuição e está disponível em http://www.eclipse.org/legal/epl-v10.html