| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!-- saved from url=(0014)about:internet --><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><link rel="stylesheet" href="../../style.css" type="text/css" media="screen"><link rel="stylesheet" href="../../print.css" type="text/css" media="print"><link rel="stylesheet" href="../../override.css" type="text/css"><meta name="keywords" content="State,mx.states.State,AFTER,BEFORE,END,FIRST,LAST,STOP,autoReverse,basedOn,creationPolicy,creationPolicy,destination,destructionPolicy,effect,fromState,handlerFunction,interruptionBehavior,isArray,isStyle,items,itemsDescriptor,itemsFactory,name,name,name,name,originalHandlerFunction,overrides,position,position,propertyName,relativeTo,relativeTo,stateGroups,target,target,target,target,target,targetFactory,toState,value,value,valueFactory,valueFactory,vectorClass"><title>mx.states.State</title></head><body><script language="javascript" type="text/javascript" src="../../asdoc.js"></script><script language="javascript" type="text/javascript" src="../../help.js"></script><script language="javascript" type="text/javascript" src="../../cookies.js"></script><script language="javascript" type="text/javascript"><!-- |
| asdocTitle = 'State - ApacheFlex API Reference'; |
| var baseRef = '../../'; |
| window.onload = configPage; |
| --></script> |
| <script type="text/javascript"> |
| scrollToNameAnchor(); |
| </script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">Apache Flex 4.16.1 API Reference </td><td class="titleTableTopNav" align="right"><a href="../../package-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Packages</a> | <a href="../../class-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Classes</a> | <a href="../../all-index-A.html" onclick="loadClassListFrame('../../index-list.html')">Index</a> | <a id="framesLink1" href="../../index.html?mx/states/State.html&mx/states/class-list.html">Frames</a><a id="noFramesLink1" style="display:none" href="" onclick="parent.location=document.location"> No Frames </a></td><td class="titleTableLogo" align="right" rowspan="3"><img src="../../images/logo.jpg" class="logoImage" alt="AdobeLogo" title="AdobeLogo"></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">State</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a> | <a href="#eventSummary">Events</a></td></tr><tr class="titleTableRow3"><td colspan="3"> </td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve"> |
| <!-- |
| |
| if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("State"); titleBar_setSubNav(false,true,false,false,false,false,true,false,true,false,false ,false,false,false,false,false);} |
| --> |
| </script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">mx.states</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class State</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">State <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> flash.events.EventDispatcher</td></tr></table><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p></p><p></p> |
| The State class defines a view state, a particular view of a component. |
| For example, a product thumbnail could have two view states; |
| a base view state with minimal information, and a rich view state with |
| additional information. |
| The <code>overrides</code> property specifies a set of child classes |
| to add or remove from the base view state, and properties, styles, and event |
| handlers to set when the view state is in effect. |
| <p>You use the State class in the <code>states</code> property |
| of Flex components. |
| You can only specify a <code>states</code> property at the root of an |
| application or a custom control, not on child controls.</p> |
| <p>You enable a view state by setting a component's |
| <code>currentState</code> property.</p> |
| <p></p><a name="mxmlSyntaxSummary"></a><span class="classHeaderTableLabel">MXML Syntax</span><span id="showMxmlLink" style="display:none"><a href="#mxmlSyntaxSummary" onclick="toggleMXMLOnly();"><img src="../../images/collapsed.gif" title="collapsed" alt="collapsed" class="collapsedImage">Show MXML Syntax</a><br/></span><span id="hideMxmlLink"><a href="#mxmlSyntaxSummary" onclick="toggleMXMLOnly();"><img src="../../images/expanded.gif" title="expanded" alt="expanded" class="expandedImage">Hide MXML Syntax</a></span><div id="mxmlSyntax" class="mxmlSyntax"> <p>The <code><mx:State></code> tag has the following attributes:</p> |
| <pre> |
| <mx:State |
| <b>Properties</b> |
| basedOn="null" |
| name="null" |
| overrides="null" |
| /> |
| </pre> |
| </div><script language="javascript" type="text/javascript"><!-- |
| setMXMLOnly(); |
| --></script><p><span class="classHeaderTableLabel">Default MXML Property</span><code>overrides</code></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="AddChild.html" target="">mx.states.AddChild</a><br/><a href="RemoveChild.html" target="">mx.states.RemoveChild</a><br/><a href="SetEventHandler.html" target="">mx.states.SetEventHandler</a><br/><a href="SetProperty.html" target="">mx.states.SetProperty</a><br/><a href="SetStyle.html" target="">mx.states.SetStyle</a><br/><a href="Transition.html" target="">mx.states.Transition</a></div><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProperty"><tr><th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#basedOn" class="signatureLink">basedOn</a> : String<div class="summaryTableDescription"> |
| The name of the view state upon which this view state is based, or |
| null if this view state is not based on a named view state.</div></td><td class="summaryTableOwnerCol">State</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#name" class="signatureLink">name</a> : String<div class="summaryTableDescription"> |
| The name of the view state.</div></td><td class="summaryTableOwnerCol">State</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#overrides" class="signatureLink">overrides</a> : Array<div class="summaryTableDescription"> |
| The overrides for this view state, as an Array of objects that implement |
| the IOverride interface.</div></td><td class="summaryTableOwnerCol">State</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#stateGroups" class="signatureLink">stateGroups</a> : Array<div class="summaryTableDescription"> |
| The state groups that this view state belongs to as an array of String.</div></td><td class="summaryTableOwnerCol">State</td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#State()" class="signatureLink">State</a>(properties:Object = null)</div><div class="summaryTableDescription"> |
| Constructor.</div></td><td class="summaryTableOwnerCol">State</td></tr></table></div><a name="eventSummary"></a><div class="summarySection"><div class="summaryTableTitle">Events</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableEvent"><tr><th> </th><th colspan="2">Event</th><th> Summary </th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:enterState" class="signatureLink">enterState</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched after a view state has been entered.</td><td class="summaryTableOwnerCol">State</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:exitState" class="signatureLink">exitState</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched just before a view state is exited.</td><td class="summaryTableOwnerCol">State</td></tr></table></div><script language="javascript" type="text/javascript"><!-- |
| showHideInherited(); |
| --></script><div class="MainContent"><div class="detailSectionHeader">Property Detail</div><a name="propertyDetail"></a><a name="basedOn"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">basedOn</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>public var basedOn:String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The name of the view state upon which this view state is based, or |
| <code>null</code> if this view state is not based on a named view state. |
| If this value is <code>null</code>, the view state is based on a root |
| state that consists of the properties, styles, event handlers, and |
| children that you define for a component without using a State class. |
| </p><p> The default value is <code>null</code>.</p></div><a name="propertyDetail"></a><a name="name"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">name</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var name:String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The name of the view state. |
| State names must be unique for a given component. |
| This property must be set. |
| |
| </p></div><a name="propertyDetail"></a><a name="overrides"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">overrides</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var overrides:Array</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The overrides for this view state, as an Array of objects that implement |
| the IOverride interface. These overrides are applied in order when the |
| state is entered, and removed in reverse order when the state is exited. |
| <p>The following Flex classes implement the IOverride interface and let you |
| define the view state characteristics:</p> |
| <ul> |
| <li>AddChild</li> |
| <li>RemoveChild</li> |
| <li>SetEventHandler</li> |
| <li>SetProperty</li> |
| <li>SetStyle</li> |
| </ul> |
| <p>The <code>overrides</code> property is the default property of the |
| State class. You can omit the <code><mx:overrides></code> tag |
| and its child <code><mx:Array></code>tag if you use MXML tag |
| syntax to define the overrides.</p> |
| |
| </p></div><a name="propertyDetail"></a><a name="stateGroups"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">stateGroups</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var stateGroups:Array</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The state groups that this view state belongs to as an array of String. |
| |
| </p></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="State()"></a><a name="State(Object)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">State</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function State(properties:Object = null)</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p> |
| Constructor. |
| </p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">properties</span>:Object</code> (default = <code>null</code>)<code></code> — Object containing property settings for this State. |
| |
| </td></tr></table></div><div class="detailSectionHeader"> Event Detail </div><a name="event:enterState"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">enterState</td><td class="detailHeaderType"> Event </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/FlexEvent.html"><code>mx.events.FlexEvent</code></a><br/><span class="label">FlexEvent.type property = </span><a href="../../mx/events/FlexEvent.html#ENTER_STATE"><code>mx.events.FlexEvent.ENTER_STATE</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched after a view state has been entered. |
| </p> |
| The <code>FlexEvent.ENTER_STATE</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>enterState</code> event. |
| <p>This event will only be dispatched when there are one or more relevant listeners |
| attached to the dispatching object.</p> |
| |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:exitState"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">exitState</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/FlexEvent.html"><code>mx.events.FlexEvent</code></a><br/><span class="label">FlexEvent.type property = </span><a href="../../mx/events/FlexEvent.html#EXIT_STATE"><code>mx.events.FlexEvent.EXIT_STATE</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched just before a view state is exited. |
| This event is dispatched before the changes |
| to the default view state have been removed. |
| </p> |
| The <code>FlexEvent.EXIT_STATE</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>exitState</code> event. |
| <p>This event will only be dispatched when there are one or more relevant listeners |
| attached to the dispatching object.</p> |
| |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><br/><br/><hr><br/><p></p><center class="copyright"><footer>The Apache Software Foundation</footer><br/>Wed Nov 15 2017, 09:50 AM +01:00 </center></div></body></html><!--The Apache Software Foundation<br/>Wed Nov 15 2017, 09:50 AM +01:00 --> |
