Asistentes de creación
Identificador:
org.eclipse.ui.newWizards
Descripción:
Este punto de extensión permite registrar
extensiones de asistente de creación de recursos. Los asistentes de creación
aparecen como opciones dentro del "Diálogo Nuevo" y se emplean típicamente para
crear carpetas y archivos.
En el "Diálogo Nuevo", los asistentes están organizados por categorías que
generalmente reflejan el dominio de un problema en particular. Por ejemplo, un
conector orientado a Java puede definir una categoría llamada "Java", que es
apropiada para los asistentes de creación de "Clase" o "Paquete". Con el
atributo category, los conectores pueden hacer referencia a las
categorías definidas por otro conector. Los asistentes que no pertenecen a
ninguna categoría, así como los asistentes con vías de acceso a categorías no
válidas, acabarán en la categoría "Otras".
Los asistentes pueden
especificar opcionalmente un subelemento description cuyo cuerpo debe
contener un texto corto que describa el asistente.
Código de configuración:
<!ELEMENT extension (category | wizard | primaryWizard)*>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
- point: identificador totalmente calificado del punto de extensión destino
- id: identificador opcional de la instancia de extensión
- name: nombre opcional de la instancia de extensión
<!ELEMENT category EMPTY>
<!ATTLIST category
id CDATA #REQUIRED
name CDATA #REQUIRED
parentCategory CDATA #IMPLIED>
- id: nombre exclusivo que puede utilizarse para identificar esta categoría.
- name: nombre traducible de la categoría, que se utilizará en el recuadro
de diálogo.
- parentCategory: vía de acceso a otra categoría si la presente categoría
debe añadirse como hija.
<!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: nombre exclusivo que puede utilizarse para identificar este asistente
- name: nombre traducible del asistente, que se utilizará en el recuadro
de diálogo.
- icon: vía de acceso relativa del icono que se utilizará junto con el
nombre para representar el asistente como una de las opciones del recuadro de
diálogo de creación.
- category: vía de acceso delimitada por barras inclinadas ('/') de los
ID de las categorías. Cada símbolo de la vía de acceso debe representar un ID
de categoría válido definido anteriormente por este conector o por
otro. Si se omite, el asistente se añadirá a la categoría "Otras".
- class: nombre totalmente calificado de la clase Java que implementa
org.eclipse.ui.INewWizard.
- project: atributo opcional que indica que el asistente creará un recurso
IProject.
También hace que el asistente aparezca como opción en el "Diálogo
Proyecto nuevo".
- finalPerspective: atributo opcional que identifica una perspectiva que
debe activarse cuando termina la creación del recurso IProject.
- preferredPerspectives: atributo opcional que especifica una lista de ID de perspectiva separados por comas. Si la perspectiva actual se encuentra en esta lista, no se produce ninguna activación de perspectiva cuando finaliza la creación de recursos de IProject.
- helpHref: URL de ayuda que puede describir este asistente con detalle.
A partir del release 3.0
- descriptionImage: imagen más grande que puede ayudar a describir este asistente.
A partir del release 3.0
- canFinishEarly: si el asistente puede finalizar sin mostrar páginas
al usuario.
- hasPages: si el asistente proporciona páginas.
<!ELEMENT description (#PCDATA)>
subelemento opcional cuyo cuerpo contiene un texto corto
que describe qué hará el asistente al iniciarse.
<!ELEMENT selection EMPTY>
<!ATTLIST selection
class CDATA #REQUIRED
name CDATA #IMPLIED>
- class: nombre de clase totalmente calificado. Si cada objeto de la
selección del entorno de trabajo implementa esta interfaz, la selección pasará
al asistente. De lo contrario, se pasa una selección vacía.
- name: filtro de nombres opcional. Cada objeto de la selección del
entorno de trabajo debe coincidir con el filtro de nombres que debe pasarse al
asistente.
<!ELEMENT primaryWizard EMPTY>
<!ATTLIST primaryWizard
id CDATA #REQUIRED>
un medio de declarar que un asistente es "primario" en la UI. Un asistente primario se resalta en el diálogo de asistente nuevo. Tenga en cuenta que los desarrolladores de conectores no deben utilizar este elemento. Este elemento existe a fin de que los gestores de productos puedan resaltar un conjunto de asistentes para sus productos.
- id: ID de un asistente que debe convertirse en primario.
Ejemplos:
A continuación figura un ejemplo de configuración asistente de creación:
<extension point=
"org.eclipse.ui.newWizards"
>
<category
id=
"com.xyz.XYZ"
name=
"Asistentes XYZ"
>
</category>
<category
id=
"com.xyz.XYZ.Web"
name=
"Asistentes Web"
parentCategory=
"com.xyz.XYZ"
>
</category>
<wizard
id=
"com.xyz.wizard1"
name=
"Artefacto XYZ"
category=
"com.xyz.XYZ/com.xyz.XYZ.Web"
icon=
"./icons/XYZwizard1.gif"
class=
"com.xyz.XYZWizard1"
>
<description>
Crear un artefacto simple XYZ y establecer el contenido inicial
</description>
<selection class=
"org.eclipse.core.resources.IResource"
/>
</wizard>
</extension>
Información sobre las API:
El valor del atributo class debe representar una clase que implemente
org.eclipse.ui.INewWizard.
Si el asistente se crea desde dentro de
Asistente Nuevo, se insertará en el asistente existente.
Si el asistente se
lanza como acceso directo (desde el menú Archivo Nuevo o mediante un botón de la
barra de herramientas), aparecerá como recuadro de diálogo independiente.
Implementación suministrada:
El entorno de trabajo viene con asistentes para crear recursos vacíos de los tipos siguientes: proyecto,
carpeta y archivo. Para registrar estos asistentes se utiliza el mismo mecanismo
que el descrito más arriba.
También pueden aparecer asistentes adicionales,
sujetos a la instalación de las plataformas concretas.
Copyright (c) 2002, 2004 IBM Corporation y otros.
Reservados todos los derechos. Este programa y sus materiales adjuntos están
disponibles bajo los términos de la licencia pública común (Eclipse Public
License) v1.0 que acompaña a esta distribución, y está disponible en
http://www.eclipse.org/legal/epl-v10.html