qnx.fuse.ui.expandablecontrol.ExpandableControlLabelButton

ExpandableControlLabelButton

Properties | Methods | Events


Packageqnx.fuse.ui.expandablecontrol
Classpublic class ExpandableControlLabelButton
InheritanceExpandableControlLabelButton Inheritance LabelButton Inheritance Button Inheritance SkinnableComponent Inheritance UIComponent Inheritance flash.display.MovieClip

The ExpandableControlLabelButton is by the ExpandableControl class as its button.

Class information:
BlackBerry 10 Version:   10.0.0



Public Properties

 PropertyDefined By
  animationTime : Number
Gets or sets the animation time of the tweens.
ExpandableControlLabelButton
  arrowPaddingRight : int
Gets or sets the arrow padding right.
ExpandableControlLabelButton
 InheritedcontextActions : Vector.<ActionSet>
Gets or Sets a Vector of ActionSet objects.
UIComponent
 InheritedcontextMultiSelectText : String
Gets or Sets a String to be displayed when showing the Multi Select Context Menu.
UIComponent
 InheritedcurrentTheme : String
[read-only] Returns the current theme this component is styled with.
UIComponent
 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
 Inheritedid : String
The id is a name for the component that can be used in CSS using the # selector.
UIComponent
 InheritedincludeInLayout : Boolean
Specifies whether or not the component should be included in its parent container's layout.
UIComponent
 Inheritedlabel : String
Gets or sets the label for the button.
LabelButton
 InheritedlayoutData : Object
Gets or sets the layoutData.
UIComponent
 Inheritedlocale : String
Gets or sets the current locale of the component.
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
  open : Boolean
Gets or sets whether the button is in the open state (arrow pointing upwards) or in the closed state (arrow pointing downwards)
ExpandableControlLabelButton
 InheritedpaddingBottom : uint
Sets the number of extra pixels that are added to the bottom of the label, between the text and the border of the button.
LabelButton
 InheritedpaddingLeft : uint
Sets the number of extra pixels that are added to the left of the label, between the border of the button and the text.
LabelButton
 InheritedpaddingRight : uint
Sets the number of extra pixels that are added to the right of the label, between the text and the border of the button.
LabelButton
 InheritedpaddingTop : uint
Sets the number of extra pixels that are added to the top of the label, between the border of the button and the text.
LabelButton
 Inheritedselected : Boolean
Setting the selected property changes the visual state of the Button to selected.
Button
 Inheritedstate : String
Gets or sets the state of the component.
SkinnableComponent
 InheritedstyleChildren : Boolean
Allows you to style the children of this component with CSS.
UIComponent
 Inheritedtoggle : Boolean
The toggle property allows the button to switch between its selected and released states each time it's tapped.
Button
 InheritedtruncationMode : String
Gets or sets the truncationMode of the button, which defines how the label in the button will be treated when the it is too large to appear within the dimensions of the button.
LabelButton
  valueLabel : String
Gets or sets the value label.
ExpandableControlLabelButton

Protected Properties

 PropertyDefined By
 InheritedaccessibilityImplimentationClass : Class
UIComponent
  cssID : String
[override] [read-only] Returns the CSS ID of the component.
ExpandableControlLabelButton
 InheritedexplicitLocale : Boolean
Set to true when the locale property has been set externally.
UIComponent
 InheritedinternalID : String
The Component's Id used for styling.
UIComponent
 InheritedlongPressEnabled : Boolean
Specifies whether the UIComponent can detect a long press.
UIComponent

Public Methods

 MethodDefined By
  
Creates a new ExpandableControlLabelButton instance.
ExpandableControlLabelButton
 Inherited
Cancels a long press from occuring on the component.
UIComponent
 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
configureStyles(styles:Array):void
[override] The SkinnableComponent version styles the component with the base style first, and then styles it with the current state's style.
SkinnableComponent
 Inherited
destroy():void
Call this method when you want to have your object collected by the garbage collector.
UIComponent
 Inherited
Returns the CSS selector for the object, composing it from its position in the display hierarchy and an optional ID selector.
UIComponent
 Inherited
Returns the size options for the given control.
UIComponent
  
