| Package | qnx.fuse.ui.core |
| Class | public class SkinnableComponent |
| Inheritance | SkinnableComponent  UIComponent flash.display.MovieClip |
| Subclasses | ActivityIndicator, Button, CellRenderer, ProgressBar, TextInputBase |
SkinnableComponent class is the base class for components that can be skinned.
| Property | Defined By | ||
|---|---|---|---|
 | explicitHeight : Number [read-only] | UIComponent | |
| explicitWidth : Number [read-only] | UIComponent | |
| includeInLayout : Boolean
Specifies if the component should be included in it's parent containers layout. | UIComponent | |
| layoutData : Object
Returns the layout data for the object. | UIComponent | |
| minHeight : Number
Sets the minimum preferred height of the control. | UIComponent | |
| minWidth : Number
Sets the minimum preferred width of the control. | UIComponent | |
| state : String
Gets or sets the state of the component. | SkinnableComponent | ||
| Method | Defined By | ||
|---|---|---|---|
Constructs a SkinnableComponent instance. | SkinnableComponent | ||
| 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 | |
| destroy():void
Call this method when you want to have your object collected by the garbage collector. | UIComponent | |
| getSizeOptions():int | UIComponent | |
| invalidateDisplayList():void
Calling this method results in a call to the components validateDisplayList() method before the display list is rendered. | UIComponent | |
| invalidateProperties():void
Calling this method results in a call to the components validateProperties() method before the display list is rendered. | UIComponent | |
| measure(availableWidth:Number, availableHeight:Number):LayoutMeasurement | UIComponent | |
| setActualSize(w:Number, h:Number):void
Sets the width and height of the object without setting
the explicitWidth and explicitHeight. | UIComponent | |
| setLayoutBounds(bounds:Rectangle):void
Sets the receiver's size and location to the rectangular area specified
by the arguments. | UIComponent | |
| setPosition(x:Number, y:Number):void
Sets the x and y position of the component. | UIComponent | |
setSkin(newSkin:Object):void
Set the skin object on the component for it to render. | SkinnableComponent | ||
| validateDisplayList():void
Validates the display list of the component by calling the updateDisplayList(). | UIComponent | |
| validateNow():void
Validates the component immediately by calling validateProperties(), validateSizes(), and validateDisplayList() if necessary. | UIComponent | |
| validateProperties():void
Validates the properties of the component by calling the commitProperties() method. | UIComponent | |
| Method | Defined By | ||
|---|---|---|---|
| commitProperties():void
Process properties of the component. | UIComponent | |
| commitState():void
Process the state of the component. | UIComponent | |
| doMeasure(availableWidth:Number, availableHeight:Number):LayoutMeasurement | UIComponent | |
| flushCache():void
Invoked as part of parentLayoutChanged. | UIComponent | |
| onAdded():void
Called when the instance is added to the stage. | UIComponent | |
| onRemoved():void
Called when the instance is removed from the stage. | UIComponent | |
| parentLayoutChanged():void
Invalidates the parent's size and display list if includeInLayout property is set to true. | UIComponent | |
| updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Sets the size and position of the children of the component. | UIComponent | |
updateSkin(unscaledWidth:Number, unscaledHeight:Number):void
Updates the skin. | SkinnableComponent | ||
| state | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesstate:StringGets or sets the state of the component.
Each component and skin may implement different states. When possible this property should be set to one of the values in the SkinStates class.
When a state change occurs the commitProperties() method is called.
This is where you can adjust the state of any children in your own components to reflect the new state.
public function get state():String public function set state(value:String):voidSee also
| SkinnableComponent | () | Constructor |
public function SkinnableComponent()
Constructs a SkinnableComponent instance.
| setSkin | () | method |
public function setSkin(newSkin:Object):voidSet the skin object on the component for it to render.
If a skin is found, it is removed and a new skin is created.
The cellSkin parameter can be one of three different types: Class, String, or DisplayObject instance.
Class, a new instance of that class is created and returned.String, the flash.utils.getDefinitionByName will attempt to create a new method.DisplayObject instance, the x and y values of the instance are set to 0 and returned.Skins must implement the ISkin interface.
Parameters
newSkin:Object |
See also
| updateSkin | () | method |
protected function updateSkin(unscaledWidth:Number, unscaledHeight:Number):voidUpdates the skin.
This method is called from the updateDisplayList method with the same unscaledWidth and unscaledHeight values.
Component developers should override this method if they wish to position or change the size of the skin based on the components size.
Parameters
unscaledWidth:Number | |
unscaledHeight:Number |