ComponentDescriptor  - AS3 Flex

对将在其中创建组件的文档 Object 的引用。

相关 API 元素

MXML 中所指定的包含组件事件处理程序的名称/值对的 Object。

例如，如果编写

      <mx:DataGrid id="dg" initialize="fetchData(); initDataGrid();"  change="changeHandler(event);"/>
      

则描述符的 events 属性即为以下 Object

      { initialize: "__dg_initialize", change: "__dg_change" }
      

如果没有为组件指定 MXML 事件处理程序，则 event 属性为 null

字符串 "__dg_initialize" 和 "__dg_change" 是 MXML 编译器自动生成的事件处理函数方法的名称。这些方法的主体中包含您指定为事件属性值的 ActionScript 语句。例如，自动生成的 initialize 处理函数是

      public function __dg_initialize(event:mx.events.FlexEvent):void
      {
          fetchData();
          initDataGrid();
      }
      

您不应认为自动生成的事件处理程序始终由名称指定；在新版本的 Flex 中可能会有所改变。

Container 方法 createComponentsFromDescriptors() 可借助此属性使用 addEventListener() 方法来注册自动生成的事件处理程序。

MXML 中指定的组件的标识符。

例如，如果编写

      <mx:TextInput id="firstName" text="Enter your first name here"/>
      

则描述符的 id 属性即为 String "firstName"。

如果没有为组件指定 MXML id，则 id 属性为 null。

id 属性的值将成为 MXML 文档对象中一个公用变量的名称，由 MXML 编译器自动生成。此变量的值是对使用此描述符创建的 UIComponent 对象的引用。例如，正因为如此，您才可以从包含此 TextInput 实例的文档中的任何位置引用 TextInput 控件的 text 属性作为 firstName.text。

如果已指定一个 id，并且是非空字符串，还会成为 DisplayObject 对象的 name。如果未指定 id 或其值为空，则 DisplayObject 对象的 name 将保留自动生成的字符串（如 "Button3"），它由 NameUtil.createUniqueName() 方法返回。name 在生成由 toString() 方法返回的字符串时使用。还可用于通过调用 getChildByName() 从组件的父级中查找组件。

相关 API 元素

MXML 中指定的包含组件属性的名称/值对的 Object。

例如，如果编写

      <mx:TextInput width="150" text="Hello"/>
      

则描述符的 properties 属性即为以下 Object

      { width: 150, text: "Hello" }
      

如果没有为组件指定 MXML 属性，则 properties 属性为 null。在此情形下，组件将使用默认属性值。

此 Object 通过调用由 propertiesFactory 属性指定的函数生成，然后缓存以供后续访问。然而，当 Repeater 使用同一描述符生成多个组件实例时，应为每个组件实例生成 properties Object 的一个全新副本，使它们不用共享作为 Array 或 Object 引用的属性值。Repeater 通过在描述符上调用 invalidateProperties() 方法来完成此操作。

相关 API 元素

一个 Function，用于返回 MXML 中指定的包含组件属性的名称/值对的 Object。

例如，如果编写

      <mx:TextInput width="150" text="Hello">
      

则描述符的 propertiesFactory 属性即为以下 Function：

      function():Object { return { width: 150, text: "Hello" }; }
      

如果没有为组件指定 MXML 属性，则 propertiesFactory 属性为 null。在此情形下，组件将使用默认属性值。

propertyFactory 是一个可返回 Object 的 Function 而不是一个实际 Object，这是由于 ComponentDescriptor 对象树是允许逐渐“展开”的。如果描述符树中关于文档的所有描述符都在启动时创建，则启动时间就会延长。

properties 属性返回一个缓存 Object，此对象由该工厂函数生成。

注意：事件处理程序（如 click="doSomething();"）位于 events Object 中，而不位于 properties Object 中。

相关 API 元素

MXML 中指定的组件的 Class。

例如，如果编写

      <mx:TextInput/>
      

则描述符的 type 属性即为类 mx.controls.TextInput。

对于由 MXML 编译器创建的 ComponentDescriptor 对象而言，此属性始终非 null，因为每个 MXML 标签都有一个标签名，如 mx:TextInput。

MXML 标签与其对应类之间的映射由 XML 命名空间和与此命名空间关联的“清单”文件（如果存在）确定。例如，由 mx: 前缀表示的标准 Flex 命名空间 http://www.adobe.com/2006/mxml 与清单文件 mxml-manifest.xml 关联（在 flex-config.xml 文件中），此文件具有以下标签

      <component id="TextInput" class="mx.controls.TextInput"/>
      

可将标签名 mx:TextInput 映射到 Class mx.controls.TextInput。请注意，使用清单文件允许将一个 XML 命名空间中的组件映射到多个 ActionScript 包中的类。

构造函数。

使缓存的 properties 属性失效。下次读取 properties 属性时，将使用由 propertiesFactory 属性值指定的函数重新生成这些属性。

返回字符串“ComponentDescriptor_”以及 id 属性的值。