﻿<!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"><meta name="book" content="ActionScript&nbsp;3.0&nbsp;Language&nbsp;and&nbsp;Components&nbsp;Reference"><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="Mouse,flash.ui.Mouse,A,ALTERNATE,ARROW,AUTO,BACKQUOTE,BACKSLASH,BACKSPACE,B,BUTTON,CAPS_LOCK,C,COMMA,COMMAND,CONTROL,CharCodeStrings,D,DELETE,DOWN,E,END,ENTER,EQUAL,ESCAPE,F10,F11,F12,F13,F14,F15,F1,F2,F3,F4,F5,F6,F7,F8,F9,F,G,HAND,H,HOME,IBEAM,I,INSERT,J,K,KEYNAME_BEGIN,KEYNAME_BREAK,KEYNAME_CLEARDISPLAY,KEYNAME_CLEARLINE,KEYNAME_DELETECHAR,KEYNAME_DELETE,KEYNAME_DELETELINE,KEYNAME_DOWNARROW,KEYNAME_END,KEYNAME_EXECUTE,KEYNAME_F10,KEYNAME_F11,KEYNAME_F12,KEYNAME_F13,KEYNAME_F14,KEYNAME_F15,KEYNAME_F16,KEYNAME_F17,KEYNAME_F18,KEYNAME_F19,KEYNAME_F1,KEYNAME_F20,KEYNAME_F21,KEYNAME_F22,KEYNAME_F23,KEYNAME_F24,KEYNAME_F25,KEYNAME_F26,KEYNAME_F27,KEYNAME_F28,KEYNAME_F29,KEYNAME_F2,KEYNAME_F30,KEYNAME_F31,KEYNAME_F32,KEYNAME_F33,KEYNAME_F34,KEYNAME_F35,KEYNAME_F3,KEYNAME_F4,KEYNAME_F5,KEYNAME_F6,KEYNAME_F7,KEYNAME_F8,KEYNAME_F9,KEYNAME_FIND,KEYNAME_HELP,KEYNAME_HOME,KEYNAME_INSERTCHAR,KEYNAME_INSERT,KEYNAME_INSERTLINE,KEYNAME_LEFTARROW,KEYNAME_MENU,KEYNAME_MODESWITCH,KEYNAME_NEXT,KEYNAME_PAGEDOWN,KEYNAME_PAGEUP,KEYNAME_PAUSE,KEYNAME_PREV,KEYNAME_PRINT,KEYNAME_PRINTSCREEN,KEYNAME_REDO,KEYNAME_RESET,KEYNAME_RIGHTARROW,KEYNAME_SCROLLLOCK,KEYNAME_SELECT,KEYNAME_STOP,KEYNAME_SYSREQ,KEYNAME_SYSTEM,KEYNAME_UNDO,KEYNAME_UPARROW,KEYNAME_USER,L,LEFTBRACKET,LEFT,LEFT,M,MINUS,N,NUMBER_0,NUMBER_1,NUMBER_2,NUMBER_3,NUMBER_4,NUMBER_5,NUMBER_6,NUMBER_7,NUMBER_8,NUMBER_9,NUMPAD,NUMPAD_0,NUMPAD_1,NUMPAD_2,NUMPAD_3,NUMPAD_4,NUMPAD_5,NUMPAD_6,NUMPAD_7,NUMPAD_8,NUMPAD_9,NUMPAD_ADD,NUMPAD_DECIMAL,NUMPAD_DIVIDE,NUMPAD_ENTER,NUMPAD_MULTIPLY,NUMPAD_SUBTRACT,NUM_PAD,O,PAGE_DOWN,PAGE_UP,P,PERIOD,Q,QUOTE,R,RIGHTBRACKET,RIGHT,RIGHT,S,SEMICOLON,SHIFT,SLASH,SPACE,STANDARD,STRING_BEGIN,STRING_BREAK,STRING_CLEARDISPLAY,STRING_CLEARLINE,STRING_DELETE,STRING_DELETECHAR,STRING_DELETELINE,STRING_DOWNARROW,STRING_END,STRING_EXECUTE,STRING_F10,STRING_F11,STRING_F12,STRING_F13,STRING_F14,STRING_F15,STRING_F16,STRING_F17,STRING_F18,STRING_F19,STRING_F1,STRING_F20,STRING_F21,STRING_F22,STRING_F23,STRING_F24,STRING_F25,STRING_F26,STRING_F27,STRING_F28,STRING_F29,STRING_F2,STRING_F30,STRING_F31,STRING_F32,STRING_F33,STRING_F34,STRING_F35,STRING_F3,STRING_F4,STRING_F5,STRING_F6,STRING_F7,STRING_F8,STRING_F9,STRING_FIND,STRING_HELP,STRING_HOME,STRING_INSERT,STRING_INSERTCHAR,STRING_INSERTLINE,STRING_LEFTARROW,STRING_MENU,STRING_MODESWITCH,STRING_NEXT,STRING_PAGEDOWN,STRING_PAGEUP,STRING_PAUSE,STRING_PREV,STRING_PRINT,STRING_PRINTSCREEN,STRING_REDO,STRING_RESET,STRING_RIGHTARROW,STRING_SCROLLLOCK,STRING_SELECT,STRING_STOP,STRING_SYSREQ,STRING_SYSTEM,STRING_UNDO,STRING_UPARROW,STRING_USER,TAB,T,U,UP,V,W,X,Y,Z,builtInItems,capsLock,caption,clear,clipboardItems,clipboardMenu,copy,cursor,customItems,cut,forwardAndBack,items,link,loop,numItems,numLock,paste,play,print,quality,rewind,save,selectAll,separatorBefore,visible,zoom,addItemAt,clone,clone,containsItem,display,getItemAt,getItemIndex,hideBuiltInItems,hide,isAccessible,removeAllItems,removeItemAt,show,systemClearMenuItem,systemCopyLinkMenuItem,systemCopyMenuItem,systemCutMenuItem,systemOpenLinkMenuItem,systemPasteMenuItem,systemSelectAllMenuItem"><title>flash.ui.Mouse (ActionScript 3.0)</title><script src="../../AC_OETags.js" type="text/javascript"></script></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 = 'Mouse - ActionScript 3.0 Language and Components Reference';

				var baseRef = '../../';

				window.onload = configPage;
			      
			    -->  
            </script>
