Packagefeathers.controls.renderers
Classpublic class DefaultDataGridCellRenderer
InheritanceDefaultDataGridCellRenderer Inheritance BaseDefaultItemRenderer Inheritance ToggleButton Inheritance Button Inheritance BasicButton Inheritance FeathersControl Inheritance Sprite Inheritance DisplayObjectContainer Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
Implements IDataGridCellRenderer

Product Version : Feathers 3.4.0

The default cell renderer for the DataGrid component. Supports up to three optional sub-views, including a label to display text, an icon to display an image, and an "accessory" to display a UI component or another display object (with shortcuts for including a second image or a second label).

See also

feathers.controls.DataGrid


Public Properties
 PropertyDefined By
 InheritedaccessoryField : String
The field in the item that contains a display object to be positioned in the accessory position of the renderer.
BaseDefaultItemRenderer
 InheritedaccessoryFunction : Function
A function that returns a display object to be positioned in the accessory position of the renderer.
BaseDefaultItemRenderer
 InheritedaccessoryLabelFactory : Function
A function that generates ITextRenderer that uses the result of accessoryLabelField or accessoryLabelFunction.
BaseDefaultItemRenderer
 InheritedaccessoryLabelField : String
The field in the item that contains a string to be displayed in a renderer-managed ITextRenderer in the accessory position of the renderer.
BaseDefaultItemRenderer
 InheritedaccessoryLabelFunction : Function
A function that returns a string to be displayed in a renderer-managed ITextRenderer in the accessory position of the renderer.
BaseDefaultItemRenderer
 InheritedaccessoryLabelProperties : Object
An object that stores properties for the accessory label text renderer sub-component (if using accessoryLabelField or accessoryLabelFunction), and the properties will be passed down to the text renderer when this component validates.
BaseDefaultItemRenderer
 InheritedaccessoryLoaderFactory : Function
A function that generates an ImageLoader that uses the result of accessorySourceField or accessorySourceFunction.
BaseDefaultItemRenderer
 InheritedaccessorySourceField : 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
 InheritedaccessorySourceFunction : 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
 InheritedaddedEffect : Function
An optional effect that is activated when the component is added to the stage.
FeathersControl
 Inheritedalpha : Number
The opacity of the object.
DisplayObject
 Inheritedbase : DisplayObject
[read-only] The topmost object in the display tree the object is part of.
DisplayObject
 Inheritedbaseline : Number
[read-only] Returns the text baseline measurement, in pixels.
Button
 InheritedblendMode : String
The blend mode determines how the object is blended with the objects underneath.
DisplayObject
 Inheritedbounds : Rectangle
[read-only] The bounds of the object relative to the local coordinates of the parent.
DisplayObject
  column : DataGridColumn
The column where the cell is rendered in the data grid.
DefaultDataGridCellRenderer
  columnIndex : int
The index (numeric position, starting from zero) of the item within the data grid's columns.
DefaultDataGridCellRenderer
 InheritedcurrentState : String
[read-only] The current state of the button.
BasicButton
 Inheriteddata : Object
The item displayed by this renderer.
BaseDefaultItemRenderer
  dataField : String
The field used to access this column's data from the item within the data grid's data provider.
DefaultDataGridCellRenderer
 InheriteddefaultAccessory : DisplayObject
The accessory used when no other accessory is defined for the current state.
BaseDefaultItemRenderer
 InheriteddefaultLabelProperties : Object
An object that stores properties for the button's label text renderer when no specific properties are defined for the button's current state, and the properties will be passed down to the label text renderer when the button validates.
Button
 InheriteddefaultTextEditorFactory : Function
[static] A function used by all UI controls that support text editor to create an ITextEditor instance.
FeathersControl
 InheriteddefaultTextRendererFactory : Function
[static] A function used by all UI controls that support text renderers to create an ITextRenderer instance.
FeathersControl
 InheriteddelayTextureCreationOnScroll : Boolean
If enabled, automatically manages the delayTextureCreation property on accessory and icon ImageLoader instances when the owner scrolls.
BaseDefaultItemRenderer
 Inheriteddepth : int
[read-only] The component's depth in the display list, relative to the stage.
FeathersControl
 InheritedeffectsSuspended : Boolean
[read-only] Indicates if effects have been suspended.
FeathersControl
 InheritedenabledField : String
The field in the item that determines if the item renderer is enabled, if the list is enabled.
BaseDefaultItemRenderer
 InheritedenabledFunction : Function
A function used to determine if a specific item is enabled.
BaseDefaultItemRenderer
 InheritedexplicitHeight : Number
[read-only] The height value explicitly set by passing a value to the height setter or by calling the setSize() function.
FeathersControl
 InheritedexplicitMaxHeight : Number
[read-only] The maximum height value explicitly set by passing a value to the maxHeight setter.
FeathersControl
 InheritedexplicitMaxWidth : Number
[read-only] The maximum width value explicitly set by passing a value to the maxWidth setter.
FeathersControl
 InheritedexplicitMinHeight : Number
[read-only] The minimum height value explicitly set by passing a value to the minHeight setter.
FeathersControl
 InheritedexplicitMinWidth : Number
[read-only] The minimum width value explicitly set by passing a value to the minWidth setter.
FeathersControl
 InheritedexplicitWidth : Number
[read-only] The width value explicitly set by passing a value to the width setter or to the setSize() method.
FeathersControl
 InheritedfactoryID : String
The ID of the factory used to create this item renderer.
BaseDefaultItemRenderer
 Inheritedfilter : FragmentFilter
