feathers.controls.renderers.BaseDefaultItemRenderer

Public Properties

	Property		Defined By
		accessoryField : String The field in the item that contains a display object to be positioned in the accessory position of the renderer.	BaseDefaultItemRenderer
		accessoryFunction : Function A function that returns a display object to be positioned in the accessory position of the renderer.	BaseDefaultItemRenderer
		accessoryGap : Number The space, in pixels, between the accessory and the other child it is positioned relative to.	BaseDefaultItemRenderer
		accessoryLabelFactory : Function A function that generates ITextRenderer that uses the result of accessoryLabelField or accessoryLabelFunction.	BaseDefaultItemRenderer
		accessoryLabelField : String The field in the item that contains a string to be displayed in a renderer-managed Label in the accessory position of the renderer.	BaseDefaultItemRenderer
		accessoryLabelFunction : Function A function that returns a string to be displayed in a renderer-managed Label in the accessory position of the renderer.	BaseDefaultItemRenderer
		accessoryLabelProperties : Object A set of key/value pairs to be passed down to a label accessory.	BaseDefaultItemRenderer
		accessoryLoaderFactory : Function A function that generates an ImageLoader that uses the result of accessorySourceField or accessorySourceFunction.	BaseDefaultItemRenderer
		accessoryOffsetX : Number Offsets the x position of the accessory by a certain number of pixels.	BaseDefaultItemRenderer
		accessoryOffsetY : Number Offsets the y position of the accessory by a certain number of pixels.	BaseDefaultItemRenderer
		accessoryPosition : String The location of the accessory, relative to one of the other children.	BaseDefaultItemRenderer
		accessorySourceField : String A field in the item that contains a starling.textures.Texture or a URL that points to a bitmap to be used as the item renderer's accessory.	BaseDefaultItemRenderer
		accessorySourceFunction : Function A function that generates a starling.textures.Texture or a URL that points to a bitmap to be used as the item renderer's accessory.	BaseDefaultItemRenderer
		alpha : Number The opacity of the object.	DisplayObject
		autoFlatten : Boolean Determines if the button should automatically call flatten() after it finishes drawing.	Button
		base : DisplayObject [read-only] The topmost object in the display tree the object is part of.	DisplayObject
		blendMode : String The blend mode determines how the object is blended with the objects underneath.	DisplayObject
		bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent.	DisplayObject
		clipRect : Rectangle [override]	FeathersControl
		data : Object The item displayed by this renderer.	BaseDefaultItemRenderer
		defaultIcon : DisplayObject The icon used when no other icon is defined for the current state.	Button
		defaultLabelProperties : Object The default label properties are a set of key/value pairs to be passed down ot the button's label instance, and it is used when no other properties are defined for the button's current state.	Button
		defaultSelectedIcon : DisplayObject The icon used when no other icon is defined for the current state when the button is selected.	Button
		defaultSelectedLabelProperties : Object The default selected label properties are a set of key/value pairs to be passed down ot the button's label instance, and it is used when the button is selected and no other properties are defined for the button's current state.	Button
		defaultSelectedSkin : DisplayObject The skin used when no other skin is defined for the current state when the button is selected.	Button
		defaultSkin : DisplayObject The skin used when no other skin is defined for the current state.	Button
		defaultTextEditorFactory : Function [static] A function used by all UI controls that support text editor to create an ITextEditor instance.	FeathersControl
		defaultTextRendererFactory : Function [static] A function used by all UI controls that support text renderers to create an ITextRenderer instance.	FeathersControl
		disabledIcon : DisplayObject The icon used for the button's disabled state.	Button
		disabledLabelProperties : Object A set of key/value pairs to be passed down ot the button's label instance when the button is in the disabled state.	Button
		disabledSkin : DisplayObject The skin used for the button's disabled state.	Button
		downIcon : DisplayObject The icon used for the button's down state.	Button
		downLabelProperties : Object A set of key/value pairs to be passed down ot the button's label instance when the button is in the down state.	Button
		downSkin : DisplayObject The skin used for the button's down state.	Button
		filter : FragmentFilter The filter that is attached to the display object.	DisplayObject
		focusManager : IFocusManager The current focus manager for this component.	FeathersControl
		gap : Number The space, in pixels, between the icon and the label.	Button
		hasVisibleArea : Boolean [read-only] Indicates if an object occupies any visible area.	DisplayObject
		height : Number [override] The height of the component, in pixels.	FeathersControl
		horizontalAlign : String The location where the button's content is aligned horizontally (on the x-axis).	Button
		hoverIcon : DisplayObject The icon used for the button's hover state.	Button
		hoverLabelProperties : Object A set of key/value pairs to be passed down ot the button's label instance when the button is in the hover state.	Button
		hoverSkin : DisplayObject The skin used for the button's hover state.	Button
		iconField : String The field in the item that contains a display object to be displayed as an icon or other graphic next to the label in the renderer.	BaseDefaultItemRenderer
		iconFunction : Function A function used to generate an icon for a specific item.	BaseDefaultItemRenderer
		iconLoaderFactory : Function A function that generates an ImageLoader that uses the result of iconSourceField or iconSourceFunction.	BaseDefaultItemRenderer
		iconOffsetX : Number Offsets the x position of the icon by a certain number of pixels.	Button
		iconOffsetY : Number Offsets the y position of the icon by a certain number of pixels.	Button
		iconPosition : String The location of the icon, relative to the label.	Button
		iconSourceField : String The field in the item that contains a starling.textures.Texture or a URL that points to a bitmap to be used as the item renderer's icon.	BaseDefaultItemRenderer
		iconSourceFunction : Function A function used to generate a starling.textures.Texture or a URL that points to a bitmap to be used as the item renderer's icon.	BaseDefaultItemRenderer
		includeInLayout : Boolean Determines if the ILayout should use this object or ignore it.	FeathersControl
		isEnabled : Boolean [override]	Button
		isFlattened : Boolean [read-only] Indicates if the sprite was flattened.	Sprite
		isFocusEnabled : Boolean Determines if this component can receive focus.	FeathersControl
		isInitialized : Boolean [read-only] Determines if the component has been initialized yet.	FeathersControl
		isQuickHitAreaEnabled : Boolean Similar to mouseChildren on the classic display list.	FeathersControl
		isSelected : Boolean Indicates if the button is selected or not.	Button
		isToggle : Boolean Determines if the button may be selected or unselected when clicked.	Button
		itemHasIcon : Boolean If true, the icon will come from the renderer's item using the appropriate field or function for the icon.	BaseDefaultItemRenderer
		itemHasLabel : Boolean If true, the label will come from the renderer's item using the appropriate field or function for the label.	BaseDefaultItemRenderer
		keepDownStateOnRollOut : Boolean = false Determines if a pressed button should remain in the down state if a touch moves outside of the button's bounds.	Button
		label : String The text displayed on the button.	Button
		labelFactory : Function A function used to instantiate the button's label subcomponent.	Button
		labelField : String The field in the item that contains the label text to be displayed by the renderer.	BaseDefaultItemRenderer
		labelFunction : Function A function used to generate label text for a specific item.	BaseDefaultItemRenderer
		labelOffsetX : Number Offsets the x position of the label by a certain number of pixels.	Button
		labelOffsetY : Number Offsets the y position of the label by a certain number of pixels.	Button
		layoutData : ILayoutData Extra parameters associated with this display object that will be used by the layout algorithm.	FeathersControl
		layoutOrder : String The accessory's position will be based on which other child (the label or the icon) the accessory should be relative to.	BaseDefaultItemRenderer
		maxHeight : Number The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.	FeathersControl
		maxWidth : Number The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.	FeathersControl
		minHeight : Number The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.	FeathersControl
		minTouchHeight : Number If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded.	FeathersControl
		minTouchWidth : Number If using isQuickHitAreaEnabled, and the hit area's width is smaller than this value, it will be expanded.	FeathersControl
		minWidth : Number The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.	FeathersControl
		name : String [override] The concatenated nameList, with each name separated by spaces.	FeathersControl
		nameList : TokenList [read-only] Contains a list of all "names" assigned to this control.	FeathersControl
		nextTabFocus : IFocusDisplayObject The next object that will receive focus when the tab key is pressed.	FeathersControl
		numChildren : int [read-only] The number of children of this container.	DisplayObjectContainer
		padding : Number Quickly sets all padding properties to the same value.	Button
		paddingBottom : Number The minimum space, in pixels, between the button's bottom edge and the button's content.	Button
		paddingLeft : Number The minimum space, in pixels, between the button's left edge and the button's content.	Button
		paddingRight : Number The minimum space, in pixels, between the button's right edge and the button's content.	Button
		paddingTop : Number The minimum space, in pixels, between the button's top edge and the button's content.	Button
		parent : DisplayObjectContainer [read-only] The display object container that contains this display object.	DisplayObject
		pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0).	DisplayObject
		pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0).	DisplayObject
		root : DisplayObject [read-only] The root object the display object is connected to (i.e.	DisplayObject
		rotation : Number The rotation of the object in radians.	DisplayObject
		scaleX : Number The horizontal scale factor.	DisplayObject
		scaleY : Number The vertical scale factor.	DisplayObject
		selectedDisabledIcon : DisplayObject The icon used for the button's disabled state when the button is selected.	Button
		selectedDisabledLabelProperties : Object A set of key/value pairs to be passed down ot the button's label instance when the button is in the disabled state and is selected.	Button
		selectedDisabledSkin : DisplayObject The skin used for the button's disabled state when the button is selected.	Button
		selectedDownIcon : DisplayObject The icon used for the button's down state when the button is selected.	Button
		selectedDownLabelProperties : Object A set of key/value pairs to be passed down ot the button's label instance when the button is in the down state and is selected.	Button
		selectedDownSkin : DisplayObject The skin used for the button's down state when the button is selected.	Button
		selectedHoverIcon : DisplayObject The icon used for the button's hover state when the button is selected.	Button
		selectedHoverLabelProperties : Object A set of key/value pairs to be passed down ot the button's label instance when the button is in the hover state and is selected.	Button
		selectedHoverSkin : DisplayObject The skin used for the button's hover state when the button is selected.	Button
		selectedUpIcon : DisplayObject The icon used for the button's up state when the button is selected.	Button
		selectedUpLabelProperties : Object A set of key/value pairs to be passed down ot the button's label instance when the button is in the up state and is selected.	Button
		selectedUpSkin : DisplayObject The skin used for the button's up state when the button is selected.	Button
		skewX : Number The horizontal skew angle in radians.	DisplayObject
		skewY : Number The vertical skew angle in radians.	DisplayObject
		stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected to the stage.	DisplayObject
		stateToIconFunction : Function Returns an icon for the current state.	Button
		stateToLabelPropertiesFunction : Function Returns a text format for the current state.	Button
		stateToSkinFunction : Function Returns a skin for the current state.	Button
		stopAccessoryTouchEventPropagation : Boolean = true If enabled, calls event.stopPropagation() when TouchEvents are dispatched by the accessory.	BaseDefaultItemRenderer
		touchable : Boolean Indicates if this object (and its children) will receive touch events.	DisplayObject
		transformationMatrix : Matrix The transformation matrix of the object relative to its parent.	DisplayObject
		upIcon : DisplayObject The icon used for the button's up state.	Button
		upLabelProperties : Object A set of key/value pairs to be passed down ot the button's label instance when the button is in the up state.	Button
		upSkin : DisplayObject The skin used for the button's up state.	Button
		useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite.	DisplayObject
		useStateDelayTimer : Boolean If true, the down state (and subsequent state changes) will be delayed to make scrolling look nicer.	BaseDefaultItemRenderer
		verticalAlign : String The location where the button's content is aligned vertically (on the y-axis).	Button
		visible : Boolean The visibility of the object.	DisplayObject
		width : Number [override] The width of the component, in pixels.	FeathersControl
		x : Number The x coordinate of the object relative to the local coordinates of the parent.	DisplayObject
		y : Number The y coordinate of the object relative to the local coordinates of the parent.	DisplayObject

	Property	Defined By
		accessoryLabelName : String = feathers-item-renderer-accessory-label The value added to the nameList of the accessory label.	BaseDefaultItemRenderer
		actualHeight : Number = 0 The final height value that should be used for layout.	FeathersControl
		actualWidth : Number = 0 The final width value that should be used for layout.	FeathersControl
		explicitHeight : Number = NaN The height value explicitly set by calling the height setter or setSize().	FeathersControl
		explicitWidth : Number = NaN The width value explicitly set by calling the width setter or setSize().	FeathersControl
		labelName : String = feathers-button-label The value added to the nameList of the label.	Button
		labelTextRenderer : ITextRenderer The text renderer for the button's label.	Button
		stateNames : Vector.<String> [read-only] A list of all valid state names.	Button

	Method	Defined By
		BaseDefaultItemRenderer() Constructor.	BaseDefaultItemRenderer
		addChild(child:DisplayObject):DisplayObject Adds a child to the container.	DisplayObjectContainer
		addChildAt(child:DisplayObject, index:int):DisplayObject Adds a child to the container at a certain index.	DisplayObjectContainer
		addEventListener(type:String, listener:Function):void [override]	DisplayObject
		alignPivot(hAlign:String = center, vAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system of the object.	DisplayObject
		broadcastEvent(event:Event):void Dispatches an event on all children (recursively).	DisplayObjectContainer
		broadcastEventWith(type:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively).	DisplayObjectContainer
		contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively).	DisplayObjectContainer
		dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type.	EventDispatcher
		dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered listeners for the given type.	EventDispatcher
		dispose():void [override] Disposes the resources of all children.	Sprite
		flatten():void Optimizes the sprite for optimal rendering performance.	Sprite
		getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Returns a rectangle that completely encloses the object as it appears in another coordinate system.	Sprite
		getChildAt(index:int):DisplayObject Returns a child object at a certain index.	DisplayObjectContainer
		getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively).	DisplayObjectContainer
		getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found.	DisplayObjectContainer
		getClipRect(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle Returns the bounds of the container's clipRect in the given coordinate space, or null if the sprite doens't have a clipRect.	Sprite
		getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system to another.	DisplayObject
		globalToLocal(globalPoint:Point, resultPoint:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system.	DisplayObject
		hasEventListener(type:String):Boolean Returns if there are listeners registered for a certain event type.	EventDispatcher
		hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil if the test fails.	Sprite
		invalidate(flag:String):void Call this function to tell the UI control that a redraw is pending.	FeathersControl
		isInvalid(flag:String = null):Boolean Indicates whether the control is pending validation or not.	FeathersControl
		itemToLabel(item:Object):String Using labelField and labelFunction, generates a label from the item.	BaseDefaultItemRenderer
		localToGlobal(localPoint:Point, resultPoint:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates.	DisplayObject
		removeChild(child:DisplayObject, dispose:Boolean = false):DisplayObject Removes a child from the container.	DisplayObjectContainer
		removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index.	DisplayObjectContainer
		removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included).	DisplayObjectContainer
		removeEventListener(type:String, listener:Function):void [override]	DisplayObject
		removeEventListeners(type:String = null):void [override]	DisplayObject
		removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it.	DisplayObject
		render(support:RenderSupport, parentAlpha:Number):void [override] Renders the display object with the help of a support object.	Sprite
		setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index.	DisplayObjectContainer
		setSize(width:Number, height:Number):void Sets both the width and the height of the control.	FeathersControl
		sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function of the Vector class).	DisplayObjectContainer
		swapChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the indexes of two children.	DisplayObjectContainer
		swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children.	DisplayObjectContainer
		unflatten():void Removes the rendering optimizations that were created when flattening the sprite.	Sprite
		validate():void Immediately validates the control, which triggers a redraw, if one is pending.	FeathersControl

	Method	Defined By
		draw():void Override to customize layout and to adjust properties of children.	FeathersControl
		initialize():void Called the first time that the UI control is added to the stage, and you should override this function to customize the initialization process.	FeathersControl
		itemToAccessory(item:Object):DisplayObject Uses the accessory fields and functions to generate an accessory for a specific item.	BaseDefaultItemRenderer
		itemToIcon(item:Object):DisplayObject Uses the icon fields and functions to generate an icon for a specific item.	BaseDefaultItemRenderer
		setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean Sets the width and height of the control, with the option of invalidating or not.	FeathersControl

Summary	Defined By
added	Dispatched when an object is added to a parent.	DisplayObject
addedToStage	Dispatched when an object is connected to the stage (directly or indirectly).	DisplayObject
change	Dispatched when the button is selected or unselected.	Button
enterFrame	Dispatched once every frame on every object that is connected to the stage.	DisplayObject
flatten	Dispatched on all children when the object is flattened.	Sprite
initialize	Dispatched after initialize() has been called, but before the first time that draw() has been called.	FeathersControl
keyDown	Dispatched when a key on the keyboard is pressed.	DisplayObject
keyUp	Dispatched when a key on the keyboard is released.	DisplayObject
removed	Dispatched when an object is removed from its parent.	DisplayObject
removedFromStage	Dispatched when an object is removed from the stage and won't be rendered any longer.	DisplayObject
resize	Dispatched when the width or height of the control changes.	FeathersControl
touch	Dispatched when an object is touched.	DisplayObject
triggered	Dispatched when the button is released while the touch is still within the button's bounds (a tap or click that should trigger the button).	Button

	Constant	Defined By
		ACCESSORY_POSITION_BOTTOM : String = bottom [static] The accessory will be positioned below its origin.	BaseDefaultItemRenderer
		ACCESSORY_POSITION_LEFT : String = left [static] The accessory will be positioned to the left of its origin.	BaseDefaultItemRenderer
		ACCESSORY_POSITION_MANUAL : String = manual [static] The accessory will be positioned manually with no relation to another child.	BaseDefaultItemRenderer
		ACCESSORY_POSITION_RIGHT : String = right [static] The accessory will be positioned to the right of its origin.	BaseDefaultItemRenderer
		ACCESSORY_POSITION_TOP : String = top [static] The accessory will be positioned above its origin.	BaseDefaultItemRenderer
		DEFAULT_CHILD_NAME_ACCESSORY_LABEL : String = feathers-item-renderer-accessory-label [static] The default value added to the nameList of the accessory label.	BaseDefaultItemRenderer
		DEFAULT_CHILD_NAME_LABEL : String = feathers-button-label [static] The default value added to the nameList of the label.	Button
		HORIZONTAL_ALIGN_CENTER : String = center [static] The icon and label will be aligned horizontally to the center of the button.	Button
		HORIZONTAL_ALIGN_LEFT : String = left [static] The icon and label will be aligned horizontally to the left edge of the button.	Button
		HORIZONTAL_ALIGN_RIGHT : String = right [static] The icon and label will be aligned horizontally to the right edge of the button.	Button
		ICON_POSITION_BOTTOM : String = bottom [static] The icon will be positioned below the label.	Button
		ICON_POSITION_LEFT : String = left [static] The icon will be positioned to the left of the label.	Button
		ICON_POSITION_LEFT_BASELINE : String = leftBaseline [static] The icon will be positioned to the left the label, and the bottom of the icon will be aligned to the baseline of the label text.	Button
		ICON_POSITION_MANUAL : String = manual [static] The icon will be positioned manually with no relation to the position of the label.	Button
		ICON_POSITION_RIGHT : String = right [static] The icon will be positioned to the right of the label.	Button
		ICON_POSITION_RIGHT_BASELINE : String = rightBaseline [static] The icon will be positioned to the right the label, and the bottom of the icon will be aligned to the baseline of the label text.	Button
		ICON_POSITION_TOP : String = top [static] The icon will be positioned above the label.	Button
		INVALIDATION_FLAG_ALL : String = all [static] Flag to indicate that everything is invalid and should be redrawn.	FeathersControl
		INVALIDATION_FLAG_DATA : String = data [static] Invalidation flag to indicate that the primary data displayed by the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_LAYOUT : String = layout [static] Invalidation flag to indicate that the layout of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_SCROLL : String = scroll [static] Invalidation flag to indicate that the scroll position of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_SELECTED : String = selected [static] Invalidation flag to indicate that the selection of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_SIZE : String = size [static] Invalidation flag to indicate that the dimensions of the UI control have changed.	FeathersControl
		INVALIDATION_FLAG_SKIN : String = skin [static] Invalidation flag to indicate that the skin of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_STATE : String = state [static] Invalidation flag to indicate that the state has changed.	FeathersControl
		INVALIDATION_FLAG_STYLES : String = styles [static] Invalidation flag to indicate that the styles or visual appearance of the UI control has changed.	FeathersControl
		LAYOUT_ORDER_LABEL_ACCESSORY_ICON : String = labelAccessoryIcon [static] The layout order will be the label first, then the accessory relative to the label, then the icon relative to both.	BaseDefaultItemRenderer
		LAYOUT_ORDER_LABEL_ICON_ACCESSORY : String = labelIconAccessory [static] The layout order will be the label first, then the icon relative to label, then the accessory relative to both.	BaseDefaultItemRenderer
		VERTICAL_ALIGN_BOTTOM : String = bottom [static] The icon and label will be aligned vertically to the bottom edge of the button.	Button
		VERTICAL_ALIGN_MIDDLE : String = middle [static] The icon and label will be aligned vertically to the middle of the button.	Button
		VERTICAL_ALIGN_TOP : String = top [static] The icon and label will be aligned vertically to the top edge of the button.	Button

Property Detail

accessoryField

property

accessoryField:String

The field in the item that contains a display object to be positioned in the accessory position of the renderer. If you wish to display an Image in the accessory position, it's better for performance to use accessorySourceField instead.

All of the accessory fields and functions, ordered by priority:

accessorySourceFunction
accessorySourceField
accessoryLabelFunction
accessoryLabelField
accessoryFunction
accessoryField

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

accessoryFunction

property

accessoryFunction:Function

A function that returns a display object to be positioned in the accessory position of the renderer. If you wish to display an Image in the accessory position, it's better for performance to use accessorySourceFunction instead.

The function is expected to have the following signature:

function( item:Object ):DisplayObject

All of the accessory fields and functions, ordered by priority:

accessorySourceFunction
accessorySourceField
accessoryLabelFunction
accessoryLabelField
accessoryFunction
accessoryField

Implementation
public function get accessoryFunction():Function
public function set accessoryFunction(value:Function):void

accessoryGap

property

accessoryGap:Number

The space, in pixels, between the accessory and the other child it is positioned relative to. Applies to either horizontal or vertical spacing, depending on the value of accessoryPosition. If the value is NaN, the value of the gap property will be used instead.

If accessoryGap is set to Number.POSITIVE_INFINITY, the accessory and the component it is relative to will be positioned as far apart as possible.

Implementation
public function get accessoryGap():Number
public function set accessoryGap(value:Number):void

See also

gap
accessoryPosition

accessoryLabelFactory

property

accessoryLabelFactory:Function

A function that generates ITextRenderer that uses the result of accessoryLabelField or accessoryLabelFunction. CAn be used to set properties on the ITextRenderer.

The function is expected to have the following signature:

function():ITextRenderer

Implementation
public function get accessoryLabelFactory():Function
public function set accessoryLabelFactory(value:Function):void

accessoryLabelField

property

accessoryLabelField:String

The field in the item that contains a string to be displayed in a renderer-managed Label in the accessory position of the renderer. The renderer will automatically reuse an internal Label and swap the text when the data changes. This Label may be skinned by changing the accessoryLabelFactory.

Using an accessory label will result in better performance than passing in a Label through a accessoryField or accessoryFunction because the renderer can avoid costly display list manipulation.

All of the accessory fields and functions, ordered by priority:

accessorySourceFunction
accessorySourceField
accessoryLabelFunction
accessoryLabelField
accessoryFunction
accessoryField

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

accessoryLabelFunction

property

accessoryLabelFunction:Function

A function that returns a string to be displayed in a renderer-managed Label in the accessory position of the renderer. The renderer will automatically reuse an internal Label and swap the text when the data changes. This Label may be skinned by changing the accessoryLabelFactory.

Using an accessory label will result in better performance than passing in a Label through a accessoryField or accessoryFunction because the renderer can avoid costly display list manipulation.

The function is expected to have the following signature:

function( item:Object ):String

All of the accessory fields and functions, ordered by priority:

accessorySourceFunction
accessorySourceField
accessoryLabelFunction
accessoryLabelField
accessoryFunction
accessoryField

Implementation
public function get accessoryLabelFunction():Function
public function set accessoryLabelFunction(value:Function):void

accessoryLabelName

property

protected var accessoryLabelName:String = feathers-item-renderer-accessory-label

The value added to the nameList of the accessory label.

accessoryLabelProperties

property

accessoryLabelProperties:Object

A set of key/value pairs to be passed down to a label accessory.

If the subcomponent has its own subcomponents, their properties can be set too, using attribute @ notation. For example, to set the skin on the thumb of a SimpleScrollBar which is in a Scroller which is in a List, you can use the following syntax:

list.scrollerProperties.@verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);

