Liferay配置檔案Tag标簽參考

http://blog.csdn.net/samxx8/article/details/6559455

1、Icon

Icon元素指定了一個在portlet中顯示的圖檔

2、Virtual—path

Virual—path 的值指定了一個虛拟路徑用于覆寫預設的servlet内容路徑.舉個例子,假設你的portlet被部署在servlet路徑”/test-portlet”. 通過預設值, portal将會傳回到”/test-portlet”的servlet内容路徑. 你可以通過設定虛拟路徑到”/virtual”來覆寫預設路徑, portal 就會傳回到”/virtual”的servlet内容路徑.預設值是””, 這意味着沒有使用.

3、Struts-path

這個選項隻在用Liferay Struts Portlet 架構時才有用. 假設struts—path的值是”mail”. 這就告訴了portal說所有的路徑為mail/*的請求都在這個portlet’s領域的考慮範圍之内.如果使用者通路到這個portlet的話,隻有路徑比對mail/*的使用者請求才被允許通路. 這對于portlet 請求和标準的servlet請求同樣适用.

4、Configuration-path

Configuration-path 的值是一個Struts 路徑,允許使用者配置運作時的portlet.

5、Indexer-class

Indexer-class的值必須是一個實作com.liferay.util.lucene.Indexer的類,并且被調用來建立,或者更新對于portlet的索引.

6、Open-search-class

Open-search-class 的值必須是一個實作com.liferay.portal.kernel.search.opensearch的類, 并且以opensearch1.1的标準來被調用,以獲得搜尋結果.

7、Scheduler-class

Scheduler-class的值必須是一個實作com.liferay.portal.job.scheduler的類, 并且被調用來确定這個portlet的Schedule Quartz jobs.

8、Portlet-url-class

Portlet-url-class 的值必須是一個繼承了com.liferay.portlet.portleturlimplwrapper 的類.指定這個類來覆寫預設的portlet URL實作.

9、Friendly-url-mapper-class

Friendly-url-mapper-class 的值必須是一個實作com.liferay.portal.kernel.portlet.friendlyURLMapper的類.如果在portlet之内的内容要使用一個friendly URL 就要使用這個.它的使用例子在MessageBoards portlet中.

10、url-encoder-class

url-encoder-class 的值必須是一個實作com.liferay.portal.kernel.servletURLEncoder的類.使用這個來建立一個自定義的URLEncoder,這個URLEncoder 是供RenderResponse 類來使用,用于實作encodeURL方法.在你需要添加自定義的邏輯來重寫URLs時這個将會非常有用.

11、Portlet-data-handler-class

Portlet-data-handler-class 的值必須是一個實作com.liferay.portal.kernel.lar.PortletDataHandler的類,并且當歸檔計劃執行時被調用.

12、Smtp-message-listener-class

Smtp-message-listener-class 的值必須是一個實作了com.liferay.portal.kernel.smtp.MessageListener 的類, 并且當傳輸電子信件時才被調用.

13、Preferences-company-wide

如果這個portlet 的參數在整個公司内都可以通路,就将Preferencescompany-wide 的值設定為true,.将這個值設定為true 意味着不能使用preference-unique-layout 和preferences-owned-by-group 的值.預設值是false.例如,管理者可以将這些參數放置于一個聲明好的portlet中,這個portlet可以以資訊的形式來記錄portlet中的參數.這些資訊在公司的所有頁面中都能通路.這個portlet不能被執行個體化,因為執行個體化的portlet有唯一的自增長的portlet id.被封裝的聲明的portlet的預設的行為将執行個體化的值設定為true,以便普通使用者不能建立公司全局資訊.一個更深層的引用将會包括對編輯模式的許可,這種編輯模式是相對于浏覽模式來講,允許管理者設定資訊而使用者隻能浏覽資訊.

14、Preferences-unique-per-layout

如果這個portlet 的參數對每個頁面都是唯一的,就将Preferencesunique-per-layout的值設定為true..如果将其設定為false,這個portlet的參數将會在所有頁面中被通路.預設值是true.

15、Preferences-owned-by-group

如果這個portlet顯示在一個組的頁面中并且這個portlet的參數是由這個組來決定的, 就将preferences-owned-by-group的值設定為true. 如果将其設定為false,這些參數将會一直被使用者擁有.預設值是true.

假設股票portlet 有一個preferences-unique-per-layout, 将其設定為true并且将preference-owned-by-group設定為false.使用者可以對于每個個人頁面來指定不同的股票清單.也可以對每一個社群頁面指定不同的股票清單.

假設股票portlet 有一個preferences-unique-per-layout, 将其設定為false并且将preference-owned-by-group設定為false. 使用者可以指定一個股票清單可以在所有的個人頁面中檢視.也可以在一個社群頁面指定一個股票清單.

假設股票portlet 有一個preferences-unique-per-layout, 将其設定為true并且将preference-owned-by-group設定為true. 使用者可以對于每個個人頁面來指定不同的股票清單.管理者可以在社群裡指定對使用者的portlet參數.管理者可以對每一個社群頁指定不同的股票清單,這些頁面之後可以被社群内的所有使用者分享.

假設股票portlet 有一個preferences-unique-per-layout 将其設定為false并且将preference-owned-by-group設定為true. 使用者可以指定一個股票清單可以通過所有的個人頁面來分享. 管理者可以在一個社群頁中指定對使用者的portlet參數. 管理者可以指定一個股票清單可以通過一個社群的指定頁面的所有使用者來分享.

16、Use-default-template

如果portlet使用預設的模闆來裝飾和包裝内容, 就将Use-default-template的值設定為true. 将其設定為false允許開發者組織和編輯portlet的整體輸出内容.預設值是true.如果你想要你的portlet與其他portlet不同,或者如果你想要你的portlet輸出内容沒有邊框,這個值就是最常用的方式.

17、Show-portlet-access-denied

如果使用者展示的portlet 有一個不允許的通路資訊, 就将Show-portletaccess-denied 的值設定為true, 此資訊是由于這些使用者不能通路這些portlet.預設值在poral.properties值指定.

18、Show-portlet-inactive

将Show-portlet-inactive的值設定為true, 如果使用者展示的portlet有一個不活躍的資訊,如果将其設定為false,如果portlet是不活躍的, 使用者将不能顯示出這個portlet.預設值在portal.properties中指定.

19、Action-url-redirect

将Action-url-redirect 的值設定為true, 如果這個portlet 的一個actionURL可以導緻自動的重定向.這可以幫助防止重複送出. 預設值是false.

20、Restore-current-view

将Restore-current-view的值設定為true, 如果當切換至最大化和正常狀态,portlet恢複到目前視圖時.如果将其設定為false, portlet将會重新設定目前視圖,當其切換至最大化和正常狀态時.預設值是true.

21、Maximize-edit

将Maximize-edit的值設定為true, 如果當使用者處于編輯狀态,portlet正處于最大化狀态時.這隻影響預設的portal 圖示, 并且此時這個圖示不是portlet開發者能夠編輯的.預設值是false.

22、Maximize-help

将maximize-help的值設定為true, 如果當使用者處于編輯狀态, portlet正處于最大化狀态時.這隻影響預設的portal 圖示, 并且此時這個圖示不是portlet開發者能夠編輯的.預設值是false.

23、Pop-up-print

将pop-up-print的值設定為true如果portlet正處于彈出狀态并且使用者正處于列印模式,這隻影響到預設的portal圖示, 并且此時這個圖示不是portlet開發者能夠編輯的.預設值是true.

24、Layout-cacheable

将Layout-cacheable标記設定為true,如果在這個portlet所包含的資料不會改變除非頁面布局或者portlet實體改變.

25、Instanceable

将instanceable的值設定為true, 如果portlet可以在一個頁面中顯示多次,如果将其設定為false, portlet隻在頁面中顯示其一次. 預設值是false.

26、Private-request-attributes

将Private-request-attributes的值設定為true, 如果這個portlet不與其他portlet共享請求屬性. 預設值是true.

27、Private-session-attributes

将Private-session-attributes的值設定為true, 如果這個portlet并不與其他的portal共享會話屬性.預設值是true.性質”session.shared.attributes”在portal.properties指定了哪一個會話屬性可以分享即使private-sessionattributes的值是true.

28、Render-weight

預設值是1.如果将其設定小于1, portlet就會表現出并行性,如果将其設定為1或者更高, portlet 就會顯示出連續性. 擁有一個更高的render-weight 的portlets有更高的優先級,并且在有低級别的render-weight的portlet之前呈現出來.如果ajaxable值設定為false, 最好将render-weight的值設定為1. 這就意味着如果ajaxable設定為false,ajaxable可以覆寫render-weight的值.

29、Ajaxable

預設值為true. 如果将其設定為false,portlet将不能通過ajax來顯示.

30、Header-css

設定CSS的相關聯的路徑,這些css是與portal的頁面布局的頭有關聯的樣式.

31、Header-javascript

設定javascript的相關聯的路徑,這些javascript是與portal的頁面布局的頭有關聯的.

32、Add-default-resource

如果将Add-default-resource的值設定為false, porlet并不依附于頁面而是動态加載,之後使用者會發現他沒有權限來檢視這個portlet, 如果将Adddefault-resource的值設定為true,預設的portlet資源和權限被添加到頁面中.使用者可以檢視這個portlet.大多數的portlets不受這種影響并且可以從這種靈活性中受益.然而,為了防止安全循環漏洞,預設值是false.

33、System

将system的值設定為true, 如果portlet是一個系統portlet, 使用者不能手動添加portlet到他們的頁面中.預設值是false.

34、Active

将active的值設定為true, 如果portlet是活躍的并且可供使用者使用.如果将其設定為false, portlet将會不活躍或者不能讓使用者擷取.預設值是true.這個設定值将會通過管理portlet在運作時改變.

35、Include

将include 值設定為true 如果portal 會使用這個portlet. 如果将其設定為false, portlet将會不能被portal使用. 預設值是true. 那些無論活躍或者不活躍的portlets,如果它們不包含在portal中,它們将不能被使用者使用.由于這些portlets不會在系統中顯示出來, 使用者将不會知道這些portlet的存在. 這就使得Liferay開發者封裝一系列的portlets在一個核心包中, 并且允許自定義的部署方式來開或者關獨立的portlets或設定portlets. 這遵循了siebel和microsoft的捆綁所有在一個核心包中的并且用xml來配置或注冊注入來打開或關掉所有特性或一些特性的模式. 我們并不推薦自定義的部署者通過移去具體的portlets來修改核心源檔案, 因為這防止了今後的輕松更新.最佳的打開或者關閉portlets的方式就是設定include元素. 這種方式來做事情的優點是變得非常易于部署Liferay. 所有的特性在一個包中都能使用,缺點是并不能優化所有的portlets, 是以你浪費了磁盤空間, 甚至可能導緻一個微小的靜态的記憶體印記.然而, 我們認為對于提供一個簡單的安裝和更新路徑來說, 額外的磁盤空間和記憶體使用是一個很便宜的代價.

37、Role-mapper

Role-mapper包括兩個具體的名稱role-name和role-link.role-name值必須是在portlet.xml中定義的一個具體使用者.role-link值必須是Liferay使用者存在于資料庫中.role-mapper元素組織了這些值來映射從portlet.xml的使用者到Liferay資料庫中的使用者. 這是必須的, 因為Liferay使用者可能包含spaces無論portlet.xml中的使用者包不包含spaces. 這也增加了額外的靈活性, portlet賣主并不需要知道任何關于Liferay’s使用者的資訊.

38、Role-name

參見role-mapper元素的簡介

39、Role-link

參見role-mapper元素的簡介

40、Custom-user-attribute

自定義的使用者屬性包括一些名稱,這些名稱是用一個自定義的擴充了ccom.liferay.portlet.customuserattributes的類.下載下傳一個簡單的關鍵可部署的portlet WAR 叫test.war. 找到類:com.liferay.portlet.teststruts.teststrutsuserattributes 來觀察是否它關聯了自定義的使用者屬性”user.name.test”與值”test name”.可以修改這個類來讀取從其他資料庫中自定義的使用者屬性,例如LDAP伺服器,或一個web服務.

41、Name

參見Custom-user-attributer元素的簡介

42、Custom-class

參見Custom-user-attributer元素的簡介