Packageardisia.components.compassContainer
Classpublic class CompassMinimizedRegion
InheritanceCompassMinimizedRegion Inheritance spark.components.supportClasses.SkinnableComponent

Displayed when a CompassRegionContainer is minimized and hidden.

Used exclusively by the CompassContainer class.


Public Properties
 PropertyDefined By
  region : String
The region's string description of the cardinal region represented.
CompassMinimizedRegion
  title : String
The region title.
CompassMinimizedRegion
Public Methods
 MethodDefined By
  
dispose():void
Remove the container from the display list and remove listeners.
CompassMinimizedRegion
Protected Methods
 MethodDefined By
  
eventHandler(event:MouseEvent):void
Handles events on the control.
CompassMinimizedRegion
  
restoreButtonPartHandler(event:Event):void
Handles events on the restore button part.
CompassMinimizedRegion
  
updateRestoreButtonPart():void
Update the restore button part.
CompassMinimizedRegion
  
updateTitleLabelPart():void
Update the title label part.
CompassMinimizedRegion
Events
 Event Summary Defined By
  
floatChangeRequest
Float change request.CompassMinimizedRegion
  
restoreRegionRequest
Dispatched when the restore button part is clicked.CompassMinimizedRegion
Styles
 Style Description Defined By
  
borderAlpha
Type: Number CSS Inheritance: no
Border alpha. 		CompassMinimizedRegion
  
borderColor
Type: uint Format: Color CSS Inheritance: no
Border color. 		CompassMinimizedRegion
  
borderVisible
Type: Boolean CSS Inheritance: no
Whether to display a border. 		CompassMinimizedRegion
Skin Parts

This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.


 Skin Part Description Defined By
  
restoreButtonPart:spark.components.supportClasses.ButtonBase
Required: false Part Type: Static
Used to restore the minimized compass region.
CompassMinimizedRegion
  
titleLabelPart:spark.components.supportClasses.TextBase
Required: false Part Type: Static
Optional label used to diplay the title of the minimized region.
CompassMinimizedRegion
Skin States

To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.


 Skin State Description Defined By
  
disabled
CompassMinimizedRegion
  
east
CompassMinimizedRegion
  
north
CompassMinimizedRegion
  
south
CompassMinimizedRegion
  
west
CompassMinimizedRegion
Property Detail
regionproperty
region:String

The region's string description of the cardinal region represented. Used to set the skin state.

The default value is null.


Implementation
    public function get region():String
    public function set region(value:String):void
titleproperty 
title:String

The region title.

The default value is null.


Implementation
    public function get title():String
    public function set title(value:String):void
Method Detail
dispose()method
public function dispose():void

Remove the container from the display list and remove listeners.

eventHandler()method 
protected function eventHandler(event:MouseEvent):void

Handles events on the control.

Parameters

event:MouseEvent — the MouseEvent that triggered the handler

restoreButtonPartHandler()method 
protected function restoreButtonPartHandler(event:Event):void

Handles events on the restore button part.

Parameters

event:Event — the Event that triggered the handler

updateRestoreButtonPart()method 
protected function updateRestoreButtonPart():void

Update the restore button part.

updateTitleLabelPart()method 
protected function updateTitleLabelPart():void

Update the title label part.

Event Detail
floatChangeRequest Event
Event Object Type: ardisia.components.compassContainer.events.CompassContainerEvent
CompassContainerEvent.type property = ardisia.components.compassContainer.events.CompassContainerEvent

Float change request.

restoreRegionRequest Event  
Event Object Type: ardisia.components.compassContainer.events.CompassContainerEvent
CompassContainerEvent.type property = ardisia.components.compassContainer.events.CompassContainerEvent

Dispatched when the restore button part is clicked.





Mon Sep 15 2014, 01:55 AM -06:00