Package | flexlib.containers |
Class | public class SuperTabNavigator |
Inheritance | SuperTabNavigator ![]() |
The SuperTabNavigator functions exactly like the TabNavigator, but adds some functionality. Added functionality includes:
These features make the SuperTabNavigator function much more like the tabs in Firefox.
MXML SyntaxThe <mx:SuperTabNavigator>
tag inherits all of the
tag attributes of the TabNavigator,
and adds the following tag attributes:
<mx:SuperTabNavigator Styles popupButtonStyleName="Value of thepopupButtonStyleName
property" leftButtonStyleName="Value of theleftButtonStyleName
property" rightButtonStyleName="Value of therightButtonStyleName
property" Properties popUpButtonPolicy="on|auto|off" startScrollingEvent="MouseEvent.MOUSE_DOWN|MouseEvent.MOUSE_OVER" stopScrollingEvent="MouseEvent.MOUSE_UP|MouseEvent.MOUSE_OUT" scrollSpeed="100" dragEnabled="true|false" dropEnabled="true|false" minTabWidth="60" > ... child tags ... </mx:SuperTabNavigator>
See also
Property | Defined by | ||
---|---|---|---|
allowTabSqueezing : Boolean
Boolean indicating if tab width should be adjusted to try to squeeze all tabs so we don't need
scrolling.
| SuperTabNavigator | ||
closePolicy : String
The close policy for tabs.
| SuperTabNavigator | ||
dragEnabled : Boolean
Boolean indicating whether or not this SuperTabNavigator allows
tabs to be dragged from the tab bar.
| SuperTabNavigator | ||
dropEnabled : Boolean
Boolean indicating whether or not this SuperTabNavigator allows
tabs to be dropped on the tab bar.
| SuperTabNavigator | ||
editableTabLabels : Boolean
Boolean indicating if tab labels can be edited.
| SuperTabNavigator | ||
minTabWidth : Number
The minimum tab width allowed to display tabs.
| SuperTabNavigator | ||
popUpButtonPolicy : String
Either POPUPPOLICY.AUTO, POPUPOLICY_ON, or POPUPPOLICY_OFF.
| SuperTabNavigator | ||
POPUPPOLICY_AUTO : String = "auto" [static]
Static variable indicating the Button will be shown if there is more
than one tab in the SuperTabNavigator.
| SuperTabNavigator | ||
POPUPPOLICY_OFF : String = "off" [static]
Static variable indicating the Button will never be shown to the
right of the tab bar.
| SuperTabNavigator | ||
POPUPPOLICY_ON : String = "on" [static]
Static variable indicating the Button will always be shown to the
right of the tab bar, no matter how many tabs are open.
| SuperTabNavigator | ||
scrollSpeed : Number
The delay in milliseconds between scrolling the tabs.
| SuperTabNavigator | ||
startScrollingEvent : String | SuperTabNavigator | ||
stopScrollingEvent : String | SuperTabNavigator |
Method | Defined by | ||
---|---|---|---|
initialize():void
| SuperTabNavigator | ||
setClosePolicyForTab(index:int, value:String):void
| SuperTabNavigator | ||
styleChanged(styleProp:String):void
| SuperTabNavigator |
Method | Defined by | ||
---|---|---|---|
For extensibility, if you want to use a custom extended version of SuperTabBar, you can do so by
overriding the
createTabBar method and returning an instance of any class that extends
SuperTabBar . | SuperTabNavigator | ||
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
| SuperTabNavigator |
Event | Summary | Defined by | ||
---|---|---|---|---|
Fired when the close button of a tab is clicked. | SuperTabNavigator | |||
SuperTabNavigator |
allowTabSqueezing | property |
allowTabSqueezing:Boolean
[read-write]
Boolean indicating if tab width should be adjusted to try to squeeze all tabs so we don't need
scrolling. If true, tabs will be squeezed until they reach the minTabWidth
value, at which
point they scroll. If false, tabs will never be resized smaller than their default widths.
The default value is true
.
public function get allowTabSqueezing():Boolean
public function set allowTabSqueezing(value:Boolean):void
closePolicy | property |
closePolicy:String
[read-write]The close policy for tabs.
Implementation public function get closePolicy():String
public function set closePolicy(value:String):void
See also
dragEnabled | property |
dragEnabled:Boolean
[read-write]Boolean indicating whether or not this SuperTabNavigator allows tabs to be dragged from the tab bar.
If both dragEnabled and dropEnabled are true then the SuperTabNavigator allows reordering of tabs by drag and drop
The default value is true
.
public function get dragEnabled():Boolean
public function set dragEnabled(value:Boolean):void
dropEnabled | property |
dropEnabled:Boolean
[read-write]Boolean indicating whether or not this SuperTabNavigator allows tabs to be dropped on the tab bar.
If both dragEnabled and dropEnabled are true then the SuperTabNavigator allows reordering of tabs by drag and drop
The default value is true
.
public function get dropEnabled():Boolean
public function set dropEnabled(value:Boolean):void
editableTabLabels | property |
editableTabLabels:Boolean
[read-write]Boolean indicating if tab labels can be edited. If true, the user can double click on a tab label and edit the label.
Implementation public function get editableTabLabels():Boolean
public function set editableTabLabels(value:Boolean):void
minTabWidth | property |
minTabWidth:Number
[read-write]The minimum tab width allowed to display tabs.
If tabs cannot fit at their default size, then they are shrunk until they reach minTabWidth. If they still cannot fit then they remain at minTabWidth and the SuperTabBar scrolls the tabs.
The default value is 60
.
public function get minTabWidth():Number
public function set minTabWidth(value:Number):void
popUpButtonPolicy | property |
popUpButtonPolicy:String
[read-write]Either POPUPPOLICY.AUTO, POPUPOLICY_ON, or POPUPPOLICY_OFF.
Indicates how the Button to the right of the tabs should
be shown. AUTO means the button will be shown if there is more than
one tab. ON means it will always be shown, and OFF means it will never
be shown.
Implementation
public function get popUpButtonPolicy():String
public function set popUpButtonPolicy(value:String):void
POPUPPOLICY_AUTO | property |
public static var POPUPPOLICY_AUTO:String = "auto"
Static variable indicating the Button will be shown if there is more than one tab in the SuperTabNavigator. Used to set popUpButtonPolicy.
POPUPPOLICY_OFF | property |
public static var POPUPPOLICY_OFF:String = "off"
Static variable indicating the Button will never be shown to the right of the tab bar. Used to set popUpButtonPolicy.
POPUPPOLICY_ON | property |
public static var POPUPPOLICY_ON:String = "on"
Static variable indicating the Button will always be shown to the right of the tab bar, no matter how many tabs are open. Used to set popUpButtonPolicy.
scrollSpeed | property |
scrollSpeed:Number
[read-write]The delay in milliseconds between scrolling the tabs.
The smaller the number here the faster the scrolling speed.
Implementation public function get scrollSpeed():Number
public function set scrollSpeed(value:Number):void
startScrollingEvent | property |
startScrollingEvent:String
[read-write]Implementation
public function get startScrollingEvent():String
public function set startScrollingEvent(value:String):void
stopScrollingEvent | property |
stopScrollingEvent:String
[read-write]Implementation
public function get stopScrollingEvent():String
public function set stopScrollingEvent(value:String):void
createTabBar | () | method |
protected function createTabBar():SuperTabBar
For extensibility, if you want to use a custom extended version of SuperTabBar, you can do so by
overriding the createTabBar
method and returning an instance of any class that extends
SuperTabBar
.
SuperTabBar |
initialize | () | method |
public override function initialize():void
setClosePolicyForTab | () | method |
public function setClosePolicyForTab(index:int, value:String):void
Parameters
index:int |
|
value:String |
styleChanged | () | method |
public override function styleChanged(styleProp:String):void
Parameters
styleProp:String |
updateDisplayList | () | method |
protected override function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Parameters
unscaledWidth:Number |
|
unscaledHeight:Number |
tabClose | event |
flexlib.events.SuperTabEvent
Fired when the close button of a tab is clicked. To stop the default action, which will remove the child from the collection of children, call event.preventDefault() in your listener.
tabsReordered | event |