The filter that is attached to the display object.
DisplayObject
 InheritedfocusInEffect : Function
An optional effect that is activated when the component receives focus.
FeathersControl
 InheritedfocusManager : IFocusManager
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The current focus manager for this component.
FeathersControl
 InheritedfocusOutEffect : Function
An optional effect that is activated when the component loses focus.
FeathersControl
 InheritedfocusOwner : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Used for associating focusable display objects that are not direct children with an "owner" focusable display object, such as pop-ups.
FeathersControl
  globalStyleProvider : IStyleProvider
[static] The default IStyleProvider for all DefaultListItemRenderer components.
DefaultDataGridCellRenderer
 Inheritedheight : Number
[override] The height of the component, in pixels.
FeathersControl
 InheritedhideEffect : Function
An optional effect that is activated when the component is hidden.
FeathersControl
 InheritediconField : 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
 InheritediconFunction : Function
A function used to generate an icon for a specific item.
BaseDefaultItemRenderer
 InheritediconLabelFactory : Function
A function that generates ITextRenderer that uses the result of iconLabelField or iconLabelFunction.
BaseDefaultItemRenderer
 InheritediconLabelField : String
The field in the item that contains a string to be displayed in a renderer-managed ITextRenderer in the icon position of the renderer.
BaseDefaultItemRenderer
 InheritediconLabelFunction : Function
A function that returns a string to be displayed in a renderer-managed ITextRenderer in the icon position of the renderer.
BaseDefaultItemRenderer
 InheritediconLabelProperties : Object
An object that stores properties for the icon label text renderer sub-component (if using iconLabelField or iconLabelFunction), and the properties will be passed down to the text renderer when this component validates.
BaseDefaultItemRenderer
 InheritediconLoaderFactory : Function
A function that generates an ImageLoader that uses the result of iconSourceField or iconSourceFunction.
BaseDefaultItemRenderer
 InheritediconSourceField : 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
 InheritediconSourceFunction : 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
 InheritedincludeInLayout : Boolean
Determines if the ILayout should use this object or ignore it.
FeathersControl
 Inheritedis3D : Boolean
[read-only] Indicates if this object or any of its parents is a 'Sprite3D' object.
DisplayObject
 InheritedisChildFocusEnabled : Boolean
Determines if this component's children can receive focus.
BaseDefaultItemRenderer
 InheritedisCreated : Boolean
[read-only] Determines if the component has been initialized and validated for the first time.
FeathersControl
 InheritedisEnabled : Boolean
Indicates whether the control is interactive or not.
FeathersControl
 InheritedisFocusEnabled : Boolean
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Determines if this component can receive focus.
FeathersControl
 InheritedisInitialized : Boolean
[read-only] Determines if the component has been initialized yet.
FeathersControl
 InheritedisLongPressEnabled : Boolean
Determines if FeathersEventType.LONG_PRESS will be dispatched.
Button
 InheritedisQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list.
FeathersControl
 InheritedisSelectableOnAccessoryTouch : Boolean
If enabled, the item renderer may be selected by touching the accessory.
BaseDefaultItemRenderer
 InheritedisSelected : Boolean
Indicates if the button is selected or not.
ToggleButton
 InheritedisShowingFocus : Boolean
[read-only] The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Indicates if the showFocus() method has been called on the object when it has focus.
FeathersControl
 InheritedisToggle : Boolean
Determines if the button may be selected or deselected as a result of user interaction.
ToggleButton
 InheriteditemHasAccessory : Boolean
If true, the accessory will come from the renderer's item using the appropriate field or function for the accessory.
BaseDefaultItemRenderer
 InheriteditemHasEnabled : Boolean
If true, the renderer's enabled state will come from the renderer's item using the appropriate field or function for enabled.
BaseDefaultItemRenderer
 InheriteditemHasIcon : Boolean
If true, the icon will come from the renderer's item using the appropriate field or function for the icon.
BaseDefaultItemRenderer
 InheriteditemHasLabel : Boolean
If true, the label will come from the renderer's item using the appropriate field or function for the label.
BaseDefaultItemRenderer
 InheriteditemHasSelectable : Boolean
If true, the ability to select the renderer will come from the renderer's item using the appropriate field or function for selectable.
BaseDefaultItemRenderer
 InheriteditemHasSkin : Boolean
If true, the skin will come from the renderer's item using the appropriate field or function for the skin.
BaseDefaultItemRenderer
 Inheritedlabel : String
The text displayed on the button.
Button
 InheritedlabelFactory : Function
A function used to instantiate the button's label text renderer sub-component.
Button
 InheritedlabelField : String
The field in the item that contains the label text to be displayed by the renderer.
BaseDefaultItemRenderer
 InheritedlabelFunction : Function
A function used to generate label text for a specific item.
BaseDefaultItemRenderer
 InheritedlayoutData : ILayoutData
Extra parameters associated with this display object that will be used by the layout algorithm.
FeathersControl
 InheritedlongPressDuration : Number
The duration, in seconds, of a long press.
Button
 InheritedmaintainTouchFocus : Boolean
[read-only] The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. If true, the display object should remain in focus, even if something else is touched.
FeathersControl
 Inheritedmask : DisplayObject
The display object that acts as a mask for the current object.
DisplayObject
 InheritedmaskInverted : Boolean
Indicates if the masked region of this object is set to be inverted.
DisplayObject
 InheritedmaxHeight : Number
