以前做插件用到的ActionSet都只是依葫蘆畫瓢,沒有真正理解它,現在開始好好學習學習,主要是看"Building Commercial-Quality Plug-ins"寫的
Action的組成包括幾個部分,一個是在plugin.xml中的聲明,一個是在Eclipse UI中會用到的IAction實例化對象, 另一個是封裝在IActionDelegate中的action執行代碼. action的實例化是基于plugin.xml配置文件和IActionDelegate定義的,Eclipse可以先在界面上將action顯示出來,直到用戶點擊了菜單或者工具條按鈕才會去真正的加載插件,這也就是所謂的Eclipse的延遲加載機制
IActionDelegate有幾個子類需要說明一下:
IActionDelegate2 如果實現IActionDelegate需要一些其他的信息,而這些信息在IActionDelegate銷毀時需要同時被銷毀時, 它可以提供相關是生命周期事件方法來處理
IEditorActionDelegate 是跟editor相關的
IObjectActionDelegate 是跟上下文菜單相關的
IViewActionDelegate 是跟view相關的
IWorkbenchWindowActionDelegate是跟menubar和toolbar相關的
Actions和Eclipse中的其他東東一樣,也是通過擴展點org.eclipse.ui.actionSets來添加到Eclipse IDE的各個地方,actions的外在表現形式主要有menubar, toolbar, context menu這樣幾種
在actionSets的下級節點是actionSet, 它有幾個屬性,id,label都不用說了,還有一個visible屬性,表示在打開Eclipse時是否顯示該action,通常我們可以通過Window > Customize Perspective...來設置action是否可見
在actionSet下可以添加menu節點, 它的id,label屬性不用說了,其中的path是用來指定菜單的顯示位置的,一般設置為additions
action并不是直接添加到menu上的, 而是跟menu內部的group關聯的,所以我們必須先在menu下創建group,即新建groupMarker, 其name必須保證在當前menu下唯一, menu還有一種叫separator的group, 在separator group處添加的menu item會在這個組中的第一個菜單項上面添加一條水平線.而groupMarker則不會有線, 當其他action要添加到該menu group下時,使用水平線進行分組就顯得非常必要
group只是用來標識menu的位置,即指這個位置可以添加菜單項, 而不是實際的menu item, 實際的menu item是action
因為menu會有層次關系,所以actionSet中專門用一個menu節點來表現這種層次關系, 而toolbar則沒有這種情況,所以這里沒有提供toolbar節點
在actionSet下添加action就是最終我們要toolbar上顯示的按鈕和menubar上的menu item, 這里有幾個屬性, id和label不用說了,menuBarPath是menu要顯示的位置, 比如"com.qualityeclipse.favorites.workbenchMenu/content",這個值就是actionSet+"/"+group name, toolbarPath 就是toolbar item的顯示位置, 比如"Normal/additions", 還有幾個屬性不常用到,但是有必要解釋一下
allowLabelUpdate這個要在retarget屬性為true的時候有效,還不是很清楚
class 是menu或button要執行的動作, 如果使用的是pulldown風格的action,還需要實現IWorkbenchWindowPulldownDelegate接口,它的構造函數是無參數的,如果要傳遞參數,還需要是要實現IExecutableExtension 接口, 這個接口還不是很清楚
definitionId 這個是用來指定action對應的command唯一標識符的
enablesFor 是一個表達式,用來表示當前action是否可用
retarget 不是很理解
state主要是針對style屬性為radio和toggle的,表示當前action是否被選中
style:默認是push,還有radio,表示一組menu中只能有一個被選中, toggle當它是checkbox好了, pulldown說明是子菜單項或者是下拉toolbar menu
對于action所使用的圖標,我們可以從Eclipse下的plugins\org.eclipse.ui_3.1.2.jar 和 plugins\org.eclipse.jdt.ui_3.1.2.jar得到一些gif的圖片
Eclipse中actionSet以及下級元素都是有id的,而且他們可以通過一種path的方式來進行指定,比如com.qualityeclipse.favorites.workbenchMenu/content,如果上一級節點是workbench menu bar或者是view content menu的話,那么它的上一級節點是不用指定的,只要指定group就好
為了方便其他的插件的action能添加到該插件的actionSet下, 在為插件定義group的時候, 會添加一個為additions的group, additions是eclipse使用的一個默認標識符,用來表示其他action或menu顯示的位置, 在class中它的對應常量是IWorkbenchActionConstants.MB_ADDITIONS, 比如我們定義了一個menu,指定其path為additions, 這表示我們的menu將添加到window的左邊,因為這個就是workbench menubar的additons所在的位置, 如果指定的是window/additions, 那么將作為子菜單項添加到window下
當一個actionSet下定義的action跟另一個actionSet下定義的menu關聯的時候將發生Invalid Menu Extension (Path is invalid): some.action.id的異常, 為了避免這種問題,menu需要在兩個actionSet都定義
toolbarPath的指定也跟menuBarPath有同樣的情況, 比如定義為Normal/additions, 這里的Normal指的是workbench toolbar, additions就是action要顯示的group位置
action的class屬性是封裝了執行動作的類,它實現了IWorkbenchWindowActionDelegate, 在它里面有幾個方法需要介紹一下, 一個是selectionChanged, 用來動態修改action的state狀態值, 是否可用,以及action的text屬性等, 比如對于enableFor屬性來說, 它根據選中對象的數量來判斷action是否可用, 但是通過selectionChanged可以通過當前選定的對象的情況來調用setEnable()方法從而更精確的控制action是否可用, 有時候當插件還沒有加載,在調用action的run方法時會加載插件,這時可能在調用run()方法之前沒有調用selectedChange方法, 因此在run()方面里面需要寫一些防護性代碼,比如空值的判斷之類的, 另外run()是在主UI線程中執行的,因此,如果該執行耗時較長,需要將其放到后臺線程中執行.
插件運行之后在menubar和toolbar上看到定義的actionSet,可以試試下面的方法:
在Window > Customize Perspective... 下看看是不是actionSet沒有選中
使用Window > Reset Perspective刷新當前視圖
關閉重新打開當前視圖
如果還沒有出來,可以在在run或者debug的設置中將"Clear workspace data before launching "選中, 然后再啟動運行
雖然通過擴展點可以非常方便的在Eclipse上添加,但是這個玩意兒多了也不是什么好事, 可能會降低用戶體驗,因此需要進行控制, actionSet擴展點也有相關的設置來指定是否可見, 而且還可以調用IActionSetDescriptor.setInitiallyVisible() 來控制頂層菜單是否可見, 另一種解決辦法就是在首選項中提供一個checkbox讓用戶決定是否顯示頂層菜單,其編程實現就是在代碼中調用IActionSetDescriptor.setInitiallyVisible()和IWorkbenchPage.hideActionSet()來進行控制
Action的組成包括幾個部分,一個是在plugin.xml中的聲明,一個是在Eclipse UI中會用到的IAction實例化對象, 另一個是封裝在IActionDelegate中的action執行代碼. action的實例化是基于plugin.xml配置文件和IActionDelegate定義的,Eclipse可以先在界面上將action顯示出來,直到用戶點擊了菜單或者工具條按鈕才會去真正的加載插件,這也就是所謂的Eclipse的延遲加載機制
IActionDelegate有幾個子類需要說明一下:
IActionDelegate2 如果實現IActionDelegate需要一些其他的信息,而這些信息在IActionDelegate銷毀時需要同時被銷毀時, 它可以提供相關是生命周期事件方法來處理
IEditorActionDelegate 是跟editor相關的
IObjectActionDelegate 是跟上下文菜單相關的
IViewActionDelegate 是跟view相關的
IWorkbenchWindowActionDelegate是跟menubar和toolbar相關的
Actions和Eclipse中的其他東東一樣,也是通過擴展點org.eclipse.ui.actionSets來添加到Eclipse IDE的各個地方,actions的外在表現形式主要有menubar, toolbar, context menu這樣幾種
在actionSets的下級節點是actionSet, 它有幾個屬性,id,label都不用說了,還有一個visible屬性,表示在打開Eclipse時是否顯示該action,通常我們可以通過Window > Customize Perspective...來設置action是否可見
在actionSet下可以添加menu節點, 它的id,label屬性不用說了,其中的path是用來指定菜單的顯示位置的,一般設置為additions
action并不是直接添加到menu上的, 而是跟menu內部的group關聯的,所以我們必須先在menu下創建group,即新建groupMarker, 其name必須保證在當前menu下唯一, menu還有一種叫separator的group, 在separator group處添加的menu item會在這個組中的第一個菜單項上面添加一條水平線.而groupMarker則不會有線, 當其他action要添加到該menu group下時,使用水平線進行分組就顯得非常必要
group只是用來標識menu的位置,即指這個位置可以添加菜單項, 而不是實際的menu item, 實際的menu item是action
因為menu會有層次關系,所以actionSet中專門用一個menu節點來表現這種層次關系, 而toolbar則沒有這種情況,所以這里沒有提供toolbar節點
在actionSet下添加action就是最終我們要toolbar上顯示的按鈕和menubar上的menu item, 這里有幾個屬性, id和label不用說了,menuBarPath是menu要顯示的位置, 比如"com.qualityeclipse.favorites.workbenchMenu/content",這個值就是actionSet+"/"+group name, toolbarPath 就是toolbar item的顯示位置, 比如"Normal/additions", 還有幾個屬性不常用到,但是有必要解釋一下
allowLabelUpdate這個要在retarget屬性為true的時候有效,還不是很清楚
class 是menu或button要執行的動作, 如果使用的是pulldown風格的action,還需要實現IWorkbenchWindowPulldownDelegate接口,它的構造函數是無參數的,如果要傳遞參數,還需要是要實現IExecutableExtension 接口, 這個接口還不是很清楚
definitionId 這個是用來指定action對應的command唯一標識符的
enablesFor 是一個表達式,用來表示當前action是否可用
retarget 不是很理解
state主要是針對style屬性為radio和toggle的,表示當前action是否被選中
style:默認是push,還有radio,表示一組menu中只能有一個被選中, toggle當它是checkbox好了, pulldown說明是子菜單項或者是下拉toolbar menu
對于action所使用的圖標,我們可以從Eclipse下的plugins\org.eclipse.ui_3.1.2.jar 和 plugins\org.eclipse.jdt.ui_3.1.2.jar得到一些gif的圖片
Eclipse中actionSet以及下級元素都是有id的,而且他們可以通過一種path的方式來進行指定,比如com.qualityeclipse.favorites.workbenchMenu/content,如果上一級節點是workbench menu bar或者是view content menu的話,那么它的上一級節點是不用指定的,只要指定group就好
為了方便其他的插件的action能添加到該插件的actionSet下, 在為插件定義group的時候, 會添加一個為additions的group, additions是eclipse使用的一個默認標識符,用來表示其他action或menu顯示的位置, 在class中它的對應常量是IWorkbenchActionConstants.MB_ADDITIONS, 比如我們定義了一個menu,指定其path為additions, 這表示我們的menu將添加到window的左邊,因為這個就是workbench menubar的additons所在的位置, 如果指定的是window/additions, 那么將作為子菜單項添加到window下
當一個actionSet下定義的action跟另一個actionSet下定義的menu關聯的時候將發生Invalid Menu Extension (Path is invalid): some.action.id的異常, 為了避免這種問題,menu需要在兩個actionSet都定義
toolbarPath的指定也跟menuBarPath有同樣的情況, 比如定義為Normal/additions, 這里的Normal指的是workbench toolbar, additions就是action要顯示的group位置
action的class屬性是封裝了執行動作的類,它實現了IWorkbenchWindowActionDelegate, 在它里面有幾個方法需要介紹一下, 一個是selectionChanged, 用來動態修改action的state狀態值, 是否可用,以及action的text屬性等, 比如對于enableFor屬性來說, 它根據選中對象的數量來判斷action是否可用, 但是通過selectionChanged可以通過當前選定的對象的情況來調用setEnable()方法從而更精確的控制action是否可用, 有時候當插件還沒有加載,在調用action的run方法時會加載插件,這時可能在調用run()方法之前沒有調用selectedChange方法, 因此在run()方面里面需要寫一些防護性代碼,比如空值的判斷之類的, 另外run()是在主UI線程中執行的,因此,如果該執行耗時較長,需要將其放到后臺線程中執行.
插件運行之后在menubar和toolbar上看到定義的actionSet,可以試試下面的方法:
在Window > Customize Perspective... 下看看是不是actionSet沒有選中
使用Window > Reset Perspective刷新當前視圖
關閉重新打開當前視圖
如果還沒有出來,可以在在run或者debug的設置中將"Clear workspace data before launching "選中, 然后再啟動運行
雖然通過擴展點可以非常方便的在Eclipse上添加,但是這個玩意兒多了也不是什么好事, 可能會降低用戶體驗,因此需要進行控制, actionSet擴展點也有相關的設置來指定是否可見, 而且還可以調用IActionSetDescriptor.setInitiallyVisible() 來控制頂層菜單是否可見, 另一種解決辦法就是在首選項中提供一個checkbox讓用戶決定是否顯示頂層菜單,其編程實現就是在代碼中調用IActionSetDescriptor.setInitiallyVisible()和IWorkbenchPage.hideActionSet()來進行控制
安徽新華電腦學校專業職業規劃師為你提供更多幫助【在線咨詢】