Packageflexlib.events
Classpublic class WindowShadeEvent
InheritanceWindowShadeEvent Inheritance flash.events.Event

The WindowShadeEvent class represents event objects that are specific to the WindowShade container.

See also

flexlib.containers.WindowShade


Public Methods
 MethodDefined By
  
WindowShadeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)
Constructs a new WindowShadeEvent.
WindowShadeEvent
Public Constants
 ConstantDefined By
  CLOSE_BEGIN : String = closeBegin
[static] The WindowShadeEvent.CLOSE_BEGIN constant defines the value of the type property of a WindowShadeEvent object used to indicate that a WindowShade is about to be closed.
WindowShadeEvent
  CLOSE_END : String = closeEnd
[static] The WindowShadeEvent.CLOSE_END constant defines the value of the type property of a WindowShadeEvent object used to indicate that a WindowShade has been completely opened.
WindowShadeEvent
  OPEN_BEGIN : String = openBegin
[static] The WindowShadeEvent.OPEN_BEGIN constant defines the value of the type property of a WindowShadeEvent object used to indicate that a WindowShade is about to be opened.
WindowShadeEvent
  OPENED_CHANGED : String = openedChanged
[static] The WindowShadeEvent.OPENED_CHANGED constant defines the value of the type property of the event object for a openedChanged event, which indicates that the value of the opened property has been toggled, either through user action or programattically.
WindowShadeEvent
  OPEN_END : String = openEnd
[static] The WindowShadeEvent.OPEN_END constant defines the value of the type property of a WindowShadeEvent object used to indicate that a WindowShade has been completely opened.
WindowShadeEvent
Constructor Detail
WindowShadeEvent()Constructor
public function WindowShadeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)

Constructs a new WindowShadeEvent.

Parameters
type:String
 
bubbles:Boolean (default = false)
 
cancelable:Boolean (default = false)
Constant Detail
CLOSE_BEGINConstant
public static const CLOSE_BEGIN:String = closeBegin

The WindowShadeEvent.CLOSE_BEGIN constant defines the value of the <codeph>type</codeph> property of a WindowShadeEvent object used to indicate that a WindowShade is about to be closed. This type of WindowShadeEvent is not cancelable. <p>In most cases, an event of this type will be followed by an event of type WindowShadeEvent.CLOSE_END (<codeph>closeEnd</codeph>); however, if the user clicks the header button before the closing transition has run to completion, the <codeph>closeEnd</codeph> event will not be dispatched, since the WindowShade will not be left in the closed state.</p>

CLOSE_ENDConstant 
public static const CLOSE_END:String = closeEnd

The WindowShadeEvent.CLOSE_END constant defines the value of the <codeph>type</codeph> property of a WindowShadeEvent object used to indicate that a WindowShade has been completely opened. The WindowShade, however, is not guaranteed to have been rendered in the fully open state when this event is dispatched. (Use callLater in the event handler if this is a problem.) This type of WindowShadeEvent is not cancelable.

OPEN_BEGINConstant 
public static const OPEN_BEGIN:String = openBegin

The WindowShadeEvent.OPEN_BEGIN constant defines the value of the <codeph>type</codeph> property of a WindowShadeEvent object used to indicate that a WindowShade is about to be opened. This type of WindowShadeEvent is not cancelable. <p>In most cases, an event of this type will be followed by an event of type WindowShadeEvent.OPEN_END (<codeph>openEnd</codeph>); however, if the user clicks the header button before the opening transition has run to completion, the <codeph>openEnd</codeph> event will not be dispatched, since the WindowShade will not be left in the open state.</p>

OPEN_ENDConstant 
public static const OPEN_END:String = openEnd

The WindowShadeEvent.OPEN_END constant defines the value of the <codeph>type</codeph> property of a WindowShadeEvent object used to indicate that a WindowShade has been completely opened. The WindowShade, however, is not guaranteed to have been rendered in the fully open state when this event is dispatched. (Use callLater in the event handler if this is a problem.) This type of WindowShadeEvent is not cancelable.

OPENED_CHANGEDConstant 
public static const OPENED_CHANGED:String = openedChanged

The WindowShadeEvent.OPENED_CHANGED constant defines the value of the <codeph>type</codeph> property of the event object for a <codeph>openedChanged</codeph> event, which indicates that the value of the <codeph>opened</codeph> property has been toggled, either through user action or programattically. <p>This is the only WindowShadeEvent type that can be cancelled by a listener function. If the <codeph>preventDefault()</codeph> method is called, the previous value of the <codeph>opened</codeph> property will be restored. The restoration will trigger an additonal PropertyChangeEvent to keep properties bound to the <codeph>opened</codeph> property in sync, but it will not trigger another <codeph>openChanged</codeph> event.</p>