The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedmaxWidth : Number
The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminHeight : Number
The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded.
FeathersControl
 InheritedminTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's width is smaller than this value, it will be expanded.
FeathersControl
 InheritedminWidth : Number
The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedmoveEffect : Function
An optional effect that is activated when the component is moved to a new position.
FeathersControl
 Inheritedname : String
The name of the display object (default: null).
DisplayObject
 InheritednextDownFocus : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.DOWN is pressed at KeyLocation.D_PAD and a focus manager is enabled.
FeathersControl
 InheritednextLeftFocus : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.LEFT is pressed at KeyLocation.D_PAD and a focus manager is enabled.
FeathersControl
 InheritednextRightFocus : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.RIGHT is pressed at KeyLocation.D_PAD and a focus manager is enabled.
FeathersControl
 InheritednextTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when the tab key is pressed when a focus manager is enabled.
FeathersControl
 InheritednextUpFocus : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.UP is pressed at KeyLocation.D_PAD and a focus manager is enabled.
FeathersControl
 InheritednumChildren : int
[read-only] The number of children of this container.
DisplayObjectContainer
 InheritednumLines : int
[read-only] The number of text lines displayed by the button.
Button
  owner : DataGrid
The data grid that contains this cell renderer.
DefaultDataGridCellRenderer
 Inheritedparent : DisplayObjectContainer
[read-only] The display object container that contains this display object.
DisplayObject
 InheritedpivotX : Number
The x coordinate of the object's origin in its own coordinate space (default: 0).
DisplayObject
 InheritedpivotY : Number
The y coordinate of the object's origin in its own coordinate space (default: 0).
DisplayObject
 InheritedpreviousTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The previous object that will receive focus when the tab key is pressed while holding shift when a focus manager is enabled.
FeathersControl
 InheritedrequiresRedraw : Boolean
[read-only] Indicates if the object needs to be redrawn in the upcoming frame, i.e.
DisplayObject
 InheritedresizeEffect : Function
An optional effect that is activated when the component is resized with new dimensions.
FeathersControl
 Inheritedroot : DisplayObject
