| Package | feathers.controls.renderers |
| Class | public class DefaultGroupedListItemRenderer |
| Inheritance | DefaultGroupedListItemRenderer  BaseDefaultItemRenderer Button FeathersControl Sprite DisplayObjectContainer DisplayObject EventDispatcher Object |
| Implements | IGroupedListItemRenderer |
See also
| 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 | |
| groupIndex : int
The index of the item's parent group within the data provider of the
grouped list. | DefaultGroupedListItemRenderer | ||
| 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 | |
| itemIndex : int
The index of the item within its parent group. | DefaultGroupedListItemRenderer | ||
| 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 | |
| layoutIndex : int
The index of the item within the layout. | DefaultGroupedListItemRenderer | ||
| 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 | |
| owner : GroupedList
The grouped list that contains this item renderer. | DefaultGroupedListItemRenderer | ||
| 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 | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | DefaultGroupedListItemRenderer | ||
| Adds a child to the container. | DisplayObjectContainer | |
| 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 | |
| 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 | |
| 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 | |
| groupIndex | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesgroupIndex:intThe index of the item's parent group within the data provider of the grouped list.
public function get groupIndex():int public function set groupIndex(value:int):void| itemIndex | property |
itemIndex:intThe index of the item within its parent group.
public function get itemIndex():int public function set itemIndex(value:int):void| layoutIndex | property |
layoutIndex:intThe index of the item within the layout.
public function get layoutIndex():int public function set layoutIndex(value:int):void| owner | property |
owner:GroupedListThe grouped list that contains this item renderer.
public function get owner():GroupedList public function set owner(value:GroupedList):void| DefaultGroupedListItemRenderer | () | Constructor |
public function DefaultGroupedListItemRenderer()Constructor.