Struts 平铺标记的属性

本文档描述在 Struts 平铺标记库中定义的元素的属性。缺省情况下,这些元素中每个元素的名称都有 tiles: 前缀。

每个 Struts 元素都有一定数目的属性,可使用元素的“属性”视图来设置这些属性。在使用元素的“属性”视图时,使用此“属性”的表来查找想要了解其更多详细信息的属性。某些属性具有相同名称,但在不同元素中有不同的用法。属性是按字母顺序列示的。

元素 属性 描述
add beanName 指定要使用其值的 bean 的名称。如果有指定上下文,将从指定上下文检索该 bean。否则,使用方法 pageContext.findAttribute。如果指定 beanProperty,则从相应的 bean 属性检索值。
beanProperty 指定要检索其值的 bean 属性的名称。此属性支持嵌套属性和索引属性。
beanScope 指定搜索 bean 的范围。缺省情况下,使用方法 pageContext.findAttribute。范围可以是任何 JSP 范围、componenttemplate。后两种情况下,将在平铺上下文中搜索 bean。
content value 的同义词。
direct 指定如何处理内容:true 表示内容被包含在文件中;false(缺省值)表示内容包括在其它地方。这是指定内容类型的另一种方式。如果指定 true,则内容被解释为字符串;否则被解释为页。此属性是为了与 JSP 模板兼容而存在的。
role 指定使元素成为条件元素的角色。如果用户不处于指定的角色,则除非正在某定义中使用该元素,否则忽略该元素。
type 指定下列其中一种内容类型:
definition
指定在工厂(XML 文件)中定义的定义。将在 <insert attribute="attributeName"> 标记中的插入平铺中搜索定义,其中 attributeName 是用于此标记的名称。
page
包括来自指定 URL 的内容。此属性的同义词是 template
string
直接提供内容。
如果省略 type 属性,则除非内容来自类型化 bean,否则内容是非类型化的。
value 指定元素的值。该值可以是字符串,也可以是对象。
definition extends 指定用来初始化此新定义的父代定义的名称。将在定义工厂中搜索父代定义。
id 指定用以保存新创建的定义 bean 的名称。
page 指定要插入的平铺布局文件(一种 JSP 文件)的 URL。
role 指定在插入此定义之前要检查的角色。如果没有为当前用户定义角色,则不插入定义。检查是在插入时完成的,而不是在定义过程中完成的。
scope 指定将在其中创建新定义 bean 的变量范围。如果省略此属性,则会在页范围中创建 bean。
template page 的同义词。
get flush 如果指定为 true,则在插入新页之前清除当前页输出流。缺省值为 false
ignore 如果此属性的值为 true 且由 name 指定的内容不存在,则将返回而不写任何内容。缺省值为 false,如果 name 内容不存在,则该缺省值将导致抛出运行时异常。
name 指定要从平铺范围获取的内容的名称。
role 如果用户不处于指定的角色,将导致忽略该元素。
getAsString ignore 如果此属性的值为 truename 指定的属性不存在,则将返回而不写任何内容。缺省值为 false,如果该属性不存在,则这一缺省值将导致抛出运行时异常。
name 指定属性名称。
role 如果用户不处于指定的角色,将导致忽略该元素。
importAttribute ignore 如果此属性的值为 truename 指定的属性不存在,则将返回而无任何错误。缺省值为 false,如果该属性不存在,则这一缺省值将导致抛出运行时异常。
name 指定要导入的属性的名称。缺省情况下,将导入所有属性。
scope 指定要将属性导入其中的范围。缺省值为 page
initComponentDefinitions classname 指定要创建并初始化的工厂的类名。
file 指定定义文件的名称。
insert attribute 指定当前平铺上下文中属性的名称。此属性的值被传递给 name(请参阅下面的描述)。
beanName 如果找到的 bean 或属性值是 Attribute 类(Direct 和 Instance 等等)之一的实例,则将根据类类型插入。否则,将对该 bean 调用 toString 方法,且返回的 String 类被用作要插入的名称(请参阅下面的 name)。
beanProperty 指定要检索其值的 bean 属性的名称。此属性支持嵌套属性和索引属性。
beanScope 指定搜索 bean 的范围。缺省情况下,使用方法 pageContext.findAttribute。范围可以是任何 JSP 范围、componenttemplate。后两种情况下,将在平铺上下文中搜索 bean。
component 指定表示要插入的平铺的 URI 的字符串。
controllerClass 指定就在插入页之前调用的控制器的 Java™ 类类型。控制器准备要由插入的平铺呈示的数据。该类必须实现或继承下列类之一:
  • org.apache.struts.tiles.Controller
  • org.apache.struts.tiles.ControllerSupport
  • org.apache.struts.action.Action(使用了包装器 org.apache.struts.action.ActionController)