Implementation
public function get accessoryLabelProperties():Object
public function set accessoryLabelProperties(value:Object):void

accessoryLoaderFactory

property

accessoryLoaderFactory:Function

A function that generates an ImageLoader that uses the result of accessorySourceField or accessorySourceFunction. Useful for transforming the ImageLoader in some way. For example, you might want to scale the texture for current DPI or apply pixel snapping.

The function is expected to have the following signature:

function():ImageLoader

Implementation
public function get accessoryLoaderFactory():Function
public function set accessoryLoaderFactory(value:Function):void

accessoryOffsetX

property

accessoryOffsetX:Number

Offsets the x position of the accessory by a certain number of pixels.

Implementation
public function get accessoryOffsetX():Number
public function set accessoryOffsetX(value:Number):void

accessoryOffsetY

property

accessoryOffsetY:Number

Offsets the y position of the accessory by a certain number of pixels.

Implementation
public function get accessoryOffsetY():Number
public function set accessoryOffsetY(value:Number):void

accessoryPosition

property

accessoryPosition:String

The location of the accessory, relative to one of the other children. Use ACCESSORY_POSITION_MANUAL to position the accessory from the top-left corner.

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

See also

layoutOrder

accessorySourceField

property

accessorySourceField:String

A field in the item that contains a starling.textures.Texture or a URL that points to a bitmap to be used as the item renderer's accessory. The renderer will automatically manage and reuse an internal ImageLoader sub-component and this value will be passed to the source property. The ImageLoader may be customized by changing the accessoryLoaderFactory.

