com.adobe.mosaic.sparklib.tabLayout.events

# TabLayoutEvent - AS3 ADEP Composite Application

Package | com.adobe.mosaic.sparklib.tabLayout.events
Class | public class TabLayoutEvent
Inheritance | TabLayoutEvent Event Object

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtime Versions: | AIR 2.6, Flash Player 10.2

Event class dispatched by the TabLayout component.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | bubbles : Boolean [read-only] Indicates whether an event is a bubbling event. | Event
|  | cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented. | Event
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener. | Event
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | index : int The index of the tab target of this event. | TabLayoutEvent
|  | newTabName : String The new name for the tab at the given index. | TabLayoutEvent
|  | relatedIndex : int = -1 When a tab (index) has been closed, relatedIndex is set to the index of the tab that will be shown or -1 if no more tabs exist. | TabLayoutEvent
|  | target : Object [read-only] The event target. | Event
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | TabLayoutEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false) Constructor. | TabLayoutEvent
|  | clone():Event Duplicates an instance of an Event subclass. | Event
|  | formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event. | Event
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | preventDefault():void Cancels an event's default behavior if that behavior can be canceled. | Event
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. | Event
|  | stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. | Event
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns a string containing all the properties of the Event object. | Event
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | ADD_TAB : String = "addTab" [static] A new tab is requested. | TabLayoutEvent
|  | CLOSE_TAB : String = "closeTab" [static] Tab at index is being hidden. | TabLayoutEvent
|  | RENAME_TAB : String = "renameTab" [static] Tab at the index has been renamed. | TabLayoutEvent
|  | SAVE_TAB : String = "saveTab" [static] Tab at index should be saved. | TabLayoutEvent

Property Detail

### index

property

`public var index:int`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtime Versions: | AIR 2.6, Flash Player 10.2

The index of the tab target of this event.

### newTabName

property

`public var newTabName:String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtime Versions: | AIR 2.6, Flash Player 10.2

The new name for the tab at the given index.

### relatedIndex

property

`public var relatedIndex:int = -1`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtime Versions: | AIR 2.6, Flash Player 10.2

When a tab (index) has been closed, relatedIndex is set to the index of the tab that will be shown or -1 if no more tabs exist. When a tab has been selected, relatedIndex is set to the previously selected tab index (or -1 if no tab was previously selected).

Constructor Detail

### TabLayoutEvent

()
Constructor

`public function TabLayoutEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtime Versions: | AIR 2.6, Flash Player 10.2

Constructor.

Parameters

| `type:String` — The type of event.
| `bubbles:Boolean` (default = `false`)`` — Whether or not the event bubbles up the event chain.
| `cancelable:Boolean` (default = `false`)`` — Whether or not the event may be cancelled.

Constant Detail

### ADD_TAB

Constant

`public static const ADD_TAB:String = "addTab"`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtime Versions: | AIR 2.6, Flash Player 10.2

A new tab is requested.

### CLOSE_TAB

Constant

`public static const CLOSE_TAB:String = "closeTab"`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtime Versions: | AIR 2.6, Flash Player 10.2

Tab at index is being hidden.

### RENAME_TAB

Constant

`public static const RENAME_TAB:String = "renameTab"`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtime Versions: | AIR 2.6, Flash Player 10.2

Tab at the index has been renamed.

### SAVE_TAB

Constant

`public static const SAVE_TAB:String = "saveTab"`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtime Versions: | AIR 2.6, Flash Player 10.2

Tab at index should be saved.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00