qnx.ui.buttons.Button

Button

Properties | Methods


Packageqnx.ui.buttons
Classpublic class Button
InheritanceButton Inheritance SkinnableComponent Inheritance UIComponent Inheritance flash.display.MovieClip
Subclasses IconButton, LabelButton

The Button class represents a common button.

A button consists of a skin, which changes based on the current state of the button. You can create a custom skin by implementing the ISkin interface. A button has an up, down, selected, and disabled state.

The following image shows a Button instance in the up state:

A button.

You can also use the toggle property to make the button behave like a toggle switch.



Class information:
PlayBook Tablet OS Version:   1.0.6

See also

Button skins
LabelButton
IconButton



Public Properties

 PropertyDefined By
 Inheritedcontainment : String
Gets or sets a property that determines how a component is contained within a parent container.
UIComponent
  selected : Boolean
Gets or sets the selected property of the button.
Button
 Inheritedsize : Number
Gets or sets the size for this component (as a percentage of the container's size, or in pixels).
UIComponent
 InheritedsizeMode : String
Gets or sets the size mode for this component.
UIComponent
 InheritedsizeUnit : String
Gets or sets the unit of measure for the size property.
UIComponent
  toggle : Boolean
Gets or sets the toggle property of the button.
Button

Public Methods

 MethodDefined By
  
Constructs a Button instance.
Button
 Inherited
destroy():void
Call this method when you want to have your object collected by the garbage collector.
UIComponent
 Inherited
drawNow():void
Calls the draw() method.
UIComponent
 Inherited
invalidate(property:String = all, invalidateNow:Boolean = false):void
Marks the property as invalid and the draw() method is called on the next frame or the next render, whichever comes first.
UIComponent
 Inherited
setPosition(x:Number, y:Number):void
Sets the x and y position of the component.
UIComponent
 Inherited
setSize(w:Number, h:Number):void
Sets the width and height of the component.
UIComponent
 Inherited
setSkin(cellSkin:Object):void
Set the skin object on the component for it to render.
SkinnableComponent

Protected Methods

 MethodDefined By
 Inherited
callLater(method:Function):void
Calls the specified method on the next frame or the next render, which ever happens first.
UIComponent
 Inherited
createInstance(linkage:Object):DisplayObject
Calling this method will attempt to create a DisplayObject instance based on the value of the linkage parameter.
UIComponent
 Inherited
draw():void
Called every time you set the width and height of the component.
UIComponent
 Inherited
isInvalid(property:String, ... properties):Boolean
Checks to see if the property is invalid and returns true if it is.
UIComponent
 Inherited
onAdded():void
Called when the instance is added to the stage.
UIComponent
 Inherited
onRemoved():void
Called when the instance is removed from the stage.
UIComponent
 Inherited
setEnabled(val:Boolean):void
Called when the enabled property changes.
UIComponent
 Inherited
validate(property:String = all):void
Lets the component know that the specified property has been validated.
UIComponent

Property Detail

selected


selected:Boolean

Gets or sets the selected property of the button.

The default value is false.


Implementation

public function get selected():Boolean
public function set selected(value:Boolean):void

toggle


toggle:Boolean

Gets or sets the toggle property of the button. When set to true, the button's selected state is toggled when the button is released. When the user touches the button, the button remains selected. When the user touches the button again, the button is released.

         private function initializeUI():void
         {
             mySimpleButton = new Button();            
             mySimpleButton.width = 100;
             mySimpleButton.setPosition(30, 30);
             mySimpleButton.toggle = true;
             mySimpleButton.selected = true;
         
             this.addChild(mySimpleButton);
                         
         }
         

The default value is false.


Implementation

public function get toggle():Boolean
public function set toggle(value:Boolean):void

Constructor Detail

Button()


public function Button()

Constructs a Button instance.