Using an accessory source will result in better performance than passing in an ImageLoader or Image through a accessoryField or accessoryFunction because the renderer can avoid costly display list manipulation.

All of the accessory fields and functions, ordered by priority:

accessorySourceFunction
accessorySourceField
accessoryLabelFunction
accessoryLabelField
accessoryFunction
accessoryField

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

accessorySourceFunction

property

accessorySourceFunction:Function

A function that generates a starling.textures.Texture or a URL that points to a bitmap to be used as the item renderer's accessory. The renderer will automatically manage and reuse an internal ImageLoader sub-component and this value will be passed to the source property. The ImageLoader may be customized by changing the accessoryLoaderFactory.

The function is expected to have the following signature:

function( item:Object ):Object

The return value is a valid value for the source property of an ImageLoader component.

All of the accessory fields and functions, ordered by priority:

accessorySourceFunction
accessorySourceField
accessoryLabelFunction
accessoryLabelField
accessoryFunction
accessoryField

Implementation
public function get accessorySourceFunction():Function
public function set accessorySourceFunction(value:Function):void

data

property

data:Object

The item displayed by this renderer.

Implementation
public function get data():Object
public function set data(value:Object):void

iconField

property

iconField:String

The field in the item that contains a display object to be displayed as an icon or other graphic next to the label in the renderer.

