qnx.fuse.ui.buttons.Button

Button

Properties | Methods


Packageqnx.fuse.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
 InheritedexplicitHeight : Number
[read-only] Returns the explicit height (actual height, in pixels) of the UI component.
UIComponent
 InheritedexplicitWidth : Number
[read-only] Returns the explicit width (actual width, in pixels) of the UI component.
UIComponent
 InheritedincludeInLayout : Boolean
Specifies whether or not the component should be included in its parent container's layout.
UIComponent
 InheritedlayoutData : Object
Returns the layout data for the object.
UIComponent
 InheritedminHeight : Number
Gets or sets the minimum preferred height of the control.
UIComponent
 InheritedminWidth : Number
Gets or sets the minimum preferred width of the control.
UIComponent
  selected : Boolean
Gets or sets the selected property of the button.
Button
 Inheritedstate : String
Gets or sets the state of the component.
SkinnableComponent
  toggle : Boolean
Gets or sets the toggle property of the button.
Button

Public Methods

 MethodDefined By
  
Constructs a Button instance.
Button
 Inherited
childChanged(resizedChild:DisplayObject = null):Boolean
Notifies the UIComponent that one or more of its children has changed in a manner that may affect this object's layout.
UIComponent
 Inherited
destroy():void
Call this method when you want to have your object collected by the garbage collector.
UIComponent
 Inherited
Returns the size options for the given control.
UIComponent
 Inherited
Calling this method results in a call to the components validateDisplayList() method before the display list is rendered.
UIComponent
 Inherited
Calling this method results in a call to the components validateProperties() method before the display list is rendered.
UIComponent
 Inherited
measure(availableWidth:Number, availableHeight:Number):LayoutMeasurement
This method calls doMeasure() in order to calculate the preferred size of the control.
UIComponent
 Inherited
setActualSize(w:Number, h:Number):void
Sets the width and height of the object without setting the explicitWidth and explicitHeight.
UIComponent
 Inherited
setLayoutBounds(bounds:Rectangle):void
Sets the receiver's size and location to the rectangular area specified by the arguments.
UIComponent
 Inherited
setPosition(x:Number, y:Number):void
Sets the x and y position of the component.
UIComponent
 Inherited
setSkin(newSkin:Object):void
Set the skin object on the component for it to render.
SkinnableComponent
 Inherited
Validates the display list of the component by calling the updateDisplayList().
UIComponent
 Inherited
Validates the component immediately by calling validateProperties(), validateSizes(), and validateDisplayList() if necessary.
UIComponent
 Inherited
Validates the properties of the component by calling the commitProperties() method.
UIComponent

Protected Methods

 MethodDefined By
 Inherited
Process properties of the component.
UIComponent
 Inherited
Process the state of the component.
UIComponent
 Inherited
doMeasure(availableWidth:Number, availableHeight:Number):LayoutMeasurement
Performs a measurement on the control, and returns a LayoutMeasurement instance containing the available width and height within the layout.
UIComponent
 Inherited
flushCache():void
Invoked as part of parentLayoutChanged.
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
Invalidates the parent's size and display list if includeInLayout property is set to true.
UIComponent
 Inherited
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Sets the size and position of the children of the component.
UIComponent
 Inherited
updateSkin(unscaledWidth:Number, unscaledHeight:Number):void
Updates the skin.
SkinnableComponent

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.