<script language="javascript" type="text/javascript"><!--
function submitValue(){
var searchStr=document.getElementById('search-livedocs').value;
window.location="../../search.html"+"###"+searchStr;
}
--></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">ActionScript 3.0 Language and Components Reference</td><td class="titleTableSearch" align="center"><form class="searchForm" method="get" action="../../search.html" onsubmit="submitValue();"><input class="hidden" name="loc" value="" type="hidden"><input class="hidden" name="termPrefix" value="" type="hidden"><input class="hidden" name="term" value="" type="hidden"><input class="hidden" name="area" value="" type="hidden"><input id="search-livedocs" name="search_text" value="" title="" type="text"> <input type="button" name="action" value="Search" onclick="submitValue()"></form></td><td class="titleTableTopNav" align="right"><a href="../../../../Flash/10.0_Welcome/index.html">Home</a>&nbsp;|&nbsp;<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="../../language-elements.html">Language Elements</a>&nbsp;| <a href="../../all-index-Symbols.html" onclick="loadClassListFrame('../../index-list.html')">Index</a>&nbsp;|&nbsp;<a href="../../appendixes.html">Appendixes</a>&nbsp;|&nbsp;<a href="../../conventions.html">Conventions</a>&nbsp;|&nbsp;<a id="framesLink1" href="../../index.html?flash/ui/Mouse.html&amp;flash/ui/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=" Adobe Logo " title=" Adobe Logo "></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">Mouse</td><td class="titleTableSubNav" id="subNav" align="right" colspan="2"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a>&nbsp;| <a href="#eventSummary">Events</a>&nbsp;| <a href="#styleSummary">Styles</a>&nbsp;| <a href="#effectSummary">Effects</a>&nbsp;| <a href="#constantSummary">Constants</a>&nbsp;| <a href="#includeExamplesSummary">Examples</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("Mouse"); titleBar_setSubNav(false,true,false	,false,false,false,true,true,false	,false,false,false,false,false);}

				    
				        
				    
				-->
                
                    
                
			</script><div 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')">flash.ui</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public final   class  Mouse</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">Mouse  <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> <a href="../../Object.html">Object</a></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>Runtime Versions:&nbsp;</b></td><td>AIR 1.0, Flash Player 9</td></tr></table><p></p><p></p><p></p>
        The methods of the Mouse class are used to hide and show the mouse pointer,
 or to set the pointer to a specific style.
 The Mouse class is a top-level class whose properties and methods 
 you can access without using a constructor.
        <span src="flashonly">The pointer is visible by default, 
 but you can hide it and implement a custom pointer.</span>
        
            <p></p><p><a href="#includeExamplesSummary">View the examples</a></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="../../flash/events/MouseEvent.html" target="">flash.events.MouseEvent</a></div><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><div class="showHideLinks"><div id="hideInheritedProperty" class="hideInheritedProperty"><a class="showHideLink" href="#propertySummary" onclick="javascript:setInheritedVisible(false,'Property');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Hide Inherited Public Properties</a></div><div id="showInheritedProperty" class="showInheritedProperty"><a class="showHideLink" href="#propertySummary" onclick="javascript:setInheritedVisible(true,'Property');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Public Properties</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProperty"><tr><th>&nbsp;</th><th colspan="2">Property</th><th>Defined By</th></tr><tr class="hideInheritedProperty"><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="../../Object.html#constructor" class="signatureLink">constructor</a> : <a href="../../Object.html">Object</a><div class="summaryTableDescription">A reference to the class object or constructor function for a given object instance.</div></td><td class="summaryTableOwnerCol"><a href="../../Object.html">Object</a></td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#cursor" class="signatureLink">cursor</a> : <a href="../../String.html">String</a><div class="summaryTableDescription">[static] Sets the mouse cursor.</div></td><td class="summaryTableOwnerCol">Mouse</td></tr><tr class="hideInheritedProperty"><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="../../Object.html#prototype" class="signatureLink">prototype</a> : <a href="../../Object.html">Object</a><div class="summaryTableDescription">[static] A reference to the prototype object of a class or function object.</div></td><td class="summaryTableOwnerCol"><a href="../../Object.html">Object</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>Defined By</th></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="../../Object.html#hasOwnProperty()" class="signatureLink">hasOwnProperty</a>(name:<a href="../../String.html">String</a>):<a href="../../Boolean.html">Boolean</a></div><div class="summaryTableDescription">Indicates whether an object has a specified property defined.</div></td><td class="summaryTableOwnerCol"><a href="../../Object.html">Object</a></td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#hide()" class="signatureLink">hide</a>():<a href="../../specialTypes.html#void">void</a></div><div class="summaryTableDescription">[static] Hides the pointer.</div></td><td class="summaryTableOwnerCol">Mouse</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="../../Object.html#isPrototypeOf()" class="signatureLink">isPrototypeOf</a>(theClass:<a href="../../Object.html">Object</a>):<a href="../../Boolean.html">Boolean</a></div><div class="summaryTableDescription">Indicates whether an instance of the Object class is in the prototype chain of the object specified 
  as the parameter.</div></td><td class="summaryTableOwnerCol"><a href="../../Object.html">Object</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="../../Object.html#propertyIsEnumerable()" class="signatureLink">propertyIsEnumerable</a>(name:<a href="../../String.html">String</a>):<a href="../../Boolean.html">Boolean</a></div><div class="summaryTableDescription">Indicates whether the specified property exists and is enumerable.</div></td><td class="summaryTableOwnerCol"><a href="../../Object.html">Object</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="../../Object.html#setPropertyIsEnumerable()" class="signatureLink">setPropertyIsEnumerable</a>(name:<a href="../../String.html">String</a>, isEnum:<a href="../../Boolean.html">Boolean</a> = true):<a href="../../specialTypes.html#void">void</a></div><div class="summaryTableDescription">Sets the availability of a dynamic property for loop operations.</div></td><td class="summaryTableOwnerCol"><a href="../../Object.html">Object</a></td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#show()" class="signatureLink">show</a>():<a href="../../specialTypes.html#void">void</a></div><div class="summaryTableDescription">[static] Displays the pointer.</div></td><td class="summaryTableOwnerCol">Mouse</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="../../Object.html#toString()" class="signatureLink">toString</a>():<a href="../../String.html">String</a></div><div class="summaryTableDescription">Returns the string representation of the specified object.</div></td><td class="summaryTableOwnerCol"><a href="../../Object.html">Object</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="../../Object.html#valueOf()" class="signatureLink">valueOf</a>():<a href="../../Object.html">Object</a></div><div class="summaryTableDescription">Returns the primitive value of the specified object.</div></td><td class="summaryTableOwnerCol"><a href="../../Object.html">Object</a></td></tr></table></div><script language="javascript" type="text/javascript"><!--
                      showHideInherited();
                      --></script><div class="MainContent"><div class="detailSectionHeader">Property Detail</div><a name="propertyDetail"></a><a name="cursor"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">cursor</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>cursor:<a href="../../String.html">String</a></code>&nbsp;&nbsp;[read-write] <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>Runtime Versions:&nbsp;</b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p>
          Sets the mouse cursor.
          <p>
            The default value is
            <code>flash.ui.MouseCursor.AUTO</code>
            .
          </p>
          
          <p>To set values for this property, use the following string values:</p>
          
          <table class="innertable" ><tr><th>String value</th><th>Description</th></tr><tr><td>
                    <code>flash.ui.MouseCursor.AUTO</code>
                  </td><td>Mouse cursor will change automatically based on the object under the mouse.</td></tr><tr><td>
                    <code>flash.ui.MouseCursor.ARROW</code>
                  </td><td>Mouse cursor will be an arrow.</td></tr><tr><td>
                    <code>flash.ui.MouseCursor.BUTTON</code>
                  </td><td>Mouse cursor will be a button clicking hand.</td></tr><tr><td>
                    <code>flash.ui.MouseCursor.HAND</code>
                  </td><td>Mouse cursor will be a dragging hand.</td></tr><tr><td>
                    <code>flash.ui.MouseCursor.IBEAM</code>
                  </td><td>Mouse cursor will be an I-beam.</td></tr></table>
          
        </p><br/><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public static function get cursor():<a href="../../String.html">String</a></code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set cursor(value:<a href="../../String.html">String</a>):<a href="../../specialTypes.html#void">void</a></code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code><a href="../../ArgumentError.html">ArgumentError</a> </code> &mdash; 
              If set to any value which is not a member of
              <code>flash.ui.MouseCursor</code>
              .
            </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="MouseCursor.html" target="">flash.ui.MouseCursor</a></div></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="hide()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">hide</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public static function hide():<a href="../../specialTypes.html#void">void</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>Runtime Versions:&nbsp;</b></td><td>AIR 1.0, Flash Player 9</td></tr></table><p></p><p></p><p>
          Hides the pointer. The pointer is visible by default.
          <p>
            <b>Note:</b>
            You need to call
            <code>Mouse.hide()</code>
            only once, regardless of
  the number of previous calls to
            <code>Mouse.show()</code>
            .
          </p>
          
        </p><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../flash/display/DisplayObject.html#mouseX" target="">flash.display.DisplayObject.mouseX</a><br/><a href="../../flash/display/DisplayObject.html#mouseY" target="">flash.display.DisplayObject.mouseY</a></div></div><a name="show()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">show</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public static function show():<a href="../../specialTypes.html#void">void</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>Runtime Versions:&nbsp;</b></td><td>AIR 1.0, Flash Player 9</td></tr></table><p></p><p></p><p>
          Displays the pointer. The pointer is visible by default.
          <p>
            <b>Note:</b>
            You need to call
            <code>Mouse.show()</code>
            only once, regardless of
  the number of previous calls to
            <code>Mouse.hide()</code>
            .
          </p>
          
        </p><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../flash/display/DisplayObject.html#mouseX" target="">flash.display.DisplayObject.mouseX</a><br/><a href="../../flash/display/DisplayObject.html#mouseY" target="">flash.display.DisplayObject.mouseY</a></div></div><a name="includeExamplesSummary"></a><div class="detailSectionHeader">Examples<span class="usage"><a href="../../ExampleInstruct.html"> How to use examples </a></span></div><div class="exampleHeader">MouseExample.as</div><br/><div class="detailBody">
        The following example uses the MouseExample, SimpleButton,
 ButtonDisplayState, and CustomCursor classes to place a simple button on the Stage. The button
 has a custom pointer and the button changes when clicked.  This is accomplished with the following steps:
        <ol><li>
            Declare the following instance properties:
            <code>cursor</code>
            of type CustomCursor,
            <code>child</code>
            of type
  CustomButton, and
            <code>gutter</code>
            of type uint.
          </li><li>
            Assign
            <code>child</code>
            to a new CustomButton instance, set its
            <i>x</i>
            and
            <i>y</i>
            coordinates to 10 pixels each, and then add the instance to the display list.
  The CustomButton class overrides the
            <code>downState</code>
            ,
            <code>upState</code>
            ,
            <code>overState</code>
            , and
            <code>hitTestState</code>
            properties in SimpleButton.  Each of these 
  properties instantiates a ButtonDisplayState object, which draws a different square, depending 
  on the state of the
            <code>child</code>
            instance.
          </li><li>
            The
            <code>child</code>
            instance is then used to add a
            <code>MOUSE_OVER</code>
            event listener and
            <code>mouseOverHandler()</code>
            listener method, along with a
            <code>MOUSE_OUT</code>
            event listener and associated
            <code>mouseOutHandler()</code>
            method.
          </li><li>
            The event listeners work as follows:
            <ul><li>
                <code>mouseOverHandler</code>
                : Hides the "normal" pointer and adds a
                <code>MOUSE_MOVE</code>
                listener, which processes the mouse moves using
                <code>mouseMoveHandler()</code>
                , described
      below.
              </li><li>
                <code>mouseOutHandler</code>
                : When the mouse moves outside the custom button, the
      "normal" pointer is shown, the
                <code>MOUSE_MOVE</code>
                event listener is removed, and the custom cursor's
      visibility is set to
                <code>false</code>
                .
              </li><li>
                <code>mouseMoveHandler</code>
                : Moves the custom cursor around wherever the pointer is 
      moved and sets the custom cursor's visibility to
                <code>true</code>
                .
              </li></ul>
          </li><li>
            Back in the
            <code>MouseExample</code>
            constructor, the cursor property is assigned to a new 
  CustomCursor object and then added to the display list using
            <code>addChild()</code>
            .  
  The CustomCursor class draws a small nearly black square in place of the "normal" pointer
  whenever the mouse is over
            <code>child</code>
            .
          </li><li>
            A fourth event listener of type
            <code>MOUSE_LEAVE</code>
            is added, with the associated
            <code>mouseLeaveHandler()</code>
            method.  In this method (called if the mouse leaves the Stage),
            <code>mouseOutHandler()</code>
            is passed a new
            <code>mouseMove</code>
            listener object, which essentially
  removes the pointer so it is not left on the Stage.
          </li></ol>
        
        <div class="listing"><pre>package {
    import flash.display.Sprite;
    import flash.display.DisplayObject;
    import flash.ui.Mouse;
    import flash.events.*;

    public class MouseExample extends Sprite {
         private var cursor:CustomCursor;
         private var child:CustomButton;
         private var gutter:uint = 10;

        public function MouseExample() {
            child = new CustomButton();
            child.x = gutter;
            child.y = gutter;
            addChild(child);

            child.addEventListener(MouseEvent.MOUSE_OVER, mouseOverHandler);
            child.addEventListener(MouseEvent.MOUSE_OUT, mouseOutHandler);

            cursor = new CustomCursor();
            addChild(cursor);

            stage.addEventListener(Event.MOUSE_LEAVE, mouseLeaveHandler);
        }

        private function mouseOverHandler(event:MouseEvent):void {
            trace("mouseOverHandler");
            Mouse.hide();
            child.addEventListener(MouseEvent.MOUSE_MOVE, mouseMoveHandler);
        }

        private function mouseOutHandler(event:MouseEvent):void {
            trace("mouseOutHandler");
            Mouse.show();
            child.removeEventListener(MouseEvent.MOUSE_MOVE, mouseMoveHandler);
            cursor.visible = false;
        }

        private function mouseMoveHandler(event:MouseEvent):void {
            trace("mouseMoveHandler");
            cursor.x = event.localX;
            cursor.y = event.localY;
            event.updateAfterEvent();
            cursor.visible = true;
        }

        private function mouseLeaveHandler(event:Event):void {
            trace("mouseLeaveHandler");
            mouseOutHandler(new MouseEvent(MouseEvent.MOUSE_MOVE));
        }
    }
}

