blob: eee3f1a3855a3ad9d0c60236e0680e7f94a6eedc [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="VideoPlayerAccImpl,spark.accessibility.VideoPlayerAccImpl,enableAccessibility,enableAccessibility,enableAccessibility,enableAccessibility,enableAccessibility,enableAccessibility,enableAccessibility,enableAccessibility,enableAccessibility,enableAccessibility,enableAccessibility,enableAccessibility,enableAccessibility,enableAccessibility,enableAccessibility,enableAccessibility,enableAccessibility,enableAccessibility,enableAccessibility"><title>spark.accessibility.VideoPlayerAccImpl</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 = 'VideoPlayerAccImpl - 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?spark/accessibility/VideoPlayerAccImpl.html&amp;spark/accessibility/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">VideoPlayerAccImpl</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#methodSummary">Methods</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("VideoPlayerAccImpl"); titleBar_setSubNav(false,false,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')">spark.accessibility</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class VideoPlayerAccImpl</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">VideoPlayerAccImpl <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> <a href="../../mx/accessibility/AccImpl.html">AccImpl</a> <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> flash.accessibility.AccessibilityImplementation</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 4</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 10, AIR 2.0</td></tr></table><p></p><p></p><p></p><p></p>
VideoPlayerAccImpl is the accessibility implementation class
for spark.components.VideoPlayer.
<p>When a Spark VideoPlayer is created,
its <code>accessibilityImplementation</code> property
is set to an instance of this class.
The Flash Player then uses this class to allow MSAA clients
such as screen readers to see and manipulate the VideoPlayer.
See the mx.accessibility.AccImpl and
flash.accessibility.AccessibilityImplementation classes
for background information about accessibility implementation
classes and MSAA.</p>
<p>
<b>Children</b>
</p>
<p>The VideoPlayer has six MSAA children:
<ol>
<li>Play/Pause control</li>
<li>Scrub control</li>
<li>Play time indicator</li>
<li>Mute control</li>
<li>Volume control</li>
<li>Full Screen control</li>
</ol>
</p>
<p>The controls will always appear in the same order for accessibility
regardless of the order of controls in the skin.</p>
<p>
<b>Role</b>
</p>
<p>The MSAA Role of a VideoPlayer is ROLE_SYSTEM_PANE.</p>
<p>The Role of each child control is:
<ol>
<li>Play/Pause control: ROLE_SYSTEM_BUTTON</li>
<li>Scrub control: ROLE_SYSTEM_SLIDER</li>
<li>Play time indicator: ROLE_SYSTEM_STATICTEXT</li>
<li>Mute control: ROLE_SYSTEM_BUTTON</li>
<li>Volume control: ROLE_SYSTEM_SLIDER</li>
<li>Full Screen control: ROLE_SYSTEM_BUTTON</li>
</ol>
</p>
<p>
<b>Name</b>
</p>
<p>The MSAA Name of a VideoPlayer is, by default,
specified by a locale-dependent resource.
For the en_US locale, the name is "VideoPlayer".
When wrapped in a FormItem element,
this name is combined with the FormItem's label.
To override this behavior,
set the VideoPlayer's's <code>accessibilityName</code> property.</p>
<p>The Name of each child control is similarly specified by a resource.
The en_US names are:
<ol>
<li>Play/Pause control: "Play" or "Pause"</li>
<li>Scrub control: "Scrub Bar"</li>
<li>Play time indicator: the displayed text</li>
<li>Mute control: "Muted" or "Not muted"</li>
<li>Volume control: "Volume Bar"</li>
<li>Full Screen control: "Full Screen"</li>
</ol>
</p>
<p>To override the names of these child controls, reskin the VideoPlayer
and set the <code>accessibilityName</code> of the controls.</p>
<p>Note that the Play/Pause control and the Mute control
have MSAA Names which change as you interact with them.
To specify them, set <code>accessibilityName</code>
to a comma-separated list of MSAA Names,
such as "Play,Pause" or "Not Muted,Muted".</p>
<p>When the Name of the VideoPlayer or one of its child controls changes,
a VideoPlayer dispatches the MSAA event EVENT_OBJECT_NAMECHANGE
with the proper childID for the control or 0 for itself.</p>
<p>
<b>Description</b>
</p>
<p>The MSAA Description of a VideoPlayer is, by default, the empty string,
but you can set the VideoPlayer's <code>accessibilityDescription</code>
property.</p>
<p>The Description of each child control is the empty string.</p>
<p>
<b>State</b>
</p>
<p>The MSAA State of a VideoPlayer is STATE_SYSTEM_NORMAL.</p>
<p>The State of each child control is:
<ol>
<li>Play/Pause control:
<ul>
<li>STATE_SYSTEM_UNAVAILABLE</li>
<li>STATE_SYSTEM_FOCUSABLE</li>
<li>STATE_SYSTEM_FOCUSED</li>
</ul>
</li>
<li>Scrub control:
<ul>
<li>STATE_SYSTEM_UNAVAILABLE</li>
<li>STATE_SYSTEM_FOCUSABLE</li>
<li>STATE_SYSTEM_FOCUSED</li>
</ul>
</li>
<li>Play time indicator:
<ul>
<li>STATE_SYSTEM_UNAVAILABLE</li>
<li>STATE_SYSTEM_READONLY</li>
</ul>
</li>
<li>Mute control:
<ul>
<li>STATE_SYSTEM_UNAVAILABLE</li>
<li>STATE_SYSTEM_FOCUSABLE</li>
<li>STATE_SYSTEM_FOCUSED</li>
</ul>
</li>
<li>Volume control:
<ul>
<li>STATE_SYSTEM_UNAVAILABLE</li>
<li>STATE_SYSTEM_FOCUSABLE</li>
<li>STATE_SYSTEM_FOCUSED</li>
</ul>
</li>
<li>Full Screen control:
<ul>
<li>STATE_SYSTEM_UNAVAILABLE</li>
<li>STATE_SYSTEM_FOCUSABLE</li>
<li>STATE_SYSTEM_FOCUSED</li>
</ul>
</li>
</ol>
</p>
<p>When the State of the VideoPlayer or one of its child controls changes,
a VideoPlayer dispatches the MSAA event EVENT_OBJECT_STATECHANGE
with the proper childID for the control or 0 for itself.</p>
<p>
<b>Value</b>
</p>
<p>A VideoPlayer does not have an MSAA Value.</p>
<p>THe Value of each child control is:
<ol>
<li>Play/Pause control: no Value</li>
<li>Scrub control: Value of slider as an amount of time</li>
<li>Play time indicator: no Value</li>
<li>Mute control: no Value</li>
<li>Volume control: Value of slider</li>
<li>Full Screen control: no Value</li>
</ol>
</p>
<p>When the Value of a child control changes,
a VideoPlayer dispatches the MSAA event EVENT_OBJECT_VALUECHANGE
with the proper childID for the control.</p>
<p>
<b>Location</b>
</p>
<p>The MSAA Location of a VideoPlayer, or one of its child controls,
is its bounding rectangle.</p>
<p>
<b>Default Action</b>
</p>
<p>A VideoPlayer does not have an MSAA DefaultAction.</p>
<p>The DefaultAction of each child control is:
<ol>
<li>Play/Pause control: "Press"</li>
<li>Scrub control: none</li>
<li>Play time indicator: none</li>
<li>Mute control: "Press"</li>
<li>Volume control: none</li>
<li>Full Screen control: "Press"</li>
</ol>
</p>
<p>Performing the default action of one of the child controls
will have the following effect:
<ol>
<li>Play/Pause control: toggle between Play and Pause</li>
<li>Scrub control: none</li>
<li>Play time indicator: none</li>
<li>Mute control: toggle between Mute and Not Muted</li>
<li>Volume control: none</li>
<li>Full Screen control: toogle Full Screen on and off</li>
</ol>
</p>
<p>
<b>Focus</b>
</p>
<p>A VideoPlayer accepts focus.
When it does so, it dispatches the MSAA event EVENT_OBJECT_FOCUS event.</p>
<p>Some of its child controls also accept focus:
<ol>
<li>Play/Pause control: accepts focus</li>
<li>Scrub control: accepts focus</li>
<li>Play time indicator: does not accept focus</li>
<li>Mute control: transfers focus to Volume Bar</li>
<li>Volume control: accepts focus</li>
<li>Full Screen control: accepts focus</li>
</ol>
</p>
<p>When reporting focus, the VideoPlayer reports itself
if it is focused and none of its child controls is focused.
Otherwise, the focus may be reported as being on
the Play/Pause control, the Scrub control,
the Volume control, or the Full Screen control.</p>
<p>
<b>Selection</b>
</p>
<p>A VideoPlayer does not support selection in the MSAA sense.</p>
<p></p><br/><hr></div><a name="protectedPropertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Protected Properties</div><div class="showHideLinks"><div id="hideInheritedProtectedProperty" class="hideInheritedProtectedProperty"><a class="showHideLink" href="#protectedPropertySummary" onclick="javascript:setInheritedVisible(false,'ProtectedProperty');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Hide Inherited Protected Properties</a></div><div id="showInheritedProtectedProperty" class="showInheritedProtectedProperty"><a class="showHideLink" href="#protectedPropertySummary" onclick="javascript:setInheritedVisible(true,'ProtectedProperty');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Protected Properties</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable hideInheritedProtectedProperty" id="summaryTableProtectedProperty"><tr><th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class="hideInheritedProtectedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/accessibility/AccImpl.html#eventsToHandle" class="signatureLink">eventsToHandle</a> : Array<div class="summaryTableDescription">[read-only]
All subclasses must override this function by returning an array
of strings of the events to listen for.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/accessibility/AccImpl.html">AccImpl</a></td></tr><tr class="hideInheritedProtectedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/accessibility/AccImpl.html#master" class="signatureLink">master</a> : <a href="../../mx/core/UIComponent.html">UIComponent</a><div class="summaryTableDescription">
A reference to the UIComponent instance that this AccImpl instance
is making accessible.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/accessibility/AccImpl.html">AccImpl</a></td></tr><tr class="hideInheritedProtectedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/accessibility/AccImpl.html#role" class="signatureLink">role</a> : uint<div class="summaryTableDescription">
Accessibility role of the component being made accessible.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/accessibility/AccImpl.html">AccImpl</a></td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><div class="showHideLinks"><div id="hideInheritedMethod" class="hideInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(false,'Method');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Hide Inherited Public Methods</a></div><div id="showInheritedMethod" class="showInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(true,'Method');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Public Methods</a></div></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="#VideoPlayerAccImpl()" class="signatureLink">VideoPlayerAccImpl</a>(master:<a href="../../mx/core/UIComponent.html">UIComponent</a>)</div><div class="summaryTableDescription">
Constructor.</div></td><td class="summaryTableOwnerCol">VideoPlayerAccImpl</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#enableAccessibility()" class="signatureLink">enableAccessibility</a>():void</div><div class="summaryTableDescription">[static]
Enables accessibility in the VideoPlayer class.</div></td><td class="summaryTableOwnerCol">VideoPlayerAccImpl</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/accessibility/AccImpl.html#getFormName()" class="signatureLink">getFormName</a>(component:<a href="../../mx/core/UIComponent.html">UIComponent</a>):String</div><div class="summaryTableDescription">[static]
Method for supporting Form Accessibility.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/accessibility/AccImpl.html">AccImpl</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/accessibility/AccImpl.html#isAncestorDisabled()" class="signatureLink">isAncestorDisabled</a>(component:<a href="../../mx/core/UIComponent.html">UIComponent</a>):Boolean</div><div class="summaryTableDescription">[static]
Returns true if an ancestor of the component has enabled set to false.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/accessibility/AccImpl.html">AccImpl</a></td></tr></table></div><a name="protectedMethodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Protected Methods </div><div class="showHideLinks"><div id="hideInheritedProtectedMethod" class="hideInheritedProtectedMethod"><a class="showHideLink" href="#protectedMethodSummary" onclick="javascript:setInheritedVisible(false,'ProtectedMethod');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Show Inherited Protected Methods</a></div><div id="showInheritedProtectedMethod" class="showInheritedProtectedMethod"><a class="showHideLink" href="#protectedMethodSummary" onclick="javascript:setInheritedVisible(true,'ProtectedMethod');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Protected Methods</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable hideInheritedProtectedMethod" id="summaryTableProtectedMethod"><tr><th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class="hideInheritedProtectedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/accessibility/AccImpl.html#eventHandler()" class="signatureLink">eventHandler</a>(event:Event):void</div><div class="summaryTableDescription">
Generic event handler.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/accessibility/AccImpl.html">AccImpl</a></td></tr><tr class="hideInheritedProtectedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/accessibility/AccImpl.html#getName()" class="signatureLink">getName</a>(childID:uint):String</div><div class="summaryTableDescription">
Returns the name of the accessible component.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/accessibility/AccImpl.html">AccImpl</a></td></tr><tr class="hideInheritedProtectedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/accessibility/AccImpl.html#getState()" class="signatureLink">getState</a>(childID:uint):uint</div><div class="summaryTableDescription">
Utility method to determine state of the accessible component.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/accessibility/AccImpl.html">AccImpl</a></td></tr></table></div><script language="javascript" type="text/javascript"><!--
showHideInherited();
--></script><div class="MainContent"><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="VideoPlayerAccImpl()"></a><a name="VideoPlayerAccImpl(mx.core.UIComponent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">VideoPlayerAccImpl</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function VideoPlayerAccImpl(master:<a href="../../mx/core/UIComponent.html">UIComponent</a>)</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 4</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 10, AIR 2.0</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">master</span>:<a href="../../mx/core/UIComponent.html">UIComponent</a></code> &mdash; The UIComponent instance that this AccImpl instance
is making accessible.
</td></tr></table></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="enableAccessibility()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">enableAccessibility</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public static function enableAccessibility():void</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 4</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 10, AIR 2.0</td></tr></table><p></p><p></p><p>
Enables accessibility in the VideoPlayer class.
<p>This method is called by application startup code
that is autogenerated by the MXML compiler.
Afterwards, when instances of VideoPlayer are initialized,
their <code>accessibilityImplementation</code> property
will be set to an instance of this class.</p>
</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 -->