熱門精品專業
Eclipse WTP Projects Facets實戰指南(2)
原創作者: macrochen 閱讀:388次 評論:0條 更新時間:2007-11-21
修飾工作
給facet在選擇列表中添加圖標
格式如下:
xml 代碼
- <extension point="org.eclipse.wst.common.project.facet.ui.images">
- <image facet="{string}" path="{string}"/> (0 or more)
- <image category="{string}" path="{string}"/> (0 or more)
- extension>
設置如下:
xml 代碼
- <extension point="org.eclipse.wst.common.project.facet.ui.images">
- <image facet="formgen.core" path="icons/formgen-core.gif"/>
- <image facet="formgen.ext" path="icons/formgen-ext.gif"/>
- <image category="formgen.category" path="icons/formgen-cat.gif"/>
- extension>
效果如圖
添加向導頁
有時候我們可能需要根據用戶的輸入來執行facet, 通過添加wizard page來接收用戶的輸入, 用戶在facet選擇列表頁做出選擇之后,將出現我們添加的wizard Page
下面通過給我們的servlet指定url pattern的例子來進行說明
plugin.xml設置格式如下:
xml 代碼
- <extension point="org.eclipse.wst.common.project.facet.core.facets">
- <action>
- <config-factory class="class:org.eclipse.wst.common.project.facet.core.IActionConfigFactory"/>
- action>
- extension>
- <extension point="org.eclipse.wst.common.project.facet.ui.wizardPages">
- <wizard-pages action="{string}"> (0 or more)
- <page class="{class:org.eclipse.wst.common.project.facet.ui.IFacetWizardPage}"/> (1 or more)
- wizard-pages>
- extension>
這里需要說明的是為了讓我們定制的wizard page和action delegate之間進行通信, 需要使用一個javabean或者是map來封裝wizard page中輸入的數據, 而且必須在action配置中提供一個action factory,該對象將由factory創建, wizard page填充數據, action delegate負責從該對象讀取數據
除外,wizard page將通過指定的action id來引用action, 這也是我們前面推薦指定action id而不是系統生成的原因
配置如下:
xml 代碼
- <extension point="org.eclipse.wst.common.project.facet.core.facets">
- <project-facet-version facet="formgen.core" version="1.0">
- <action type="INSTALL" id="formgen.core.install">
- <config-factory class="com.formgen.eclipse.FormGenCoreFacetInstallConfig$Factory"/>
- action>
- project-facet-version>
- extension>
- <extension point="org.eclipse.wst.common.project.facet.ui.wizardPages">
- <wizard-pages action="formgen.core.install">
- <page class="com.formgen.eclipse.FormGenCoreFacetInstallPage"/>
- wizard-pages>
- extension>
代碼如下:
java 代碼
- package com.formgen.eclipse;
- import org.eclipse.wst.common.project.facet.core.IActionConfigFactory;
- public final class FormGenCoreFacetInstallConfig
- {
- private String urlPattern = "*.form";
- public String getUrlPattern()
- {
- return this.urlPattern;
- }
- public void setUrlPattern( final String urlPattern )
- {
- this.urlPattern = urlPattern;
- }
- public static final class Factory implements IActionConfigFactory
- {
- public Object create()
- {
- return new FormGenCoreFacetInstallConfig();
- }
- }
- }
java 代碼
- package com.formgen.eclipse;
- import org.eclipse.swt.SWT;
- import org.eclipse.swt.layout.GridData;
- import org.eclipse.swt.layout.GridLayout;
- import org.eclipse.swt.widgets.Composite;
- import org.eclipse.swt.widgets.Label;
- import org.eclipse.swt.widgets.Text;
- import org.eclipse.wst.common.project.facet.ui.AbstractFacetWizardPage;
- public final class FormGenCoreFacetInstallPage extends AbstractFacetWizardPage
- {
- private FormGenCoreFacetInstallConfig config;
- private Text urlPatternTextField;
- public FormGenCoreFacetInstallPage()
- {
- super( "formgen.core.facet.install.page" );
- setTitle( "FormGen Core" );
- setDescription( "Configure the FormGen servlet." );
- }
- public void createControl( final Composite parent )
- {
- final Composite composite = new Composite( parent, SWT.NONE );
- composite.setLayout( new GridLayout( 1, false ) );
- final Label label = new Label( composite, SWT.NONE );
- label.setLayoutData( gdhfill() );
- label.setText( "URL Pattern:" );
- this.urlPatternTextField = new Text( composite, SWT.BORDER );
- this.urlPatternTextField.setLayoutData( gdhfill() );
- this.urlPatternTextField.setText( this.config.getUrlPattern() );
- setControl( composite );
- }
- public void setConfig( final Object config )
- {
- this.config = (FormGenCoreFacetInstallConfig) config;
- }
- public void transferStateToConfig()
- {
- this.config.setUrlPattern( this.urlPatternTextField.getText() );
- }
- private static GridData gdhfill()
- {
- return new GridData( GridData.FILL_HORIZONTAL );
- }
- }
java 代碼
- package com.formgen.eclipse;
- import org.eclipse.core.resources.IFolder;
- import org.eclipse.core.resources.IProject;
- import org.eclipse.core.runtime.CoreException;
- import org.eclipse.core.runtime.IProgressMonitor;
- import org.eclipse.core.runtime.Path;
- import org.eclipse.wst.common.project.facet.core.IDelegate;
- import org.eclipse.wst.common.project.facet.core.IProjectFacetVersion;
- public final class FormGenCoreFacetInstallDelegate implements IDelegate
- {
- public void execute( final IProject pj,
- final IProjectFacetVersion fv,
- final Object config,
- final IProgressMonitor monitor )
- throws CoreException
- {
- monitor.beginTask( "", 2 );
- try
- {
- final FormGenCoreFacetInstallConfig cfg
- = (FormGenCoreFacetInstallConfig) config;
- final IFolder webInfLib = Utils.getWebInfLibDir( pj );
- Utils.copyFromPlugin( new Path( "libs/formgen-core.jar" ),
- webInfLib.getFile( "formgen-core.jar" ) );
- monitor.worked( 1 );
- Utils.registerFormGenServlet( pj, cfg.getUrlPattern() );
- monitor.worked( 1 );
- }
- finally
- {
- monitor.done();
- }
- }
- }
效果如圖
定義Preset
為了將創建某個工程所需要的facet集中在一個用一個名字代替,這就需要使用preset(或稱configuration),其擴展點格式如下:
xml 代碼
- <extension point="org.eclipse.wst.common.project.facet.core.facets">
- <preset id="{string}">
- <label>{string}</label>
- <description>{string}</description> (optional)
- <facet id="{string}" version="{string}"/> (1 or more)
- </preset>
- </extension>
為了讓preset能應用于指定的facet project, preset必須包含所有的fixed facet, 所謂的fixed facet指的是那些要創建的工程所必須的而不能刪除的facet.
設置如下:
xml 代碼
- <extension point="org.eclipse.wst.common.project.facet.core.facets">
- <preset id="formgen.preset">
- <label>FormGen Web Project</label>
- <description>Creates a web project with FormGen functionality.</description>
- <facet id="jst.java" version="5.0"/>
- <facet id="jst.web" version="2.2"/>
- <facet id="formgen.core" version="1.0"/>
- <facet id="formgen.ext" version="1.0"/>
- </preset>
- </extension>
效果如圖
指定runtime映射
在創建project的時候,有時候需要指定項目依賴的runtime,我們也可以通過擴展點來檢查當前的facet所需要的runtime是否指定.
配置格式如下:
xml 代碼
- <extension point="org.eclipse.wst.common.project.facet.core.runtimes">
- <supported> (0 or more)
- <runtime-component any="{boolean}"/> (optional)
- <runtime-component id="{string}"/ version="{version.expr}"/> (0 or more)
- <facet id="{string}"/ version="{version.expr}"/> (1 or more)
- </supported>
- </extension>
下面是不依賴其他組件的配置:
xml 代碼
- <extension point="org.eclipse.wst.common.project.facet.core.runtimes">
- <supported>
- <runtime-component any="true"/>
- <facet id="formgen.core"/>
- <facet id="formgen.ext"/>
- </supported>
- </extension>
下面是依賴tomcat的配置
xml 代碼
- <extension point="org.eclipse.wst.common.project.facet.core.runtimes">
- <supported>
- <runtime-component id="org.eclipse.jst.server.tomcat" version="[5.0"/>
- <facet id="formgen.core"/>
- <facet id="formgen.ext"/>
- </supported>
- </extension>
總結
通過上面的步驟, 我們創建了一個完整的project facet, 這里面包括指定約束, 實現action, 對facet分組, 創建wizard page. 更多的信息可看下面的參考附錄
附錄A 定制Version Comparetor
就是對版本進行比較的策略進行定制, 如果要使用自己的版本比較方式, 那么可以通過擴展點來處理,格式如下:
xml 代碼
- <extension point="org.eclipse.wst.common.project.facet.core.facets">
- <project-facet>
- <version-comparator class="{class:java.util.Comparator<String>}"/>
- </project-facet>
- </extension>
可以直接從接口從頭實現,也可以繼承org.eclipse.wst.common.project.facet.core.DefaultVersionComparator來進行定制
代碼如下:
java 代碼
- /**
- * Returns the string containing the separator characters that should be
- * used when breaking the version string into segments. The default
- * implementation returns ".". Subclasses can override this method.
- *
- * @return the separator characters
- */
- protected String getSeparators();
- /**
- * Parses a segment of the version string. The default implementation parses
- * the first segment as an integer (leading zeroes are ignored) and the
- * rest of the segments as decimals (leading zeroes are kept). Subclasses
- * can override this method to provide custom parsing for any number of
- * segments.
- *
- * @param version the full version string
- * @param segment the version segment
- * @param position the position of the segment in the version string
- * @return the parsed representation of the segment as a {@see Comparable}
- * @throws VersionFormatException if encountered an error while parsing
- */
- protected Comparable parse( final String version,
- final String segment,
- final int position )
- throws VersionFormatException;
附錄B Version Expression
為了一次指定多個版本,就需要使用版本表達式(version expression), 在很多地方我都用到了版本表達式, 版本表達式如果有多個,則使用逗號分隔,這里的逗號表示或的意思, 范圍通過括號加破折號來制定,如[x-z), 中括號表示包含, 小括號表示不包含
下面是一些例子:
1.2
1.2,1.5,3.2
[1.2-3.2]
[3.7-5.0)
[3.7
5.0)
1.2,[3.0-4.5),[7.3
附錄C Event Handler
project fact可以為某些事件注冊listener, 這些時間包括:
PRE_INSTALL
POST_INSTALL
PRE_UNINSTALL
POST_UNINSTALL
PRE_VERSION_CHANGE
POST_VERSION_CHANGE
RUNTIME_CHANGED
事件處理器的聲明和action的聲明非常類似,但是他們也有一些區別,主要體現在:
與action不同, 事件處理器無法由用戶直接觸發,因此無法將事件處理器與wizard page關聯,也無法為其提供封裝數據的配置對象
可以給一個事件設置多個事件處理器,但是他們的調用順序是不確定的
事件處理器的配置格式如下:
xml 代碼
- <extension point="org.eclipse.wst.common.project.facet.core.facets">
- <event-handler facet="{string}" version="{version.expr}" type="{event.type}">
- <delegate class="{class:org.eclipse.wst.common.project.facet.core.IDelegate}"/>
- </action>
- </extension>
與action的配置很類似,也實現了IDelegate接口, 而且event-handler也可以嵌入到project-facet-version元素內部,此時的facet和version屬性將被忽略.
PRE_* and POST_* 事件處理器用來取得配置對象,然后傳遞給IDelegate的execute方法使用, RUNTIME_CHANGED 事件處理器是用來取得IRuntimeChangedEvent實例
java 代碼
- package org.eclipse.wst.common.project.facet.core;
- import org.eclipse.wst.common.project.facet.core.runtime.IRuntime;
- /**
- * Describes the runtime changed event to the RUNTIME_CHANGED event handlers.
- */
- public interface IRuntimeChangedEvent
- {
- /**
- * Returns the runtime previously associated with the project.
- *
- * @return the runtime previously associated with the project, or null
- */
- IRuntime getOldRuntime();
- /**
- * Returns the runtime that's now associated with the project.
- *
- * @return the runtime that's now associated with the project, or null
- */
- IRuntime getNewRuntime();
- }
附錄D Property Tester
Property Tester是用來被org.eclipse.core.expressions 包中的擴展點測試使用的,它常用來決定某些菜單或者屬性頁選項是否可用.屬性名為org.eclipse.wst.common.project.facet.core.projectFacet,值為facet id或者facet id 加冒號再加版本表達式的組合
下面的這個例子用來控制project的屬性頁是否可用
xml 代碼
- <extension point="org.eclipse.ui.propertyPages">
- <page
- adaptable="true"
- objectClass="org.eclipse.core.resources.IProject"
- name="FormGen Properties"
- class="com.formgen.eclipse.FormGenPropertiesPage"
- id="org.eclipse.jst.j2ee.internal.J2EEDependenciesPage">
- <enabledWhen>
- <test
- forcePluginActivation="true"
- property="org.eclipse.wst.common.project.facet.core.projectFacet"
- value="formgen.core"/>
- </enabledWhen>
- </page>
- </extension>
附錄E Wizard Content
有時候我們可能根據其他facet所對應的wizard page的用戶輸入來調整action的行為, 而IWizardContet接口就是為該目的而設計的, wizard page的setWizardContext方法被調用的時候會取得該接口的handler, 如果你的代碼對IWziardContenxt造成依賴,可能需要注意以下事項:
1.fact需要的內容可能在執行前已經被install了, 此時在wizard context中將無法找到要install的配置,所以在需要做一些判斷
2.如果某些情況下wizard page不被調用的話,要給配置對象設置默認值
下面是IWizardContext接口的代碼:
java 代碼
- package org.eclipse.wst.common.project.facet.ui;
- import java.util.Set;
- &nb
安徽新華電腦學校專業職業規劃師為你提供更多幫助【在線咨詢】
