Apache Flex (FlexJS) 0.7.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
MXMLBeadView

Package | org.apache.flex.html
Class | public class MXMLBeadView
Inheritance | MXMLBeadView ContainerView BeadViewBase EventDispatcher flash.events.EventDispatcher
Implements | IStrand, ILayoutHost
Subclasses | TitleBarView

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The MXMLBeadView class extends ContainerView and adds support for databinding and specification of children in MXML.

Default MXML Property `mxmlContent`

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | beads : Array The array property that is used to add additional beads to an MXML tag. | MXMLBeadView
|  | contentView : IParentIUIBase [read-only] The sub-element used as the parent of the container's elements. | ContainerView
|  | currentState : String The name of the current state. | MXMLBeadView
|  | host : IUIBase [read-only] The host component. | BeadViewBase
|  | model : Object [read-only] The model object. | MXMLBeadView
|  | mxmlContent : Array The default property. | MXMLBeadView
|  | MXMLDescriptor : Array [read-only] An array of data that describes the MXML attributes and tags in an MXML document. | MXMLBeadView
|  | resizableView : IUIBase [read-only] The view that can be resized. | ContainerView
|  | states : Array The array of view states. | MXMLBeadView
|  | strand : IStrand [override] [write-only] An MXMLBeadView doesn't create its children until it is added to the strand. | MXMLBeadView
|  | _strand : IStrand The strand. | BeadViewBase
|  | transitions : Array The array of transitions. | MXMLBeadView
|  | viewportModel : IViewportModel [read-only] The data model used by the viewport to determine how it should present the content area. | ContainerView

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | viewport : IViewport [read-only] The viewport used to present the content and may display scroll bars (depending on the actual type of viewport). | ContainerView

Public Methods

| Method | Defined By
--- | --- | ---
|  | MXMLBeadView() Constructor. | MXMLBeadView
|  | addBead(bead:IBead):void Add a bead to the strand. | MXMLBeadView
|  | generateMXMLAttributes(data:Array):void An method called by the compiler's generated code to kick off the setting of MXML attribute values and instantiation of child tags. | MXMLBeadView
|  | getBeadByType(classOrInterface:Class):IBead Find a bead on the strand. | MXMLBeadView
|  | hasState(state:String):Boolean true if the array of states contains a state with this name. | MXMLBeadView
|  | removeBead(value:IBead):IBead Remove a bead from the strand. | MXMLBeadView

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | childrenChangedHandler(event:Event):void Whenever children are added, listeners are added to detect changes in their size. | ContainerView
|  | childResizeHandler(event:Event):void This event handles changes to the size of children of the container by running the layout again and adjusting the size of the container or viewport as necessary. | ContainerView
|  | completeSetup():void Called when the host is ready to complete its setup (usually after its size has been determined). | ContainerView
|  | createViewport():void Creates the Viewport (or ScrollableViewport) through which the content area is presented. | ContainerView
|  | displayBackgroundAndBorder(host:UIBase):void | ContainerView
|  | getChromeMetrics():Rectangle Calculate the space taken up by non-content children like a TItleBar in a Panel. | ContainerView
|  | initCompleteHandler(event:Event):void Handles the initComplete event by completing the setup and kicking off the presentation of the Container. | ContainerView
|  | layoutViewAfterContentLayout():void Adjusts the size of the host, or adds scrollbars to the viewport, after the layout has been run. | ContainerView
|  | layoutViewBeforeContentLayout():void Positions the viewport, then sets any known sizes of the Viewport prior to laying out its content. | ContainerView
|  | performLayout(event:Event):void Executes the layout associated with this container. | ContainerView
|  | resizeHandler(event:Event):void Handles dynamic changes to the host's size by running the layout once the viewport has been adjusted. | ContainerView
|  | viewCreatedHandler(event:Event):void Handles the viewCreated event by performing the first layout if there are children already present (ie, from MXML). | ContainerView

Property Detail

beads | property

`public var beads:Array`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The array property that is used to add additional beads to an MXML tag. From ActionScript, just call addBead directly.

currentState | property |

`currentState:String`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The name of the current state.

This property can be used as the source for data binding.

Implementation
`public function get currentState():String`
`public function set currentState(value:String):void`

model | property |

`model:Object` [read-only]

The model object.

This property can be used as the source for data binding.

Implementation
`public function get model():Object`

mxmlContent | property |

`public var mxmlContent:Array`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The default property. Child tags in MXML documents get assigned to this property, but are actually encoded by the compiler into the MXMLDescriptor array. Therefore, setting this property from ActionScript will have no effect at runtime.

MXMLDescriptor | property |

`MXMLDescriptor:Array` [read-only]

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

An array of data that describes the MXML attributes and tags in an MXML document. This data is usually decoded by an MXMLDataInterpreter

Implementation
`public function get MXMLDescriptor():Array`

states | property |

`states:Array`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The array of view states. These should be instances of org.apache.flex.states.State.

Implementation
`public function get states():Array`
`public function set states(value:Array):void`

strand | property |

`strand:IStrand` [write-only] [override]

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

An MXMLBeadView doesn't create its children until it is added to the strand.

This property can be used as the source for data binding.

Implementation
`public function set strand(value:IStrand):void`

transitions | property |

`transitions:Array`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The array of transitions.

Implementation
`public function get transitions():Array`
`public function set transitions(value:Array):void`
Constructor Detail

MXMLBeadView | () | Constructor

`public function MXMLBeadView()`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

Constructor.

Method Detail

addBead | () | method

`public function addBead(bead:IBead):void`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

Add a bead to the strand.

Parameters

| `bead:IBead` — The bead to be added.

generateMXMLAttributes | () | method |

`public function generateMXMLAttributes(data:Array):void`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

An method called by the compiler's generated code to kick off the setting of MXML attribute values and instantiation of child tags. The call has to be made in the generated code in order to ensure that the constructors have completed first.

Parameters

| `data:Array` — The encoded data representing the MXML attributes.

getBeadByType | () | method |

`public function getBeadByType(classOrInterface:Class):IBead`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

Find a bead on the strand.

Parameters

| `classOrInterface:Class` — The class or interface to use to search for the bead

Returns

| `IBead` — The bead.

hasState | () | method |

`public function hasState(state:String):Boolean`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

`true` if the array of states contains a state with this name.

Parameters

| `state:String` — The state namem.

Returns

| `Boolean` — True if state in state array

removeBead | () | method |

`public function removeBead(value:IBead):IBead`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

Remove a bead from the strand.

Parameters

| `value:IBead` — bead The bead to be removed.

Returns

| `IBead`

Mon Sep 5 2016, 07:19 AM -07:00