blob: 70ba5bda952c71ad70e15d06bb1976c46326099b [file] [log] [blame]
<!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="CloseEvent,mx.events.CloseEvent,ACTION_SCRIPT,ACTIVATE_FOCUS_REQUEST,ACTIVATE_POP_UP_REQUEST,ADD,ADD,ADD_EVENT_LISTENER_REQUEST,ADD_FOCUS_MANAGER,ADD_POP_UP_PLACE_HOLDER_REQUEST,ADD_POP_UP_REQUEST,APPLICATION_ACTIVATE,APPLICATION_COMPLETE,APPLICATION_DEACTIVATE,APPLICATION_URL_CHANGE,AT_BOTTOM,AT_LEFT,AT_RIGHT,AT_TOP,BACKWARD,BACK_KEY_PRESSED,BOTTOM,BRIDGE_AIR_WINDOW_ACTIVATE,BRIDGE_AIR_WINDOW_DEACTIVATE,BRIDGE_APPLICATION_ACTIVATE,BRIDGE_APPLICATION_UNLOADING,BRIDGE_FOCUS_MANAGER_ACTIVATE,BRIDGE_NEW_APPLICATION,BRIDGE_WINDOW_ACTIVATE,BRIDGE_WINDOW_DEACTIVATE,BROWSER_URL_CHANGE,BUFFERING,BUTTON_DOWN,CANCELLED,CANCELLED,CANCELLED,CAN_ACTIVATE_POP_UP_REQUEST,CHANGE,CHANGE,CHANGE,CHANGE,CHANGE,CHANGE,CHANGE,CHANGE_END,CHANGE_START,CHANGING,CHILD_ADD,CHILD_INDEX_CHANGE,CHILD_REMOVE,CLICK_SOMEWHERE,CLOSE,CLOSE,CLOSE,COLLECTION_CHANGE,COLUMN_STRETCH,COLUMN_STRETCH,COMPLETE,COMPLETE,COMPLETE,CONNECTION_ERROR,CONTENT_CREATION_COMPLETE,CREATE_MODAL_WINDOW_REQUEST,CREATION_COMPLETE,CUBE_COMPLETE,CUBE_PROGRESS,CUE_POINT,CUE_POINT,CURRENT_STATE_CHANGE,CURRENT_STATE_CHANGING,CURSOR_MANAGER_REQUEST,CURSOR_UPDATE,DATA_CHANGE,DEACTIVATE_FOCUS_REQUEST,DEACTIVATE_POP_UP_REQUEST,DELETE,DIRECTORY_CHANGE,DIRECTORY_CHANGING,DIRECTORY_CLOSING,DIRECTORY_OPENING,DISCONNECTED,DISPATCH_DRAG_EVENT,DISPLAY_LIST,DIVIDER_DRAG,DIVIDER_PRESS,DIVIDER_RELEASE,DOUBLE_CLICK_SOMEWHERE,DRAG_COMPLETE,DRAG_DROP,DRAG_ENTER,DRAG_EXIT,DRAG_MANAGER_REQUEST,DRAG_OVER,DRAG_START,EFFECT_END,EFFECT_REPEAT,EFFECT_START,EFFECT_STOP,EFFECT_UPDATE,ENTER,ENTER,ENTER_FRAME,ENTER_STATE,ERROR,ERROR,ERROR,EXEC_QUEUED_CMD,EXIT_STATE,FILE_CHOOSE,FLEX_WINDOW_ACTIVATE,FLEX_WINDOW_DEACTIVATE,FORWARD,GET_PARENT_FLEX_MODULE_FACTORY_REQUEST,GET_SIZE_REQUEST,GET_VISIBLE_RECT_REQUEST,HEADER_DRAG_OUTSIDE,HEADER_DROP_OUTSIDE,HEADER_RELEASE,HEADER_RELEASE,HEADER_SHIFT,HIDE,HIDE_MODAL_WINDOW_REQUEST,HIDE_MOUSE_CURSOR_REQUEST,HORIZONTAL,IDLE,INITIALIZE,INIT_COMPLETE,INIT_MANAGER_REQUEST,INIT_PROGRESS,INVALID,INVALID,INVALIDATE_REQUEST,IS_BRIDGE_CHILD_REQUEST,ITEM_CLICK,ITEM_CLICK,ITEM_CLICK,ITEM_CLICK,ITEM_CLOSE,ITEM_CLOSE,ITEM_DOUBLE_CLICK,ITEM_EDITOR_CREATE,ITEM_EDIT_BEGIN,ITEM_EDIT_BEGIN,ITEM_EDIT_BEGIN,ITEM_EDIT_BEGINNING,ITEM_EDIT_BEGINNING,ITEM_EDIT_BEGINNING,ITEM_EDIT_END,ITEM_EDIT_END,ITEM_EDIT_END,ITEM_FOCUS_IN,ITEM_FOCUS_IN,ITEM_FOCUS_IN,ITEM_FOCUS_OUT,ITEM_FOCUS_OUT,ITEM_FOCUS_OUT,ITEM_OPEN,ITEM_OPEN,ITEM_OPENING,ITEM_OPENING,ITEM_ROLL_OUT,ITEM_ROLL_OUT,ITEM_ROLL_OUT,ITEM_ROLL_OVER,ITEM_ROLL_OVER,ITEM_ROLL_OVER,LINE_DOWN,LINE_LEFT,LINE_RIGHT,LINE_UP,LOADING,LOADING,MENU_HIDE,MENU_KEY_PRESSED,MENU_SHOW,MENU_SHOW,METADATA_RECEIVED,MOUSE_DOWN_OUTSIDE,MOUSE_DOWN_SOMEWHERE,MOUSE_MOVE_SOMEWHERE,MOUSE_UP_SOMEWHERE,MOUSE_WHEEL_CHANGING,MOUSE_WHEEL_OUTSIDE,MOUSE_WHEEL_SOMEWHERE,MOVE,MOVE,MOVE_FOCUS_REQUEST,MUTED_CHANGE,NAVIGATOR_STATE_LOADING,NAVIGATOR_STATE_SAVING,NEW_COLUMN,NEW_COLUMN,NEW_ROW,NEW_ROW,NEW_ROW,NEXT_MONTH,NEXT_YEAR,OPEN,OTHER,OTHER,OTHER,OVERLAY_CREATED,PAGE_DOWN,PAGE_LEFT,PAGE_RIGHT,PAGE_UP,PAUSED,PLAYHEAD_UPDATE,PLAYING,PREINITIALIZE,PREVIOUS_MONTH,PREVIOUS_YEAR,PROGRESS,PROGRESS,PROGRESS,PROPERTIES,PROPERTY_CHANGE,QUERY_PROGRESS,READY,READY,READY,REFRESH,REMOVE,REMOVE,REMOVE_EVENT_LISTENER_REQUEST,REMOVE_POP_UP_PLACE_HOLDER_REQUEST,REMOVE_POP_UP_REQUEST,RENDER,REPEAT,REPEAT_END,REPEAT_START,REPLACE,RESET,RESET_MOUSE_CURSOR_REQUEST,RESIZE,RESIZING,REWIND,REWINDING,RSL_ADD_PRELOADED,RSL_COMPLETE,RSL_ERROR,RSL_PROGRESS,SCROLL,SCROLL,SCROLL,SEEKING,SELECTION_CHANGE,SETUP,SET_ACTUAL_SIZE_REQUEST,SET_SHOW_FOCUS_INDICATOR_REQUEST,SHOW,SHOW_MODAL_WINDOW_REQUEST,SHOW_MOUSE_CURSOR_REQUEST,SIZE,SORT,STATE_CHANGE,STATE_CHANGE_COMPLETE,STATE_CHANGE_INTERRUPTED,STOPPED,SYSTEM_MANAGER_REQUEST,THUMB,THUMB_DRAG,THUMB_POSITION,THUMB_PRESS,THUMB_RELEASE,THUMB_TRACK,TOOLTIP_MANAGER_REQUEST,TOOL_TIP_CREATE,TOOL_TIP_END,TOOL_TIP_HIDE,TOOL_TIP_SHOW,TOOL_TIP_SHOWN,TOOL_TIP_START,TOP,TOUCH_INTERACTION_END,TOUCH_INTERACTION_START,TOUCH_INTERACTION_STARTING,TRACK,TRANSFORM_CHANGE,TRANSITION_END,TRANSITION_START,TWEEN_END,TWEEN_START,TWEEN_UPDATE,UNLOAD,UPDATE,UPDATE,UPDATE_COMPLETE,URL_CHANGE,URL_CHANGED,VALID,VALID,VALUE_COMMIT,VERTICAL,WINDOW_ACTIVATE,WINDOW_COMPLETE,WINDOW_DEACTIVATE,WINDOW_MOVE,WINDOW_RESIZE,action,altKey,animate,animate,buttonDown,clickTarget,color,column,columnIndex,columnIndex,columnIndex,ctrlKey,cuePointName,cuePointTime,cuePointType,data,data,dataField,dataField,delta,delta,detail,detail,detail,direction,dispatchEvent,dispatchEvent,dividerIndex,dragEventType,dragInitiator,dragSource,draggedItem,dropTarget,effectInstance,errorText,errorText,errorText,errorText,eventType,field,file,headerPart,index,index,index,index,info,isResourceModule,item,item,item,item,item,itemRenderer,itemRenderer,itemRenderer,itemRenderer,items,keyCode,kind,kind,label,label,label,lastURL,listener,loaderInfo,localX,localX,location,menu,menuBar,message,message,module,multiColumnSort,name,nativeMenu,nativeMenuItem,newDate,newIndex,newState,newValue,oldHeight,oldIndex,oldLocation,oldState,oldValue,oldWidth,oldX,oldY,opening,opening,playheadTime,position,priority,progress,property,reason,reason,reason,reason,relatedObject,relatedObject,relatedObject,relatedObject,removeColumnFromSort,requestor,results,rowIndex,rowIndex,rowIndex,rslIndex,rslTotal,shiftKey,source,state,stateResponsive,thumbIndex,toolTip,total,triggerEvent,triggerEvent,triggerEvent,triggerEvent,triggerEvent,triggerEvent,triggerEvent,triggerEvent,url,url,useCapture,useWeakReference,value,value,value,value,value"><title>mx.events.CloseEvent</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 = 'CloseEvent - 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>&nbsp;|&nbsp;<a href="../../class-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Classes</a>&nbsp;|&nbsp;<a href="../../all-index-A.html" onclick="loadClassListFrame('../../index-list.html')">Index</a>&nbsp;|&nbsp;<a id="framesLink1" href="../../index.html?mx/events/CloseEvent.html&amp;mx/events/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">CloseEvent</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a>&nbsp;| <a href="#constantSummary">Constants</a></td></tr><tr class="titleTableRow3"><td colspan="3">&nbsp;</td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("CloseEvent"); titleBar_setSubNav(true,true,false,false,false,false,false,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.events</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class CloseEvent</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">CloseEvent <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> flash.events.Event</td></tr></table><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p></p><p></p>
The CloseEvent class represents event objects specific to popup windows,
such as the Alert control.
<p></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="../../mx/controls/Alert.html" target="">mx.controls.Alert</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>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#detail" class="signatureLink">detail</a> : int<div class="summaryTableDescription">
Identifies the button in the popped up control that was clicked.</div></td><td class="summaryTableOwnerCol">CloseEvent</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>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#CloseEvent()" class="signatureLink">CloseEvent</a>(type:String, bubbles:Boolean = false, cancelable:Boolean = false, detail:int = -1)</div><div class="summaryTableDescription">
Constructor.</div></td><td class="summaryTableOwnerCol">CloseEvent</td></tr></table></div><a name="constantSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Constants</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableConstant"><tr><th>&nbsp;</th><th colspan="2">Constant</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#CLOSE" class="signatureLink">CLOSE</a> : String = close<div class="summaryTableDescription">[static]
The CloseEvent.CLOSE constant defines the value of the
type property of the event object for a close event.</div></td><td class="summaryTableOwnerCol">CloseEvent</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="detail"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">detail</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>public var detail:int</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
Identifies the button in the popped up control that was clicked. This
property is for controls with multiple buttons.
The Alert control sets this property to one of the following constants:
<ul>
<li><code>Alert.YES</code></li>
<li><code>Alert.NO</code></li>
<li><code>Alert.OK</code></li>
<li><code>Alert.CANCEL</code></li>
</ul>
</p></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="CloseEvent()"></a><a name="CloseEvent(String,Boolean,Boolean,int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">CloseEvent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function CloseEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, detail:int = -1)</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</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 :&nbsp;</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">type</span>:String</code> &mdash; The event type; indicates the action that caused the event.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">bubbles</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; Specifies whether the event can bubble up the display list hierarchy.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">cancelable</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; Specifies whether the behavior associated with the event can be prevented.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">detail</span>:int</code> (default = <code>-1</code>)<code></code> &mdash; Value of the detail property; identifies the button in the popped up
control that was clicked.
</td></tr></table></div><div class="detailSectionHeader">Constant Detail</div><a name="constantDetail"></a><a name="CLOSE"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">CLOSE</td><td class="detailHeaderType">Constant</td></tr></table><div class="detailBody"><code>public static const CLOSE:String = close</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
The <code>CloseEvent.CLOSE</code> constant defines the value of the
<code>type</code> property of the event object for a <code>close</code> event.
<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>detail</code></td><td>For controls with multiple buttons,
<code>detail</code> identifies the button in the popped up control
that was clicked.</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>
</p></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 -->