Liferay配置文件Tag标签参考

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