Packageflexlib.controls
Classpublic class CanvasButton
InheritanceCanvasButton Inheritance mx.controls.Button
Implements mx.core.IContainer
Subclasses CanvasButtonAccordionHeader

A Button control that allows you to add any UI components to the Button via MXML.

The CanvasButton is an extension of Button that lets you set the contents of the Button to any UI components, as opposed to only a single icon and label like the normal Button control allows.

Example usage:

	 <flexlib:CanvasButton width="150" >
	 	<mx:VBox height="100%" width="100%" verticalGap="0">
	 			<mx:Label text="This is a" width="100%" textAlign="left" />
	 			<mx:Label text="crazy" textAlign="center" fontSize="20" fontStyle="italic" fontWeight="bold" width="100%" />
	 			<mx:Label text="button!" width="100%" textAlign="right" />
	 	</mx:VBox>
	 </flexlib:CanvasButton>
	 

See also

mx.controls.Button


Public Properties
 PropertyDefined By
  buttonMode : Boolean
[override]
CanvasButton
  childDescriptors : Array
[write-only] Since this class implements IContainer, when it is created it's parent container will set the childDescriptors property with UIComponentDescriptor objects.
CanvasButton
  creatingContentPane : Boolean
CanvasButton
  defaultButton : IFlexDisplayObject
CanvasButton
  horizontalScrollPolicy : String
CanvasButton
  horizontalScrollPosition : Number
CanvasButton
  mouseChildren : Boolean
[override]
CanvasButton
  verticalScrollPolicy : String
CanvasButton
  verticalScrollPosition : Number
CanvasButton
  viewMetrics : EdgeMetrics
CanvasButton
Protected Properties
 PropertyDefined By
  _creatingContentPane : Boolean
CanvasButton
  _defaultButton : IFlexDisplayObject
CanvasButton
  _horizontalScrollPosition : Number
CanvasButton
  _verticalScrollPosition : Number
CanvasButton
  _viewMetrics : EdgeMetrics
CanvasButton
Public Methods
 MethodDefined By
  
CanvasButton
Protected Methods
 MethodDefined By
  
[override]
CanvasButton
  
measure():void
[override]
CanvasButton
  
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
[override]
CanvasButton
Property Detail
_creatingContentPaneproperty
protected var _creatingContentPane:Boolean

_defaultButtonproperty 
protected var _defaultButton:IFlexDisplayObject

_horizontalScrollPositionproperty 
protected var _horizontalScrollPosition:Number

_verticalScrollPositionproperty 
protected var _verticalScrollPosition:Number

_viewMetricsproperty 
protected var _viewMetrics:EdgeMetrics

buttonModeproperty 
buttonMode:Boolean[override]


Implementation
    public function get buttonMode():Boolean
    public function set buttonMode(value:Boolean):void
childDescriptorsproperty 
childDescriptors:Array  [write-only]

Since this class implements IContainer, when it is created it's parent container will set the childDescriptors property with UIComponentDescriptor objects. These are used to create the child components that are set in MXML.


Implementation
    public function set childDescriptors(value:Array):void
creatingContentPaneproperty 
creatingContentPane:Boolean


Implementation
    public function get creatingContentPane():Boolean
    public function set creatingContentPane(value:Boolean):void
defaultButtonproperty 
defaultButton:IFlexDisplayObject


Implementation
    public function get defaultButton():IFlexDisplayObject
    public function set defaultButton(value:IFlexDisplayObject):void
horizontalScrollPolicyproperty 
horizontalScrollPolicy:String


Implementation
    public function get horizontalScrollPolicy():String
    public function set horizontalScrollPolicy(value:String):void
horizontalScrollPositionproperty 
horizontalScrollPosition:Number


Implementation
    public function get horizontalScrollPosition():Number
    public function set horizontalScrollPosition(value:Number):void
mouseChildrenproperty 
mouseChildren:Boolean[override]


Implementation
    public function get mouseChildren():Boolean
    public function set mouseChildren(value:Boolean):void
verticalScrollPolicyproperty 
verticalScrollPolicy:String


Implementation
    public function get verticalScrollPolicy():String
    public function set verticalScrollPolicy(value:String):void
verticalScrollPositionproperty 
verticalScrollPosition:Number


Implementation
    public function get verticalScrollPosition():Number
    public function set verticalScrollPosition(value:Number):void
viewMetricsproperty 
viewMetrics:EdgeMetrics


Implementation
    public function get viewMetrics():EdgeMetrics
    public function set viewMetrics(value:EdgeMetrics):void
Constructor Detail
CanvasButton()Constructor
public function CanvasButton()



Method Detail
createChildren()method
override protected function createChildren():void

measure()method 
override protected function measure():void

updateDisplayList()method 
override protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void

Parameters

unscaledWidth:Number
 
unscaledHeight:Number