fl.controls.LabelButton - ActionScript® 3.0 Reference for the Adobe® Flash® Platform

Package	fl.controls
Class	public class LabelButton
Inheritance	LabelButton BaseButton UIComponent Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object
Implements	IFocusManagerComponent
Subclasses	Button, CellRenderer, CheckBox, HeaderRenderer, RadioButton

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

The LabelButton class is an abstract class that extends the BaseButton class by adding a label, an icon, and toggle functionality. The LabelButton class is subclassed by the Button, CheckBox, RadioButton, and CellRenderer classes.

The LabelButton component is used as a simple button class that can be combined with custom skin states that support ScrollBar buttons, NumericStepper buttons, ColorPicker swatches, and so on.

View the examples

Related API Elements

fl.controls.BaseButton

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		accessibilityImplementation : AccessibilityImplementation The current accessibility implementation (AccessibilityImplementation) for this InteractiveObject instance.	InteractiveObject
		accessibilityProperties : AccessibilityProperties The current accessibility options for this display object.	DisplayObject
		alpha : Number Indicates the alpha transparency value of the object specified.	DisplayObject
		autoRepeat : Boolean Gets or sets a Boolean value that indicates whether the buttonDown event is dispatched more than one time when the user holds the mouse button down over the component.	BaseButton
		blendMode : String A value from the BlendMode class that specifies which blend mode to use.	DisplayObject
		blendShader : Shader [write-only] Sets a shader that is used for blending the foreground and background.	DisplayObject
		buttonMode : Boolean Specifies the button mode of this sprite.	Sprite
		cacheAsBitmap : Boolean If set to true, Flash runtimes cache an internal bitmap representation of the display object.	DisplayObject
		cacheAsBitmapMatrix : Matrix If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true.	DisplayObject
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		contextMenu : NativeMenu Specifies the context menu associated with this object.	InteractiveObject
		doubleClickEnabled : Boolean Specifies whether the object receives doubleClick events.	InteractiveObject
		dropTarget : DisplayObject [read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.	Sprite
		enabled : Boolean [override] Gets or sets a value that indicates whether the component can accept user input.	BaseButton
		filters : Array An indexed array that contains each filter object currently associated with the display object.	DisplayObject
		focusEnabled : Boolean Gets or sets a Boolean value that indicates whether the component can receive focus after the user clicks it.	UIComponent
		focusManager : IFocusManager Gets or sets the FocusManager that controls focus for this component and its peers.	UIComponent
		focusRect : Object Specifies whether this object displays a focus rectangle.	InteractiveObject
		graphics : Graphics [read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.	Sprite
		height : Number [override] Gets or sets the height of the component, in pixels.	UIComponent
		hitArea : Sprite Designates another sprite to serve as the hit area for a sprite.	Sprite
		label : String Gets or sets the text label for the component.	LabelButton
		labelPlacement : String Position of the label in relation to a specified icon.	LabelButton
		loaderInfo : LoaderInfo [read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.	DisplayObject
		mask : DisplayObject The calling display object is masked by the specified mask object.	DisplayObject
		mouseChildren : Boolean Determines whether or not the children of the object are mouse, or user input device, enabled.	DisplayObjectContainer
		mouseEnabled : Boolean Specifies whether this object receives mouse, or other user input, messages.	InteractiveObject
		mouseFocusEnabled : Boolean Gets or sets a value that indicates whether the component can receive focus after the user clicks it.	UIComponent
		mouseX : Number [read-only] Indicates the x coordinate of the mouse or user input device position, in pixels.	DisplayObject
		mouseY : Number [read-only] Indicates the y coordinate of the mouse or user input device position, in pixels.	DisplayObject
		name : String Indicates the instance name of the DisplayObject.	DisplayObject
		needsSoftKeyboard : Boolean Specifies whether a virtual keyboard (an on-screen, software keyboard) should display when this InteractiveObject instance receives focus.	InteractiveObject
		numChildren : int [read-only] Returns the number of children of this object.	DisplayObjectContainer
		opaqueBackground : Object Specifies whether the display object is opaque with a certain background color.	DisplayObject
		parent : DisplayObjectContainer [read-only] Indicates the DisplayObjectContainer object that contains this display object.	DisplayObject
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		root : DisplayObject [read-only] For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file.	DisplayObject
		rotation : Number Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.	DisplayObject
		rotationX : Number Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		rotationY : Number Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		rotationZ : Number Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		scale9Grid : Rectangle The current scaling grid that is in effect.	DisplayObject
		scaleX : Number [override] Multiplies the current width of the component by a scale factor.	UIComponent
		scaleY : Number [override] Multiplies the current height of the component by a scale factor.	UIComponent
		scaleZ : Number Indicates the depth scale (percentage) of an object as applied from the registration point of the object.	DisplayObject
		scrollRect : Rectangle The scroll rectangle bounds of the display object.	DisplayObject
		selected : Boolean [override] Gets or sets a Boolean value that indicates whether a toggle button is toggled in the on or off position.	LabelButton
		softKeyboardInputAreaOfInterest : Rectangle Defines the area that should remain on-screen when a soft keyboard is displayed.	InteractiveObject
		soundTransform : flash.media:SoundTransform Controls sound within this sprite.	Sprite
		stage : Stage [read-only] The Stage of the display object.	DisplayObject
		tabChildren : Boolean Determines whether the children of the object are tab enabled.	DisplayObjectContainer
		tabEnabled : Boolean Specifies whether this object is in the tab order.	InteractiveObject
		tabIndex : int Specifies the tab ordering of objects in a SWF file.	InteractiveObject
		textField : flash.text:TextField A reference to the component's internal text field.	LabelButton
		textSnapshot : flash.text:TextSnapshot [read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.	DisplayObjectContainer
		toggle : Boolean Gets or sets a Boolean value that indicates whether a button can be toggled.	LabelButton
		transform : flash.geom:Transform An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.	DisplayObject
		useHandCursor : Boolean A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls over a sprite in which the buttonMode property is set to true.	Sprite
		visible : Boolean [override] Gets or sets a value that indicates whether the current component instance is visible.	UIComponent
		width : Number [override] Gets or sets the width of the component, in pixels.	UIComponent
		x : Number [override] Gets or sets the x coordinate that represents the position of the component along the x axis within its parent container.	UIComponent
		y : Number [override] Gets or sets the y coordinate that represents the position of the component along the y axis within its parent container.	UIComponent
		z : Number Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.	DisplayObject

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		LabelButton() Creates a new LabelButton component instance.	LabelButton
		addChild(child:DisplayObject):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance.	DisplayObjectContainer
		addChildAt(child:DisplayObject, index:int):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance.	DisplayObjectContainer
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		areInaccessibleObjectsUnderPoint(point:Point):Boolean Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point.	DisplayObjectContainer
		clearStyle(style:String):void Deletes a style property from this component instance.	UIComponent
		contains(child:DisplayObject):Boolean Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.	DisplayObjectContainer
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		drawFocus(focused:Boolean):void Shows or hides the focus indicator on this component.	UIComponent
		drawNow():void Initiates an immediate draw operation, without invalidating everything as invalidateNow does.	UIComponent
		getBounds(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.	DisplayObject
		getChildAt(index:int):DisplayObject Returns the child display object instance that exists at the specified index.	DisplayObjectContainer
		getChildByName(name:String):DisplayObject Returns the child display object that exists with the specified name.	DisplayObjectContainer
		getChildIndex(child:DisplayObject):int Returns the index position of a child DisplayObject instance.	DisplayObjectContainer
		getFocus():InteractiveObject Retrieves the object that currently has focus.	UIComponent
		getObjectsUnderPoint(point:Point):Array Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.	DisplayObjectContainer
		getRect(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the boundary of the display object, based on the coordinate system defined by the targetCoordinateSpace parameter, excluding any strokes on shapes.	DisplayObject
		getStyle(style:String):Object Retrieves a style property that is set in the style lookup chain of the component.	UIComponent
		getStyleDefinition():Object [static] Retrieves the default style map for the current component.	LabelButton
		globalToLocal(point:Point):Point Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.	DisplayObject
		globalToLocal3D(point:Point):Vector3D Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.	DisplayObject
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		hitTestObject(obj:DisplayObject):Boolean Evaluates the bounding box of the display object to see if it overlaps or intersects with the bounding box of the obj display object.	DisplayObject
		hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters.	DisplayObject
		invalidate(property:String, callLater:Boolean = true):void Marks a property as invalid and redraws the component on the next frame unless otherwise specified.	UIComponent
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		local3DToGlobal(point3d:Vector3D):Point Converts a three-dimensional point of the three-dimensional display object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.	DisplayObject
		localToGlobal(point:Point):Point Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.	DisplayObject
		mergeStyles(... list):Object [static] Merges the styles from multiple classes into one object.	UIComponent
		move(x:Number, y:Number):void Moves the component to the specified position within its parent.	UIComponent
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeChild(child:DisplayObject):DisplayObject Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.	DisplayObjectContainer
		removeChildAt(index:int):DisplayObject Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.	DisplayObjectContainer
		removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):void Removes one or more child DisplayObject instances from the DisplayObjectContainer instance.	DisplayObjectContainer
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		requestSoftKeyboard():Boolean Raises a virtual keyboard.	InteractiveObject
		setChildIndex(child:DisplayObject, index:int):void Changes the position of an existing child in the display object container.	DisplayObjectContainer
		setFocus():void Sets the focus to this component.	UIComponent
		setMouseState(state:String):void Set the mouse state via ActionScript.	BaseButton
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		setSize(width:Number, height:Number):void Sets the component to the specified width and height.	UIComponent
		setStyle(style:String, value:Object):void Sets a style property on this component instance.	UIComponent
		startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite.	Sprite
		startTouchDrag(touchPointID:int, lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite on a touch-enabled device.	Sprite
		stopDrag():void Ends the startDrag() method.	Sprite
		stopTouchDrag(touchPointID:int):void Ends the startTouchDrag() method, for use with touch-enabled devices.	Sprite
		swapChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the z-order (front-to-back order) of the two specified child objects.	DisplayObjectContainer
		swapChildrenAt(index1:int, index2:int):void Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.	DisplayObjectContainer
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		validateNow():void Validates and updates the properties and layout of this object, redrawing it if necessary.	UIComponent
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		getStyleValue(name:String):Object Returns the specified style for a component, considering all styles set on the global level, component level and instance level.	UIComponent

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
added	Dispatched when a display object is added to the display list.	DisplayObject
addedToStage	Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.	DisplayObject
buttonDown	Dispatched when the user presses the Button component.	BaseButton
change	Dispatched when the value of the selected property of a toggle Button component changes.	BaseButton
clear	Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.	InteractiveObject
click	Dispatched after the toggle button receives input from a mouse device or from the spacebar.	LabelButton
contextMenu	Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application.	InteractiveObject
copy	Dispatched when the user activates the platform-specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu.	InteractiveObject
cut	Dispatched when the user activates the platform-specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu.	InteractiveObject
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
doubleClick	Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true.	InteractiveObject
enterFrame	[broadcast event] Dispatched when the playhead is entering a new frame.	DisplayObject
exitFrame	[broadcast event] Dispatched when the playhead is exiting the current frame.	DisplayObject
focusIn	Dispatched after a display object gains focus.	InteractiveObject
focusOut	Dispatched after a display object loses focus.	InteractiveObject
frameConstructed	[broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.	DisplayObject
gesturePan	Dispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a finger from left to right over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
gesturePressAndTap	Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen).	InteractiveObject
gestureRotate	Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
gestureSwipe	Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
gestureTwoFingerTap	Dispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
gestureZoom	Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
hide	Dispatched after the component visibility changes from visible to invisible.	UIComponent
imeStartComposition	This event is dispatched to any client app that supports inline input with an IME	InteractiveObject
keyDown	Dispatched when the user presses a key.	InteractiveObject
keyFocusChange	Dispatched when the user attempts to change focus by using keyboard navigation.	InteractiveObject
keyUp	Dispatched when the user releases a key.	InteractiveObject
labelChange	Dispatched after the label value changes.	LabelButton
middleClick	Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.	InteractiveObject
middleMouseDown	Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.	InteractiveObject
middleMouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseDown	Dispatched when a user presses the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseFocusChange	Dispatched when the user attempts to change focus by using a pointer device.	InteractiveObject
mouseMove	Dispatched when a user moves the pointing device while it is over an InteractiveObject.	InteractiveObject
mouseOut	Dispatched when the user moves a pointing device away from an InteractiveObject instance.	InteractiveObject
mouseOver	Dispatched when the user moves a pointing device over an InteractiveObject instance.	InteractiveObject
mouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseWheel	Dispatched when a mouse wheel is spun over an InteractiveObject instance.	InteractiveObject
move	Dispatched after the component is moved.	UIComponent
nativeDragComplete	Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.	InteractiveObject
nativeDragDrop	Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop().	InteractiveObject
nativeDragEnter	Dispatched by an InteractiveObject when a drag gesture enters its boundary.	InteractiveObject
nativeDragExit	Dispatched by an InteractiveObject when a drag gesture leaves its boundary.	InteractiveObject
nativeDragOver	Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary.	InteractiveObject
nativeDragStart	Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.	InteractiveObject
nativeDragUpdate	Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.	InteractiveObject
paste	Dispatched when the user activates the platform-specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu.	InteractiveObject
proximityBegin	Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen.	InteractiveObject
proximityEnd	Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.	InteractiveObject
proximityMove	Dispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold.	InteractiveObject
proximityOut	Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen.	InteractiveObject
proximityOver	Dispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen.	InteractiveObject
proximityRollOut	Dispatched when the user moves an active stylus away from this InteractiveObject and any of its children while remaining within the proximity detection threshold of the screen.	InteractiveObject
proximityRollOver	Dispatched when the user moves an active stylus over this InteractiveObject from outside the object's tree of descendents in the display list (while remaining within the proximity detection threshold of the screen).	InteractiveObject
removed	Dispatched when a display object is about to be removed from the display list.	DisplayObject
removedFromStage	Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.	DisplayObject
render	[broadcast event] Dispatched when the display list is about to be updated and rendered.	DisplayObject
resize	Dispatched after the component is resized.	UIComponent
rightClick	Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.	InteractiveObject
rightMouseDown	Dispatched when a user presses the pointing device button over an InteractiveObject instance.	InteractiveObject
rightMouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
rollOut	Dispatched when the user moves a pointing device away from an InteractiveObject instance.	InteractiveObject
rollOver	Dispatched when the user moves a pointing device over an InteractiveObject instance.	InteractiveObject
selectAll	Dispatched when the user activates the platform-specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu.	InteractiveObject
show	Dispatched after the component visibility changes from invisible to visible.	UIComponent
softKeyboardActivate	Dispatched immediately after the soft keyboard is raised.	InteractiveObject
softKeyboardActivating	Dispatched immediately before the soft keyboard is raised.	InteractiveObject
softKeyboardDeactivate	Dispatched immediately after the soft keyboard is lowered.	InteractiveObject
tabChildrenChange	Dispatched when the value of the object's tabChildren flag changes.	InteractiveObject
tabEnabledChange	Dispatched when the object's tabEnabled flag changes.	InteractiveObject
tabIndexChange	Dispatched when the value of the object's tabIndex property changes.	InteractiveObject
textInput	Dispatched when a user enters one or more characters of text.	InteractiveObject
touchBegin	Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).	InteractiveObject
touchEnd	Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).	InteractiveObject
touchMove	Dispatched when the user moves the point of contact with a touch-enabled device (such as drags a finger across a mobile phone or tablet with a touch screen).	InteractiveObject
touchOut	Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen).	InteractiveObject
touchOver	Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
touchRollOut	Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen).	InteractiveObject
touchRollOver	Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
touchTap	Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject

Styles

Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.

Common Styles

Click for more information on styles

Hide Inherited Styles

Show Inherited Styles

	Description	Defined By
disabledIcon	Type: Class Name of the class to use as the icon when the button is disabled. The default value is `null`.	LabelButton
disabledSkin	Type: Class Name of the class to use as the skin for the background and border when the button is not selected and is disabled. The default value is `Button_disabledSkin`.	LabelButton
disabledTextFormat	Type: flash.text.TextFormat The TextFormat object to use to render the component label when the button is disabled.	UIComponent
downIcon	Type: Class Name of the class to use as the icon when the button is not selected and the mouse button is down. The default value is `null`.	LabelButton
downSkin	Type: Class Name of the class to use as the skin for the background and border when the button is not selected and the mouse button is down. The default value is `Button_downSkin`.	LabelButton
embedFonts	Type: Boolean Indicates whether embedded font outlines are used to render the text field. If this value is `true`, Flash Player renders the text field by using embedded font outlines. If this value is `false`, Flash Player renders the text field by using device fonts. If you set the `embedFonts` property to `true` for a text field, you must specify a font for that text by using the `font` property of a TextFormat object that is applied to the text field. If the specified font is not embedded in the SWF file, the text is not displayed. The default value is `false`.	LabelButton
focusRectPadding	Type: Number Format: Length The padding that separates the outside boundaries of the component from the outside edges of the focus indicator, in pixels.	UIComponent
focusRectSkin	Type: Class The skin to be used to display focus indicators.	UIComponent
icon	Type: Class Name of the class to use as the icon when a toggle button is not selected and the mouse is not over the button. The default value is `null`.	LabelButton
overIcon	Type: Class Name of the class to use as the icon when the button is not selected and the mouse is over the component. The default value is `null`.	LabelButton
overSkin	Type: Class Name of the class to use as the skin for the background and border when the button is not selected and the mouse is over the component. The default value is `Button_overSkin`.	LabelButton
repeatDelay	Type: Number Format: Time The number of milliseconds to wait after the `buttonDown` event is first dispatched before sending a second `buttonDown` event. The default value is `500`.	LabelButton
repeatInterval	Type: Number Format: Time The interval, in milliseconds, between `buttonDown` events that are dispatched after the delay that is specified by the `repeatDelay` style. The default value is `35`.	LabelButton
selectedDisabledIcon	Type: Class Name of the class to use as the icon when the button is selected and disabled. The default value is `null`.	LabelButton
selectedDisabledSkin	Type: Class Name of the class to use as the skin for the background and border when a toggle button is selected and disabled. The default value is `Button_selectedDisabledSkin`.	LabelButton
selectedDownIcon	Type: Class Name of the class to use as the icon when the button is selected and the mouse button is down. The default value is `null`.	LabelButton
selectedDownSkin	Type: Class Name of the class to use as the skin for the background and border when a toggle button is selected and the mouse button is down. The default value is `Button_selectedDownSkin`.	LabelButton
selectedOverIcon	Type: Class Name of the class to use as the icon when the button is selected and the mouse is over the component. The default value is `null`.	LabelButton
selectedOverSkin	Type: Class Name of the class to use as the skin for the background and border when a toggle button is selected and the mouse is over the component. The default value is `Button_selectedOverSkin`.	LabelButton
selectedUpIcon	Type: Class Name of the class to use as the icon when the button is selected and the mouse button is up. The default value is `null`.	LabelButton
selectedUpSkin	Type: Class Name of the class to use as the skin for the background and border when a toggle button is selected and the mouse is not over the component. The default value is `Button_selectedUpSkin`.	LabelButton
textFormat	Type: flash.text.TextFormat The TextFormat object to use to render the component label.	UIComponent
textPadding	Type: Number Format: Length The spacing between the text and the edges of the component, and the spacing between the text and the icon, in pixels. The default value is `5`.	LabelButton
upIcon	Type: Class Name of the class to use as the icon when a toggle button is not selected and the mouse is not over the button. The default value is `null`.	LabelButton
upSkin	Type: Class Name of the class to use as the skin for the background and border when the button is not selected and the mouse is not over the component. The default value is `Button_upSkin`.	LabelButton

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		version : String = "3.0.3.1" The version number of the components.	UIComponent

Property Detail

label

property

label:String

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets or sets the text label for the component. By default, the label text appears centered on the button.

Note: Setting this property triggers the labelChange event object to be dispatched.

The default value is "Label".

Implementation
public function get label():String
public function set label(value:String):void

Related API Elements

labelChange

labelPlacement

property

labelPlacement:String

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Position of the label in relation to a specified icon.

In ActionScript, you can use the following constants to set this property:

ButtonLabelPlacement.RIGHT
ButtonLabelPlacement.LEFT
ButtonLabelPlacement.BOTTOM
ButtonLabelPlacement.TOP

The default value is ButtonLabelPlacement.RIGHT.

Implementation
public function get labelPlacement():String
public function set labelPlacement(value:String):void

Related API Elements

ButtonLabelPlacement

Example ( How to use this example )

The following example creates a Button component instance and sets its labelPlacement property to ButtonLabelPlacement.BOTTOM:


import fl.controls.Button;
import fl.controls.ButtonLabelPlacement;

var myButton:Button = new Button();
myButton.label = "ButtonLabelPlacement.BOTTOM";
myButton.labelPlacement = ButtonLabelPlacement.BOTTOM;
myButton.setStyle("icon", myLibraryAsset);
myButton.setSize(200, 100);
myButton.move(10, 10);
addChild(myButton);

selected

property

selected:Boolean[override]

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets or sets a Boolean value that indicates whether a toggle button is toggled in the on or off position. A value of true indicates that it is toggled in the on position; a value of false indicates that it is toggled in the off position. This property can be set only if the toggle property is set to true.

For a CheckBox component, this value indicates whether the box displays a check mark. For a RadioButton component, this value indicates whether the component is selected.

The user can change this property by clicking the component, but you can also set this property programmatically.

If the toggle property is set to true, changing this property also dispatches a change event.

The default value is false.

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

Example ( How to use this example )

The following example demonstrates how you can create a toggle button using the toggle property and listening for the change event to determine when a button is selected:


import fl.controls.Button;

var myButton:Button = new Button();
myButton.toggle = true;
myButton.move(10, 10);
myButton.addEventListener(Event.CHANGE, changeHandler);
addChild(myButton);

function changeHandler(event:Event):void {
    trace("Button toggled (selected:" + event.currentTarget.selected + ")");
}

textField

property

public var textField:flash.text:TextField

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

A reference to the component's internal text field.

toggle

property

toggle:Boolean

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets or sets a Boolean value that indicates whether a button can be toggled. A value of true indicates that it can; a value of false indicates that it cannot.

If this value is true, clicking the button toggles it between selected and unselected states. You can get or set this state programmatically by using the selected property.

If this value is false, the button does not stay pressed after the user releases it. In this case, its selected property is always false.

Note: When the toggle is set to false, selected is forced to false because only toggle buttons can be selected.

The default value is false.

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

Example ( How to use this example )

The following example creates a toggleable Button by setting its toggle property to true and listening for its change event to be dispatched:


import fl.controls.Button;

var myButton:Button = new Button();
myButton.toggle = true;
myButton.selected = true;
myButton.label = "selected:" + myButton.selected;
myButton.width = 120;
myButton.move(10, 10);
myButton.addEventListener(Event.CHANGE, changeHandler);
addChild(myButton);

function changeHandler(event:Event):void {
    var myBtn:Button = event.currentTarget as Button;
    myBtn.label = "selected:" + myBtn.selected;
}

Constructor Detail

LabelButton

()

Constructor

public function LabelButton()

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Creates a new LabelButton component instance.

Method Detail

getStyleDefinition

()

method

public static function getStyleDefinition():Object

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Retrieves the default style map for the current component. The style map contains the type that is appropriate for the component, depending on the style that the component uses. For example, the disabledTextFormat style contains a value of null or a TextFormat object. You can use these styles and call setStyle() on the current component. The following code overrides the default disabledTextFormat style on the specified component:

componentInstance.setStyle("disabledTextFormat", new TextFormat());

Returns

Object — Default styles object.

Related API Elements

fl.core.UIComponent.getStyle()
fl.core.UIComponent.setStyle()
fl.managers.StyleManager

Example ( How to use this example )

The following example creates a style browser for several component classes:

import fl.controls.*;
import fl.containers.*;
import fl.controls.listClasses.*;
import fl.controls.dataGridClasses.*;
import fl.controls.progressBarClasses.*;
import fl.core.UIComponent;
import fl.data.DataProvider;

var dp:DataProvider = new DataProvider();
dp.addItem( { label: "BaseScrollPane",    data:BaseScrollPane } );
dp.addItem( { label: "Button",             data:Button } );
dp.addItem( { label: "CellRenderer",    data:CellRenderer } );
dp.addItem( { label: "CheckBox",         data:CheckBox } );
dp.addItem( { label: "ColorPicker",     data:ColorPicker } );
dp.addItem( { label: "ComboBox",         data:ComboBox } );
dp.addItem( { label: "DataGrid",         data:DataGrid } );
dp.addItem( { label: "HeaderRenderer",    data:HeaderRenderer } );
dp.addItem( { label: "ImageCell",        data:ImageCell } );
dp.addItem( { label: "IndeterminateBar",data:IndeterminateBar } );
dp.addItem( { label: "Label",             data:Label } );
dp.addItem( { label: "List",             data:List } );
dp.addItem( { label: "NumericStepper",     data:NumericStepper } );
dp.addItem( { label: "ProgressBar",     data:ProgressBar } );
dp.addItem( { label: "RadioButton",     data:RadioButton } );
dp.addItem( { label: "ScrollPane",         data:ScrollPane } );
dp.addItem( { label: "Slider",             data:Slider } );
dp.addItem( { label: "TextArea",         data:TextArea } );
dp.addItem( { label: "TextInput",         data:TextInput } );
dp.addItem( { label: "TileList",         data:TileList } );
dp.addItem( { label: "UILoader",         data:UILoader } );
dp.addItem( { label: "UIComponent",     data:UIComponent } );

var cb:ComboBox = new ComboBox();
cb.move(10,10);
cb.setSize(300,25);
cb.prompt = "Select a component to view its styles";
cb.rowCount = 12;
cb.dataProvider = dp;
cb.addEventListener(Event.CHANGE, showStyleDefinition);
addChild(cb);

var dg:DataGrid = new DataGrid();
dg.setSize(425,300);
dg.move(10,50);
dg.columns = [ new DataGridColumn("StyleName"), new DataGridColumn("DefaultValue") ];
addChild(dg);

function showStyleDefinition(e:Event):void {
    var componentClass:Class = e.target.selectedItem.data as Class;
    var styles:Object = componentClass["getStyleDefinition"].call(this);
    trace(styles.toString());
    var styleData:DataProvider = new DataProvider();
    for(var i:* in styles) {
        trace(i + " : " + styles[i]);
        styleData.addItem( { StyleName:i, DefaultValue:styles[i] } );
    }
    styleData.sortOn("StyleName");
    dg.dataProvider = styleData;
}

Event Detail

click

Event

Event Object Type: flash.events.MouseEvent
property MouseEvent.type = flash.events.MouseEvent.CLICK

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Dispatched after the toggle button receives input from a mouse device or from the spacebar.

Defines the value of the type property of a click event object.

This event has the following properties:

Property	Value
`altKey`	`true` if the Alt key is active (Windows).
`bubbles`	`true`
`buttonDown`	For click events, this value is always `false`.
`cancelable`	`false`; there is no default behavior to cancel.
`commandKey`	`true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey`	`true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey`	`true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`localX`	The horizontal coordinate at which the event occurred relative to the containing sprite.
`localY`	The vertical coordinate at which the event occurred relative to the containing sprite.
`shiftKey`	`true` if the Shift key is active; `false` if it is inactive.
`stageX`	The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY`	The vertical coordinate at which the event occurred in global stage coordinates.
`target`	The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

Example ( How to use this example )

The following example creates a Button component instance and listens for the click event to be dispatched:


import fl.controls.Button;

var myButton:Button = new Button();
myButton.label = "Click me";
myButton.addEventListener(MouseEvent.CLICK, clickHandler);
myButton.move(10, 10);
addChild(myButton);

function clickHandler(event:MouseEvent):void {
    trace("clicked (localX:" + event.localX + ", localY:" + event.localY + ")");
}

labelChange

Event

Event Object Type: fl.events.ComponentEvent
property ComponentEvent.type = fl.events.ComponentEvent.LABEL_CHANGE

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Dispatched after the label value changes.

Defines the value of the type property of a labelChange event object.

This event has the following properties:

Property	Value
`bubbles`	`false`
`cancelable`	`false`; there is no default behavior to cancel.
`currentTarget`	The object that is actively processing the event object with an event listener.
`target`	The object that dispatched the event. The target is not always the object listening for the event. Use the `currentTarget` property to access the object that is listening for the event.

Example ( How to use this example )

The following example creates a Button component instance and listens for the labelChange event to be dispatched whenever the button's label property changes:


import fl.controls.Button;
import fl.events.ComponentEvent;

var myButton:Button = new Button();
myButton.addEventListener(ComponentEvent.LABEL_CHANGE, labelChangeHandler);
myButton.label = "Click me";
myButton.move(10, 10);
addChild(myButton);

function labelChangeHandler(event:ComponentEvent):void {
    trace("labelChange: " + event.currentTarget.label);
}

Examples How to use this example

LabelButtonExample.as

This example extends the functionality of the LabelButton class to create an icon that displays a tool tip when rolled over.

To run the example, follow these steps:

Add the List and Button components to the library.
Create an icon symbol and name it MyIcon.
In the symbol properties for MyIcon, toggle the option "Export for ActionScript".
Save this code as LabelButtonExample.as in the same directory as your FLA file.
Set the Document class in the FLA file to LabelButtonExample.

package
{ 
    import flash.display.Sprite;
    import flash.events.Event;
    import fl.data.DataProvider;
    import fl.controls.List;
    import fl.controls.ComboBox;
    import fl.core.UIComponent;
    import fl.events.ListEvent;
    
    public class LabelButtonExample extends Sprite
    {
        public function LabelButtonExample() {
            var myIcon:IconWithToolTip = new IconWithToolTip();
            myIcon.setStyle("icon", MyIcon);
            myIcon.iconDescription = "Icon Description";
            myIcon.move(50,50);
            addChild(myIcon);
        }
    }
}

IconWithToolTip.as

Save the following code as IconWithToolTip.as in the same directory as your FLA file:

package {
    import fl.controls.LabelButton;
    import flash.events.MouseEvent;
    import flash.text.TextField;
    import flash.text.TextFieldAutoSize;
    import flash.text.TextFormat;
    
    public class IconWithToolTip extends LabelButton
    {
        public var iconDescription:String = "";
        private var toolTip:TextField;
        private var format:TextFormat;
        
        public function IconWithToolTip() {
            addEventListener(MouseEvent.MOUSE_OVER,showToolTip);
            addEventListener(MouseEvent.MOUSE_OUT,hideToolTip);
            format = new TextFormat();
            format.font = "Verdana";
            format.size = 10;
            format.bold = true;
            createToolTip();
        }

        private function createToolTip():void {
            toolTip = new TextField();
            toolTip.background = true;
            toolTip.backgroundColor = 0xFFCC66;
            toolTip.border = true;
            toolTip.borderColor = 0x000000;
            toolTip.multiline = false;
            toolTip.autoSize = TextFieldAutoSize.CENTER;
            toolTip.visible = false;
            addChild(toolTip);            
        }

        private function showToolTip(e:MouseEvent):void {
            toolTip.text = iconDescription;
            toolTip.x = 20;
            toolTip.y = 0;
            toolTip.visible = true;
            toolTip.setTextFormat(format);
        }

        private function hideToolTip(e:MouseEvent):void {
            toolTip.visible = false;    
        }
    }
}

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

Classes x

label

labelPlacement

selected

textField

toggle

LabelButton

getStyleDefinition

click

labelChange