| Package | flexlib.containers |
| Class | public class WindowShade |
| Inheritance | WindowShade mx.core.LayoutContainer |
| Property | Defined By | ||
|---|---|---|---|
| closedHeight : Number = 0 | WindowShade | ||
| headerLocation : String
Specifies where the header button is placed relative tot he content of this WindowShade. | WindowShade | ||
| headerRenderer : IFactory
To control the header used on the WindowShade component you can either set the headerClass or the
headerRenderer. | WindowShade | ||
| label : String [override]
The text that appears on the headerButton. | WindowShade | ||
| opened : Boolean
Sets or gets the state of this WindowShade, either opened (true) or closed (false). | WindowShade | ||
| viewMetrics : EdgeMetrics [override] [read-only] | WindowShade | ||
| Method | Defined By | ||
|---|---|---|---|
| WindowShade | |||
| Method | Defined By | ||
|---|---|---|---|
applyHeaderButtonStyles(button:Button):void | WindowShade | ||
createOrReplaceHeaderButton():void | WindowShade | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the WindowShade is about to be closed. | WindowShade | |||
| Dispatched when the WindowShade has finished closing. | WindowShade | |||
| Dispatched when the WindowShade is about to be opened. | WindowShade | |||
| Dispatched when the opened property is changed, either through user action or programatically. | WindowShade | |||
| Dispatched when the WindowShade has finished opening. | WindowShade | |||
| closedHeight | property |
public var closedHeight:Number = 0| headerLocation | property |
headerLocation:String
Specifies where the header button is placed relative tot he content of this WindowShade. Possible
values are top and bottom.
This property can be used as the source for data binding.
public function get headerLocation():String public function set headerLocation(value:String):void| headerRenderer | property |
headerRenderer:IFactory
To control the header used on the WindowShade component you can either set the headerClass or the
headerRenderer. The headerRenderer works similar to the itemRenderer of a List control.
You can set this using MXML using any Button control. This would let you customize things like button skin. You could
even combine this with the CanvasButton component to make complex headers.
public function get headerRenderer():IFactory public function set headerRenderer(value:IFactory):void| label | property |
label:String[override] The text that appears on the headerButton.
public function get label():String public function set label(value:String):void| opened | property |
opened:BooleanSets or gets the state of this WindowShade, either opened (true) or closed (false).
public function get opened():Boolean public function set opened(value:Boolean):void| viewMetrics | property |
viewMetrics:EdgeMetrics [read-only] [override] public function get viewMetrics():EdgeMetrics| WindowShade | () | Constructor |
public function WindowShade()| applyHeaderButtonStyles | () | method |
protected function applyHeaderButtonStyles(button:Button):voidParameters
button:Button |
| createOrReplaceHeaderButton | () | method |
protected function createOrReplaceHeaderButton():void| closeBegin | Event |
flexlib.events.WindowShadeEventflexlib.events.WindowShadeEvent.CLOSE_BEGINDispatched when the WindowShade is about to be closed. This event cannot be cancelled.
In most cases, an event of this type will be followed by an event of type WindowShadeEvent.CLOSE_END (closeEnd); however,
if the user clicks the header button before the closing transition has run to completion, the closeEnd event will
not be dispatched, since the WindowShade will not be left in the closed state.
type
property of a WindowShadeEvent object used to indicate that a WindowShade is about to be closed. This
type of WindowShadeEvent is not cancelable.
In most cases, an event of this type will be followed by an event of type WindowShadeEvent.CLOSE_END (closeEnd); however,
if the user clicks the header button before the closing transition has run to completion, the closeEnd event will
not be dispatched, since the WindowShade will not be left in the closed state.
| closeEnd | Event |
flexlib.events.WindowShadeEventflexlib.events.WindowShadeEvent.CLOSE_ENDDispatched when the WindowShade has finished closing. This event cannot be cancelled.
The WindowShadeEvent.CLOSE_END constant defines the value of thetype
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.
| openBegin | Event |
flexlib.events.WindowShadeEventflexlib.events.WindowShadeEvent.OPEN_BEGINDispatched when the WindowShade is about to be opened.
In most cases, an event of this type will be followed by an event of type WindowShadeEvent.OPEN_END (openEnd); however,
if the user clicks the header button before the closing transition has run to completion, the openEnd event will
not be dispatched, since the WindowShade will not be left in the opened state.
type
property of a WindowShadeEvent object used to indicate that a WindowShade is about to be opened. This
type of WindowShadeEvent is not cancelable.
In most cases, an event of this type will be followed by an event of type WindowShadeEvent.OPEN_END (openEnd); however,
if the user clicks the header button before the opening transition has run to completion, the openEnd event will
not be dispatched, since the WindowShade will not be left in the open state.
| openedChanged | Event |
flexlib.events.WindowShadeEventflexlib.events.WindowShadeEvent.OPENED_CHANGED
Dispatched when the opened property is changed, either through user action
or programatically. This event is cancelable. When cancelled through a call to Event.preventDefault(),
the opened property will be restored to its previous state.
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.
This is the only WindowShadeEvent type that can be cancelled by a listener function. If the
preventDefault() method is called, the previous value of the opened property
will be restored. The restoration will trigger an additonal PropertyChangeEvent to keep properties bound to
the opened property in sync, but it will not trigger another openChanged event.
| openEnd | Event |
flexlib.events.WindowShadeEventflexlib.events.WindowShadeEvent.OPEN_ENDDispatched when the WindowShade has finished opening. This event cannot be cancelled.
The WindowShadeEvent.OPEN_END constant defines the value of thetype
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.