import flash.display.Shape;
import flash.display.SimpleButton;
    
class CustomButton extends SimpleButton {
    var upColor:uint = 0xFFCC00;
    var overColor:uint = 0xCCFF00;
    var downColor:uint = 0x00CCFF;
    var size:uint = 80;
    
    public function CustomButton() {
        downState = new ButtonDisplayState(downColor, size+10);
        overState = new ButtonDisplayState(overColor, size);
        upState = new ButtonDisplayState(upColor, size);
        hitTestState = new ButtonDisplayState(upColor, size);
    }
}

class ButtonDisplayState extends Shape {
    var bgColor:uint;
    var size:uint;
    
    public function ButtonDisplayState(bgColor:uint, size:uint) {
        this.bgColor = bgColor;
        this.size = size;
        draw();
    }
    
    private function draw():void {
        graphics.clear();
        graphics.beginFill(bgColor);
        graphics.drawRect(0, 0, size, size);
        graphics.endFill();
    }
}
    
class CustomCursor extends Shape {
    var bgColor:uint = 0x333333;
    var size:uint = 10;
    
    public function CustomCursor() {
        visible = false;
        draw();
    }
    
    private function draw():void {
        graphics.clear();
        graphics.beginFill(bgColor);
        graphics.drawRect(0, 0, size, size);
        graphics.endFill();
    }
}</pre></div>
      </div><br/><br/><hr><br/><p></p><center class="copyright"> &copy; 2004-2008 Adobe Systems Incorporated. All rights reserved. <br/>Thu Oct 30 2008, 07:08 PM -07:00  </center><div style="display:none">Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse Mouse </div><div style="display:none">flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse flash.ui.Mouse </div></div></body></html><!-- &copy; 2004-2008 Adobe Systems Incorporated. All rights reserved. <br/>Thu Oct 30 2008, 07:08 PM -07:00  -->
