/FD3/FlashDevelop/Bin/Debug/Library/AS3/frameworks/FlashIDE/fl/controls/BaseButton.as

https://bitbucket.org/kkszysiu/flashdevelop · ActionScript · 174 lines · 53 code · 4 blank · 117 comment · 0 complexity · cbd33522854e490eceb3505208001861 MD5 · raw file 

    

  1. package fl.controls

    2. 

  2. {

    3. 

  3. 	import fl.core.InvalidationType;

    4. 

  4. 	import fl.core.UIComponent;

    5. 

  5. 	import fl.events.ComponentEvent;

    6. 

  6. 	import flash.display.DisplayObject;

    7. 

  7. 	import flash.display.Sprite;

    8. 

  8. 	import flash.events.Event;

    9. 

  9. 	import flash.events.MouseEvent;

    10. 

  10. 	import flash.events.TimerEvent;

    11. 

  11. 	import flash.utils.Timer;

    12. 

  12. 

    13. 

  13. 	/**
    14. 

  14. 	 * Dispatched when the user presses the Button component.
	 * If the <code>autoRepeat</code> property is <code>true</code>,
	 * this event is dispatched at specified intervals until the
	 * button is released. 
	 *
	 * <p>The <code>repeatDelay</code> style is used to
	 * specify the delay before the <code>buttonDown</code> event is 
	 * dispatched a second time. The <code>repeatInterval</code> style 
	 * specifies the interval at which this event is dispatched thereafter,
	 * until the user releases the button.</p>
	 *
     * @eventType fl.events.ComponentEvent.BUTTON_DOWN
     *
     * @includeExample examples/BaseButton.autoRepeat.1.as -noswf
     *
     * @see #autoRepeat
	 * @see #style:repeatDelay style
	 * @see #style:repeatInterval style
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    15. 

  15. 	 */
    16. 

  16. 	[Event(name="buttonDown", type="fl.events.ComponentEvent")] 

    17. 

  17. 	/**
    18. 

  18. 	 * Dispatched when the value of the <code>selected</code> property
	 * of a toggle Button component changes. A toggle Button component is a 
	 * Button component whose <code>toggle</code> property is set to <code>true</code>.
	 *
	 * <p>The CheckBox and RadioButton components dispatch this event after  
     * there is a change in the <code>selected</code> property.</p>
	 *
	 * @eventType flash.events.Event.CHANGE
     *
     * @includeExample examples/LabelButton.toggle.1.as -noswf
     *
     * @see #selected selected
     * @see LabelButton#toggle LabelButton.toggle
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    19. 

  19. 	 */
    20. 

  20. 	[Event(name="change", type="flash.events.Event")] 

    21. 

  21. 	/**
    22. 

  22. 	 * @copy fl.controls.LabelButton#style:upSkin
     *
     * @default Button_upSkin
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    23. 

  23. 	 */
    24. 

  24. 	[Style(name="upSkin", type="Class")] 

    25. 

  25. 	/**
    26. 

  26. 	 * @copy fl.controls.LabelButton#style:downSkin
     *
     * @default Button_downSkin
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    27. 

  27. 	 */
    28. 

  28. 	[Style(name="downSkin", type="Class")] 

    29. 

  29. 	/**
    30. 

  30. 	 * @copy fl.controls.LabelButton#style:overSkin
     *
     * @default Button_overSkin
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    31. 

  31. 	 */
    32. 

  32. 	[Style(name="overSkin", type="Class")] 

    33. 

  33. 	/**
    34. 

  34. 	 * @copy fl.controls.LabelButton#style:disabledSkin
     *
     * @default Button_disabledSkin
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    35. 

  35. 	 */
    36. 

  36. 	[Style(name="disabledSkin", type="Class")] 

    37. 

  37. 	/**
    38. 

  38. 	 * @copy fl.controls.LabelButton#style:selectedDisabledSkin
     *
     * @default Button_selectedDisabledSkin
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    39. 

  39. 	 */
    40. 

  40. 	[Style(name="selectedDisabledSkin", type="Class")] 

    41. 

  41. 	/**
    42. 

  42. 	 * @copy fl.controls.LabelButton#style:selectedUpSkin
     *
     * @default Button_selectedUpSkin
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    43. 

  43. 	 */
    44. 

  44. 	[Style(name="selectedUpSkin", type="Class")] 

    45. 

  45. 	/**
    46. 

  46. 	 * @copy fl.controls.LabelButton#style:selectedDownSkin
     *
     * @default Button_selectedDownSkin
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    47. 

  47. 	 */
    48. 

  48. 	[Style(name="selectedDownSkin", type="Class")] 

    49. 

  49. 	/**
    50. 

  50. 	 * @copy fl.controls.LabelButton#style:selectedOverSkin
     *
     * @default Button_selectedOverSkin
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    51. 

  51. 	 */
    52. 

  52. 	[Style(name="selectedOverSkin", type="Class")] 

    53. 

  53. 	/**
    54. 

  54. 	 * The number of milliseconds to wait after the <code>buttonDown</code> 
	 * event is first dispatched before sending a second <code>buttonDown</code> 
	 * event.
     *
     * @default 500
	 *
	 * @see #event:buttonDown
     * @see #autoRepeat
	 * @see #style:repeatInterval
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    55. 

  55. 	 */
    56. 

  56. 	[Style(name="repeatDelay", type="Number", format="Time")] 

    57. 

  57. 	/**
    58. 

  58. 	 * The interval, in milliseconds, between <code>buttonDown</code> events 
	 * that are dispatched after the delay that is specified by the <code>repeatDelay</code>
	 * style. 
     *
     * @default 35
     *
	 * @see #event:buttonDown
     * @see #autoRepeat
	 * @see #style:repeatDelay
	 *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    59. 

  59. 	 */
    60. 

  60. 	[Style(name="repeatInterval", type="Number", format="Time")] 

    61. 

  61. 

    62. 

  62. 	/**
    63. 

  63. 	 * The BaseButton class is the base class for all button components, defining 
     * properties and methods that are common to all buttons. This class handles 
     * drawing states and the dispatching of button events.
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    64. 

  64. 	 */
    65. 

  65. 	public class BaseButton extends UIComponent

    66. 

  66. 	{

    67. 

  67. 		/**
    68. 

  68. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    69. 

  69. 		 */
    70. 

  70. 		protected var background : DisplayObject;

    71. 

  71. 		/**
    72. 

  72. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    73. 

  73. 		 */
    74. 

  74. 		protected var mouseState : String;

    75. 

  75. 		/**
    76. 

  76. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    77. 

  77. 		 */
    78. 

  78. 		protected var _selected : Boolean;

    79. 

  79. 		/**
    80. 

  80. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    81. 

  81. 		 */
    82. 

  82. 		protected var _autoRepeat : Boolean;

    83. 

  83. 		/**
    84. 

  84. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    85. 

  85. 		 */
    86. 

  86. 		protected var pressTimer : Timer;

    87. 

  87. 		/**
    88. 

  88. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    89. 

  89. 		 */
    90. 

  90. 		private var _mouseStateLocked : Boolean;

    91. 

  91. 		/**
    92. 

  92. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    93. 

  93. 		 */
    94. 

  94. 		private var unlockedMouseState : String;

    95. 

  95. 		/**
    96. 

  96. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    97. 

  97. 		 */
    98. 

  98. 		private static var defaultStyles : Object;

    99. 

  99. 

    100. 

  100. 		/**
    101. 

  101. 		 * Gets or sets a value that indicates whether the component can accept user 
		 * input. A value of <code>true</code> indicates that the component can accept
		 * user input; a value of <code>false</code> indicates that it cannot. 
		 *
		 * <p>When this property is set to <code>false</code>, the button is disabled.
		 * This means that although it is visible, it cannot be clicked. This property is 
		 * useful for disabling a specific part of the user interface. For example, a button
		 * that is used to trigger the reloading of a web page could be disabled
		 * by using this technique.</p>
         *
         * @default true
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    102. 

  102. 		 */
    103. 

  103. 		public function get enabled () : Boolean;

    104. 

  104. 		/**
    105. 

  105. 		 * @private (setter)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    106. 

  106. 		 */
    107. 

  107. 		public function set enabled (value:Boolean) : void;

    108. 

  108. 		/**
    109. 

  109. 		 * Gets or sets a Boolean value that indicates whether a toggle button 
		 * is selected. A value of <code>true</code> indicates that the button is
		 * selected; a value of <code>false</code> indicates that it is not. 
		 * This property has no effect if the <code>toggle</code> property 
		 * is not set to <code>true</code>. 
		 *
		 * <p>For a CheckBox component, this value indicates whether the box is
		 * checked. For a RadioButton component, this value indicates whether the 
		 * component is selected.</p>
		 *
		 * <p>This value changes when the user clicks the component  
         * but can also be changed programmatically. If the <code>toggle</code> 
		 * property is set to <code>true</code>, changing this property causes  
		 * a <code>change</code> event object to be dispatched.</p>
		 *
         * @default false
         *
         * @includeExample examples/LabelButton.toggle.1.as -noswf
		 *
         * @see #event:change change
         * @see LabelButton#toggle LabelButton.toggle
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    110. 

  110. 		 */
    111. 

  111. 		public function get selected () : Boolean;

    112. 

  112. 		/**
    113. 

  113. 		 * @private (setter)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    114. 

  114. 		 */
    115. 

  115. 		public function set selected (value:Boolean) : void;

    116. 

  116. 		/**
    117. 

  117. 		 * Gets or sets a Boolean value that indicates whether the <code>buttonDown</code> event 
		 * is dispatched more than one time when the user holds the mouse button down over the component.
         * A value of <code>true</code> indicates that the <code>buttonDown</code> event 
		 * is dispatched repeatedly while the mouse button remains down; a value of <code>false</code>
		 * indicates that the event is dispatched only one time.
         * 
         * <p>If this value is <code>true</code>, after the delay specified by the 
		 * <code>repeatDelay</code> style, the <code>buttonDown</code> 
         * event is dispatched at the interval that is specified by the <code>repeatInterval</code> style.</p>
         *
         * @default false
         *
         * @includeExample examples/BaseButton.autoRepeat.1.as -noswf
         *
         * @see #style:repeatDelay
         * @see #style:repeatInterval
         * @see #event:buttonDown
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    118. 

  118. 		 */
    119. 

  119. 		public function get autoRepeat () : Boolean;

    120. 

  120. 		/**
    121. 

  121. 		 * @private (setter)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    122. 

  122. 		 */
    123. 

  123. 		public function set autoRepeat (value:Boolean) : void;

    124. 

  124. 		/**
    125. 

  125. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    126. 

  126. 		 */
    127. 

  127. 		public function set mouseStateLocked (value:Boolean) : void;

    128. 

  128. 

    129. 

  129. 		/**
    130. 

  130. 		 * @copy fl.core.UIComponent#getStyleDefinition()
         *
		 * @includeExample ../core/examples/UIComponent.getStyleDefinition.1.as -noswf
		 *
         * @see fl.core.UIComponent#getStyle() UIComponent.getStyle()
         * @see fl.core.UIComponent#setStyle() UIComponent.setStyle()
         * @see fl.managers.StyleManager StyleManager
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    131. 

  131. 		 */
    132. 

  132. 		public static function getStyleDefinition () : Object;

    133. 

  133. 		/**
    134. 

  134. 		 * Creates a new BaseButton instance.
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    135. 

  135. 		 */
    136. 

  136. 		public function BaseButton ();

    137. 

  137. 		/**
    138. 

  138. 		 * Set the mouse state via ActionScript. The BaseButton class
		 * uses this property internally, but it can also be invoked manually,
		 * and will set the mouse state visually.
         *
         * @param state A string that specifies a mouse state. Supported values are
         * "up", "over", and "down".
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    139. 

  139. 		 */
    140. 

  140. 		public function setMouseState (state:String) : void;

    141. 

  141. 		/**
    142. 

  142. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    143. 

  143. 		 */
    144. 

  144. 		protected function setupMouseEvents () : void;

    145. 

  145. 		/**
    146. 

  146. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    147. 

  147. 		 */
    148. 

  148. 		protected function mouseEventHandler (event:MouseEvent) : void;

    149. 

  149. 		/**
    150. 

  150. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    151. 

  151. 		 */
    152. 

  152. 		protected function startPress () : void;

    153. 

  153. 		/**
    154. 

  154. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    155. 

  155. 		 */
    156. 

  156. 		protected function buttonDown (event:TimerEvent) : void;

    157. 

  157. 		/**
    158. 

  158. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    159. 

  159. 		 */
    160. 

  160. 		protected function endPress () : void;

    161. 

  161. 		/**
    162. 

  162. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    163. 

  163. 		 */
    164. 

  164. 		protected function draw () : void;

    165. 

  165. 		/**
    166. 

  166. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    167. 

  167. 		 */
    168. 

  168. 		protected function drawBackground () : void;

    169. 

  169. 		/**
    170. 

  170. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    171. 

  171. 		 */
    172. 

  172. 		protected function drawLayout () : void;

    173. 

  173. 	}

    174. 

  174. }
    175.