Package | mx.containers |
Class | public class ViewStack |
Inheritance | ViewStack Container UIComponent FlexSprite flash.display.Sprite |
Implements | IHistoryManagerClient |
Subclasses | TabNavigator |
A ViewStack container does not provide a user interface
for selecting which child container is currently visible.
Typically, you set its selectedIndex
or
selectedChild
property in ActionScript in response to
some user action. Alternately, you can associate a LinkBar, TabBar or ToggleButtonBar
container with a ViewStack container to provide a navigation interface.
To do so, specify the ViewStack container as the value of the
dataProvider
property of the LinkBar, TabBar or
ToggleButtonBar container.
You might decide to use a more complex navigator container than the ViewStack container, such as a TabNavigator container or Accordion container. In addition to having a collection of child containers, these containers provide their own user interface controls for navigating between their children.
When you change the currently visible child container,
you can use the hideEffect
property of the container being
hidden and the showEffect
property of the newly visible child
container to apply an effect to the child containers.
The ViewStack container waits for the hideEffect
of the child
container being hidden to complete before it reveals the new child
container.
You can interrupt a currently playing effect if you change the
selectedIndex
property of the ViewStack container
while an effect is playing.
The ViewStack container has the following default sizing characteristics:
Characteristic | Description |
---|---|
Default size | The width and height of the initial active child. |
Container resizing rules | By default, ViewStack containers are sized only once to fit the size of the first child container. They do not resize when you navigate to other child containers. To force ViewStack containers to resize when you navigate to a different child container, set the resizeToContent property to true. |
Child sizing rules | Children are sized to their default size. If the child is larger than the ViewStack container, it is clipped. If the child is smaller than the ViewStack container, it is aligned to the upper-left corner of the ViewStack container. |
Default padding | 0 pixels for top, bottom, left, and right values. |
The <mx:ViewStack>
tag inherits the
tag attributes of its superclass, with the exception of scrolling-related
attributes, and adds the following tag attributes:
<mx:ViewStack Properties historyManagementEnabled="false|true" resizeToContent="false|true" selectedIndex="0" Styles horizontalGap="8" paddingBottom="0" paddingTop="0" verticalGap="6" Events change="No default" > ... child tags ... </mx:ViewStack>
See also
Property | Defined by | ||
---|---|---|---|
activeEffects : Array
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances.
| UIComponent | ||
automationDelegate : Object
The delegate object that handles the automation-related functionality.
| UIComponent | ||
automationName : String
Name that can be used as an identifier for this object.
| UIComponent | ||
automationTabularData : Object
An implementation of the
IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | ||
automationValue : Array
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application.
| UIComponent | ||
baselinePosition : Number
The y-coordinate of the baseline
of the first line of text of the component.
| UIComponent | ||
borderMetrics : EdgeMetrics
Returns an EdgeMetrics object that has four properties:
left , top , right ,
and bottom . | Container | ||
cacheHeuristic : Boolean
Used by Flex to suggest bitmap caching for the object.
| UIComponent | ||
cachePolicy : String
Specifies the bitmap caching policy for this object.
| UIComponent | ||
childDescriptors : Array
Array of UIComponentDescriptor objects produced by the MXML compiler.
| Container | ||
className : String
The name of this instance's class, such as
"Button" . | UIComponent | ||
clipContent : Boolean
Whether to apply a clip mask if the positions and/or sizes
of this container's children extend outside the borders of
this container.
| Container | ||
contentMouseX : Number
Returns the x position of the mouse, in the content coordinate system.
| Container | ||
contentMouseY : Number
Returns the y position of the mouse, in the content coordinate system.
| Container | ||
creatingContentPane : Boolean
Containers use an internal content pane to control scrolling.
| Container | ||
creationIndex : int
Specifies the order to instantiate and draw the children
of the container.
| Container | ||
creationPolicy : String
The child creation policy for this Container.
| Container | ||
currentLooperData : Object
When using this component as the child of a DataLooper element, this holds the current element's corresponding looping data.
| UIComponent | ||
currentState : String
The current view state of the component.
| UIComponent | ||
cursorManager : ICursorManager
Gets the CursorManager that controls the cursor for this component
and its peers.
| UIComponent | ||
data : Object
The
data property lets you pass a value
to the component when you use it in an item renderer or item editor. | Container | ||
descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the
createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | ||
document : Object
A reference to the document object associated with this UIComponent.
| UIComponent | ||
doubleClickEnabled : Boolean
Specifies whether the UIComponent object receives
doubleClick events. | UIComponent | ||
enabled : Boolean
Whether the component can accept user interaction.
| UIComponent | ||
errorString : String
The text that will be displayed by a component's error tip when a
component is monitored by a Validator and validation fails.
| UIComponent | ||
explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitMaxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitMaxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitMinHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitMinWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
flexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
| UIComponent | ||
focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
| UIComponent | ||
focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers.
| UIComponent | ||
focusPane : Sprite
The focus pane associated with this object.
| UIComponent | ||
globalX : Number | UIComponent | ||
globalY : Number | UIComponent | ||
height : Number
Number that specifies the height of the component, in pixels,
in the parent's coordinates.
| UIComponent | ||
historyManagementEnabled : Boolean
If
true , enables history management
within this ViewStack container. | ViewStack | ||
icon : Class
The Class of the icon displayed by some navigator
containers to represent this Container.
| Container | ||
id : String
ID of the component.
| UIComponent | ||
includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container.
| UIComponent | ||
inheritingStyles : Object
The beginning of this component's chain of inheriting styles.
| UIComponent | ||
initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required).
| UIComponent | ||
instanceIndex : int
The index of a repeated component.
| UIComponent | ||
instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document.
| UIComponent | ||
isDocument : Boolean
Determines whether this UIComponent instance is a document object,
that is, whether it is at the top of the hierarchy of a Flex
application, MXML component, or ActionScript component.
| UIComponent | ||
isPopUp : Boolean
Set to
true by the PopUpManager to indicate
that component has been popped up. | UIComponent | ||
label : String
The text displayed by some navigator containers to represent
this Container.
| Container | ||
maxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
maxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
measuredHeight : Number
The default height of the component, in pixels.
| UIComponent | ||
measuredMinHeight : Number
The default minimum height of the component, in pixels.
| UIComponent | ||
measuredMinWidth : Number
The default minimum width of the component, in pixels.
| UIComponent | ||
measuredWidth : Number
The default width of the component, in pixels.
| UIComponent | ||
minHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
minWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
miscHolder : Object
A utility holder for any various properties
| UIComponent | ||
moduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
| UIComponent | ||
mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
| UIComponent | ||
move_enableProtection : Boolean = false | UIComponent | ||
nestLevel : int
Depth of this object in the containment hierarchy.
| UIComponent | ||
nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
| UIComponent | ||
numAutomationChildren : int
The number of automation children this container has.
| UIComponent | ||
numChildren : int
Number of child components in this container.
| Container | ||
owner : DisplayObjectContainer
The owner of this UIComponent.
| UIComponent | ||
parent : DisplayObjectContainer
The parent container or component for this component.
| UIComponent | ||
parentApplication : Object
A reference to the Application object that contains this UIComponent
instance.
| UIComponent | ||
parentDocument : Object
A reference to the parent document object for this UIComponent.
| UIComponent | ||
percentHeight : Number
Number that specifies the height of a component as a percentage
of its parent's size.
| UIComponent | ||
percentWidth : Number
Number that specifies the width of a component as a percentage
of its parent's size.
| UIComponent | ||
processedDescriptors : Boolean
Set to
true after immediate or deferred child creation,
depending on which one happens. | UIComponent | ||
rawChildren : IChildList
A container typically contains child components, which can be enumerated
using the
Container.getChildAt() method and
Container.numChildren property. | Container | ||
repeater : IRepeater
A reference to the Repeater object
in the parent document that produced this UIComponent.
| UIComponent | ||
repeaterIndex : int
The index of the item in the data provider
of the Repeater that produced this UIComponent.
| UIComponent | ||
repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent.
| UIComponent | ||
repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent.
| UIComponent | ||
resizeToContent : Boolean
If
true , the ViewStack container automatically
resizes to the size of its current child. | ViewStack | ||
scaleX : Number
Number that specifies the horizontal scaling factor.
| UIComponent | ||
scaleY : Number
Number that specifies the vertical scaling factor.
| UIComponent | ||
screen : Rectangle
Returns an object that contains the size and position of the base
drawing surface for this object.
| UIComponent | ||
selectedChild : Container
A reference to the currently visible child container.
| ViewStack | ||
selectedIndex : int
The zero-based index of the currently visible child container.
| ViewStack | ||
setActualSize_enableProtection : Boolean = false | UIComponent | ||
setVisible_enableProtection : Boolean = true | UIComponent | ||
showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy.
| UIComponent | ||
states : Array
The view states that are defined for this component.
| UIComponent | ||
styleClassOverridesInline : Boolean = true
Specifies if class-specific styles (as defined by the
styleName property) override inline styles. | UIComponent | ||
styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
| UIComponent | ||
styleName : Object
The class style used by this component.
| UIComponent | ||
systemManager : ISystemManager
Returns the SystemManager object used by this component.
| UIComponent | ||
toolTip : String
Text to display in the ToolTip.
| UIComponent | ||
transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs.
| UIComponent | ||
tweeningProperties : Array
Array of properties that are currently being tweened on this object.
| UIComponent | ||
uid : String
A unique identifier for the object.
| UIComponent | ||
updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required).
| UIComponent | ||
validationSubField : String
Used by a validator to associate a subfield with this component.
| UIComponent | ||
viewMetrics : EdgeMetrics
Returns an object that has four properties:
left ,
top , right , and bottom . | Container | ||
viewMetricsAndPadding : EdgeMetrics
Returns an object that has four properties:
left ,
top , right , and bottom . | Container | ||
visible : Boolean
Controls the visibility of this UIComponent.
| UIComponent | ||
visible_unprotected : Boolean
If setVisible_enableProtection is enabled, this allows access to determine what the pseudo-state is -- that is, what's been requested, regardless of any prevention of default behavior.
| UIComponent | ||
width : Number
Number that specifies the width of the component, in pixels,
in the parent's coordinates.
| UIComponent | ||
x : Number
Number that specifies the component's horizontal position,
in pixels, within its parent container.
| UIComponent | ||
xmlDescriptor : XML
For certain dynamically created elements, this represents the XML node used to create that element.
| UIComponent | ||
y : Number
Number that specifies the component's vertical position,
in pixels, within its parent container.
| UIComponent |
Property | Defined by | ||
---|---|---|---|
actualCreationPolicy : String
The creation policy of this container.
| Container | ||
contentHeight : Number [read-only]
The height of the area, in pixels, in which content is displayed.
| ViewStack | ||
contentWidth : Number [read-only]
The width of the area, in pixels, in which content is displayed.
| ViewStack | ||
contentX : Number [read-only]
The x coordinate of the area of the ViewStack container
in which content is displayed, in pixels.
| ViewStack | ||
contentY : Number [read-only]
The y coordinate of the area of the ViewStack container
in which content is displayed, in pixels.
| ViewStack | ||
unscaledHeight : Number
A convenience method for determining the unscaled height
of the component.
| UIComponent | ||
unscaledWidth : Number
A convenience method for determining the unscaled width
of the component
All of a component's drawing and child layout should be done
within a bounding rectangle of this width, which is also passed
as an argument to
updateDisplayList() . | UIComponent |
Method | Defined by | ||
---|---|---|---|
Constructor.
| ViewStack | ||
addChild(child:DisplayObject):DisplayObject
Adds a child DisplayObject to this Container.
| Container | ||
addChildAt(child:DisplayObject, index:int):DisplayObject
Adds a child DisplayObject to this Container.
| Container | ||
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
| UIComponent | ||
clearStyle(styleProp:String):void
Deletes a style property from this component instance.
| UIComponent | ||
contentToGlobal(point:Point):Point
Converts a
Point object from content coordinates to global coordinates. | Container | ||
contentToLocal(point:Point):Point
Converts a
Point object from content to local coordinates. | Container | ||
createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within
this container.
| UIComponent | ||
Given a single UIComponentDescriptor, create the corresponding
component and add the component as a child of this Container.
| Container | ||
createComponentsFromDescriptors(recurse:Boolean = true):void
Iterate through the Array of
childDescriptors ,
and call the createComponentFromDescriptor() method for each one. | Container | ||
createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Creates an
id reference to this IUIComponent object
on its parent document object. | UIComponent | ||
deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Deletes the
id reference to this IUIComponent object
on its parent document object. | UIComponent | ||
Returns a UITextFormat object corresponding to the text styles
for this UIComponent.
| UIComponent | ||
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
| UIComponent | ||
drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component.
| UIComponent | ||
drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programatically draws a rectangle into this skin's Graphics object.
| UIComponent | ||
effectFinished(effectInst:IEffectInstance):void
Called by the effect instance when it stops playing on the component.
| UIComponent | ||
effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component.
| UIComponent | ||
endEffectsStarted():void
Ends all currently playing effects on the component.
| UIComponent | ||
executeBindings(recurse:Boolean = false):void
Executes all the data bindings on this Container.
| Container | ||
executeChildBindings(recurse:Boolean):void
Executes the bindings into this Container's child UIComponent objects.
| Container | ||
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete.
| UIComponent | ||
getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index.
| UIComponent | ||
getChildAt(index:int):DisplayObject
Gets the nth child component object.
| Container | ||
getChildByName(name:String):DisplayObject
Returns the child whose
name property is the specified String. | Container | ||
getChildIndex(child:DisplayObject):int
Gets the zero-based index of a specific child.
| Container | ||
getChildren():Array
Returns an Array of DisplayObject objects consisting of the content children
of the container.
| Container | ||
getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance.
| UIComponent | ||
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as
getting the constraint style for this component.
| UIComponent | ||
getDescendantByName(name:String):DisplayObject
Searches all children for the first child named with the passed value; returns that child, or null if not found.
| UIComponent | ||
getDescendantsByName(name:String):Array
Searches all children for all children named with the passed value; returns an array with those children, or an empty array if none found.
| UIComponent | ||
getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | ||
getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | ||
getFocus():InteractiveObject
Gets the object that currently has focus.
| UIComponent | ||
getRepeaterItem(whichRepeater:int = -1):Object
Returns the item in the
dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | ||
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this
component's style lookup chain.
| UIComponent | ||
getVisibleRect(targetParent:DisplayObject = null):Rectangle
MOVED OVER FROM SDK 3.2 UIComponent - Allows for popped-up alerts to be displayed correctly - NGR MOVED 11-20-08
| UIComponent | ||
globalToContent(point:Point):Point
Converts a
Point object from global to content coordinates. | Container | ||
horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | ||
initialize():void
Initializes the internal structure of this component.
| UIComponent | ||
initializeRepeaterArrays(parent:IRepeaterClient):void
Initializes various properties which keep track of repeated instances
of this component.
| UIComponent | ||
invalidateDisplayList():void
Marks a component so that its
updateDisplayList()
method gets called during a later screen update. | UIComponent | ||
invalidateProperties():void
Marks a component so that its
commitProperties()
method gets called during a later screen update. | UIComponent | ||
invalidateSize():void
Marks a component so that its
measure()
method gets called during a later screen update. | UIComponent | ||
Loads the state of this object.
| ViewStack | ||
localToContent(point:Point):Point
Converts a
Point object from local to content coordinates. | Container | ||
measureHTMLText(htmlText:String):TextLineMetrics
Measures the specified HTML text, which may contain HTML tags such
as
<font> and <b> ,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | ||
measureText(text:String):TextLineMetrics
Measures the specified text, assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent.
| UIComponent | ||
move(x:Number, y:Number):void
Moves the component to a specified position within its parent.
| UIComponent | ||
move_unprotected(x:Number, y:Number):void
Same as move, but cannot be prevented via the protection_move event.
| UIComponent | ||
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children.
| UIComponent | ||
owns(child:DisplayObject):Boolean
Returns
true if the chain of owner properties
points from child to this UIComponent. | UIComponent | ||
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent.
| UIComponent | ||
prepareToPrint(target:IFlexDisplayObject):Object
Prepares an IFlexDisplayObject for printing.
| UIComponent | ||
regenerateStyleCache(recursive:Boolean):void
Builds or rebuilds the CSS style cache for this component
and, if the
recursive parameter is true ,
for all descendants of this component as well. | UIComponent | ||
registerEffects(effects:Array):void
For each effect event, registers the EffectManager
as one of the event listeners.
| UIComponent | ||
removeAllChildren():void
Removes all children from the child list of this container.
| Container | ||
removeChild(child:DisplayObject):DisplayObject
Removes a child DisplayObject from the child list of this Container.
| Container | ||
removeChildAt(index:int):DisplayObject
Removes a child DisplayObject from the child list of this Container
at the specified index.
| Container | ||
replayAutomatableEvent(event:Event):Boolean
Replays the specified event.
| UIComponent | ||
resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided.
| UIComponent | ||
resumeBackgroundProcessing():void
[static]
Resumes the background processing of methods
queued by
callLater() , after a call to
suspendBackgroundProcessing() . | UIComponent | ||
saveState():Object
Saves the state of this object.
| ViewStack | ||
setActualSize(w:Number, h:Number):void
Sizes the object.
| UIComponent | ||
setActualSize_unprotected(w:Number, h:Number):void
Same as setActualSize, but is not cancelable via the protection_size event.
| UIComponent | ||
setChildIndex(child:DisplayObject, newIndex:int):void
Sets the index of a particular child.
| Container | ||
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as
setting the constraint style for this component.
| UIComponent | ||
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
| UIComponent | ||
setFocus():void
Sets the focus to this component.
| UIComponent | ||
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
| UIComponent | ||
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the
visible property changes. | UIComponent | ||
setVisible_unprotected(value:Boolean, noEvent:Boolean = false):void
Same as setVisible, but cannot be prevented.
| UIComponent | ||
styleChanged(styleProp:String):void
Detects changes to style properties.
| UIComponent | ||
stylesInitialized():void
Flex calls the
stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | ||
suspendBackgroundProcessing():void
[static]
Blocks the background processing of methods
queued by
callLater() ,
until resumeBackgroundProcessing() is called. | UIComponent | ||
toString():String
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application.
| FlexSprite | ||
validateDisplayList():void
Validates the position and size of children and draws other
visuals.
| UIComponent | ||
validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary.
| UIComponent | ||
validateProperties():void
Used by layout logic to validate the properties of a component
by calling the
commitProperties() method. | UIComponent | ||
validateSize(recursive:Boolean = false):void
Validates the measured size of the component
If the
LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | ||
validationResultHandler(event:ValidationResultEvent):void
Handles both the
valid and invalid events from a
validator assigned to this component. | UIComponent | ||
verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to
drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent |
Method | Defined by | ||
---|---|---|---|
adjustFocusRect(obj:DisplayObject = null):void
Adjust the focus rectangle.
| UIComponent | ||
attachOverlay():void
Used internally by the Dissolve Effect to add the overlay to the chrome of a container.
| Container | ||
childrenCreated():void
Performs any final processing after child objects are created.
| UIComponent | ||
commitProperties():void
Processes the properties set on the component.
| UIComponent | ||
commitSelectedIndex(newIndex:int):void
Commits the selected index.
| ViewStack | ||
createBorder():void
Creates the container's border skin
if it is needed and does not already exist.
| Container | ||
createChildren():void
Create child objects of the component.
| UIComponent | ||
createInFontContext(classObj:Class):Object
Creates a new object using a context
based on the embedded font being used.
| UIComponent | ||
createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object
Creates the object using a given moduleFactory.
| UIComponent | ||
focusInHandler(event:FocusEvent):void
The event handler called when a UIComponent object gets focus.
| UIComponent | ||
focusOutHandler(event:FocusEvent):void
The event handler called when a UIComponent object loses focus.
| UIComponent | ||
initializationComplete():void
Finalizes the initialization of this component.
| UIComponent | ||
initializeAccessibility():void
Initializes this component's accessibility code.
| UIComponent | ||
isOurFocus(target:DisplayObject):Boolean
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus.
| UIComponent | ||
keyDownHandler(event:KeyboardEvent):void
The event handler called for a
keyDown event. | UIComponent | ||
keyUpHandler(event:KeyboardEvent):void
The event handler called for a
keyUp event. | UIComponent | ||
layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void
Respond to size changes by setting the positions and sizes
of this container's borders.
| Container | ||
measure():void
Calculates the default sizes and minimum and maximum values of the
ViewStack container.
| ViewStack | ||
resourcesChanged():void
This method is called when a UIComponent is constructed,
and again whenever the ResourceManager dispatches
a
"change" Event to indicate
that the localized resources have changed in some way. | UIComponent | ||
scrollChildren():void
Positions the container's content area relative to the viewable area
based on the horizontalScrollPosition and verticalScrollPosition properties.
| Container | ||
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Responds to size changes by setting the positions and sizes
of this container's children.
| ViewStack |
Event | Summary | Defined by | ||
---|---|---|---|---|
Dispatched when the component is added to a container as a content child
by using the addChild() or addChildAt() method. | UIComponent | |||
Dispatched when the selected child container changes. | ViewStack | |||
Dispatched after a child has been added to a container. | Container | |||
Dispatched after the index (among the container children) of a container child changes. | Container | |||
Dispatched before a child of a container is removed. | Container | |||
Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | |||
Dispatched after the view state has changed. | UIComponent | |||
Dispatched after the currentState property changes,
but before the view state changes. | UIComponent | |||
Dispatched when the data property changes. | Container | |||
Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop. | UIComponent | |||
Dispatched by the drop target when the user releases the mouse over it. | UIComponent | |||
Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | |||
Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | |||
Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | |||
Dispatched by the drag initiator when starting a drag operation. | UIComponent | |||
Dispatched after an effect ends. | UIComponent | |||
Dispatched just before an effect starts. | UIComponent | |||
Dispatched after the component has returned to the root view state. | UIComponent | |||
Dispatched before the component exits from the root view state. | UIComponent | |||
Dispatched when an object's state changes from visible to invisible. | UIComponent | |||
Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | |||
Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | |||
Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | |||
Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | |||
Dispatched when the object has moved. | UIComponent | |||
Dispatched at the beginning of the component initialization sequence. | UIComponent | |||
Dispatched when the component is about to be hidden (visible = false); calling event.preventDefault() will stop the action from occuring. | UIComponent | |||
Dispatched when the component is about to be moved via move(); calling event.preventDefault() will stop the action from occuring. | UIComponent | |||
Dispatched when the component is about to be shown (visible = true); calling event.preventDefault() will stop the action from occuring. | UIComponent | |||
Dispatched when the component is about to be sized via setActualSize(); calling event.preventDefault() will stop the action from occuring. | UIComponent | |||
Dispatched when the component is removed from a container as a content child
by using the removeChild() or removeChildAt() method. | UIComponent | |||
Dispatched when the component is resized. | UIComponent | |||
Dispatched when an object's state changes from invisible to visible. | UIComponent | |||
Dispatched by the component when it is time to create a ToolTip. | UIComponent | |||
Dispatched by the component when its ToolTip has been hidden and will be discarded soon. | UIComponent | |||
Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | |||
Dispatched by the component when its ToolTip is about to be shown. | UIComponent | |||
Dispatched by the component when its ToolTip has been shown. | UIComponent | |||
Dispatched by a component whose toolTip property is set,
as soon as the user moves the mouse over it. | UIComponent | |||
Dispatched when an object has had its commitProperties() ,
measure() , and
updateDisplayList() methods called (if needed). | UIComponent | |||
Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | |||
Dispatched when values are changed programmatically or by user interaction. | UIComponent |
Style | Description | Defined by | ||
---|---|---|---|---|
Type: Number CSS Inheritance: no Alpha level of the color defined by the backgroundColor
property, of the image or SWF file defined by the backgroundImage
style. | Container | |||
Type: String CSS Inheritance: no If a background image is specified, this style specifies whether it is fixed with regard to the viewport ( "fixed" )
or scrolls along with the content ("scroll" ). | Container | |||
Type: uint Format: Color CSS Inheritance: no Background color of a component. | Container | |||
Type: uint Format: Color CSS Inheritance: yes Background color of the component when it is disabled. | Container | |||
Type: Object Format: File CSS Inheritance: no Background image of a component. | Container | |||
Type: String CSS Inheritance: no Scales the image specified by backgroundImage
to different percentage sizes. | Container | |||
Type: uint Format: Color CSS Inheritance: yes Determines the color of a ProgressBar. | Container | |||
Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | |||
Type: uint Format: Color CSS Inheritance: no Color of the border. | Container | |||
Type: String CSS Inheritance: no Bounding box sides. | Container | |||
Type: Class CSS Inheritance: no The border skin class of the component. | Container | |||
Type: String CSS Inheritance: no Bounding box style. | Container | |||
Type: Number Format: Length CSS Inheritance: no Bounding box thickness. | Container | |||
Type: String CSS Inheritance: no The vertical distance in pixels from the lower edge of the component to the lower edge of its content area. | UIComponent | |||
Type: Number CSS Inheritance: no The color brightness of the component. | UIComponent | |||
Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. | Container | |||
Type: Number CSS Inheritance: no The color contrast of the component. | UIComponent | |||
Type: Number Format: Length CSS Inheritance: no Radius of component corners. | Container | |||
Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. | Container | |||
Type: Number CSS Inheritance: no The alpha value for the overlay that is placed on top of the container when it is disabled. | Container | |||
Type: uint Format: Color CSS Inheritance: yes Color of the drop shadow. | Container | |||
Type: Boolean CSS Inheritance: no Boolean property that specifies whether the component has a visible drop shadow. | Container | |||
Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | |||
Type: String CSS Inheritance: yes Sets the antiAliasType property of internal TextFields. | Container | |||
Type: String CSS Inheritance: yes Name of the font to use. | Container | |||
Type: String CSS Inheritance: yes Sets the gridFitType property of internal TextFields that represent text in Flex controls. | Container | |||
Type: Number CSS Inheritance: yes Sets the sharpness property of internal TextFields that represent text in Flex controls. | Container | |||
Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. | Container | |||
Type: String CSS Inheritance: yes Determines whether the text is italic font. | Container | |||
Type: Number CSS Inheritance: yes Sets the thickness property of internal TextFields that represent text in Flex controls. | Container | |||
Type: String CSS Inheritance: yes Determines whether the text is boldface. | Container | |||
Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | |||
horizontalGap
| Type: Number Format: Length CSS Inheritance: no Number of pixels between children in the horizontal direction. The default value depends on the component class; if not overriden for the class, the default value is 8. | ViewStack | ||
Type: Number CSS Inheritance: no The color hue of the component. | UIComponent | |||
Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled ( true ) or disabled (false ). | Container | |||
Type: String CSS Inheritance: no The horizontal distance in pixels from the left edge of the component's content area to the left edge of the component. | UIComponent | |||
Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. | Container | |||
Type: Number CSS Inheritance: no The opacity of the component. | UIComponent | |||
paddingBottom
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's bottom border and its content area. The default value is 0. | ViewStack | ||
Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's left border and the left edge of its content area. | Container | |||
Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's right border and the right edge of its content area. | Container | |||
paddingTop
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's top border and its content area. The default value is 0. | ViewStack | ||
Type: String CSS Inheritance: no The horizontal distance in pixels from the right edge of the component to the right edge of its content area. | UIComponent | |||
Type: Number CSS Inheritance: no The color saturation of the component. | UIComponent | |||
Type: String CSS Inheritance: no Direction of the drop shadow. | Container | |||
Type: Number Format: Length CSS Inheritance: no Distance of the drop shadow. | Container | |||
Type: String CSS Inheritance: yes Alignment of text within a container. | Container | |||
Type: String CSS Inheritance: yes Determines whether the text is underlined. | Container | |||
Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. | Container | |||
Type: uint Format: Color CSS Inheritance: yes Theme color of a component. | UIComponent | |||
Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the control's content area to the top edge of the component. | UIComponent | |||
Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent | |||
verticalGap
| Type: Number Format: Length CSS Inheritance: no Number of pixels between children in the vertical direction. The default value depends on the component class; if not overriden for the class, the default value is 6. | ViewStack |
contentHeight | property |
contentHeight:Number
[read-only]The height of the area, in pixels, in which content is displayed. You can override this getter if your content does not occupy the entire area of the ViewStack container.
Implementation protected function get contentHeight():Number
contentWidth | property |
contentWidth:Number
[read-only]The width of the area, in pixels, in which content is displayed. You can override this getter if your content does not occupy the entire area of the ViewStack container.
Implementation protected function get contentWidth():Number
contentX | property |
contentX:Number
[read-only]
The x coordinate of the area of the ViewStack container
in which content is displayed, in pixels.
The default value is equal to the value of the
paddingLeft
style property,
which has a default value of 0.
Override the get()
method if you do not want
your content to start layout at x = 0.
protected function get contentX():Number
contentY | property |
contentY:Number
[read-only]
The y coordinate of the area of the ViewStack container
in which content is displayed, in pixels.
The default value is equal to the value of the
paddingTop
style property,
which has a default value of 0.
Override the get()
method if you do not want
your content to start layout at y = 0.
protected function get contentY():Number
historyManagementEnabled | property |
historyManagementEnabled:Boolean
[read-write]
If true
, enables history management
within this ViewStack container.
As the user navigates from one child to another,
the browser remembers which children were visited.
The user can then click the browser's Back and Forward buttons
to move through this navigation history.
The default value is false
.
public function get historyManagementEnabled():Boolean
public function set historyManagementEnabled(value:Boolean):void
See also
resizeToContent | property |
resizeToContent:Boolean
[read-write]
If true
, the ViewStack container automatically
resizes to the size of its current child.
The default value is false
.
public function get resizeToContent():Boolean
public function set resizeToContent(value:Boolean):void
selectedChild | property |
selectedChild:Container
[read-write]
A reference to the currently visible child container.
The default is a reference to the first child.
If there are no children, this property is null
.
Note: You can only set this property in an ActionScript statement, not in MXML.
This property can be used as the source for data binding.
Implementation public function get selectedChild():Container
public function set selectedChild(value:Container):void
selectedIndex | property |
selectedIndex:int
[read-write]
The zero-based index of the currently visible child container.
Child indexes are in the range 0, 1, 2, ..., n - 1,
where n is the number of children.
The default value is 0, corresponding to the first child.
If there are no children, the value of this property is -1
.
Note: When you add a new child to a ViewStack
container, the selectedIndex
property is automatically
adjusted, if necessary, so that the selected child remains selected.
This property can be used as the source for data binding.
Implementation public function get selectedIndex():int
public function set selectedIndex(value:int):void
ViewStack | () | constructor |
public function ViewStack()
Constructor.
commitSelectedIndex | () | method |
protected function commitSelectedIndex(newIndex:int):void
Commits the selected index. This function is called during the commit properties phase when the selectedIndex (or selectedItem) property has changed.
ParametersnewIndex:int |
loadState | () | method |
public function loadState(state:Object):void
Loads the state of this object.
Parametersstate:Object — State of this object to load.
This will be null when loading the initial state of the application.
|
measure | () | method |
protected override function measure():void
Calculates the default sizes and minimum and maximum values of the
ViewStack container.
For more information about the measure()
method,
see the UIComponent.measure()
method.
The default size of a ViewStack container is the default size of its currently selected child, plus the padding and borders. If the ViewStack container has no children, its default size is just large enough for its padding and borders.
The minimum size of a ViewStack container is the minimum size of its currently selected child, plus the padding and borders. If the ViewStack container has no children, its minimum size is just large enough for its padding and borders.
This method does not change the maximum size of a ViewStack container - it remains unbounded.
See also
saveState | () | method |
public function saveState():Object
Saves the state of this object. The object contains name:value pairs for each property to be saved with the state.
The History Manager collects the state information from all components and encodes the information in a URL format. Most browsers have a length limitation on URLs, so the state information returned should be as minimal as possible.
ReturnsObject — The state of this object.
|
updateDisplayList | () | method |
protected override function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Responds to size changes by setting the positions and sizes
of this container's children.
For more information about the updateDisplayList()
method,
see the UIComponent.updateDisplayList()
method.
Only one of its children is visible at a time, therefore, a ViewStack container positions and sizes only that child.
The selected child is positioned in the ViewStack container's upper-left corner, and allows for the ViewStack container's padding and borders.
If the selected child has a percentage width
or
height
value, it is resized in that direction
to fill the specified percentage of the ViewStack container's
content area (i.e., the region inside its padding).
unscaledWidth:Number — Specifies the width of the component, in pixels,
in the component's coordinates, regardless of the value of the
scaleX property of the component.
|
|
unscaledHeight:Number — Specifies the height of the component, in pixels,
in the component's coordinates, regardless of the value of the
scaleY property of the component.
|
See also
change | event |
mx.events.IndexChangedEvent
mx.events.IndexChangedEvent.CHANGE
Dispatched when the selected child container changes.
The IndexChangedEvent.CHANGE constant defines the value of the
type
property of the event object for a change
event,
which indicates that an index has changed, such as when and Accordion control
changes the displayed panel or a ViewStack changes views.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
inputType | Indicates whether this event was caused by a mouse or keyboard interaction. |
newIndex | The zero-based index after the change. |
oldIndex | The zero-based index before the change. |
relatedObject | Contains a reference to the child object that corresponds to the new index. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
TriggerEvent | The event that triggered this event. |
Type | IndexChangedEvent.CHANGE |