All of the icon fields and functions, ordered by priority:

iconSourceFunction
iconSourceField
iconFunction
iconField

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

iconFunction

property

iconFunction:Function

A function used to generate an icon for a specific item.

The function is expected to have the following signature:

function( item:Object ):DisplayObject

All of the icon fields and functions, ordered by priority:

iconSourceFunction
iconSourceField
iconFunction
iconField

Implementation
public function get iconFunction():Function
public function set iconFunction(value:Function):void

iconLoaderFactory

property

iconLoaderFactory:Function

A function that generates an ImageLoader that uses the result of iconSourceField or iconSourceFunction. Useful for transforming the ImageLoader in some way. For example, you might want to scale the texture for current DPI or apply pixel snapping.

The function is expected to have the following signature:

function():ImageLoader

Implementation
public function get iconLoaderFactory():Function
public function set iconLoaderFactory(value:Function):void

iconSourceField

property

iconSourceField:String

The field in the item that contains a starling.textures.Texture or a URL that points to a bitmap to be used as the item renderer's icon. The renderer will automatically manage and reuse an internal ImageLoader sub-component and this value will be passed to the source property. The ImageLoader may be customized by changing the iconLoaderFactory.

Using an icon source will result in better performance than passing in an ImageLoader or Image through a iconField or iconFunction because the renderer can avoid costly display list manipulation.