getSkinLayoutRect():Rectangle
Returns the layout rectangle of the skin.
ExpandableControlLabelButton
 Inherited
Returns the TextFormat object for a specified state.
LabelButton
 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
  
setArrowSkin(newSkin:Object):void
Sets the skin to use for the arrow.
ExpandableControlLabelButton
 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
setTextFormatForState(format:TextFormat, stateToModify:String):void
Sets the TextFormat object for the label for a given state.
LabelButton
 Inherited
updateDefaultLocale(updateChildren:Boolean = true):void
Updates the locale property to be the same as the locale of the device.
UIComponent
 Inherited
[override] Updates the internal Label component to reflect the latest font settings.
LabelButton
 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
allowShowContextMenu(target:IEventDispatcher):Boolean
When the user presses on the component this method is called with the object that dispatched the event.
UIComponent
 Inherited
Process properties of the component.
UIComponent
 Inherited
Process the state of the component.
UIComponent
 Inherited
Style the component after the style has changed.
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
excemptFromCSSStyling(target:*, property:String = null):void
Exempts a property on an object from being styled by CSS.
UIComponent
 Inherited
flushCache():void
Invoked as part of parentLayoutChanged.
UIComponent
 Inherited
getStyleApplier():Function
A style applier is a method that gets called every time a property from the stylesheet should be applied to the component.
UIComponent
 Inherited
getStyleForState(state:String):IStyleable
A utility method to get the styling information for a given state.
SkinnableComponent
 Inherited
onAdded():void
Called when the instance is added to the stage.
UIComponent
 Inherited
Is called when a user is no longer long pressing on the component.
UIComponent
 Inherited
Is called when a user long presses on the component.
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
Calling this function will refresh the ContextMenu with whatever actions were set by contextActions.
UIComponent
 Inherited
Shows the context menu if there are contextActions associated with the control.
UIComponent
 Inherited
styleState():void
Style the component after state has changed.
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's dimensions.
SkinnableComponent

Events

 Event Summary Defined By
 InheritedDispatched when an action in the Context Menu is selected.UIComponent
 InheritedDispatched when the Context Menu has closed to the DISMISSED state.UIComponent
 InheritedDispatched when the ContextMenu is closing to the DISMISSED state.UIComponent
 InheritedDispatched when the Context Menu has opened to the PEEK or EXPANDED state.UIComponent
 InheritedDispatched when the ContextMenu is opening from the DISMISSED state.UIComponent
 InheritedDispatched when the CrossCut multiselect has been canceled.UIComponent

Property Detail

animationTime


animationTime:Number

Gets or sets the animation time of the tweens.


Implementation

public function get animationTime():Number
public function set animationTime(value:Number):void

arrowPaddingRight


arrowPaddingRight:int

Gets or sets the arrow padding right.

This is the space between the right side of the button and the right side of the arrow.


Implementation

public function get arrowPaddingRight():int
public function set arrowPaddingRight(value:int):void

cssID


cssID:String  [read-only]
[override]

Returns the CSS ID of the component. The CSS ID is used for identifying the type of component in CSS.

The default value is ExpandableControlLabelButton.


Implementation

protected function get cssID():String

open


open:Boolean

Gets or sets whether the button is in the open state (arrow pointing upwards) or in the closed state (arrow pointing downwards)


Implementation

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

valueLabel


valueLabel:String

Gets or sets the value label.

The default value is "".


Implementation

public function get valueLabel():String
public function set valueLabel(value:String):void

Constructor Detail

ExpandableControlLabelButton()


public function ExpandableControlLabelButton()

Creates a new ExpandableControlLabelButton instance.

Method Detail

getSkinLayoutRect()


public function getSkinLayoutRect():Rectangle

Returns the layout rectangle of the skin.

Returns

Rectangle — The Rectangle from calling the getLayoutRect() method of the skin.

setArrowSkin()


public function setArrowSkin(newSkin:Object):void

Sets the skin to use for the arrow.

The skin for the arrow must implement the ISkin interface. The default arrow skin is ExpandableControlButtonArrowSkin

Parameters

newSkin:Object — A new arrow skin for the button.





comments powered by Disqus