不能将 controllerClasscontrollerUrl 一起使用。
controllerUrl 指定就在插入页之前调用的控制器的 URL。该 URL 通常表示一项 Struts 操作。控制器(操作)用来准备要由插入的平铺呈示的数据。不能将 controllerUrlcontrollerClass 一起使用。
definition 指定要插入的定义的名称。定义是在一个集中式文件中定义的。此属性只可插入来自工厂的定义。要插入用标记 <tiles:definition> 定义的定义,使用 beanName=""
flush 如果设置为 true,则在插入之前清除当前页输出流。
ignore 如果此属性的值为 truename 指定的属性不存在,则将返回而不写任何内容。缺省值为 false,如果该属性不存在,则这一缺省值将导致抛出运行时异常。
name 指定要插入的实体的名称。对实体的搜索是按以下顺序进行的:定义、属性和平铺。
page component 的同义词。
role 如果用户不处于指定的角色,将导致忽略该标记。
template component 的同义词。
put beanName 指定要使用其值的 bean 的名称。如果有指定上下文,将从指定上下文检索该 bean。否则,使用方法 pageContext.findAttribute。如果指定 beanProperty,则从相应的 bean 属性检索值。
beanProperty 指定要检索其值的 bean 属性的名称。此属性支持嵌套属性和索引属性。
beanScope 指定搜索 bean 的范围。缺省情况下,使用方法 pageContext.findAttribute。范围可以是任何 JSP 范围、componenttemplate。后两种情况下,将在平铺上下文中搜索 bean。
content value 的同义词。
direct 指定如何处理内容:true 表示内容被包含在文件中;false(缺省值)表示内容包括在其它地方。这是指定内容类型的另一种方式。如果指定 true,则内容被解释为字符串;否则被解释为页。此属性是为了与 JSP 模板兼容而存在的。
name 指定正被放置的属性的名称。
role 如果用户不处于指定的角色,将导致忽略该标记。
type 指定下列其中一种内容类型:
definition
指定在工厂(XML 文件)中定义的定义。将在 <insert attribute="attributeName"> 标记中的插入平铺中搜索定义,其中 attributeName 是用于此标记的名称。
page
包括来自指定 URL 的内容。此属性的同义词是 template
string
直接提供内容。
如果省略 type 属性,则除非内容来自类型化 bean,否则内容是非类型化的。
value 指定作为字符串或对象的属性值。必须指定 valuecontentbeanName
putList name 指定列表的名称。
useAttribute classname 指定已声明变量的类。
id 指定已声明的属性和变量名称。
ignore 如果此属性的值为 truename 指定的属性不存在,则将返回而无任何错误。缺省值为 false,如果该属性不存在,则这一缺省值将导致抛出运行时异常。
name 指定平铺的属性名称。
scope 指定已声明属性的范围。缺省值为 page

相关任务
将 Struts 标记添加至 JSP 文件

相关参考
Struts bean 标记的属性
Struts HTML 标记的属性
Struts 逻辑标记的属性
Struts 嵌套标记的属性
Struts 标记的属性

使用条款 | 反馈
(C) Copyright IBM Corporation 1999, 2005. All Rights Reserved.