CasaSimpleButton

Kind of class:public class
Package:org.casalib.display
Inherits from:SimpleButton
Implements:
Version:05/29/09
Author:Aaron Clinger
Classpath:org.casalib.display.CasaSimpleButton
File last modified:Friday, 29 May 2009, 07:39:54
A base SimpleButton that implements IRemovableEventDispatcher and IDestroyable.

Summary


Constructor
  • CasaSimpleButton (upState:DisplayObject = null, overState:DisplayObject = null, downState:DisplayObject = null, hitTestState:DisplayObject = null)
    • Creates a new CasaSimpleButton.
Instance properties
  • stage : Stage
    • The Stage of the display object or if the display object is not added to the display list and StageReference is defined stage will return the default stage; otherwise null.
  • destroyed : Boolean
Instance methods
  • removeEventsForType (type:String) : void
    • Removes all events of a specific type.
  • removeEventsForListener (listener:Function) : void
    • Removes all events that report to the specified listener.
  • removeEventListeners : void
    • Removes all event listeners.
  • removeChildren (destroyChildren:Boolean = false, recursive:Boolean = false) : void
    • Removes and optionally destroys the button states of the CasaSprite.
  • removeChildrenAndDestroy (destroyChildren:Boolean = false, recursive:Boolean = false) : void
    • Removes and optionally destroys the button states of the CasaSprite then destroys itself.
  • destroy : void
    • Removes any event listeners and stops all internal processes to help allow for prompt garbage collection.

Constructor

CasaSimpleButton

public function CasaSimpleButton (
upState:DisplayObject = null, overState:DisplayObject = null, downState:DisplayObject = null, hitTestState:DisplayObject = null)

Creates a new CasaSimpleButton.
Parameters:
upState :
The initial value for the SimpleButton up state.
overState :
The initial value for the SimpleButton over state.
downState :
The initial value for the SimpleButton down state.
hitTestState:
The initial value for the SimpleButton hitTest state.

Instance properties

destroyed

public destroyed:Boolean
(read)

stage

override public stage:Stage
(read)

The Stage of the display object or if the display object is not added to the display list and StageReference is defined stage will return the default stage; otherwise null.

Instance methods

destroy

public function destroy (
) : void

Removes any event listeners and stops all internal processes to help allow for prompt garbage collection.

Always call stage before deleting last object pointer.
#

Calling destroy() on a CASA display object also removes it from its current parent.
Specified by:

removeChildren

public function removeChildren (
destroyChildren:Boolean = false, recursive:Boolean = false) : void

Removes and optionally destroys the button states of the CasaSprite.
Parameters:
destroyChildren:
If the button state implements IDestroyable call its destroy method true, or don't destroy false; defaults to false.
recursive :
Call this method with the same arguments on all of the button state's children (all the way down the display list) true, or leave the button state's children false; defaults to false.

removeChildrenAndDestroy

public function removeChildrenAndDestroy (
destroyChildren:Boolean = false, recursive:Boolean = false) : void

Removes and optionally destroys the button states of the CasaSprite then destroys itself.
Parameters:
destroyChildren:
If the button state implements IDestroyable call its destroy method true, or don't destroy false; defaults to false.
recursive :
Call this method with the same arguments on all of the button state's children (all the way down the display list) true, or leave the button state's children false; defaults to false.

removeEventListeners

public function removeEventListeners (
) : void

Removes all event listeners.
#

removeEventsForListener

public function removeEventsForListener (
listener:Function) : void

Removes all events that report to the specified listener.
#
Parameters:
listener:
The listener function that processes the event.
#

removeEventsForType

public function removeEventsForType (
type:String) : void

Removes all events of a specific type.
#
Parameters:
type:
The type of event.
#