All of the icon fields and functions, ordered by priority:

iconSourceFunction
iconSourceField
iconFunction
iconField

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

iconSourceFunction

property

iconSourceFunction:Function

A function used to generate a starling.textures.Texture or a URL that points to a bitmap to be used as the item renderer's icon. The renderer will automatically manage and reuse an internal ImageLoader sub-component and this value will be passed to the source property. The ImageLoader may be customized by changing the iconLoaderFactory.

The function is expected to have the following signature:

function( item:Object ):Object

The return value is a valid value for the source property of an ImageLoader component.

All of the icon fields and functions, ordered by priority:

iconSourceFunction
iconSourceField
iconFunction
iconField

Implementation
public function get iconSourceFunction():Function
public function set iconSourceFunction(value:Function):void

itemHasIcon

property

itemHasIcon:Boolean

If true, the icon will come from the renderer's item using the appropriate field or function for the icon. If false, the icon may be skinned for each state externally.

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

itemHasLabel

property

itemHasLabel:Boolean

If true, the label will come from the renderer's item using the appropriate field or function for the label. If false, the label may be set externally.

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

labelField

property

labelField:String

The field in the item that contains the label text to be displayed by the renderer. If the item does not have this field, and a labelFunction is not defined, then the renderer will default to calling toString() on the item. To omit the label completely, either provide a custom item renderer without a label or define a labelFunction that returns an empty string.

