Мастеры создания
Идентификатор:
org.eclipse.ui.newWizards
Описание:
Эта точка расширения служит для регистрации расширений мастера создания ресурса. Мастеры создания отображаются в виде пунктов в окне диалога "Создать" и обычно служат для создания файлов и папок.
В окне "Создать" мастеры разбиты по категориям, отражающим область конкретной задачи. Например, для модуля, работающего с Java, можно определить категорию с именем "Java", в которой находятся мастеры создания "Класса" или "Пакета". К категориям, определенным одним модулем, можно обращаться из других модулей с помощью атрибута category. Мастеры, не входящие ни в одну категорию, а также мастеры с недопустимыми путями к категориям, будут отнесены к категории "Прочие".
Для мастеров можно указывать необязательный подэлемент описания, тело которого содержит краткий текст о мастере.
Описание конфигурации:
<!ELEMENT extension (category | wizard | primaryWizard)*>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
- point - полный идентификатор целевой точки расширения
- id - необязательный идентификатор экземпляра расширения
- name - необязательное имя экземпляра расширения
<!ELEMENT category EMPTY>
<!ATTLIST category
id CDATA #REQUIRED
name CDATA #REQUIRED
parentCategory CDATA #IMPLIED>
- id - уникальное имя, которое может обозначать данную категорию
- name - переводимое имя категории, которое будет применяться в окне диалога
- parentCategory - путь к другой категории, если данная добавляется как дочерняя
<!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 - уникальное имя для обозначения данного мастера
- name - переводимое имя мастера, которое будет применяться в окне диалога
- icon - относительный путь к значку, который вместе с именем будет представлять мастер как один из вариантов в окне создания.
- category - путь, состоящий из ИД категорий, разделенных знаками косой черты ('/'). Все компоненты в этом пути должны представлять собой допустимые ИД категорий, предварительно определенные в этом или в других модулях. Если этот атрибут не указан, то мастер добавляется в категорию "Прочие".
- class - полное имя класса Java, реализующего org.eclipse.ui.INewWizard.
- project - необязательный атрибут, обозначающий мастер создания ресурса IProject.
Также отображает мастер как один из вариантов в окне "Создать проект".
- finalPerspective - необязательный атрибут, обозначающий проекцию, которая будет активизирована по завершении создания ресурса IProject.
- preferredPerspectives - необязательный атрибут, задающий список ИД проекций, разделенный запятыми. Если текущая проекция есть в списке, то по завершении создания ресурса IProject никакая проекция активизирована не будет.
- helpHref - url справки, подробно описывающей этот мастер.
Начиная с 3.0
- descriptionImage - изображение большего размера, иллюстрирующее этот мастер.
Начиная с 3.0
- canFinishEarly - возможно ли завершение работы мастера без показа пользователю страниц.
- hasPages - предоставляет ли мастер какие-либо страницы.
<!ELEMENT description (#PCDATA)>
необязательный подэлемент, тело которого содержит краткий текст, описывающий, что делает мастер после запуска
<!ELEMENT selection EMPTY>
<!ATTLIST selection
class CDATA #REQUIRED
name CDATA #IMPLIED>
- class - полное имя класса. Если все выбранные объекты в рабочей среде реализуют этот интерфейс, то выбор будет передан в мастер. В противном случае будет переда пустой выбор
- name - необязательное имя фильтра. Для передачи в мастер ни один выбранный объект в рабочей среде не должен отфильтровываться фильтром имен
<!ELEMENT primaryWizard EMPTY>
<!ATTLIST primaryWizard
id CDATA #REQUIRED>
средство для объявления мастера "главным" в UI. Главный мастер выделяется в окне создания. Обратите внимание, что этот элемент не предназначен для разработчиков модулей! Он нужен для того, чтобы менеджеры продукта могли выделить для своих продуктов необходимый набор мастеров.
- id - идентификатор мастера, который должен стать главным.
Примеры:
Ниже приведен пример конфигурации мастера создания:
<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>
Создает простой объект XYZ и настраивает начальное содержимое
</description>
<selection class=
"org.eclipse.core.resources.IResource"
/>
</wizard>
</extension>
Информация об API:
Значение атрибута класса должно представлять собой класс, реализующий org.eclipse.ui.INewWizard.
Если мастер создается из окна Создать мастер, то он будет вставлен в уже имеющийся мастер.
Если мастер запускается через ярлык (из меню Создать или с помощью кнопки на панели инструментов), то он будет самостоятельным и будет отображаться в отдельном окне диалога.
Поставляемая реализация:
Рабочая среда поставляется с мастерами для создания пустых ресурсов следующих типов: проект, папка и файл. Эти мастеры зарегистрированы теми же способами, что описаны выше.
В некоторых случаях могут поставляться дополнительные мастеры. Это зависит от конкретной установки платформы.
Copyright (c) 2002, 2004 IBM Corporation and others.
Все права защищены.
Эта программа и сопутствующие материалы распространяются на условиях Eclipse Public License v1.0, поставляемой вместе с продуктом и доступной на Web-сайте
http://www.eclipse.org/legal/epl-v10.html