flexlib :: library Documentation | All Packages | All Classes | Index | Frames No Frames |
SuperTab

Package | flexlib.controls.tabBarClasses
Class | public class SuperTab
Inheritance | SuperTab mx.controls.tabBarClasses.Tab

Public Properties

| Property | Defined By
--- | --- | ---
|  | closePolicy : String A string representing when to show the close button for the tab. | SuperTab
|  | doubleClickToEdit : Boolean = false Boolean indicating if a double click on the tab will allow the editing of the tab label. | SuperTab
|  | editableLabel : Boolean | SuperTab
|  | enabled : Boolean [override] [write-only] | SuperTab
|  | measuredWidth : Number [override] [read-only] | SuperTab
|  | selected : Boolean [override] [write-only] | SuperTab
|  | showIndicator : Boolean A Boolean to determine whether we should draw the indicator arrow icon. | SuperTab

Public Methods

| Method | Defined By
--- | --- | ---
|  | SuperTab() Constructor. | SuperTab
|  | showIndicatorAt(x:Number):void | SuperTab

Protected Methods

| Method | Defined By
--- | --- | ---
|  | createChildren():void [override] | SuperTab
|  | measure():void [override] | SuperTab
|  | rollOutHandler(event:MouseEvent):void [override] | SuperTab
|  | rollOverHandler(event:MouseEvent):void [override] We keep track of the rolled over state internally so we can set the closeButton to enabled or disabled depending on the state. | SuperTab
|  | updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void [override] | SuperTab

Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | tabUpdated | Fired when the the label of this tab is updated by the user double clicking and editing the tab label. | SuperTab

Styles

| Style | Description | Defined By
--- | --- | --- | ---
|  | indicatorClass | Type: String CSS Inheritance: no The class that is used for the indicator | SuperTab
|  | tabCloseButtonStyleName | Type: String CSS Inheritance: no Name of CSS style declaration that specifies the style to use for the close button | SuperTab

Public Constants

| Constant | Defined By
--- | --- | ---
|  | CLOSE_ALWAYS : String = close_always [static] Static variables indicating the policy to show the close button. | SuperTab
|  | CLOSE_NEVER : String = close_never [static] | SuperTab
|  | CLOSE_ROLLOVER : String = close_rollover [static] | SuperTab
|  | CLOSE_SELECTED : String = close_selected [static] | SuperTab
|  | CLOSE_TAB_EVENT : String = closeTab [static] | SuperTab

Property Detail

closePolicy | property

`closePolicy:String`

A string representing when to show the close button for the tab. Possible values include: SuperTab.CLOSE_ALWAYS, SuperTab.CLOSE_SELECTED, SuperTab.CLOSE_ROLLOVER, SuperTab.CLOSE_NEVER

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

doubleClickToEdit | property |

`public var doubleClickToEdit:Boolean = false`

Boolean indicating if a double click on the tab will allow the editing of the tab label.

The default value is `false.`.

editableLabel | property |

`editableLabel:Boolean`

Implementation
`public function get editableLabel():Boolean`
`public function set editableLabel(value:Boolean):void`

enabled | property |

`enabled:Boolean` [write-only] [override]

Implementation
`public function set enabled(value:Boolean):void`

measuredWidth | property |

`measuredWidth:Number` [read-only] [override]

Implementation
`public function get measuredWidth():Number`

selected | property |

`selected:Boolean` [write-only] [override]

Implementation
`public function set selected(value:Boolean):void`

showIndicator | property |

`showIndicator:Boolean`

A Boolean to determine whether we should draw the indicator arrow icon.

Implementation
`public function get showIndicator():Boolean`
`public function set showIndicator(value:Boolean):void`
Constructor Detail

SuperTab | () | Constructor

`public function SuperTab()`

Constructor.

Method Detail

createChildren | () | method

`override protected function createChildren():void`

measure | () | method |

`override protected function measure():void`

rollOutHandler | () | method |

`override protected function rollOutHandler(event:MouseEvent):void`

Parameters

| `event:MouseEvent`

rollOverHandler | () | method |

`override protected function rollOverHandler(event:MouseEvent):void`

We keep track of the rolled over state internally so we can set the closeButton to enabled or disabled depending on the state.

Parameters

| `event:MouseEvent`

showIndicatorAt | () | method |

`public function showIndicatorAt(x:Number):void`

Parameters

| `x:Number`

updateDisplayList | () | method |

`override protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void`

Parameters

| `unscaledWidth:Number`
| `unscaledHeight:Number`

Event Detail

tabUpdated | Event

Event Object Type: `flexlib.events.SuperTabEvent`

Fired when the the label of this tab is updated by the user double clicking and editing the tab label. Only possible if dougbleClickToEdit is true.

Constant Detail

CLOSE_ALWAYS | Constant

`public static const CLOSE_ALWAYS:String = close_always`

Static variables indicating the policy to show the close button. CLOSE_ALWAYS means the close button is always shown CLOSE_SELECTED means the close button is only shown on the currently selected tab CLOSE_ROLLOVER means the close button is show if the mouse rolls over a tab CLOSE_NEVER means the close button is never show.

CLOSE_NEVER | Constant |

`public static const CLOSE_NEVER:String = close_never`

CLOSE_ROLLOVER | Constant |

`public static const CLOSE_ROLLOVER:String = close_rollover`

CLOSE_SELECTED | Constant |

`public static const CLOSE_SELECTED:String = close_selected`

CLOSE_TAB_EVENT | Constant |

`public static const CLOSE_TAB_EVENT:String = closeTab`

Mercredi Juillet 6 2011, 09:45 PM +02:00