All of the label fields and functions, ordered by priority:

labelFunction
labelField

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

See also

labelFunction

property

labelFunction:Function

A function used to generate label text for a specific item. If this function is not null, then the labelField will be ignored.

The function is expected to have the following signature:

function( item:Object ):String

All of the label fields and functions, ordered by priority:

labelFunction
labelField

Implementation
public function get labelFunction():Function
public function set labelFunction(value:Function):void

See also

labelField

layoutOrder

property

layoutOrder:String

The accessory's position will be based on which other child (the label or the icon) the accessory should be relative to.

The accessoryPositionOrigin property will be ignored if accessoryPosition is set to ACCESSORY_POSITION_MANUAL.

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

See also

accessoryPosition
iconPosition
LAYOUT_ORDER_LABEL_ICON_ACCESSORY
LAYOUT_ORDER_LABEL_ACCESSORY_ICON

stopAccessoryTouchEventPropagation

property

public var stopAccessoryTouchEventPropagation:Boolean = true

If enabled, calls event.stopPropagation() when TouchEvents are dispatched by the accessory.

useStateDelayTimer

property

useStateDelayTimer:Boolean

If true, the down state (and subsequent state changes) will be delayed to make scrolling look nicer.

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

Constructor Detail

BaseDefaultItemRenderer

