Legend  - AS3 Flex

The creation policy of this container.

If true, measurement and layout are done when the position or size of a child is changed. If false, measurement and layout are done only once, when children are added to or removed from the container.

When using the Move effect, the layout around the component that is moving does not readjust to fit that the Move effect animates. Setting a container's autoLayout property to true has no effect on this behavior.

The Zoom effect does not work when the autoLayout property is false.

The autoLayout property does not apply to Accordion or ViewStack containers.

The default value is true.

Returns an EdgeMetrics object that has four properties: left, top, right, and bottom. The value of each property is equal to the thickness of one side of the border, expressed in pixels.

Unlike viewMetrics, this property is not overridden by subclasses of Container.

Array of UIComponentDescriptor objects produced by the MXML compiler.

Each UIComponentDescriptor object contains the information specified in one child MXML tag of the container's MXML tag. The order of the UIComponentDescriptor objects in the Array is the same as the order of the child tags. During initialization, the child descriptors are used to create the container's child UIComponent objects and its Repeater objects, and to give them the initial property values, event handlers, effects, and so on, that were specified in MXML.

Related API Elements

Whether to apply a clip mask if the positions and/or sizes of this container's children extend outside the borders of this container. If false, the children of this container remain visible when they are moved or sized outside the borders of this container. If true, the children of this container are clipped.

If clipContent is false, then scrolling is disabled for this container and scrollbars will not appear. If clipContent is true, then scrollbars will usually appear when the container's children extend outside the border of the container. For additional control over the appearance of scrollbars, see horizontalScrollPolicy and verticalScrollPolicy.

The default value is true.

Returns the x position of the mouse, in the content coordinate system. Content coordinates specify a pixel position relative to the upper left corner of the component's content, and include all of the component's content area, including any regions that are currently clipped and must be accessed by scrolling the component.

Returns the y position of the mouse, in the content coordinate system. Content coordinates specify a pixel position relative to the upper left corner of the component's content, and include all of the component's content area, including any regions that are currently clipped and must be accessed by scrolling the component.

Containers use an internal content pane to control scrolling. The creatingContentPane is true while the container is creating the content pane so that some events can be ignored or blocked.

Specifies the order to instantiate and draw the children of the container.

This property can only be used when the creationPolicy property is set to ContainerCreationPolicy.QUEUED. Otherwise, it is ignored.

The default value is -1.

The child creation policy for this MX Container. ActionScript values can be ContainerCreationPolicy.AUTO, ContainerCreationPolicy.ALL, or ContainerCreationPolicy.NONE. MXML values can be auto, all, or none.

If no creationPolicy is specified for a container, that container inherits its parent's creationPolicy. If no creationPolicy is specified for the Application, it defaults to ContainerCreationPolicy.AUTO.

A creationPolicy of ContainerCreationPolicy.AUTO means that the container delays creating some or all descendants until they are needed, a process which is known as deferred instantiation. This policy produces the best startup time because fewer UIComponents are created initially. However, this introduces navigation delays when a user navigates to other parts of the application for the first time. Navigator containers such as Accordion, TabNavigator, and ViewStack implement the ContainerCreationPolicy.AUTO policy by creating all their children immediately, but wait to create the deeper descendants of a child until it becomes the selected child of the navigator container.

A creationPolicy of ContainerCreationPolicy.ALL means that the navigator containers immediately create deeper descendants for each child, rather than waiting until that child is selected. For single-view containers such as a VBox container, there is no difference between the ContainerCreationPolicy.AUTO and ContainerCreationPolicy.ALL policies.

A creationPolicy of ContainerCreationPolicy.NONE means that the container creates none of its children. In that case, it is the responsibility of the MXML author to create the children by calling the createComponentsFromDescriptors() method.

The default value is ContainerCreationPolicy.AUTO.

The data property lets you pass a value to the component when you use it in an item renderer or item editor. You typically use data binding to bind a field of the data property to a property of this component.

You do not set this property in MXML.

The default value is null.

This property can be used as the source for data binding. When this property is modified, it dispatches the dataChange event.

Related API Elements

Set of data to be used in the Legend.

This property can be used as the source for data binding. When this property is modified, it dispatches the collectionChange event.

IDeferredContentOwner equivalent of processedDescriptors

Related API Elements

Determines how children are placed in the container. Possible MXML values are "horizontal" and "vertical". In ActionScript, you can set the direction using the values TileDirection.HORIZONTAL or TileDirection.VERTICAL. The default value is "horizontal". (If the container is a Legend container, which is a subclass of Tile, the default value is "vertical".)

The first child is always placed at the upper-left of the Tile container. If the direction is "horizontal", the children are placed left-to-right in the topmost row, and then left-to-right in the second row, and so on. If the value is "vertical", the children are placed top-to-bottom in the leftmost column, and then top-to-bottom in the second column, and so on.

The default value is "horizontal".

This property can be used as the source for data binding. When this property is modified, it dispatches the directionChanged event.

Related API Elements

The current position of the horizontal scroll bar. This is equal to the distance in pixels between the left edge of the scrollable surface and the leftmost piece of the surface that is currently visible.

The default value is 0.

This property can be used as the source for data binding. When this property is modified, it dispatches the viewChanged event.

The class used to instantiate LegendItem objects. When a legend's content is derived from the chart or data, it instantiates one instance of legendItemClass for each item described by the dataProvider. If you want custom behavior in your legend items, you can assign a subclass of LegendItem to this property to have the Legend create instances of their derived type instead.

The largest possible value for the horizontalScrollPosition property. Defaults to 0 if the horizontal scrollbar is not present.

The largest possible value for the verticalScrollPosition property. Defaults to 0 if the vertical scrollbar is not present.

Number of child components in this container.

The number of children is initially equal to the number of children declared in MXML. At runtime, new children may be added by calling addChild() or addChildAt(), and existing children may be removed by calling removeChild(), removeChildAt(), or removeAllChildren().