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元素的簡介