()

Constructor

public function BaseDefaultItemRenderer()

Constructor.

Method Detail

itemToAccessory

()

method

protected function itemToAccessory(item:Object):DisplayObject

Uses the accessory fields and functions to generate an accessory for a specific item.

All of the accessory fields and functions, ordered by priority:

accessorySourceFunction
accessorySourceField
accessoryLabelFunction
accessoryLabelField
accessoryFunction
accessoryField

Parameters

item:Object

Returns

DisplayObject

itemToIcon

()

method

protected function itemToIcon(item:Object):DisplayObject

Uses the icon fields and functions to generate an icon for a specific item.

All of the icon fields and functions, ordered by priority:

iconSourceFunction
iconSourceField
iconFunction
iconField

Parameters

item:Object

Returns

DisplayObject

itemToLabel

()

method

public function itemToLabel(item:Object):String

Using labelField and labelFunction, generates a label from the item.

All of the label fields and functions, ordered by priority:

labelFunction
labelField

Parameters

item:Object

Returns

String

Constant Detail

ACCESSORY_POSITION_BOTTOM

Constant

public static const ACCESSORY_POSITION_BOTTOM:String = bottom

The accessory will be positioned below its origin.

ACCESSORY_POSITION_LEFT

Constant

public static const ACCESSORY_POSITION_LEFT:String = left

