Assistentes de Criação
Identificador:
org.eclipse.ui.newWizards
Descrição:
Esse ponto de extensão é utilizado para registrar extensões de assistentes de criação de recursos. Os assistentes de criação aparecem como opções
dentro do "Novo Diálogo" e, normalmente, são utilizados para criar pastas e arquivos.
Em "Novo Diálogo", os assistentes estão organizados em categorias que normalmente refletem o domínio de um determinado problema. Por exemplo, um plug-in Java orientado pode definir uma categoria chamada "Java", que é adequada para os assistentes de criação "Classe" ou "Pacote". As categorias definidas por um plug-in podem ser referidas por outros plug-ins utilizando o atributo category. Assistentes sem categoria definida, bem como assistentes com caminhos de categoria inválidos terminarão na categoria "Outros".
Assistentes podem opcionalmente especificar um subelemento de descrição cujo corpo deve conter um texto curto sobre o assistente.
Marcação de Configuração:
<!ELEMENT extension (category | wizard | primaryWizard)*>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
- point - um identificador completo 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á utilizado na caixa de diálogo.
- parentCategory - um caminho para outra categoria se essa categoria tiver que ser incluída como filha.
<!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 - nome único que pode ser utilizado para identificar esse 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 juntamente 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 token no caminho deve representar um ID de categoria válido previamente definido por esse ou outro plug-in. Se omitido, o assistente será incluído na categoria "Outros".
- class - o nome completo da classe Java que implementa org.eclipse.ui.INewWizard.
- project - atributo opcional indicando que o assistente criará o recurso IProject. Também faz com que o assistente apareça como uma opção dentro do diálogo "Novo Projeto".
- finalPerspective - atributo opcional que identifica uma perspectiva para ativar quando a criação do recurso IProject estiver terminada.
- preferredPerspectives - um atributo opcional que especifica uma lista separada por vírgula de IDs de perspectiva. Se a perspectiva atual estiver na lista, não ocorrerá nenhuma ativação de perspectiva quando a criação do recurso IProject estiver concluída.
- helpHref - um url de ajuda que pode descrever esse assistente detalhadamente.
Desde 3.0
- descriptionImage - uma imagem grande que pode ajudar a descrever esse assistente.
Desde 3.0
- canFinishEarly - se o assistente é capaz de concluir sem mesmo mostrar páginas ao usuário.
- hasPages - se o assistente fornece qualquer página.
<!ELEMENT descrição (#PCDATA)>
um subelemento opcional cujo corpo contém um texto curto que descreve o que o assistente fará ao ser iniciado
<!ELEMENT selection EMPTY>
<!ATTLIST selection
class CDATA #REQUIRED
name CDATA #IMPLIED>
- class - um nome completo de classe. Se cada objeto na seleção do workbench implementar esta interface, a seleção será transmitida ao assistente. Caso contrário, será transmitida uma seleção vazia
- name - um filtro de nome opcional. Cada objeto na seleção do workbench deve corresponder ao filtro de nome que será transmitido ao assistente
<!ELEMENT primaryWizard EMPTY>
<!ATTLIST primaryWizard
id CDATA #REQUIRED>
um meio de declarar que um assistente é "primário" na UI. Um assistente primário é enfatizado no novo diálogo do assistente. Observe que esse elemento não foi planejado para ser utilizado pelos desenvolvedores de plugin! Esse elemento existe para que os gerenciadores de produtos possam enfatizar um conjunto de assistentes para seus produtos.
- id - o ID de um assistente que deve se tornar primário.
Exemplos:
A seguir 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 sobre API:
O valor do atributo de classe deve representar uma classe que implemente org.eclipse.ui.INewWizard.
Se o assistente for criado a partir de Novo Assistente, ele será inserido no assistente existente.
Se o assistente for ativado como um atalho (no menu Novo Arquivo ou em um botão da barra de ferramentas), ele aparecerá sozinho como uma caixa de diálogo separada.
Implementação Fornecida:
O workbench é fornecido com assistentes para criar recursos vazios dos seguintes tipos:
projeto, pasta e arquivo. Esses assistentes são registrados utilizando o mesmo mecanismo conforme descrito acima. Assistentes adicionais também podem aparecer, um assunto para uma instalação especial da plataforma.
Direitos Autorais (c) 2002, 2004 IBM Corporation e outros.
Todos os direitos reservados.
Este programa e os materiais que o acompanham são disponibilizados
sob os termos da Eclipse Public License v1.0 que acompanha esta
distribuição e estão disponíveis no endereço http://www.eclipse.org/legal/epl-v10.html