Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
RemoveChild

Package | mx.states
Class | public class RemoveChild
Inheritance | RemoveChild OverrideBase OnDemandEventDispatcher Object

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The RemoveChild class removes a child display object, such as a component, from a container as part of a view state. The child is only removed from the display list, it is not deleted. You use this class in the `overrides` property of the State class.

MXML Syntax Show MXML Syntax
Hide MXML Syntax

The `<mx:RemoveChild>` tag has the following attributes:

      <mx:RemoveChild
      Properties
      target="null"
      />

See also

mx.states.State
mx.states.AddChild
mx.states.Transition
mx.effects.RemoveChildAction

Public Properties

| Property | Defined By
--- | --- | ---
|  | target : Object The child to remove from the view. | RemoveChild

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | RemoveChild(target:DisplayObject = null) Constructor. | RemoveChild
|  | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void | OnDemandEventDispatcher
|  | apply(parent:UIComponent):void [override] Applies the override. | RemoveChild
|  | dispatchEvent(event:Event):Boolean | OnDemandEventDispatcher
|  | hasEventListener(type:String):Boolean | OnDemandEventDispatcher
|  | initialize():void IOverride interface method; this class implements it as an empty method. | OverrideBase
|  | remove(parent:UIComponent):void [override] Removes the override. | RemoveChild
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void | OnDemandEventDispatcher
|  | willTrigger(type:String):Boolean | OnDemandEventDispatcher

Property Detail

target | property

`public var target:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The child to remove from the view.

Constructor Detail

RemoveChild | () | Constructor

`public function RemoveChild(target:DisplayObject = null)`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

Parameters

| `target:DisplayObject` (default = `null`)`` — The child to remove from the view.

Method Detail

apply | () | method

`override public function apply(parent:UIComponent):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Applies the override. Flex retains the original value, so that it can restore the value later in the `remove()` method.

This method is called automatically when the state is entered. It should not be called directly.

Parameters

| `parent:UIComponent` — The parent of the state object containing this override. The override should use this as its target if an explicit target was not specified.

remove | () | method |

`override public function remove(parent:UIComponent):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Removes the override. The value remembered in the `apply()` method is restored.

This method is called automatically when the state is entered. It should not be called directly.

Parameters

| `parent:UIComponent` — The parent of the state object containing this override. The override should use this as its target if an explicit target was not specified.

Sun Mar 5 2017, 03:42 PM +11:00