The accessory will be positioned to the left of its origin.

ACCESSORY_POSITION_MANUAL

Constant

public static const ACCESSORY_POSITION_MANUAL:String = manual

The accessory will be positioned manually with no relation to another child. Use accessoryOffsetX and accessoryOffsetY to set the accessory position.

The accessoryPositionOrigin property will be ignored if accessoryPosition is set to ACCESSORY_POSITION_MANUAL.

See also

accessoryOffsetX
accessoryOffsetY

ACCESSORY_POSITION_RIGHT

Constant

public static const ACCESSORY_POSITION_RIGHT:String = right

The accessory will be positioned to the right of its origin.

ACCESSORY_POSITION_TOP

Constant

public static const ACCESSORY_POSITION_TOP:String = top

The accessory will be positioned above its origin.

DEFAULT_CHILD_NAME_ACCESSORY_LABEL

Constant

public static const DEFAULT_CHILD_NAME_ACCESSORY_LABEL:String = feathers-item-renderer-accessory-label

The default value added to the nameList of the accessory label.

LAYOUT_ORDER_LABEL_ACCESSORY_ICON

Constant

public static const LAYOUT_ORDER_LABEL_ACCESSORY_ICON:String = labelAccessoryIcon

The layout order will be the label first, then the accessory relative to the label, then the icon relative to both. Best used when the accessory should be between the label and the icon or when the icon position shouldn't be affected by the accessory.

LAYOUT_ORDER_LABEL_ICON_ACCESSORY

Constant

public static const LAYOUT_ORDER_LABEL_ICON_ACCESSORY:String = labelIconAccessory

The layout order will be the label first, then the icon relative to label, then the accessory relative to both.

Thu Jan 16 2014, 01:11 PM +08:00

GODPAPER	All Packages \| All Classes \| Index \| Frames No Frames
BaseDefaultItemRenderer	Properties \| Methods \| Events \| Constants

Package	feathers.controls.renderers
Class	public class BaseDefaultItemRenderer
Inheritance	BaseDefaultItemRenderer Button FeathersControl Sprite DisplayObjectContainer DisplayObject EventDispatcher Object
Subclasses	DefaultGroupedListItemRenderer, DefaultListItemRenderer