[read-only] The root object the display object is connected to (i.e.
DisplayObject
 Inheritedrotation : Number
The rotation of the object in radians.
DisplayObject
  rowIndex : int
The index (numeric position, starting from zero) of the item within the data grid's data provider.
DefaultDataGridCellRenderer
 Inheritedscale : Number
Sets both 'scaleX' and 'scaleY' to the same value.
DisplayObject
 InheritedscaleX : Number
The horizontal scale factor.
DisplayObject
 InheritedscaleY : Number
The vertical scale factor.
DisplayObject
 InheritedselectableField : String
The field in the item that determines if the item renderer can be selected, if the list allows selection.
BaseDefaultItemRenderer
 InheritedselectableFunction : Function
A function used to determine if a specific item is selectable.
BaseDefaultItemRenderer
 InheritedshowEffect : Function
An optional effect that is activated when the component is shown.
FeathersControl
 InheritedskewX : Number
The horizontal skew angle in radians.
DisplayObject
 InheritedskewY : Number
The vertical skew angle in radians.
DisplayObject
 InheritedskinField : String
The field in the item that contains a display object to be displayed as a background skin.
BaseDefaultItemRenderer
 InheritedskinFunction : Function
A function used to generate a background skin for a specific item.
BaseDefaultItemRenderer
 InheritedskinLoaderFactory : Function
A function that generates an ImageLoader that uses the result of skinSourceField or skinSourceFunction.
BaseDefaultItemRenderer
 InheritedskinSourceField : 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 skin.
BaseDefaultItemRenderer
 InheritedskinSourceFunction : 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 skin.
BaseDefaultItemRenderer
 Inheritedstage : Stage
[read-only] The stage the display object is connected to, or null if it is not connected to the stage.
DisplayObject
 InheritedstopScrollingOnAccessoryTouch : Boolean
If enabled, calls owner.stopScrolling() when TouchEvents are dispatched by the accessory.
BaseDefaultItemRenderer
 InheritedstyleName : String
The concatenated styleNameList, with values separated by spaces.
FeathersControl
 InheritedstyleNameList : TokenList
[read-only] Contains a list of all "styles" assigned to this control.
FeathersControl
 InheritedstyleProvider : IStyleProvider
When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.
FeathersControl
 InheritedtoggleGroup : ToggleGroup
When the toggle is added to a ToggleGroup, the group will manage the entire group's selection when one of the toggles in the group changes.
ToggleButton
 InheritedtoolTip : String
Text to display in a tool tip to when hovering over this component, if the ToolTipManager is enabled.
FeathersControl
 Inheritedtouchable : Boolean
Indicates if this object (and its children) will receive touch events.
DisplayObject
 InheritedtouchGroup : Boolean
If a container is a 'touchGroup', it will act as a single touchable object.
DisplayObjectContainer
 InheritedtransformationMatrix : Matrix
The transformation matrix of the object relative to its parent.
DisplayObject
 InheritedtransformationMatrix3D : Matrix3D
[read-only] The 3D transformation matrix of the object relative to its parent.
DisplayObject
 InheriteduseHandCursor : Boolean
Indicates if the mouse cursor should transform into a hand while it's over the sprite.
DisplayObject
 Inheritedvisible : Boolean
The visibility of the object.
DisplayObject
 Inheritedwidth : Number
[override] The width of the component, in pixels.
FeathersControl
 Inheritedx : Number
The x coordinate of the object relative to the local coordinates of the parent.
DisplayObject
 Inheritedy : Number
The y coordinate of the object relative to the local coordinates of the parent.
DisplayObject
Protected Properties
 PropertyDefined By
 InheritedaccessoryLabelStyleName : String = feathers-item-renderer-accessory-label
The value added to the styleNameList of the accessory label text renderer, if it exists.
BaseDefaultItemRenderer
 InheritedaccessoryLoaderStyleName : String = feathers-item-renderer-accessory-loader
The value added to the styleNameList of the accessory loader, if it exists.
BaseDefaultItemRenderer
 InheritedactualHeight : Number = 0
The final height value that should be used for layout.
FeathersControl
 InheritedactualMinHeight : Number = 0
The final minimum height value that should be used for layout.
FeathersControl
 InheritedactualMinWidth : Number = 0
The final minimum width value that should be used for layout.
FeathersControl
 InheritedactualWidth : Number = 0
The final width value that should be used for layout.
FeathersControl
 InheritedcurrentIcon : DisplayObject
The currently visible icon.
Button
 InheritedcurrentSkin : DisplayObject
The currently visible skin.
BasicButton
 InheriteddefaultStyleProvider : IStyleProvider
[read-only] When the FeathersControl constructor is called, the styleProvider property is set to this value.
FeathersControl
 InheritediconLabelStyleName : String = feathers-item-renderer-icon-label
The value added to the styleNameList of the icon label text renderer, if it exists.
BaseDefaultItemRenderer
 InheritediconLoaderStyleName : String = feathers-item-renderer-icon-loader
The value added to the styleNameList of the icon loader, if it exists.
BaseDefaultItemRenderer
 InheritedisSelectableWithoutToggle : Boolean = true
Determines if the item renderer can be selected even if isToggle is set to false.
BaseDefaultItemRenderer
 InheritedlabelStyleName : String = feathers-button-label
The value added to the styleNameList of the label text renderer.
Button
 InheritedlabelTextRenderer : ITextRenderer
The text renderer for the button's label.
Button
Public Methods
 MethodDefined By
  
Constructor.
DefaultDataGridCellRenderer
 Inherited
Adds a child to the container.
DisplayObjectContainer
 Inherited
Adds a child to the container at a certain index.
DisplayObjectContainer
 Inherited
addEventListener(type:String, listener:Function):void
[override] Registers an event listener at a certain object.
DisplayObject
 Inherited
alignPivot(horizontalAlign:String = center, verticalAlign:String = center):void
Moves the pivot point to a certain position within the local coordinate system of the object.
DisplayObject
 Inherited
broadcastEvent(event:Event):void
Dispatches an event on all children (recursively).
DisplayObjectContainer
 Inherited
broadcastEventWith(eventType:String, data:Object = null):void
Dispatches an event with the given parameters on all children (recursively).
DisplayObjectContainer
 Inherited
contains(child:DisplayObject):Boolean
Determines if a certain object is a child of the container (recursively).
DisplayObjectContainer
 Inherited
dispatchEvent(event:Event):void
Dispatches an event to all objects that have registered listeners for its type.
EventDispatcher
 Inherited
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
 Inherited
dispose():void
[override] Disposes the resources of all children.
DisplayObjectContainer
 Inherited
drawToBitmapData(out:BitmapData = null, color:uint = 0x0, alpha:Number = 0.0):BitmapData
Draws the object into a BitmapData object.
DisplayObject
 Inherited
Gets the accessory to be used by the item renderer when the item renderer's currentState property matches the specified state value.
BaseDefaultItemRenderer
 Inherited
Gets the font styles to be used to display the item renderer's accessory label text when the item renderer's currentState property matches the specified state value.
BaseDefaultItemRenderer
 Inherited
getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle
[override] Feathers components use an optimized getBounds() implementation that may sometimes behave differently than regular Starling display objects.
FeathersControl
 Inherited
Returns a child object at a certain index.
DisplayObjectContainer
 Inherited
Returns a child object with a certain name (non-recursively).
DisplayObjectContainer
 Inherited
Returns the index of a child within the container, or "-1" if it is not found.
DisplayObjectContainer
 Inherited
Gets the font styles to be used to display the button's text when the button's currentState property matches the specified state value.
Button
 Inherited
Gets the icon to be used by the button when the button's currentState property matches the specified state value.
Button
 Inherited
Gets the font styles to be used to display the item renderer's icon label text when the item renderer's currentState property matches the specified state value.
BaseDefaultItemRenderer
 Inherited
getScaleForState(state:String):Number
Gets the scale to be used by the button when the button's currentState property matches the specified state value.
Button
 Inherited
Gets the skin to be used by the button when its currentState property matches the specified state value.
BasicButton
 Inherited
getTransformationMatrix(targetSpace:DisplayObject, out:Matrix = null):Matrix
Creates a matrix that represents the transformation from the local coordinate system to another.
DisplayObject
 Inherited
getTransformationMatrix3D(targetSpace:DisplayObject, out:Matrix3D = null):Matrix3D
Creates a matrix that represents the transformation from the local coordinate system to another.
DisplayObject
 Inherited
globalToLocal(globalPoint:Point, out:Point = null):Point
Transforms a point from global (stage) coordinates to the local coordinate system.
DisplayObject
 Inherited
globalToLocal3D(globalPoint:Point, out:Vector3D = null):Vector3D
Transforms a point from global (stage) coordinates to the 3D local coordinate system.
DisplayObject
 Inherited
hasEventListener(type:String, listener:Function = null):Boolean
If called with one argument, figures out if there are any listeners registered for the given event type.
EventDispatcher
 Inherited
hideFocus():void
The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.
FeathersControl
 Inherited
hitTest(localPoint:Point):DisplayObject
[override] Returns the object that is found topmost beneath a point in local coordinates, or nil if the test fails.
DisplayObjectContainer
 Inherited
hitTestMask(localPoint:Point):Boolean
Checks if a certain point is inside the display object's mask.
DisplayObject
 Inherited
If the component has not yet initialized, initializes immediately.
FeathersControl
 Inherited
invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending.
FeathersControl
 Inherited
isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not.
FeathersControl
 Inherited
itemToLabel(item:Object):String
Using labelField and labelFunction, generates a label from the item.
BaseDefaultItemRenderer
 Inherited
local3DToGlobal(localPoint:Vector3D, out:Point = null):Point
Transforms a 3D point from the local coordinate system to global (stage) coordinates.
DisplayObject
 Inherited
localToGlobal(localPoint:Point, out:Point = null):Point
Transforms a point from the local coordinate system to global (stage) coordinates.
DisplayObject
 Inherited
move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single function call.
FeathersControl
 Inherited
removeChild(child:DisplayObject, dispose:Boolean = false):DisplayObject
Removes a child from the container.
DisplayObjectContainer
 Inherited
removeChildAt(index:int, dispose:Boolean = false):DisplayObject
Removes a child at a certain index.
DisplayObjectContainer
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void
Removes a range of children from the container (endIndex included).
DisplayObjectContainer
 Inherited
removeEventListener(type:String, listener:Function):void
[override] Removes an event listener from the object.
DisplayObject
 Inherited
removeEventListeners(type:String = null):void
[override] Removes all event listeners with a certain type, or all of them if type is null.
DisplayObject
 Inherited
removeFromParent(dispose:Boolean = false):void
Removes the object from its parent, if it has one, and optionally disposes it.
DisplayObject
 Inherited
removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void
Plays an effect before removing the component from its parent.
FeathersControl
 Inherited
render(painter:Painter):void
[override] Renders the display object with the help of a painter object.
DisplayObjectContainer
 Inherited
Resets the styleProvider property to its default value, which is usually the global style provider for the component.
FeathersControl
 Inherited
Indicates that effects should be re-activated after being suspended.
FeathersControl
 Inherited
setAccessoryForState(state:String, accessory:DisplayObject):void
Sets the accessory to be used by the item renderer when the item renderer's currentState property matches the specified state value.
BaseDefaultItemRenderer
 Inherited
Sets the font styles to be used to display the accessory label's text when the item renderer's currentState property matches the specified state value.
BaseDefaultItemRenderer
 Inherited
setChildIndex(child:DisplayObject, index:int):void
Moves a child to a certain index.
DisplayObjectContainer
 Inherited
setFontStylesForState(state:String, format:TextFormat):void
Sets the font styles to be used to display the button's text when the button's currentState property matches the specified state value.
Button
 Inherited
setIconForState(state:String, icon:DisplayObject):void
Sets the icon to be used by the button when the button's currentState property matches the specified state value.
Button
 Inherited
setIconLabelFontStylesForState(state:String, format:TextFormat):void
Sets the font styles to be used to display the icon label's text when the item renderer's currentState property matches the specified state value.
BaseDefaultItemRenderer
 Inherited
Forces the object to be redrawn in the next frame.
DisplayObject
 Inherited
setScaleForState(state:String, scale:Number):void
Sets the scale to be used by the button when the button's currentState property matches the specified state value.
Button
 Inherited
setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single function call.
FeathersControl
 Inherited
setSkinForState(state:String, skin:DisplayObject):void
Sets the skin to be used by the button when its currentState property matches the specified state value.
BasicButton
 Inherited
showFocus():void
The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.
FeathersControl
 Inherited
sortChildren(compareFunction:Function):void
Sorts the children according to a given function (that works just like the sort function of the Vector class).
DisplayObjectContainer
 Inherited
Indicates that effects should not be activated temporarily.
FeathersControl
 Inherited
Swaps the indexes of two children.
DisplayObjectContainer
 Inherited
swapChildrenAt(index1:int, index2:int):void
Swaps the indexes of two children.
DisplayObjectContainer
 Inherited
validate():void
Immediately validates the display object, if it is invalid.
FeathersControl
Protected Methods
 MethodDefined By
 Inherited
[override] If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself.
BaseDefaultItemRenderer
 Inherited
clearInvalidationFlag(flag:String):void
Clears an invalidation flag.
FeathersControl
 Inherited
commitData():void
Updates the renderer to display the item's data.
BaseDefaultItemRenderer
 Inherited
Creates the label text renderer sub-component and removes the old instance, if one exists.
Button
 Inherited
draw():void
Override to customize layout and to adjust properties of children.
FeathersControl
 Inherited
focusInHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_IN that may be overridden in subclasses to perform additional actions when the component receives focus.
FeathersControl
 Inherited
Default event handler for FeathersEventType.FOCUS_OUT that may be overridden in subclasses to perform additional actions when the component loses focus.
FeathersControl
 Inherited
The next style that is set will not be restricted.
FeathersControl
 Inherited
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
 Inherited
Uses the accessory fields and functions to generate an accessory for a specific item.
BaseDefaultItemRenderer
 Inherited
itemToEnabled(item:Object):Boolean
Uses the enabled fields and functions to generate a enabled value for a specific item.
BaseDefaultItemRenderer
 Inherited
Uses the icon fields and functions to generate an icon for a specific item.
BaseDefaultItemRenderer
 Inherited
itemToSelectable(item:Object):Boolean
Uses the selectable fields and functions to generate a selectable value for a specific item.
BaseDefaultItemRenderer
 Inherited
Uses the skin fields and functions to generate a skin for a specific item.
BaseDefaultItemRenderer
 Inherited
Positions and sizes the button's content.
Button
 Inherited
processStyleRestriction(key:Object):Boolean
Used by setters for properties that are considered "styles" to determine if the setter has been called directly on the component or from a style provider.
FeathersControl
 Inherited
Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.
FeathersControl
 Inherited
Sets the currentIcon property.
Button
 Inherited
Sets the currentSkin property.
BasicButton
 Inherited
saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean
Saves the dimensions and minimum dimensions calculated for the component.
FeathersControl
 Inherited
setInvalidationFlag(flag:String):void
Sets an invalidation flag.
FeathersControl
 Inherited
setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of invalidating or not.
FeathersControl
Events
 Event Summary Defined By
 InheritedDispatched when an object is added to a parent.DisplayObject
 InheritedDispatched when an object is connected to the stage (directly or indirectly).DisplayObject
 InheritedDispatched when the button is selected or deselected either programmatically or as a result of user interaction.ToggleButton
 InheritedDispatched after the component has validated for the first time.FeathersControl
 InheritedDispatched once every frame on every object that is connected to the stage.DisplayObject
 InheritedDispatched after initialize() has been called, but before the first time that draw() has been called.FeathersControl
 InheritedDispatched when a key on the keyboard is pressed.DisplayObject
 InheritedDispatched when a key on the keyboard is released.DisplayObject
 InheritedDispatched when the button is pressed for a long time.Button
 InheritedDispatched when an object is removed from its parent.DisplayObject
 InheritedDispatched when an object is removed from the stage and won't be rendered any longer.DisplayObject
 InheritedDispatched when the width or height of the control changes.FeathersControl
 InheritedDispatched when the display object's state changes.BasicButton
 InheritedDispatched when an object is touched.DisplayObject
 InheritedDispatched when the the user taps or clicks the button.BasicButton
Styles
 Style Description Defined By
 InheritedType: Number
The space, in pixels, between the accessory and the other child it is positioned relative to.

See also

BaseDefaultItemRenderer
 InheritedType: starling.text.TextFormat
The font styles used to display the item renderer's accessory label text when the item renderer is disabled.

See also

BaseDefaultItemRenderer
 InheritedType: starling.text.TextFormat
The font styles used to display the item renderer's accessory label text.

See also

BaseDefaultItemRenderer
 InheritedType: starling.text.TextFormat
The font styles used to display the item renderer's accessory label text when the item renderer is selected.

See also

BaseDefaultItemRenderer
 InheritedType: Number
Offsets the x position of the accessory by a certain number of pixels.

See also

BaseDefaultItemRenderer
 InheritedType: Number
Offsets the y position of the accessory by a certain number of pixels.

See also

BaseDefaultItemRenderer
 InheritedType: String
The location of the accessory, relative to one of the other children.

See also

BaseDefaultItemRenderer
 InheritedType: String
A style name to add to the item renderer's accessory label text renderer sub-component.

See also

BaseDefaultItemRenderer
 InheritedType: String
A style name to add to the item renderer's accessory loader sub-component.

See also

BaseDefaultItemRenderer
 InheritedType: String
A style name to add to the item renderer's icon label text renderer sub-component.

See also

BaseDefaultItemRenderer
 InheritedType: String
A style name to add to the item renderer's icon loader sub-component.

See also

BaseDefaultItemRenderer
 InheritedType: String
A style name to add to the button's label text renderer sub-component.

See also

Button
 InheritedType: starling.display.DisplayObject
The icon used when no other icon is defined for the current state.

See also

Button
 InheritedType: starling.display.DisplayObject
The icon used when no other icon is defined for the current state when the button is selected.

See also

ToggleButton
 InheritedType: starling.display.DisplayObject
The skin used when no other skin is defined for the current state when the button is selected.

See also

ToggleButton
 InheritedType: starling.display.DisplayObject
The skin used when no other skin is defined for the current state.

See also

BasicButton
 InheritedType: starling.text.TextFormat
The font styles used to display the button's text when the button is disabled.

See also

Button
 InheritedType: starling.display.DisplayObject
The icon used for the button's disabled state.

See also

Button
 InheritedType: starling.display.DisplayObject
The skin used for the button's disabled state.

See also

BasicButton
 InheritedType: starling.display.DisplayObject
The icon used for the button's down state.

See also

Button
 InheritedType: starling.display.DisplayObject
The skin used for the button's down state.

See also

BasicButton
 InheritedType: starling.display.DisplayObject
If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.

See also

FeathersControl
 InheritedType: Number
Quickly sets all focus padding properties to the same value.

See also

FeathersControl
 InheritedType: Number
The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin.

See also

FeathersControl
 InheritedType: Number
The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin.

See also

FeathersControl
 InheritedType: Number
The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin.

See also

FeathersControl
 InheritedType: Number
The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin.

See also

FeathersControl
 InheritedType: starling.text.TextFormat
The font styles used to display the button's text.

See also

Button
 InheritedType: Number
The space, in pixels, between the icon and the label.

See also

Button
 InheritedType: Boolean
Determines if the button's label text renderer is created or not.
Button
 InheritedType: String
The location where the button's content is aligned horizontally (on the x-axis).

See also

Button
 InheritedType: starling.display.DisplayObject
The icon used for the button's hover state.

See also

Button
 InheritedType: starling.display.DisplayObject
The skin used for the button's hover state.

See also

BasicButton
 InheritedType: starling.text.TextFormat
The font styles used to display the item renderer's icon label text when the item renderer is disabled.

See also

BaseDefaultItemRenderer
 InheritedType: starling.text.TextFormat
The font styles used to display the item renderer's icon label text.

See also

BaseDefaultItemRenderer
 InheritedType: starling.text.TextFormat
The font styles used to display the item renderer's icon label text when the item renderer is selected.

See also

BaseDefaultItemRenderer
 InheritedType: Number
Offsets the x position of the icon by a certain number of pixels.

See also

Button
 InheritedType: Number
Offsets the y position of the icon by a certain number of pixels.

See also

Button
 InheritedType: String
The location of the icon, relative to the label.

See also

Button
 InheritedType: Boolean
Determines if a pressed button should remain in the down state if a touch moves outside of the button's bounds.
BasicButton
 InheritedType: Number
Offsets the x position of the label by a certain number of pixels.

See also

Button
 InheritedType: Number
Offsets the y position of the label by a certain number of pixels.

See also

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

See also

BaseDefaultItemRenderer
 InheritedType: Number
If the value of the accessoryGap property is Number.POSITIVE_INFINITY, meaning that the gap will fill as much space as possible, the final calculated value will not be smaller than the value of the minAccessoryGap property.

See also

BaseDefaultItemRenderer
 InheritedType: Number
If the value of the gap property is Number.POSITIVE_INFINITY, meaning that the gap will fill as much space as possible, the final calculated value will not be smaller than the value of the minGap property.

See also

Button
 InheritedType: Number
Quickly sets all padding properties to the same value.

See also

Button
 InheritedType: Number
The minimum space, in pixels, between the button's bottom edge and the button's content.

See also

Button
 InheritedType: Number
The minimum space, in pixels, between the button's left edge and the button's content.

See also

Button
 InheritedType: Number
The minimum space, in pixels, between the button's right edge and the button's content.

See also

Button
 InheritedType: Number
The minimum space, in pixels, between the button's top edge and the button's content.

See also

Button
 InheritedType: Number
The button renders at this scale in the down state.

See also

Button
 InheritedType: Number
The button renders at this scale in the hover state.

See also

Button
 InheritedType: Number
If not NaN, the button renders at this scale when selected.

See also

ToggleButton
 InheritedType: starling.display.DisplayObject
The icon used for the button's disabled state when the button is selected.

See also

ToggleButton
 InheritedType: starling.display.DisplayObject
The skin used for the button's disabled state when the button is selected.

See also

ToggleButton
 InheritedType: starling.display.DisplayObject
The icon used for the button's down state when the button is selected.

See also

ToggleButton
 InheritedType: starling.display.DisplayObject
The skin used for the button's down state when the button is selected.

See also

ToggleButton
 InheritedType: starling.text.TextFormat
The font styles used to display the button's text when the button is selected.

See also

ToggleButton
 InheritedType: starling.display.DisplayObject
The icon used for the button's hover state when the button is selected.

See also

ToggleButton
 InheritedType: starling.display.DisplayObject
The skin used for the button's hover state when the button is selected.

See also

ToggleButton
 InheritedType: starling.display.DisplayObject
The icon used for the button's up state when the button is selected.

See also

ToggleButton
 InheritedType: starling.display.DisplayObject
The skin used for the button's up state when the button is selected.

See also

ToggleButton
 InheritedType: starling.display.DisplayObject
The icon used for the button's up state.

See also

Button
 InheritedType: starling.display.DisplayObject
The skin used for the button's up state.

See also

BasicButton
 InheritedType: Boolean
If true, the down state (and subsequent state changes) will be delayed to improve the user experience when scrolling on a touch screen.
BaseDefaultItemRenderer
 InheritedType: String
The location where the button's content is aligned vertically (on the y-axis).

See also

Button
 InheritedType: Boolean
Determines if the text wraps to the next line when it reaches the width (or max width) of the component.
Button
Public Constants
 ConstantDefined By
 InheritedALTERNATE_STYLE_NAME_BACK_BUTTON : String = feathers-back-button
[static] An alternate style name to use with Button to allow a theme to give it a "back button" style, perhaps with an arrow pointing backward.
Button
 InheritedALTERNATE_STYLE_NAME_CALL_TO_ACTION_BUTTON : String = feathers-call-to-action-button
[static] An alternate style name to use with Button to allow a theme to give it a more prominent, "call-to-action" style.
Button
  ALTERNATE_STYLE_NAME_CHECK : String = feathers-check-item-renderer
[static] An alternate style name to use with the default item renderer to allow a theme to give it a "check" style.
DefaultDataGridCellRenderer
 InheritedALTERNATE_STYLE_NAME_DANGER_BUTTON : String = feathers-danger-button
[static] An alternate style name to use with Button to allow a theme to give it a highly prominent, "danger" style.
Button
 InheritedALTERNATE_STYLE_NAME_DRILL_DOWN : String = feathers-drill-down-item-renderer
[static] An alternate style name to use with the default item renderer to allow a theme to give it a "drill-down" style.
BaseDefaultItemRenderer
 InheritedALTERNATE_STYLE_NAME_FORWARD_BUTTON : String = feathers-forward-button
[static] An alternate style name to use with Button to allow a theme to give it a "forward" button style, perhaps with an arrow pointing forward.
Button
 InheritedALTERNATE_STYLE_NAME_QUIET_BUTTON : String = feathers-quiet-button
[static] An alternate style name to use with Button to allow a theme to give it a less prominent, "quiet" style.
Button
  DEFAULT_CHILD_STYLE_NAME_ACCESSORY_LABEL : String = feathers-item-renderer-accessory-label
[static] The default value added to the styleNameList of the accessory label, if it exists.
DefaultDataGridCellRenderer
 InheritedDEFAULT_CHILD_STYLE_NAME_ACCESSORY_LOADER : String = feathers-item-renderer-accessory-loader
[static] The default value added to the styleNameList of the accessory loader, if it exists.
BaseDefaultItemRenderer
  DEFAULT_CHILD_STYLE_NAME_ICON_LABEL : String = feathers-item-renderer-icon-label
[static] The default value added to the styleNameList of the icon label, if it exists.
DefaultDataGridCellRenderer
 InheritedDEFAULT_CHILD_STYLE_NAME_ICON_LOADER : String = feathers-item-renderer-icon-loader
[static] The default value added to the styleNameList of the icon loader, if it exists.
BaseDefaultItemRenderer
  DEFAULT_CHILD_STYLE_NAME_LABEL : String = feathers-item-renderer-label
[static] The default value added to the styleNameList of the primary label.
DefaultDataGridCellRenderer
 InheritedINVALIDATION_FLAG_ALL : String = all
[static] Flag to indicate that everything is invalid and should be redrawn.
FeathersControl
 InheritedINVALIDATION_FLAG_DATA : String = data
[static] Invalidation flag to indicate that the primary data displayed by the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_FOCUS : String = focus
[static] Invalidation flag to indicate that the focus of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_LAYOUT : String = layout
[static] Invalidation flag to indicate that the layout of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SCROLL : String = scroll
[static] Invalidation flag to indicate that the scroll position of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SELECTED : String = selected
[static] Invalidation flag to indicate that the selection of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SIZE : String = size
[static] Invalidation flag to indicate that the dimensions of the UI control have changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SKIN : String = skin
[static] Invalidation flag to indicate that the skin of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STATE : String = state
[static] Invalidation flag to indicate that the state has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STYLES : String = styles
[static] Invalidation flag to indicate that the styles or visual appearance of the UI control has changed.
FeathersControl
Property Detail
columnproperty
column:DataGridColumn

The column where the cell is rendered in the data grid.

This property is set by the data grid, and should not be set manually.


Implementation
    public function get column():DataGridColumn
    public function set column(value:DataGridColumn):void
columnIndexproperty 
columnIndex:int

The index (numeric position, starting from zero) of the item within the data grid's columns.

This property is set by the data grid, and should not be set manually.


Implementation
    public function get columnIndex():int
    public function set columnIndex(value:int):void
dataFieldproperty 
dataField:String

The field used to access this column's data from the item within the data grid's data provider. Like the data property, this value may change if this item renderer is reused by the data grid for a different item.

This property is set by the data grid, and should not be set manually.


Implementation
    public function get dataField():String
    public function set dataField(value:String):void
globalStyleProviderproperty 
public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all DefaultListItemRenderer components.

The default value is null.

See also

ownerproperty 
owner:DataGrid

The data grid that contains this cell renderer.

This property is set by the data grid, and should not be set manually.


Implementation
    public function get owner():DataGrid
    public function set owner(value:DataGrid):void
rowIndexproperty 
rowIndex:int

The index (numeric position, starting from zero) of the item within the data grid's data provider. Like the data property, this value may change if this item renderer is reused by the list for a different item.

This property is set by the data grid, and should not be set manually.


Implementation
    public function get rowIndex():int
    public function set rowIndex(value:int):void
Constructor Detail
DefaultDataGridCellRenderer()Constructor
public function DefaultDataGridCellRenderer()

Constructor.

Constant Detail
ALTERNATE_STYLE_NAME_CHECKConstant
public static const ALTERNATE_STYLE_NAME_CHECK:String = feathers-check-item-renderer

An alternate style name to use with the default item renderer to allow a theme to give it a "check" style. If a theme does not provide a style for a check item renderer, the theme will automatically fall back to using the default item renderer style.

An alternate style name should always be added to a component's styleNameList before the component is initialized. If the style name is added later, it will be ignored.

In the following example, the check item renderer style is applied to a list's item renderers:

    list.itemRendererFactory = function():IListItemRenderer
    {
        var itemRenderer:DefaultListItemRenderer = new DefaultListItemRenderer();
        itemRenderer.styleNameList.add( DefaultListItemRenderer.ALTERNATE_STYLE_NAME_CHECK );
        return itemRenderer;
    };

See also

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

The default value added to the styleNameList of the accessory label, if it exists.

See also

DEFAULT_CHILD_STYLE_NAME_ICON_LABELConstant 
public static const DEFAULT_CHILD_STYLE_NAME_ICON_LABEL:String = feathers-item-renderer-icon-label

The default value added to the styleNameList of the icon label, if it exists.

See also

DEFAULT_CHILD_STYLE_NAME_LABELConstant 
public static const DEFAULT_CHILD_STYLE_NAME_LABEL:String = feathers-item-renderer-label

The default value added to the styleNameList of the primary label.

See also