1523 lines
90 KiB
HTML
1523 lines
90 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>Event | openfl</title>
|
|
<meta name="description" content="">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<div class="tsd-page-toolbar">
|
|
<div class="container">
|
|
<div class="table-wrap">
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</div>
|
|
<ul class="results">
|
|
<li class="state loading">Preparing search index...</li>
|
|
<li class="state failure">The search index is not available</li>
|
|
</ul>
|
|
<a href="../index.html" class="title">openfl</a>
|
|
</div>
|
|
<div class="table-cell" id="tsd-widgets">
|
|
<div id="tsd-filter">
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
<div class="tsd-filter-group">
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
<span class="tsd-select-label">All</span>
|
|
<ul class="tsd-select-list">
|
|
<li data-value="public">Public</li>
|
|
<li data-value="protected">Public/Protected</li>
|
|
<li data-value="private" class="selected">All</li>
|
|
</ul>
|
|
</div>
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
<input type="checkbox" id="tsd-filter-only-exported" />
|
|
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
|
</div>
|
|
</div>
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-page-title">
|
|
<div class="container">
|
|
<ul class="tsd-breadcrumb">
|
|
<li>
|
|
<a href="../index.html">openfl</a>
|
|
</li>
|
|
<li>
|
|
<a href="../modules/openfl.events.html">events</a>
|
|
</li>
|
|
<li>
|
|
<a href="openfl.events.event.html">Event</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class Event</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The Event class is used as the base class for the creation of Event
|
|
objects, which are passed as parameters to event listeners when an event
|
|
occurs.</p>
|
|
</div>
|
|
<p>The properties of the Event class carry basic information about an
|
|
event, such as the event's type or whether the event's default behavior can
|
|
be canceled. For many events, such as the events represented by the Event
|
|
class constants, this basic information is sufficient. Other events,
|
|
however, may require more detailed information. Events associated with a
|
|
mouse click, for example, need to include additional information about the
|
|
location of the click event and whether any keys were pressed during the
|
|
click event. You can pass such additional information to event listeners by
|
|
extending the Event class, which is what the MouseEvent class does.
|
|
ActionScript 3.0 API defines several Event subclasses for common events
|
|
that require additional information. Events associated with each of the
|
|
Event subclasses are described in the documentation for each class.</p>
|
|
<p>The methods of the Event class can be used in event listener functions
|
|
to affect the behavior of the event object. Some events have an associated
|
|
default behavior. For example, the <code>doubleClick</code> event has an
|
|
associated default behavior that highlights the word under the mouse
|
|
pointer at the time of the event. Your event listener can cancel this
|
|
behavior by calling the <code>preventDefault()</code> method. You can also
|
|
make the current event listener the last one to process an event by calling
|
|
the <code>stopPropagation()</code> or
|
|
<code>stopImmediatePropagation()</code> method.</p>
|
|
<p>Other sources of information include:</p>
|
|
<ul>
|
|
<li>A useful description about the timing of events, code execution, and
|
|
rendering at runtime in Ted Patrick's blog entry: <a
|
|
<a href="http://www.onflex.org/ted/2005/07/flash-player-mental-model-elastic.php">Flash Player Mental Model - The Elastic</a>.</li>
|
|
<li>A blog entry by Johannes Tacskovics about the timing of frame events,
|
|
such as ENTER_FRAME, EXIT_FRAME: <a href="http://blog.johannest.com/2009/06/15/the-movieclip-life-cycle-revisited-from-event-added-to-event-removed_from_stage/">The MovieClip Lifecycle</a>.</li>
|
|
<li>An article by Trevor McCauley about the order of ActionScript
|
|
operations: <a href="http://www.senocular.com/flash/tutorials/orderofoperations/">Order of Operations in ActionScript</a>.</li>
|
|
<li>A blog entry by Matt Przybylski on creating custom events:
|
|
<a href="http://evolve.reintroducing.com/2007/10/23/as3/as3-custom-events/">AS3: Custom Events</a>.</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">Event</span>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<a href="openfl.events.accelerometerevent.html" class="tsd-signature-type">AccelerometerEvent</a>
|
|
</li>
|
|
<li>
|
|
<a href="openfl.events.activityevent.html" class="tsd-signature-type">ActivityEvent</a>
|
|
</li>
|
|
<li>
|
|
<a href="openfl.events.textevent.html" class="tsd-signature-type">TextEvent</a>
|
|
</li>
|
|
<li>
|
|
<a href="openfl.events.focusevent.html" class="tsd-signature-type">FocusEvent</a>
|
|
</li>
|
|
<li>
|
|
<a href="openfl.events.gameinputevent.html" class="tsd-signature-type">GameInputEvent</a>
|
|
</li>
|
|
<li>
|
|
<a href="openfl.events.httpstatusevent.html" class="tsd-signature-type">HTTPStatusEvent</a>
|
|
</li>
|
|
<li>
|
|
<a href="openfl.events.keyboardevent.html" class="tsd-signature-type">KeyboardEvent</a>
|
|
</li>
|
|
<li>
|
|
<a href="openfl.events.mouseevent.html" class="tsd-signature-type">MouseEvent</a>
|
|
</li>
|
|
<li>
|
|
<a href="openfl.events.netstatusevent.html" class="tsd-signature-type">NetStatusEvent</a>
|
|
</li>
|
|
<li>
|
|
<a href="openfl.events.progressevent.html" class="tsd-signature-type">ProgressEvent</a>
|
|
</li>
|
|
<li>
|
|
<a href="openfl.events.sampledataevent.html" class="tsd-signature-type">SampleDataEvent</a>
|
|
</li>
|
|
<li>
|
|
<a href="openfl.events.timerevent.html" class="tsd-signature-type">TimerEvent</a>
|
|
</li>
|
|
<li>
|
|
<a href="openfl.events.touchevent.html" class="tsd-signature-type">TouchEvent</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<h2>Index</h2>
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section tsd-is-external">
|
|
<h3>Constructors</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><a href="openfl.events.event.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section tsd-is-external">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.events.event.html#bubbles" class="tsd-kind-icon">bubbles</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.events.event.html#cancelable" class="tsd-kind-icon">cancelable</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.events.event.html#currenttarget" class="tsd-kind-icon">current<wbr>Target</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.events.event.html#eventphase" class="tsd-kind-icon">event<wbr>Phase</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.events.event.html#target" class="tsd-kind-icon">target</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.events.event.html#type" class="tsd-kind-icon">type</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#activate" class="tsd-kind-icon">ACTIVATE</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#added" class="tsd-kind-icon">ADDED</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#added_to_stage" class="tsd-kind-icon">ADDED_<wbr>TO_<wbr>STAGE</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#cancel" class="tsd-kind-icon">CANCEL</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#change" class="tsd-kind-icon">CHANGE</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#clear" class="tsd-kind-icon">CLEAR</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#close" class="tsd-kind-icon">CLOSE</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#complete" class="tsd-kind-icon">COMPLETE</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#connect" class="tsd-kind-icon">CONNECT</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#context3d_create" class="tsd-kind-icon">CONTEXT3<wbr>D_<wbr>CREATE</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#copy" class="tsd-kind-icon">COPY</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#cut" class="tsd-kind-icon">CUT</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#deactivate" class="tsd-kind-icon">DEACTIVATE</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#enter_frame" class="tsd-kind-icon">ENTER_<wbr>FRAME</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#exit_frame" class="tsd-kind-icon">EXIT_<wbr>FRAME</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#frame_constructed" class="tsd-kind-icon">FRAME_<wbr>CONSTRUCTED</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#frame_label" class="tsd-kind-icon">FRAME_<wbr>LABEL</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#fullscreen" class="tsd-kind-icon">FULLSCREEN</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#id3" class="tsd-kind-icon">ID3</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#init" class="tsd-kind-icon">INIT</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#mouse_leave" class="tsd-kind-icon">MOUSE_<wbr>LEAVE</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#open" class="tsd-kind-icon">OPEN</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#paste" class="tsd-kind-icon">PASTE</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#removed" class="tsd-kind-icon">REMOVED</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#removed_from_stage" class="tsd-kind-icon">REMOVED_<wbr>FROM_<wbr>STAGE</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#render" class="tsd-kind-icon">RENDER</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#resize" class="tsd-kind-icon">RESIZE</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#scroll" class="tsd-kind-icon">SCROLL</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#select" class="tsd-kind-icon">SELECT</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#select_all" class="tsd-kind-icon">SELECT_<wbr>ALL</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#sound_complete" class="tsd-kind-icon">SOUND_<wbr>COMPLETE</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#tab_children_change" class="tsd-kind-icon">TAB_<wbr>CHILDREN_<wbr>CHANGE</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#tab_enabled_change" class="tsd-kind-icon">TAB_<wbr>ENABLED_<wbr>CHANGE</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#tab_index_change" class="tsd-kind-icon">TAB_<wbr>INDEX_<wbr>CHANGE</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#texture_ready" class="tsd-kind-icon">TEXTURE_<wbr>READY</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.events.event.html#unload" class="tsd-kind-icon">UNLOAD</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section tsd-is-external">
|
|
<h3>Methods</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.events.event.html#clone" class="tsd-kind-icon">clone</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.events.event.html#formattostring" class="tsd-kind-icon">format<wbr>ToString</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.events.event.html#isdefaultprevented" class="tsd-kind-icon">is<wbr>Default<wbr>Prevented</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.events.event.html#preventdefault" class="tsd-kind-icon">prevent<wbr>Default</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.events.event.html#stopimmediatepropagation" class="tsd-kind-icon">stop<wbr>Immediate<wbr>Propagation</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.events.event.html#stoppropagation" class="tsd-kind-icon">stop<wbr>Propagation</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.events.event.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-external">
|
|
<h2>Constructors</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|
<h3>constructor</h3>
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Event<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, bubbles<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, cancelable<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="openfl.events.event.html" class="tsd-signature-type">Event</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L384">lib/openfl/events/Event.d.ts:384</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Creates an Event object to pass as a parameter to event listeners.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>type: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The type of the event, accessible as
|
|
<code>Event.type</code>.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> bubbles: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Determines whether the Event object participates in the
|
|
bubbling stage of the event flow. The default value is
|
|
<code>false</code>.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> cancelable: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Determines whether the Event object can be canceled. The
|
|
default values is <code>false</code>.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="openfl.events.event.html" class="tsd-signature-type">Event</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-external">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="bubbles" class="tsd-anchor"></a>
|
|
<h3>bubbles</h3>
|
|
<div class="tsd-signature tsd-kind-icon">bubbles<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L346">lib/openfl/events/Event.d.ts:346</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Indicates whether an event is a bubbling event. If the event can bubble,
|
|
this value is <code>true</code>; otherwise it is <code>false</code>.</p>
|
|
</div>
|
|
<p>When an event occurs, it moves through the three phases of the event
|
|
flow: the capture phase, which flows from the top of the display list
|
|
hierarchy to the node just before the target node; the target phase, which
|
|
comprises the target node; and the bubbling phase, which flows from the
|
|
node subsequent to the target node back up the display list hierarchy.</p>
|
|
<p>Some events, such as the <code>activate</code> and <code>unload</code>
|
|
events, do not have a bubbling phase. The <code>bubbles</code> property
|
|
has a value of <code>false</code> for events that do not have a bubbling
|
|
phase.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="cancelable" class="tsd-anchor"></a>
|
|
<h3>cancelable</h3>
|
|
<div class="tsd-signature tsd-kind-icon">cancelable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L353">lib/openfl/events/Event.d.ts:353</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Indicates whether the behavior associated with the event can be prevented.
|
|
If the behavior can be canceled, this value is <code>true</code>;
|
|
otherwise it is <code>false</code>.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="currenttarget" class="tsd-anchor"></a>
|
|
<h3>current<wbr>Target</h3>
|
|
<div class="tsd-signature tsd-kind-icon">current<wbr>Target<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L361">lib/openfl/events/Event.d.ts:361</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The object that is actively processing the Event object with an event
|
|
listener. For example, if a user clicks an OK button, the current target
|
|
could be the node containing that button or one of its ancestors that has
|
|
registered an event listener for that event.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="eventphase" class="tsd-anchor"></a>
|
|
<h3>event<wbr>Phase</h3>
|
|
<div class="tsd-signature tsd-kind-icon">event<wbr>Phase<span class="tsd-signature-symbol">:</span> <a href="../enums/openfl.events.eventphase.html" class="tsd-signature-type">EventPhase</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L372">lib/openfl/events/Event.d.ts:372</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The current phase in the event flow. This property can contain the
|
|
following numeric values:</p>
|
|
</div>
|
|
<ul>
|
|
<li>The capture phase(<code>EventPhase.CAPTURING_PHASE</code>).</li>
|
|
<li>The target phase(<code>EventPhase.AT_TARGET</code>).</li>
|
|
<li>The bubbling phase(<code>EventPhase.BUBBLING_PHASE</code>).</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="target" class="tsd-anchor"></a>
|
|
<h3>target</h3>
|
|
<div class="tsd-signature tsd-kind-icon">target<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L379">lib/openfl/events/Event.d.ts:379</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The event target. This property contains the target node. For example, if
|
|
a user clicks an OK button, the target node is the display list node
|
|
containing that button.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="type" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L384">lib/openfl/events/Event.d.ts:384</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The type of event. The type is case-sensitive.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="activate" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> ACTIVATE</h3>
|
|
<div class="tsd-signature tsd-kind-icon">ACTIVATE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L64">lib/openfl/events/Event.d.ts:64</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The <code>ACTIVATE</code> constant defines the value of the
|
|
<code>type</code> property of an <code>activate</code> event object.</p>
|
|
</div>
|
|
<p><strong>Note:</strong> This event has neither a "capture phase" nor a "bubble
|
|
phase", which means that event listeners must be added directly to any
|
|
potential targets, whether the target is on the display list or not.</p>
|
|
<p>AIR for TV devices never automatically dispatch this event. You can,
|
|
however, dispatch it manually.</p>
|
|
<p>This event has the following properties:</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="added" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> ADDED</h3>
|
|
<div class="tsd-signature tsd-kind-icon">ADDED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L72">lib/openfl/events/Event.d.ts:72</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The <code>Event.ADDED</code> constant defines the value of the
|
|
<code>type</code> property of an <code>added</code> event object.</p>
|
|
</div>
|
|
<p>This event has the following properties:</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="added_to_stage" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> ADDED_<wbr>TO_<wbr>STAGE</h3>
|
|
<div class="tsd-signature tsd-kind-icon">ADDED_<wbr>TO_<wbr>STAGE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L80">lib/openfl/events/Event.d.ts:80</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The <code>Event.ADDED_TO_STAGE</code> constant defines the value of the
|
|
<code>type</code> property of an <code>addedToStage</code> event object.</p>
|
|
</div>
|
|
<p>This event has the following properties:</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="cancel" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> CANCEL</h3>
|
|
<div class="tsd-signature tsd-kind-icon">CANCEL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L92">lib/openfl/events/Event.d.ts:92</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The <code>Event.CANCEL</code> constant defines the value of the
|
|
<code>type</code> property of a <code>cancel</code> event object.</p>
|
|
</div>
|
|
<p>This event has the following properties:</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="change" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> CHANGE</h3>
|
|
<div class="tsd-signature tsd-kind-icon">CHANGE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L100">lib/openfl/events/Event.d.ts:100</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The <code>Event.CHANGE</code> constant defines the value of the
|
|
<code>type</code> property of a <code>change</code> event object.</p>
|
|
</div>
|
|
<p>This event has the following properties:</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="clear" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> CLEAR</h3>
|
|
<div class="tsd-signature tsd-kind-icon">CLEAR<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L110">lib/openfl/events/Event.d.ts:110</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="close" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> CLOSE</h3>
|
|
<div class="tsd-signature tsd-kind-icon">CLOSE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L118">lib/openfl/events/Event.d.ts:118</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The <code>Event.CLOSE</code> constant defines the value of the
|
|
<code>type</code> property of a <code>close</code> event object.</p>
|
|
</div>
|
|
<p>This event has the following properties:</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="complete" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> COMPLETE</h3>
|
|
<div class="tsd-signature tsd-kind-icon">COMPLETE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L126">lib/openfl/events/Event.d.ts:126</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The <code>Event.COMPLETE</code> constant defines the value of the
|
|
<code>type</code> property of a <code>complete</code> event object.</p>
|
|
</div>
|
|
<p>This event has the following properties:</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="connect" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> CONNECT</h3>
|
|
<div class="tsd-signature tsd-kind-icon">CONNECT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L134">lib/openfl/events/Event.d.ts:134</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The <code>Event.CONNECT</code> constant defines the value of the
|
|
<code>type</code> property of a <code>connect</code> event object.</p>
|
|
</div>
|
|
<p>This event has the following properties:</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="context3d_create" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> CONTEXT3<wbr>D_<wbr>CREATE</h3>
|
|
<div class="tsd-signature tsd-kind-icon">CONTEXT3<wbr>D_<wbr>CREATE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L136">lib/openfl/events/Event.d.ts:136</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="copy" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> COPY</h3>
|
|
<div class="tsd-signature tsd-kind-icon">COPY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L138">lib/openfl/events/Event.d.ts:138</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="cut" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> CUT</h3>
|
|
<div class="tsd-signature tsd-kind-icon">CUT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L140">lib/openfl/events/Event.d.ts:140</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="deactivate" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> DEACTIVATE</h3>
|
|
<div class="tsd-signature tsd-kind-icon">DEACTIVATE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L155">lib/openfl/events/Event.d.ts:155</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The <code>Event.DEACTIVATE</code> constant defines the value of the
|
|
<code>type</code> property of a <code>deactivate</code> event object.</p>
|
|
</div>
|
|
<p><strong>Note:</strong> This event has neither a "capture phase" nor a "bubble
|
|
phase", which means that event listeners must be added directly to any
|
|
potential targets, whether the target is on the display list or not.</p>
|
|
<p>AIR for TV devices never automatically dispatch this event. You can,
|
|
however, dispatch it manually.</p>
|
|
<p>This event has the following properties:</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="enter_frame" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> ENTER_<wbr>FRAME</h3>
|
|
<div class="tsd-signature tsd-kind-icon">ENTER_<wbr>FRAME<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L167">lib/openfl/events/Event.d.ts:167</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The <code>Event.ENTER_FRAME</code> constant defines the value of the
|
|
<code>type</code> property of an <code>enterFrame</code> event object.</p>
|
|
</div>
|
|
<p><strong>Note:</strong> This event has neither a "capture phase" nor a "bubble
|
|
phase", which means that event listeners must be added directly to any
|
|
potential targets, whether the target is on the display list or not.</p>
|
|
<p>This event has the following properties:</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="exit_frame" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> EXIT_<wbr>FRAME</h3>
|
|
<div class="tsd-signature tsd-kind-icon">EXIT_<wbr>FRAME<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L173">lib/openfl/events/Event.d.ts:173</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="frame_constructed" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> FRAME_<wbr>CONSTRUCTED</h3>
|
|
<div class="tsd-signature tsd-kind-icon">FRAME_<wbr>CONSTRUCTED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L175">lib/openfl/events/Event.d.ts:175</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="frame_label" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> FRAME_<wbr>LABEL</h3>
|
|
<div class="tsd-signature tsd-kind-icon">FRAME_<wbr>LABEL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L177">lib/openfl/events/Event.d.ts:177</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="fullscreen" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> FULLSCREEN</h3>
|
|
<div class="tsd-signature tsd-kind-icon">FULLSCREEN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L179">lib/openfl/events/Event.d.ts:179</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="id3" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> ID3</h3>
|
|
<div class="tsd-signature tsd-kind-icon">ID3<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L187">lib/openfl/events/Event.d.ts:187</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The <code>Event.ID3</code> constant defines the value of the
|
|
<code>type</code> property of an <code>id3</code> event object.</p>
|
|
</div>
|
|
<p>This event has the following properties:</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="init" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> INIT</h3>
|
|
<div class="tsd-signature tsd-kind-icon">INIT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L195">lib/openfl/events/Event.d.ts:195</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The <code>Event.INIT</code> constant defines the value of the
|
|
<code>type</code> property of an <code>init</code> event object.</p>
|
|
</div>
|
|
<p>This event has the following properties:</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="mouse_leave" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> MOUSE_<wbr>LEAVE</h3>
|
|
<div class="tsd-signature tsd-kind-icon">MOUSE_<wbr>LEAVE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L203">lib/openfl/events/Event.d.ts:203</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The <code>Event.MOUSE_LEAVE</code> constant defines the value of the
|
|
<code>type</code> property of a <code>mouseLeave</code> event object.</p>
|
|
</div>
|
|
<p>This event has the following properties:</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="open" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> OPEN</h3>
|
|
<div class="tsd-signature tsd-kind-icon">OPEN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L211">lib/openfl/events/Event.d.ts:211</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The <code>Event.OPEN</code> constant defines the value of the
|
|
<code>type</code> property of an <code>open</code> event object.</p>
|
|
</div>
|
|
<p>This event has the following properties:</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="paste" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> PASTE</h3>
|
|
<div class="tsd-signature tsd-kind-icon">PASTE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L213">lib/openfl/events/Event.d.ts:213</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="removed" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> REMOVED</h3>
|
|
<div class="tsd-signature tsd-kind-icon">REMOVED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L221">lib/openfl/events/Event.d.ts:221</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The <code>Event.REMOVED</code> constant defines the value of the
|
|
<code>type</code> property of a <code>removed</code> event object.</p>
|
|
</div>
|
|
<p>This event has the following properties:</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="removed_from_stage" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> REMOVED_<wbr>FROM_<wbr>STAGE</h3>
|
|
<div class="tsd-signature tsd-kind-icon">REMOVED_<wbr>FROM_<wbr>STAGE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L230">lib/openfl/events/Event.d.ts:230</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The <code>Event.REMOVED_FROM_STAGE</code> constant defines the value of
|
|
the <code>type</code> property of a <code>removedFromStage</code> event
|
|
object.</p>
|
|
</div>
|
|
<p>This event has the following properties:</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="render" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> RENDER</h3>
|
|
<div class="tsd-signature tsd-kind-icon">RENDER<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L242">lib/openfl/events/Event.d.ts:242</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The <code>Event.RENDER</code> constant defines the value of the
|
|
<code>type</code> property of a <code>render</code> event object.</p>
|
|
</div>
|
|
<p><strong>Note:</strong> This event has neither a "capture phase" nor a "bubble
|
|
phase", which means that event listeners must be added directly to any
|
|
potential targets, whether the target is on the display list or not.</p>
|
|
<p>This event has the following properties:</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="resize" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> RESIZE</h3>
|
|
<div class="tsd-signature tsd-kind-icon">RESIZE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L250">lib/openfl/events/Event.d.ts:250</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The <code>Event.RESIZE</code> constant defines the value of the
|
|
<code>type</code> property of a <code>resize</code> event object.</p>
|
|
</div>
|
|
<p>This event has the following properties:</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="scroll" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> SCROLL</h3>
|
|
<div class="tsd-signature tsd-kind-icon">SCROLL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L258">lib/openfl/events/Event.d.ts:258</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The <code>Event.SCROLL</code> constant defines the value of the
|
|
<code>type</code> property of a <code>scroll</code> event object.</p>
|
|
</div>
|
|
<p>This event has the following properties:</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="select" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> SELECT</h3>
|
|
<div class="tsd-signature tsd-kind-icon">SELECT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L266">lib/openfl/events/Event.d.ts:266</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The <code>Event.SELECT</code> constant defines the value of the
|
|
<code>type</code> property of a <code>select</code> event object.</p>
|
|
</div>
|
|
<p>This event has the following properties:</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="select_all" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> SELECT_<wbr>ALL</h3>
|
|
<div class="tsd-signature tsd-kind-icon">SELECT_<wbr>ALL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L268">lib/openfl/events/Event.d.ts:268</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="sound_complete" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> SOUND_<wbr>COMPLETE</h3>
|
|
<div class="tsd-signature tsd-kind-icon">SOUND_<wbr>COMPLETE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L276">lib/openfl/events/Event.d.ts:276</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The <code>Event.SOUND_COMPLETE</code> constant defines the value of the
|
|
<code>type</code> property of a <code>soundComplete</code> event object.</p>
|
|
</div>
|
|
<p>This event has the following properties:</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="tab_children_change" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> TAB_<wbr>CHILDREN_<wbr>CHANGE</h3>
|
|
<div class="tsd-signature tsd-kind-icon">TAB_<wbr>CHILDREN_<wbr>CHANGE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L289">lib/openfl/events/Event.d.ts:289</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The <code>Event.TAB_CHILDREN_CHANGE</code> constant defines the value of
|
|
the <code>type</code> property of a <code>tabChildrenChange</code> event
|
|
object.</p>
|
|
</div>
|
|
<p>This event has the following properties:</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="tab_enabled_change" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> TAB_<wbr>ENABLED_<wbr>CHANGE</h3>
|
|
<div class="tsd-signature tsd-kind-icon">TAB_<wbr>ENABLED_<wbr>CHANGE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L298">lib/openfl/events/Event.d.ts:298</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The <code>Event.TAB_ENABLED_CHANGE</code> constant defines the value of
|
|
the <code>type</code> property of a <code>tabEnabledChange</code> event
|
|
object.</p>
|
|
</div>
|
|
<p>This event has the following properties:</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="tab_index_change" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> TAB_<wbr>INDEX_<wbr>CHANGE</h3>
|
|
<div class="tsd-signature tsd-kind-icon">TAB_<wbr>INDEX_<wbr>CHANGE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L306">lib/openfl/events/Event.d.ts:306</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The <code>Event.TAB_INDEX_CHANGE</code> constant defines the value of the
|
|
<code>type</code> property of a <code>tabIndexChange</code> event object.</p>
|
|
</div>
|
|
<p>This event has the following properties:</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="texture_ready" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> TEXTURE_<wbr>READY</h3>
|
|
<div class="tsd-signature tsd-kind-icon">TEXTURE_<wbr>READY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L308">lib/openfl/events/Event.d.ts:308</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="unload" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> UNLOAD</h3>
|
|
<div class="tsd-signature tsd-kind-icon">UNLOAD<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L320">lib/openfl/events/Event.d.ts:320</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The <code>Event.UNLOAD</code> constant defines the value of the
|
|
<code>type</code> property of an <code>unload</code> event object.</p>
|
|
</div>
|
|
<p>This event has the following properties:</p>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-external">
|
|
<h2>Methods</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="clone" class="tsd-anchor"></a>
|
|
<h3>clone</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">clone<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="openfl.events.event.html" class="tsd-signature-type">Event</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L424">lib/openfl/events/Event.d.ts:424</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Duplicates an instance of an Event subclass.</p>
|
|
</div>
|
|
<p>Returns a new Event object that is a copy of the original instance of
|
|
the Event object. You do not normally call <code>clone()</code>; the
|
|
EventDispatcher class calls it automatically when you redispatch an
|
|
event - that is, when you call <code>dispatchEvent(event)</code> from a
|
|
handler that is handling <code>event</code>.</p>
|
|
<p>The new Event object includes all the properties of the original.</p>
|
|
<p>When creating your own custom Event class, you must override the
|
|
inherited <code>Event.clone()</code> method in order for it to duplicate
|
|
the properties of your custom class. If you do not set all the properties
|
|
that you add in your event subclass, those properties will not have the
|
|
correct values when listeners handle the redispatched event.</p>
|
|
<p>In this example, <code>PingEvent</code> is a subclass of
|
|
<code>Event</code> and therefore implements its own version of
|
|
<code>clone()</code>.</p>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <a href="openfl.events.event.html" class="tsd-signature-type">Event</a></h4>
|
|
<p>A new Event object that is identical to the original.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="formattostring" class="tsd-anchor"></a>
|
|
<h3>format<wbr>ToString</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">format<wbr>ToString<span class="tsd-signature-symbol">(</span>className<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L427">lib/openfl/events/Event.d.ts:427</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>className: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="isdefaultprevented" class="tsd-anchor"></a>
|
|
<h3>is<wbr>Default<wbr>Prevented</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Default<wbr>Prevented<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L438">lib/openfl/events/Event.d.ts:438</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Checks whether the <code>preventDefault()</code> method has been called on
|
|
the event. If the <code>preventDefault()</code> method has been called,
|
|
returns <code>true</code>; otherwise, returns <code>false</code>.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
<p>If <code>preventDefault()</code> has been called, returns
|
|
<code>true</code>; otherwise, returns <code>false</code>.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="preventdefault" class="tsd-anchor"></a>
|
|
<h3>prevent<wbr>Default</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">prevent<wbr>Default<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L447">lib/openfl/events/Event.d.ts:447</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Cancels an event's default behavior if that behavior can be canceled.
|
|
Many events have associated behaviors that are carried out by default. For example, if a user types a character into a text field, the default behavior is that the character is displayed in the text field. Because the <code>TextEvent.TEXT_INPUT</code> event's default behavior can be canceled, you can use the <code>preventDefault()</code> method to prevent the character from appearing.
|
|
An example of a behavior that is not cancelable is the default behavior associated with the Event.REMOVED event, which is generated whenever Flash Player is about to remove a display object from the display list. The default behavior (removing the element) cannot be canceled, so the <code>preventDefault()</code> method has no effect on this default behavior.
|
|
You can use the <code>Event.cancelable</code> property to check whether you can prevent the default behavior associated with a particular event. If the value of <code>Event.cancelable</code> is true, then <code>preventDefault()</code> can be used to cancel the event; otherwise, <code>preventDefault()</code> has no effect.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="stopimmediatepropagation" class="tsd-anchor"></a>
|
|
<h3>stop<wbr>Immediate<wbr>Propagation</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">stop<wbr>Immediate<wbr>Propagation<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L461">lib/openfl/events/Event.d.ts:461</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Prevents processing of any event listeners in the current node and any
|
|
subsequent nodes in the event flow. This method takes effect immediately,
|
|
and it affects event listeners in the current node. In contrast, the
|
|
<code>stopPropagation()</code> method doesn't take effect until all the
|
|
event listeners in the current node finish processing.</p>
|
|
</div>
|
|
<p><strong>Note: </strong> This method does not cancel the behavior associated with
|
|
this event; see <code>preventDefault()</code> for that functionality.</p>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="stoppropagation" class="tsd-anchor"></a>
|
|
<h3>stop<wbr>Propagation</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">stop<wbr>Propagation<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L477">lib/openfl/events/Event.d.ts:477</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Prevents processing of any event listeners in nodes subsequent to the
|
|
current node in the event flow. This method does not affect any event
|
|
listeners in the current node(<code>currentTarget</code>). In contrast,
|
|
the <code>stopImmediatePropagation()</code> method prevents processing of
|
|
event listeners in both the current node and subsequent nodes. Additional
|
|
calls to this method have no effect. This method can be called in any
|
|
phase of the event flow.</p>
|
|
</div>
|
|
<p><strong>Note: </strong> This method does not cancel the behavior associated with
|
|
this event; see <code>preventDefault()</code> for that functionality.</p>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="tostring" class="tsd-anchor"></a>
|
|
<h3>to<wbr>String</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/Event.d.ts#L489">lib/openfl/events/Event.d.ts:489</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Returns a string containing all the properties of the Event object. The
|
|
string is in the following format:</p>
|
|
</div>
|
|
<p><code>[Event type=_value_ bubbles=_value_
|
|
cancelable=_value_]</code></p>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
<p>A string containing all the properties of the Event object.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class="label tsd-is-external">
|
|
<span>Externals</span>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.desktop.html">openfl.desktop</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.display.html">openfl.display</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.display3d.html">openfl.display3D</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.errors.html">openfl.errors</a>
|
|
</li>
|
|
<li class="current tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.events.html">openfl.events</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.external.html">openfl.external</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.filters.html">openfl.filters</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.geom.html">openfl.geom</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.media.html">openfl.media</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.net.html">openfl.net</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.profiler.html">openfl.profiler</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.sensors.html">openfl.sensors</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.system.html">openfl.system</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.text.html">openfl.text</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.ui.html">openfl.ui</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.utils.html">openfl.utils</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
<li class=" tsd-kind-enum tsd-parent-kind-module tsd-is-external">
|
|
<a href="../enums/openfl.events.eventphase.html" class="tsd-kind-icon">Event<wbr>Phase</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.events.accelerometerevent.html" class="tsd-kind-icon">Accelerometer<wbr>Event</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.events.activityevent.html" class="tsd-kind-icon">Activity<wbr>Event</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.events.asyncerrorevent.html" class="tsd-kind-icon">Async<wbr>Error<wbr>Event</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.events.dataevent.html" class="tsd-kind-icon">Data<wbr>Event</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.events.errorevent.html" class="tsd-kind-icon">Error<wbr>Event</a>
|
|
</li>
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.events.event.html" class="tsd-kind-icon">Event</a>
|
|
<ul>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.events.event.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.events.event.html#bubbles" class="tsd-kind-icon">bubbles</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.events.event.html#cancelable" class="tsd-kind-icon">cancelable</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.events.event.html#currenttarget" class="tsd-kind-icon">current<wbr>Target</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.events.event.html#eventphase" class="tsd-kind-icon">event<wbr>Phase</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.events.event.html#target" class="tsd-kind-icon">target</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.events.event.html#type" class="tsd-kind-icon">type</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#activate" class="tsd-kind-icon">ACTIVATE</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#added" class="tsd-kind-icon">ADDED</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#added_to_stage" class="tsd-kind-icon">ADDED_<wbr>TO_<wbr>STAGE</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#cancel" class="tsd-kind-icon">CANCEL</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#change" class="tsd-kind-icon">CHANGE</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#clear" class="tsd-kind-icon">CLEAR</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#close" class="tsd-kind-icon">CLOSE</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#complete" class="tsd-kind-icon">COMPLETE</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#connect" class="tsd-kind-icon">CONNECT</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#context3d_create" class="tsd-kind-icon">CONTEXT3<wbr>D_<wbr>CREATE</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#copy" class="tsd-kind-icon">COPY</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#cut" class="tsd-kind-icon">CUT</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#deactivate" class="tsd-kind-icon">DEACTIVATE</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#enter_frame" class="tsd-kind-icon">ENTER_<wbr>FRAME</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#exit_frame" class="tsd-kind-icon">EXIT_<wbr>FRAME</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#frame_constructed" class="tsd-kind-icon">FRAME_<wbr>CONSTRUCTED</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#frame_label" class="tsd-kind-icon">FRAME_<wbr>LABEL</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#fullscreen" class="tsd-kind-icon">FULLSCREEN</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#id3" class="tsd-kind-icon">ID3</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#init" class="tsd-kind-icon">INIT</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#mouse_leave" class="tsd-kind-icon">MOUSE_<wbr>LEAVE</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#open" class="tsd-kind-icon">OPEN</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#paste" class="tsd-kind-icon">PASTE</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#removed" class="tsd-kind-icon">REMOVED</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#removed_from_stage" class="tsd-kind-icon">REMOVED_<wbr>FROM_<wbr>STAGE</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#render" class="tsd-kind-icon">RENDER</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#resize" class="tsd-kind-icon">RESIZE</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#scroll" class="tsd-kind-icon">SCROLL</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#select" class="tsd-kind-icon">SELECT</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#select_all" class="tsd-kind-icon">SELECT_<wbr>ALL</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#sound_complete" class="tsd-kind-icon">SOUND_<wbr>COMPLETE</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#tab_children_change" class="tsd-kind-icon">TAB_<wbr>CHILDREN_<wbr>CHANGE</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#tab_enabled_change" class="tsd-kind-icon">TAB_<wbr>ENABLED_<wbr>CHANGE</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#tab_index_change" class="tsd-kind-icon">TAB_<wbr>INDEX_<wbr>CHANGE</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#texture_ready" class="tsd-kind-icon">TEXTURE_<wbr>READY</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.events.event.html#unload" class="tsd-kind-icon">UNLOAD</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.events.event.html#clone" class="tsd-kind-icon">clone</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.events.event.html#formattostring" class="tsd-kind-icon">format<wbr>ToString</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.events.event.html#isdefaultprevented" class="tsd-kind-icon">is<wbr>Default<wbr>Prevented</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.events.event.html#preventdefault" class="tsd-kind-icon">prevent<wbr>Default</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.events.event.html#stopimmediatepropagation" class="tsd-kind-icon">stop<wbr>Immediate<wbr>Propagation</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.events.event.html#stoppropagation" class="tsd-kind-icon">stop<wbr>Propagation</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.events.event.html#tostring" class="tsd-kind-icon">to<wbr>String</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.events.eventdispatcher.html" class="tsd-kind-icon">Event<wbr>Dispatcher</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.events.focusevent.html" class="tsd-kind-icon">Focus<wbr>Event</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.events.fullscreenevent.html" class="tsd-kind-icon">Full<wbr>Screen<wbr>Event</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.events.gameinputevent.html" class="tsd-kind-icon">Game<wbr>Input<wbr>Event</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.events.httpstatusevent.html" class="tsd-kind-icon">HTTPStatus<wbr>Event</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.events.ieventdispatcher.html" class="tsd-kind-icon">IEvent<wbr>Dispatcher</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.events.ioerrorevent.html" class="tsd-kind-icon">IOError<wbr>Event</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.events.keyboardevent.html" class="tsd-kind-icon">Keyboard<wbr>Event</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.events.mouseevent.html" class="tsd-kind-icon">Mouse<wbr>Event</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.events.netstatusevent.html" class="tsd-kind-icon">Net<wbr>Status<wbr>Event</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.events.progressevent.html" class="tsd-kind-icon">Progress<wbr>Event</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.events.sampledataevent.html" class="tsd-kind-icon">Sample<wbr>Data<wbr>Event</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.events.securityerrorevent.html" class="tsd-kind-icon">Security<wbr>Error<wbr>Event</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.events.textevent.html" class="tsd-kind-icon">Text<wbr>Event</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.events.timerevent.html" class="tsd-kind-icon">Timer<wbr>Event</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.events.touchevent.html" class="tsd-kind-icon">Touch<wbr>Event</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.events.uncaughterrorevent.html" class="tsd-kind-icon">Uncaught<wbr>Error<wbr>Event</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.events.uncaughterrorevents.html" class="tsd-kind-icon">Uncaught<wbr>Error<wbr>Events</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer class="with-border-bottom">
|
|
<div class="container">
|
|
<h2>Legend</h2>
|
|
<div class="tsd-legend-group">
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
|
|
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
|
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
|
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
|
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
|
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
|
|
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
|
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
|
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
|
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
|
|
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
|
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="container tsd-generator">
|
|
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
</div>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
|
</body>
|
|
</html> |