Package | feathers.controls.renderers |
Class | public class BaseDefaultItemRenderer |
Inheritance | BaseDefaultItemRenderer ![]() ![]() ![]() ![]() |
Implements | IFocusContainer |
Subclasses | DefaultGroupedListItemRenderer, DefaultListItemRenderer |
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 ITextRenderer in the accessory position
of the renderer. | BaseDefaultItemRenderer | ||
accessoryLabelFunction : Function
A function that returns a string to be displayed in a
renderer-managed ITextRenderer in the accessory position
of the renderer. | BaseDefaultItemRenderer | ||
accessoryLabelProperties : 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 | ||
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 | ||
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
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 | |
![]() | defaultSelectedIcon : DisplayObject
The icon used when no other icon is defined for the current state
when the button is selected. | ToggleButton | |
![]() | defaultSelectedLabelProperties : 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 button's isSelected property is
true), and the properties will be passed down to the
label text renderer when the button validates. | ToggleButton | |
![]() | defaultSelectedSkin : DisplayObject
The skin used when no other skin is defined for the current state
when the button is selected. | ToggleButton | |
![]() | 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 | |
delayTextureCreationOnScroll : Boolean
If enabled, automatically manages the delayTextureCreation
property on accessory and icon ImageLoader instances
when the owner scrolls. | BaseDefaultItemRenderer | ||
![]() | depth : int [read-only]
The component's depth in the display list, relative to the stage. | FeathersControl | |
![]() | disabledIcon : DisplayObject
The icon used for the button's disabled state. | Button | |
![]() | disabledLabelProperties : Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_DISABLED state,
and the properties will be passed down to the label text renderer
when the button validates. | 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
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_DOWN state, and
the properties will be passed down to the label text renderer when
the button validates. | Button | |
![]() | downSkin : DisplayObject
The skin used for the button's down state. | Button | |
enabledField : String
The field in the item that determines if the item renderer is
enabled, if the list is enabled. | BaseDefaultItemRenderer | ||
enabledFunction : Function
A function used to determine if a specific item is enabled. | BaseDefaultItemRenderer | ||
![]() | focusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be
displayed above the component when showFocus() is
called. | FeathersControl | |
![]() | focusManager : IFocusManager | FeathersControl | |
![]() | focusOwner : IFocusDisplayObject | FeathersControl | |
![]() | focusPadding : Number
Quickly sets all focus padding properties to the same value. | FeathersControl | |
![]() | focusPaddingBottom : Number
The minimum space, in pixels, between the object's bottom edge and the
bottom edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingLeft : Number
The minimum space, in pixels, between the object's left edge and the
left edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingRight : Number
The minimum space, in pixels, between the object's right edge and the
right edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingTop : Number
The minimum space, in pixels, between the object's top edge and the
top edge of the focus indicator skin. | FeathersControl | |
![]() | gap : Number
The space, in pixels, between the icon and the label. | Button | |
![]() | globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all ToggleButton
components. | ToggleButton | |
![]() | hasLabelTextRenderer : Boolean
Determines if the button's label text renderer is created or not. | Button | |
![]() | 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
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_HOVER state, and
the properties will be passed down to the label text renderer when
the button validates. | 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 | ||
iconLabelFactory : Function
A function that generates ITextRenderer that uses the result
of iconLabelField or iconLabelFunction. | BaseDefaultItemRenderer | ||
iconLabelField : 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 | ||
iconLabelFunction : Function
A function that returns a string to be displayed in a
renderer-managed ITextRenderer in the icon position of
the renderer. | BaseDefaultItemRenderer | ||
iconLabelProperties : 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 | ||
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 | |
isChildFocusEnabled : Boolean
Determines if this component's children can receive focus. | BaseDefaultItemRenderer | ||
![]() | isCreated : Boolean [read-only]
Determines if the component has been initialized and validated for
the first time. | FeathersControl | |
![]() | isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
![]() | isFocusEnabled : Boolean | FeathersControl | |
![]() | isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
![]() | isLongPressEnabled : Boolean
Determines if FeathersEventType.LONG_PRESS will be
dispatched. | Button | |
![]() | isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
isSelectableOnAccessoryTouch : Boolean
If enabled, the item renderer may be selected by touching the
accessory. | BaseDefaultItemRenderer | ||
![]() | isSelected : Boolean
Indicates if the button is selected or not. | ToggleButton | |
![]() | isToggle : Boolean
Determines if the button may be selected or deselected as a result of
user interaction. | ToggleButton | |
itemHasAccessory : Boolean
If true, the accessory will come from the renderer's item using the
appropriate field or function for the accessory. | BaseDefaultItemRenderer | ||
itemHasEnabled : Boolean
If true, the renderer's enabled state will come from the renderer's
item using the appropriate field or function for enabled. | BaseDefaultItemRenderer | ||
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 | ||
itemHasSelectable : 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 | ||
itemHasSkin : Boolean
If true, the skin will come from the renderer's item using the
appropriate field or function for the skin. | 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 text renderer
sub-component. | 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 | ||
![]() | longPressDuration : Number
The duration, in seconds, of a long press. | Button | |
![]() | 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 | |
minAccessoryGap : 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. | BaseDefaultItemRenderer | ||
![]() | minGap : 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. | Button | |
![]() | 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 | |
![]() | nextTabFocus : IFocusDisplayObject | FeathersControl | |
![]() | 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 | |
![]() | previousTabFocus : IFocusDisplayObject | FeathersControl | |
![]() | scaleWhenDown : Number
The button renders at this scale in the down state. | Button | |
![]() | scaleWhenHovering : Number
The button renders at this scale in the hover state. | Button | |
selectableField : String
The field in the item that determines if the item renderer can be
selected, if the list allows selection. | BaseDefaultItemRenderer | ||
selectableFunction : Function
A function used to determine if a specific item is selectable. | BaseDefaultItemRenderer | ||
![]() | selectedDisabledIcon : DisplayObject
The icon used for the button's disabled state when the button is
selected. | ToggleButton | |
![]() | selectedDisabledLabelProperties : Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_DISABLED state
(and the button's isSelected property is
true), and the properties will be passed down to the
label text renderer when the button validates. | ToggleButton | |
![]() | selectedDisabledSkin : DisplayObject
The skin used for the button's disabled state when the button is
selected. | ToggleButton | |
![]() | selectedDownIcon : DisplayObject
The icon used for the button's down state when the button is
selected. | ToggleButton | |
![]() | selectedDownLabelProperties : Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_DOWN state (and
the button's isSelected property is true),
and the properties will be passed down to the label text renderer
when the button validates. | ToggleButton | |
![]() | selectedDownSkin : DisplayObject
The skin used for the button's down state when the button is
selected. | ToggleButton | |
![]() | selectedHoverIcon : DisplayObject
The icon used for the button's hover state when the button is
selected. | ToggleButton | |
![]() | selectedHoverLabelProperties : Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_HOVER state (and
the button's isSelected property is true),
and the properties will be passed down to the label text renderer
when the button validates. | ToggleButton | |
![]() | selectedHoverSkin : DisplayObject
The skin used for the button's hover state when the button is
selected. | ToggleButton | |
![]() | selectedUpIcon : DisplayObject
The icon used for the button's up state when the button is
selected. | ToggleButton | |
![]() | selectedUpLabelProperties : Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_UP state (and
the button's isSelected property is true),
and the properties will be passed down to the label text renderer
when the button validates. | ToggleButton | |
![]() | selectedUpSkin : DisplayObject
The skin used for the button's up state when the button is selected. | ToggleButton | |
skinField : String
The field in the item that contains a display object to be displayed
as a background skin. | BaseDefaultItemRenderer | ||
skinFunction : Function
A function used to generate a background skin for a specific item. | BaseDefaultItemRenderer | ||
skinLoaderFactory : Function
A function that generates an ImageLoader that uses the result
of skinSourceField or skinSourceFunction. | BaseDefaultItemRenderer | ||
skinSourceField : 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 | ||
skinSourceFunction : 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 | ||
![]() | 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 | |
stopScrollingOnAccessoryTouch : Boolean
If enabled, calls owner.stopScrolling() when TouchEvents are
dispatched by the accessory. | BaseDefaultItemRenderer | ||
![]() | styleName : String
The concatenated styleNameList, with values separated
by spaces. | FeathersControl | |
![]() | styleNameList : TokenList [read-only]
Contains a list of all "styles" assigned to this control. | FeathersControl | |
![]() | styleProvider : IStyleProvider
When a component initializes, a style provider may be used to set
properties that affect the component's visual appearance. | FeathersControl | |
![]() | upIcon : DisplayObject
The icon used for the button's up state. | Button | |
![]() | upLabelProperties : Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_UP state, and the
properties will be passed down to the label text renderer when the
button validates. | Button | |
![]() | upSkin : DisplayObject
The skin used for the button's up state. | Button | |
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 | |
![]() | width : Number [override]
The width of the component, in pixels. | FeathersControl |
Property | Defined By | ||
---|---|---|---|
accessoryLabelName : String
DEPRECATED: Replaced by accessoryLabelStyleName. | BaseDefaultItemRenderer | ||
accessoryLabelStyleName : String = feathers-item-renderer-accessory-label
The value added to the styleNameList of the accessory
label text renderer, if it exists. | 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 | |
![]() | currentIcon : DisplayObject
The currently visible icon. | Button | |
![]() | currentSkin : DisplayObject
The currently visible skin. | Button | |
![]() | currentState : String
The current touch state of the button. | Button | |
![]() | defaultStyleProvider : IStyleProvider [read-only]
When the FeathersControl constructor is called, the
globalStyleProvider property is set to this value. | 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 | |
iconLabelName : String
DEPRECATED: Replaced by iconLabelStyleName. | BaseDefaultItemRenderer | ||
iconLabelStyleName : String = feathers-item-renderer-icon-label
The value added to the styleNameList of the icon label
text renderer, if it exists. | BaseDefaultItemRenderer | ||
isSelectableWithoutToggle : Boolean = true
Determines if the item renderer can be selected even if
isToggle is set to false. | BaseDefaultItemRenderer | ||
![]() | labelName : String
DEPRECATED: Replaced by labelStyleName. | Button | |
![]() | labelStyleName : String = feathers-button-label
The value added to the styleNameList of the label text
renderer. | Button | |
![]() | labelTextRenderer : ITextRenderer
The text renderer for the button's label. | Button | |
![]() | stateNames : Vector.<String> [read-only]
A list of all valid touch state names for use with currentState. | Button | |
![]() | touchPointID : int = -1
The saved ID of the currently active touch. | Button |
Method | Defined By | ||
---|---|---|---|
Constructor. | BaseDefaultItemRenderer | ||
![]() | hideFocus():void
If the visual indicator of focus has been displayed by
showFocus(), call this function to hide it. | FeathersControl | |
![]() | 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 | ||
![]() | move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single
function call. | FeathersControl | |
![]() | setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single
function call. | FeathersControl | |
![]() | showFocus():void
If the object has focus, an additional visual indicator may
optionally be displayed to highlight the object. | FeathersControl | |
![]() | validate():void
Immediately validates the display object, if it is invalid. | FeathersControl |
Method | Defined By | ||
---|---|---|---|
autoSizeIfNeeded():Boolean [override]
If the component's dimensions have not been set explicitly, it will
measure its content and determine an ideal size for itself. | BaseDefaultItemRenderer | ||
![]() | clearInvalidationFlag(flag:String):void
Clears an invalidation flag. | FeathersControl | |
commitData():void
Updates the renderer to display the item's data. | BaseDefaultItemRenderer | ||
![]() | createLabel():void
Creates the label text renderer sub-component and
removes the old instance, if one exists. | Button | |
![]() | draw():void
Override to customize layout and to adjust properties of children. | FeathersControl | |
![]() | 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 | |
![]() | focusOutHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_OUT
that may be overridden in subclasses to perform additional actions
when the component loses focus. | 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 | ||
itemToEnabled(item:Object):Boolean
Uses the enabled fields and functions to generate a enabled value for
a specific item. | BaseDefaultItemRenderer | ||
itemToIcon(item:Object):DisplayObject
Uses the icon fields and functions to generate an icon for a specific
item. | BaseDefaultItemRenderer | ||
itemToSelectable(item:Object):Boolean
Uses the selectable fields and functions to generate a selectable
value for a specific item. | BaseDefaultItemRenderer | ||
itemToSkin(item:Object):DisplayObject
Uses the skin fields and functions to generate a skin for a specific
item. | BaseDefaultItemRenderer | ||
![]() | layoutContent():void
Positions and sizes the button's content. | Button | |
![]() | refreshFocusIndicator():void
Updates the focus indicator skin by showing or hiding it and
adjusting its position and dimensions. | FeathersControl | |
![]() | refreshIcon():void
Sets the currentIcon property. | Button | |
![]() | refreshSkin():void
Sets the currentSkin property. | Button | |
![]() | setInvalidationFlag(flag:String):void
Sets an invalidation flag. | FeathersControl | |
![]() | setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of
invalidating or not. | FeathersControl | |
![]() | trigger():void
Triggers 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 | ||
![]() | ALTERNATE_NAME_BACK_BUTTON : String = feathers-back-button [static]
DEPRECATED: Replaced by Button.ALTERNATE_STYLE_NAME_BACK_BUTTON. | Button | |
![]() | ALTERNATE_NAME_CALL_TO_ACTION_BUTTON : String = feathers-call-to-action-button [static]
DEPRECATED: Replaced by Button.ALTERNATE_STYLE_NAME_CALL_TO_ACTION_BUTTON. | Button | |
![]() | ALTERNATE_NAME_DANGER_BUTTON : String = feathers-danger-button [static]
DEPRECATED: Replaced by Button.ALTERNATE_STYLE_NAME_DANGER_BUTTON. | Button | |
![]() | ALTERNATE_NAME_FORWARD_BUTTON : String = feathers-forward-button [static]
DEPRECATED: Replaced by Button.ALTERNATE_STYLE_NAME_FORWARD_BUTTON. | Button | |
![]() | ALTERNATE_NAME_QUIET_BUTTON : String = feathers-quiet-button [static]
DEPRECATED: Replaced by Button.ALTERNATE_STYLE_NAME_QUIET_BUTTON. | Button | |
![]() | ALTERNATE_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 | |
![]() | ALTERNATE_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_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 | |
![]() | ALTERNATE_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 | |
![]() | ALTERNATE_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_NAME_ACCESSORY_LABEL : String = feathers-item-renderer-accessory-label [static]
DEPRECATED: Replaced by BaseDefaultItemRenderer.DEFAULT_CHILD_STYLE_NAME_ACCESSORY_LABEL. | BaseDefaultItemRenderer | ||
DEFAULT_CHILD_NAME_ICON_LABEL : String = feathers-item-renderer-icon-label [static]
DEPRECATED: Replaced by BaseDefaultItemRenderer.DEFAULT_CHILD_STYLE_NAME_ICON_LABEL. | BaseDefaultItemRenderer | ||
![]() | DEFAULT_CHILD_NAME_LABEL : String = feathers-button-label [static]
DEPRECATED: Replaced by Button.DEFAULT_CHILD_STYLE_NAME_LABEL. | 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. | 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. | BaseDefaultItemRenderer | ||
![]() | DEFAULT_CHILD_STYLE_NAME_LABEL : String = feathers-button-label [static]
The default value added to the styleNameList of the label. | Button | |
HORIZONTAL_ALIGN_CENTER : String = center [static]
The icon and label will be aligned horizontally to the center of the button. | BaseDefaultItemRenderer | ||
HORIZONTAL_ALIGN_LEFT : String = left [static]
The icon and label will be aligned horizontally to the left edge of the button. | BaseDefaultItemRenderer | ||
HORIZONTAL_ALIGN_RIGHT : String = right [static]
The icon and label will be aligned horizontally to the right edge of the button. | BaseDefaultItemRenderer | ||
ICON_POSITION_BOTTOM : String = bottom [static]
The icon will be positioned below the label. | BaseDefaultItemRenderer | ||
ICON_POSITION_LEFT : String = left [static]
The icon will be positioned to the left of the label. | BaseDefaultItemRenderer | ||
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. | BaseDefaultItemRenderer | ||
ICON_POSITION_MANUAL : String = manual [static]
The icon will be positioned manually with no relation to the position
of the label. | BaseDefaultItemRenderer | ||
ICON_POSITION_RIGHT : String = right [static]
The icon will be positioned to the right of the label. | BaseDefaultItemRenderer | ||
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. | BaseDefaultItemRenderer | ||
ICON_POSITION_TOP : String = top [static]
The icon will be positioned above the label. | BaseDefaultItemRenderer | ||
![]() | 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_FOCUS : String = focus [static]
Invalidation flag to indicate that the focus of 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 | ||
![]() | STATE_DISABLED : String = disabled [static]
Identifier for the button's disabled state. | Button | |
![]() | STATE_DOWN : String = down [static]
Identifier for the button's down state. | Button | |
![]() | STATE_HOVER : String = hover [static]
Identifier for the button's hover state. | Button | |
![]() | STATE_UP : String = up [static]
Identifier for the button's up state. | Button | |
VERTICAL_ALIGN_BOTTOM : String = bottom [static]
The icon and label will be aligned vertically to the bottom edge of the button. | BaseDefaultItemRenderer | ||
VERTICAL_ALIGN_MIDDLE : String = middle [static]
The icon and label will be aligned vertically to the middle of the button. | BaseDefaultItemRenderer | ||
VERTICAL_ALIGN_TOP : String = top [static]
The icon and label will be aligned vertically to the top edge of the button. | BaseDefaultItemRenderer |
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.
Warning: It is your responsibility to dispose all accessories
included in the data provider and accessed with accessoryField
,
or any display objects returned by accessoryFunction
.
These display objects will not be disposed when the list is disposed.
Not disposing an accessory may result in a memory leak.
All of the accessory fields and functions, ordered by priority:
accessorySourceFunction
accessorySourceField
accessoryLabelFunction
accessoryLabelField
accessoryFunction
accessoryField
In the following example, the accessory field is customized:
renderer.accessoryField = "component";
The default value is "accessory"
.
public function get accessoryField():String
public function set accessoryField(value:String):void
See also
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.
Note: As the list scrolls, this function will almost always be called more than once for each individual item in the list's data provider. Your function should not simply return a new accessory every time. This will result in the unnecessary creation and destruction of many icons, which will overwork the garbage collector and hurt performance. It's better to return a new accessory the first time this function is called for a particular item and then return the same accessory if that item is passed to this function again.
Warning: It is your responsibility to dispose all accessories
included in the data provider and accessed with accessoryField
,
or any display objects returned by accessoryFunction
.
These display objects will not be disposed when the list is disposed.
Not disposing an accessory may result in a memory leak.
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
In the following example, the accessory function is customized:
renderer.accessoryFunction = function( item:Object ):DisplayObject { if(item in cachedAccessories) { return cachedAccessories[item]; } var accessory:DisplayObject = createAccessoryForItem( item ); cachedAccessories[item] = accessory; return accessory; };
The default value is null
.
public function get accessoryFunction():Function
public function set accessoryFunction(value:Function):void
See also
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.
In the following example, the accessory gap is set to 20 pixels:
renderer.accessoryGap = 20;
The default value is NaN
.
public function get accessoryGap():Number
public function set accessoryGap(value:Number):void
See also
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
In the following example, the accessory label factory is customized:
renderer.accessoryLabelFactory = function():ITextRenderer { var renderer:TextFieldTextRenderer = new TextFieldTextRenderer(); renderer.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 ); renderer.embedFonts = true; return renderer; };
The default value is null
.
public function get accessoryLabelFactory():Function
public function set accessoryLabelFactory(value:Function):void
See also
accessoryLabelField | property |
accessoryLabelField: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. The renderer will automatically reuse an internal
ITextRenderer
and swap the text when the data changes.
This ITextRenderer
may be skinned by changing the
accessoryLabelFactory
.
Using an accessory label will result in better performance than
passing in a ITextRenderer
through an 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
In the following example, the accessory label field is customized:
renderer.accessoryLabelField = "text";
The default value is "accessoryLabel"
.
public function get accessoryLabelField():String
public function set accessoryLabelField(value:String):void
See also
accessoryLabelFunction | property |
accessoryLabelFunction:Function
A function that returns a string to be displayed in a
renderer-managed ITextRenderer
in the accessory position
of the renderer. The renderer will automatically reuse an internal
ITextRenderer
and swap the text when the data changes.
This ITextRenderer
may be skinned by changing the
accessoryLabelFactory
.
Using an accessory label will result in better performance than
passing in an ITextRenderer
through an 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
In the following example, the accessory label function is customized:
renderer.accessoryLabelFunction = function( item:Object ):String { return item.firstName + " " + item.lastName; };
The default value is null
.
public function get accessoryLabelFunction():Function
public function set accessoryLabelFunction(value:Function):void
See also
accessoryLabelName | property |
accessoryLabelName:String
DEPRECATED: Replaced by accessoryLabelStyleName
.
DEPRECATION WARNING: This property is deprecated starting with Feathers 2.1. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.
protected function get accessoryLabelName():String
protected function set accessoryLabelName(value:String):void
See also
accessoryLabelProperties | property |
accessoryLabelProperties: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. The
available properties depend on which ITextRenderer
implementation is returned by accessoryLabelFactory
.
Refer to feathers.core.ITextRenderer
for a list of available text renderer implementations.
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 which is in a SimpleScrollBar
,
which is in a List
, you can use the following syntax:
list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);
Setting properties in a accessoryLabelFactory
function instead of using accessoryLabelProperties
will
result in better performance.
In the following example, the accessory label properties are customized:
renderer.@accessoryLabelProperties.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 ); renderer.@accessoryLabelProperties.embedFonts = true;
The default value is null
.
public function get accessoryLabelProperties():Object
public function set accessoryLabelProperties(value:Object):void
See also
accessoryLabelStyleName | property |
protected var accessoryLabelStyleName:String = feathers-item-renderer-accessory-label
The value added to the styleNameList
of the accessory
label text renderer, if it exists.
See also
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 screen
density or apply pixel snapping.
The function is expected to have the following signature:
function():ImageLoader
In the following example, the loader factory is customized:
renderer.accessoryLoaderFactory = function():ImageLoader { var loader:ImageLoader = new ImageLoader(); loader.snapToPixels = true; return loader; };
The default value is function():ImageLoader { return new ImageLoader(); }
.
public function get accessoryLoaderFactory():Function
public function set accessoryLoaderFactory(value:Function):void
See also
accessoryOffsetX | property |
accessoryOffsetX:Number
Offsets the x position of the accessory by a certain number of pixels.
In the following example, the accessory x position is adjusted by 20 pixels:
renderer.accessoryOffsetX = 20;
The default value is 0
.
public function get accessoryOffsetX():Number
public function set accessoryOffsetX(value:Number):void
See also
accessoryOffsetY | property |
accessoryOffsetY:Number
Offsets the y position of the accessory by a certain number of pixels.
In the following example, the accessory y position is adjusted by 20 pixels:
renderer.accessoryOffsetY = 20;
The default value is 0
.
public function get accessoryOffsetY():Number
public function set accessoryOffsetY(value:Number):void
See also
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.
In the following example, the accessory is placed on the bottom:
renderer.accessoryPosition = BaseDefaultItemRenderer.ACCESSORY_POSITION_BOTTOM;
The default value is BaseDefaultItemRenderer.ACCESSORY_POSITION_RIGHT
.
public function get accessoryPosition():String
public function set accessoryPosition(value:String):void
See also
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
In the following example, the accessory source field is customized:
renderer.accessorySourceField = "texture";
The default value is "accessorySource"
.
public function get accessorySourceField():String
public function set accessorySourceField(value:String):void
See also
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
.
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.
Note: As the list scrolls, this function will almost always be called more than once for each individual item in the list's data provider. Your function should not simply return a new texture every time. This will result in the unnecessary creation and destruction of many textures, which will overwork the garbage collector and hurt performance. Creating a new texture at all is dangerous, unless you are absolutely sure to dispose it when necessary because neither the list nor its item renderer will dispose of the texture for you. If you are absolutely sure that you are managing the texture memory with proper disposal, it's better to return a new texture the first time this function is called for a particular item and then return the same texture if that item is passed to this function again.
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
In the following example, the accessory source function is customized:
renderer.accessorySourceFunction = function( item:Object ):Object { return "http://www.example.com/thumbs/" + item.name + "-thumb.png"; };
The default value is null
.
public function get accessorySourceFunction():Function
public function set accessorySourceFunction(value:Function):void
See also
data | property |
data:Object
The item displayed by this renderer. This property is set by the list, and should not be set manually.
public function get data():Object
public function set data(value:Object):void
delayTextureCreationOnScroll | property |
delayTextureCreationOnScroll:Boolean
If enabled, automatically manages the delayTextureCreation
property on accessory and icon ImageLoader
instances
when the owner scrolls. This applies to the loaders created when the
following properties are set: accessorySourceField
,
accessorySourceFunction
, iconSourceField
,
and iconSourceFunction
.
In the following example, any loaded textures won't be uploaded to the GPU until the owner stops scrolling:
renderer.delayTextureCreationOnScroll = true;
The default value is false
.
public function get delayTextureCreationOnScroll():Boolean
public function set delayTextureCreationOnScroll(value:Boolean):void
enabledField | property |
enabledField:String
The field in the item that determines if the item renderer is
enabled, if the list is enabled. If the item does not have
this field, and a enabledFunction
is not defined,
then the renderer will default to being enabled.
All of the label fields and functions, ordered by priority:
enabledFunction
enabledField
In the following example, the enabled field is customized:
renderer.itemHasEnabled = true; renderer.enabledField = "isEnabled";
The default value is "enabled"
.
public function get enabledField():String
public function set enabledField(value:String):void
See also
enabledFunction | property |
enabledFunction:Function
A function used to determine if a specific item is enabled. If this
function is not null, then the enabledField
will be
ignored.
The function is expected to have the following signature:
function( item:Object ):Boolean
All of the enabled fields and functions, ordered by priority:
enabledFunction
enabledField
In the following example, the enabled function is customized:
renderer.itemHasEnabled = true; renderer.enabledFunction = function( item:Object ):Boolean { return item.isEnabled; };
The default value is null
.
public function get enabledFunction():Function
public function set enabledFunction(value:Function):void
See also
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.
Warning: It is your responsibility to dispose all icons
included in the data provider and accessed with iconField
,
or any display objects returned by iconFunction
.
These display objects will not be disposed when the list is disposed.
Not disposing an icon may result in a memory leak.
All of the icon fields and functions, ordered by priority:
iconSourceFunction
iconSourceField
iconLabelFunction
iconLabelField
iconFunction
iconField
In the following example, the icon field is customized:
renderer.iconField = "photo";
The default value is "icon"
.
public function get iconField():String
public function set iconField(value:String):void
See also
iconFunction | property |
iconFunction:Function
A function used to generate an icon for a specific item.
Note: As the list scrolls, this function will almost always be called more than once for each individual item in the list's data provider. Your function should not simply return a new icon every time. This will result in the unnecessary creation and destruction of many icons, which will overwork the garbage collector and hurt performance. It's better to return a new icon the first time this function is called for a particular item and then return the same icon if that item is passed to this function again.
Warning: It is your responsibility to dispose all icons
included in the data provider and accessed with iconField
,
or any display objects returned by iconFunction
.
These display objects will not be disposed when the list is disposed.
Not disposing an icon may result in a memory leak.
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
iconLabelFunction
iconLabelField
iconFunction
iconField
In the following example, the icon function is customized:
renderer.iconFunction = function( item:Object ):DisplayObject { if(item in cachedIcons) { return cachedIcons[item]; } var icon:Image = new Image( textureAtlas.getTexture( item.textureName ) ); cachedIcons[item] = icon; return icon; };
The default value is null
.
public function get iconFunction():Function
public function set iconFunction(value:Function):void
See also
iconLabelFactory | property |
iconLabelFactory:Function
A function that generates ITextRenderer
that uses the result
of iconLabelField
or iconLabelFunction
.
CAn be used to set properties on the ITextRenderer
.
The function is expected to have the following signature:
function():ITextRenderer
In the following example, the icon label factory is customized:
renderer.iconLabelFactory = function():ITextRenderer { var renderer:TextFieldTextRenderer = new TextFieldTextRenderer(); renderer.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 ); renderer.embedFonts = true; return renderer; };
The default value is null
.
public function get iconLabelFactory():Function
public function set iconLabelFactory(value:Function):void
See also
iconLabelField | property |
iconLabelField: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. The renderer will automatically reuse an internal
ITextRenderer
and swap the text when the data changes.
This ITextRenderer
may be skinned by changing the
iconLabelFactory
.
Using an icon label will result in better performance than
passing in an ITextRenderer
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
iconLabelFunction
iconLabelField
iconFunction
iconField
In the following example, the icon label field is customized:
renderer.iconLabelField = "text";
The default value is "iconLabel"
.
public function get iconLabelField():String
public function set iconLabelField(value:String):void
See also
iconLabelFunction | property |
iconLabelFunction:Function
A function that returns a string to be displayed in a
renderer-managed ITextRenderer
in the icon position of
the renderer. The renderer will automatically reuse an internal
ITextRenderer
and swap the text when the data changes.
This ITextRenderer
may be skinned by changing the
iconLabelFactory
.
Using an icon label will result in better performance than
passing in an ITextRenderer
through a iconField
or iconFunction
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 icon fields and functions, ordered by priority:
iconSourceFunction
iconSourceField
iconLabelFunction
iconLabelField
iconFunction
iconField
In the following example, the icon label function is customized:
renderer.iconLabelFunction = function( item:Object ):String { return item.firstName + " " + item.lastName; };
The default value is null
.
public function get iconLabelFunction():Function
public function set iconLabelFunction(value:Function):void
See also
iconLabelName | property |
iconLabelName:String
DEPRECATED: Replaced by iconLabelStyleName
.
DEPRECATION WARNING: This property is deprecated starting with Feathers 2.1. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.
protected function get iconLabelName():String
protected function set iconLabelName(value:String):void
See also
iconLabelProperties | property |
iconLabelProperties: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. The
available properties depend on which ITextRenderer
implementation is returned by iconLabelFactory
. Refer to
feathers.core.ITextRenderer
for a list of available text renderer implementations.
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 which is in a SimpleScrollBar
,
which is in a List
, you can use the following syntax:
list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);
Setting properties in a iconLabelFactory
function instead of using iconLabelProperties
will
result in better performance.
In the following example, the icon label properties are customized:
renderer.@iconLabelProperties.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 ); renderer.@iconLabelProperties.embedFonts = true;
The default value is null
.
public function get iconLabelProperties():Object
public function set iconLabelProperties(value:Object):void
See also
iconLabelStyleName | property |
protected var iconLabelStyleName:String = feathers-item-renderer-icon-label
The value added to the styleNameList
of the icon label
text renderer, if it exists.
See also
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 screen
density or apply pixel snapping.
The function is expected to have the following signature:
function():ImageLoader
In the following example, the loader factory is customized:
renderer.iconLoaderFactory = function():ImageLoader { var loader:ImageLoader = new ImageLoader(); loader.snapToPixels = true; return loader; };
The default value is function():ImageLoader { return new ImageLoader(); }
.
public function get iconLoaderFactory():Function
public function set iconLoaderFactory(value:Function):void
See also
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
iconLabelFunction
iconLabelField
iconFunction
iconField
In the following example, the icon source field is customized:
renderer.iconSourceField = "texture";
The default value is "iconSource"
.
public function get iconSourceField():String
public function set iconSourceField(value:String):void
See also
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
.
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.
Note: As the list scrolls, this function will almost always be called more than once for each individual item in the list's data provider. Your function should not simply return a new texture every time. This will result in the unnecessary creation and destruction of many textures, which will overwork the garbage collector and hurt performance. Creating a new texture at all is dangerous, unless you are absolutely sure to dispose it when necessary because neither the list nor its item renderer will dispose of the texture for you. If you are absolutely sure that you are managing the texture memory with proper disposal, it's better to return a new texture the first time this function is called for a particular item and then return the same texture if that item is passed to this function again.
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
iconLabelFunction
iconLabelField
iconFunction
iconField
In the following example, the icon source function is customized:
renderer.iconSourceFunction = function( item:Object ):Object { return "http://www.example.com/thumbs/" + item.name + "-thumb.png"; };
The default value is null
.
public function get iconSourceFunction():Function
public function set iconSourceFunction(value:Function):void
See also
isChildFocusEnabled | property |
isChildFocusEnabled:Boolean
Determines if this component's children can receive focus. This
property is completely independent from the isFocusEnabled
property. In other words, it's possible to disable focus on this
component while still allowing focus on its children (or the other
way around).
In the following example, the focus is disabled:
object.isFocusEnabled = false;
The default value is true
.
public function get isChildFocusEnabled():Boolean
public function set isChildFocusEnabled(value:Boolean):void
See also
isSelectableOnAccessoryTouch | property |
isSelectableOnAccessoryTouch:Boolean
If enabled, the item renderer may be selected by touching the
accessory. By default, the accessory will not trigger selection when
using accessoryField
or accessoryFunction
.
In the following example, the item renderer can be selected when the accessory is touched:
renderer.isSelectableOnAccessoryTouch = true;
The default value is false
.
public function get isSelectableOnAccessoryTouch():Boolean
public function set isSelectableOnAccessoryTouch(value:Boolean):void
isSelectableWithoutToggle | property |
protected var isSelectableWithoutToggle:Boolean = true
Determines if the item renderer can be selected even if
isToggle
is set to false
. Subclasses are
expected to change this value, if required.
itemHasAccessory | property |
itemHasAccessory:Boolean
If true, the accessory will come from the renderer's item using the appropriate field or function for the accessory. If false, the accessory may be set using other means.
In the following example, the item doesn't have an accessory:
renderer.itemHasAccessory = false;
The default value is true
.
public function get itemHasAccessory():Boolean
public function set itemHasAccessory(value:Boolean):void
itemHasEnabled | property |
itemHasEnabled:Boolean
If true, the renderer's enabled state will come from the renderer's item using the appropriate field or function for enabled. If false, the renderer will be enabled if its owner is enabled.
In the following example, the item doesn't have an accessory:
renderer.itemHasEnabled = true;
The default value is false
.
public function get itemHasEnabled():Boolean
public function set itemHasEnabled(value:Boolean):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.
In the following example, the item doesn't have an icon:
renderer.itemHasIcon = false;
The default value is true
.
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.
In the following example, the item doesn't have a label:
renderer.itemHasLabel = false;
The default value is true
.
public function get itemHasLabel():Boolean
public function set itemHasLabel(value:Boolean):void
itemHasSelectable | property |
itemHasSelectable:Boolean
If true, the ability to select the renderer will come from the renderer's item using the appropriate field or function for selectable. If false, the renderer will be selectable if its owner is selectable.
In the following example, the item doesn't have an accessory:
renderer.itemHasSelectable = true;
The default value is false
.
public function get itemHasSelectable():Boolean
public function set itemHasSelectable(value:Boolean):void
itemHasSkin | property |
itemHasSkin:Boolean
If true, the skin will come from the renderer's item using the appropriate field or function for the skin. If false, the skin may be set for each state externally.
In the following example, the item has a skin:
renderer.itemHasSkin = true; renderer.skinField = "background";
The default value is false
.
public function get itemHasSkin():Boolean
public function set itemHasSkin(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
In the following example, the label field is customized:
renderer.labelField = "text";
The default value is "label"
.
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
In the following example, the label function is customized:
renderer.labelFunction = function( item:Object ):String { return item.firstName + " " + item.lastName; };
The default value is null
.
public function get labelFunction():Function
public function set labelFunction(value:Function):void
See also
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
.
In the following example, the layout order is changed:
renderer.layoutOrder = BaseDefaultItemRenderer.LAYOUT_ORDER_LABEL_ACCESSORY_ICON;
The default value is BaseDefaultItemRenderer.LAYOUT_ORDER_LABEL_ICON_ACCESSORY
.
public function get layoutOrder():String
public function set layoutOrder(value:String):void
See also
minAccessoryGap | property |
minAccessoryGap: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.
If the value of minAccessoryGap
is NaN
, the
value of the minGap
property will be used instead.
The following example ensures that the gap is never smaller than 20 pixels:
button.gap = Number.POSITIVE_INFINITY; button.minGap = 20;
renderer.accessoryGap = 20;
The default value is NaN
.
public function get minAccessoryGap():Number
public function set minAccessoryGap(value:Number):void
See also
selectableField | property |
selectableField:String
The field in the item that determines if the item renderer can be
selected, if the list allows selection. If the item does not have
this field, and a selectableFunction
is not defined,
then the renderer will default to being selectable.
All of the label fields and functions, ordered by priority:
selectableFunction
selectableField
In the following example, the selectable field is customized:
renderer.itemHasSelectable = true; renderer.selectableField = "isSelectable";
The default value is "selectable"
.
public function get selectableField():String
public function set selectableField(value:String):void
See also
selectableFunction | property |
selectableFunction:Function
A function used to determine if a specific item is selectable. If this
function is not null, then the selectableField
will be
ignored.
The function is expected to have the following signature:
function( item:Object ):Boolean
All of the selectable fields and functions, ordered by priority:
selectableFunction
selectableField
In the following example, the selectable function is customized:
renderer.itemHasSelectable = true; renderer.selectableFunction = function( item:Object ):Boolean { return item.isSelectable; };
The default value is null
.
public function get selectableFunction():Function
public function set selectableFunction(value:Function):void
See also
skinField | property |
skinField:String
The field in the item that contains a display object to be displayed as a background skin.
All of the icon fields and functions, ordered by priority:
skinSourceFunction
skinSourceField
skinFunction
skinField
In the following example, the skin field is customized:
renderer.itemHasSkin = true; renderer.skinField = "background";
The default value is "skin"
.
public function get skinField():String
public function set skinField(value:String):void
See also
skinFunction | property |
skinFunction:Function
A function used to generate a background skin for a specific item.
Note: As the list scrolls, this function will almost always be called more than once for each individual item in the list's data provider. Your function should not simply return a new display object every time. This will result in the unnecessary creation and destruction of many skins, which will overwork the garbage collector and hurt performance. It's better to return a new skin the first time this function is called for a particular item and then return the same skin if that item is passed to this function again.
The function is expected to have the following signature:
function( item:Object ):DisplayObject
All of the skin fields and functions, ordered by priority:
skinSourceFunction
skinSourceField
skinFunction
skinField
In the following example, the skin function is customized:
renderer.itemHasSkin = true; renderer.skinFunction = function( item:Object ):DisplayObject { if(item in cachedSkin) { return cachedSkin[item]; } var skin:Image = new Image( textureAtlas.getTexture( item.textureName ) ); cachedSkin[item] = skin; return skin; };
The default value is null
.
public function get skinFunction():Function
public function set skinFunction(value:Function):void
See also
skinLoaderFactory | property |
skinLoaderFactory:Function
A function that generates an ImageLoader
that uses the result
of skinSourceField
or skinSourceFunction
.
Useful for transforming the ImageLoader
in some way. For
example, you might want to scale the texture for current screen
density or apply pixel snapping.
The function is expected to have the following signature:
function():ImageLoader
In the following example, the loader factory is customized:
renderer.skinLoaderFactory = function():ImageLoader { var loader:ImageLoader = new ImageLoader(); loader.snapToPixels = true; return loader; };
The default value is function():ImageLoader { return new ImageLoader(); }
.
public function get skinLoaderFactory():Function
public function set skinLoaderFactory(value:Function):void
See also
skinSourceField | property |
skinSourceField: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. 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 skinLoaderFactory
.
Using a skin source will result in better performance than
passing in an ImageLoader
or Image
through
a skinField
or skinFunction
because the renderer can avoid costly display list manipulation.
All of the skin fields and functions, ordered by priority:
skinSourceFunction
skinSourceField
skinFunction
skinField
In the following example, the skin source field is customized:
renderer.itemHasSkin = true; renderer.skinSourceField = "texture";
The default value is "skinSource"
.
public function get skinSourceField():String
public function set skinSourceField(value:String):void
See also
skinSourceFunction | property |
skinSourceFunction: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. 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 skinLoaderFactory
.
Using a skin source will result in better performance than
passing in an ImageLoader
or Image
through
a skinField
or skinnFunction
because the renderer can avoid costly display list manipulation.
Note: As the list scrolls, this function will almost always be called more than once for each individual item in the list's data provider. Your function should not simply return a new texture every time. This will result in the unnecessary creation and destruction of many textures, which will overwork the garbage collector and hurt performance. Creating a new texture at all is dangerous, unless you are absolutely sure to dispose it when necessary because neither the list nor its item renderer will dispose of the texture for you. If you are absolutely sure that you are managing the texture memory with proper disposal, it's better to return a new texture the first time this function is called for a particular item and then return the same texture if that item is passed to this function again.
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 skin fields and functions, ordered by priority:
skinSourceFunction
skinSourceField
skinFunction
skinField
In the following example, the skin source function is customized:
renderer.itemHasSkin = true; renderer.skinSourceFunction = function( item:Object ):Object { return "http://www.example.com/images/" + item.name + "-skin.png"; };
The default value is null
.
public function get skinSourceFunction():Function
public function set skinSourceFunction(value:Function):void
See also
stopScrollingOnAccessoryTouch | property |
stopScrollingOnAccessoryTouch:Boolean
If enabled, calls owner.stopScrolling() when TouchEvents are dispatched by the accessory.
In the following example, the list won't stop scrolling when the accessory is touched:
renderer.stopScrollingOnAccessoryTouch = false;
The default value is true
.
public function get stopScrollingOnAccessoryTouch():Boolean
public function set stopScrollingOnAccessoryTouch(value:Boolean):void
useStateDelayTimer | property |
useStateDelayTimer:Boolean
If true, the down state (and subsequent state changes) will be delayed to make scrolling look nicer.
In the following example, the state delay timer is disabled:
renderer.useStateDelayTimer = false;
The default value is true
.
public function get useStateDelayTimer():Boolean
public function set useStateDelayTimer(value:Boolean):void
BaseDefaultItemRenderer | () | Constructor |
public function BaseDefaultItemRenderer()
Constructor.
autoSizeIfNeeded | () | method |
override protected function autoSizeIfNeeded():Boolean
If the component's dimensions have not been set explicitly, it will
measure its content and determine an ideal size for itself. If the
explicitWidth
or explicitHeight
member
variables are set, those value will be used without additional
measurement. If one is set, but not the other, the dimension with the
explicit value will not be measured, but the other non-explicit
dimension will still need measurement.
Calls setSizeInternal()
to set up the
actualWidth
and actualHeight
member
variables used for layout.
Meant for internal use, and subclasses may override this function with a custom implementation.
ReturnsBoolean |
commitData | () | method |
protected function commitData():void
Updates the renderer to display the item's data. Override this function to pass data to sub-components and react to data changes.
Don't forget to handle the case where the data is null
.
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 |
DisplayObject |
itemToEnabled | () | method |
protected function itemToEnabled(item:Object):Boolean
Uses the enabled fields and functions to generate a enabled value for a specific item.
All of the enabled fields and functions, ordered by priority:
enabledFunction
enabledField
Parameters
item:Object |
Boolean |
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
iconLabelFunction
iconLabelField
iconFunction
iconField
Parameters
item:Object |
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 |
String |
itemToSelectable | () | method |
protected function itemToSelectable(item:Object):Boolean
Uses the selectable fields and functions to generate a selectable value for a specific item.
All of the selectable fields and functions, ordered by priority:
selectableFunction
selectableField
Parameters
item:Object |
Boolean |
itemToSkin | () | method |
protected function itemToSkin(item:Object):DisplayObject
Uses the skin fields and functions to generate a skin for a specific item.
All of the skin fields and functions, ordered by priority:
skinSourceFunction
skinSourceField
skinFunction
skinField
Parameters
item:Object |
DisplayObject |
ACCESSORY_POSITION_BOTTOM | Constant |
public static const ACCESSORY_POSITION_BOTTOM:String = bottom
The accessory will be positioned below its origin.
See also
ACCESSORY_POSITION_LEFT | Constant |
public static const ACCESSORY_POSITION_LEFT:String = left
The accessory will be positioned to the left of its origin.
See also
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
ACCESSORY_POSITION_RIGHT | Constant |
public static const ACCESSORY_POSITION_RIGHT:String = right
The accessory will be positioned to the right of its origin.
See also
ACCESSORY_POSITION_TOP | Constant |
public static const ACCESSORY_POSITION_TOP:String = top
The accessory will be positioned above its origin.
See also
DEFAULT_CHILD_NAME_ACCESSORY_LABEL | Constant |
public static const DEFAULT_CHILD_NAME_ACCESSORY_LABEL:String = feathers-item-renderer-accessory-label
DEPRECATED: Replaced by BaseDefaultItemRenderer.DEFAULT_CHILD_STYLE_NAME_ACCESSORY_LABEL
.
DEPRECATION WARNING: This property is deprecated starting with Feathers 2.1. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.
See also
DEFAULT_CHILD_NAME_ICON_LABEL | Constant |
public static const DEFAULT_CHILD_NAME_ICON_LABEL:String = feathers-item-renderer-icon-label
DEPRECATED: Replaced by BaseDefaultItemRenderer.DEFAULT_CHILD_STYLE_NAME_ICON_LABEL
.
DEPRECATION WARNING: This property is deprecated starting with Feathers 2.1. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.
See also
DEFAULT_CHILD_STYLE_NAME_ACCESSORY_LABEL | Constant |
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_LABEL | Constant |
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
HORIZONTAL_ALIGN_CENTER | Constant |
public static const HORIZONTAL_ALIGN_CENTER:String = center
The icon and label will be aligned horizontally to the center of the button.
See also
HORIZONTAL_ALIGN_LEFT | Constant |
public static const HORIZONTAL_ALIGN_LEFT:String = left
The icon and label will be aligned horizontally to the left edge of the button.
See also
HORIZONTAL_ALIGN_RIGHT | Constant |
public static const HORIZONTAL_ALIGN_RIGHT:String = right
The icon and label will be aligned horizontally to the right edge of the button.
See also
ICON_POSITION_BOTTOM | Constant |
public static const ICON_POSITION_BOTTOM:String = bottom
The icon will be positioned below the label.
See also
ICON_POSITION_LEFT | Constant |
public static const ICON_POSITION_LEFT:String = left
The icon will be positioned to the left of the label.
See also
ICON_POSITION_LEFT_BASELINE | Constant |
public static const ICON_POSITION_LEFT_BASELINE:String = leftBaseline
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.
See also
ICON_POSITION_MANUAL | Constant |
public static const ICON_POSITION_MANUAL:String = manual
The icon will be positioned manually with no relation to the position
of the label. Use iconOffsetX
and iconOffsetY
to set the icon's position.
See also
ICON_POSITION_RIGHT | Constant |
public static const ICON_POSITION_RIGHT:String = right
The icon will be positioned to the right of the label.
See also
ICON_POSITION_RIGHT_BASELINE | Constant |
public static const ICON_POSITION_RIGHT_BASELINE:String = rightBaseline
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.
See also
ICON_POSITION_TOP | Constant |
public static const ICON_POSITION_TOP:String = top
The icon will be positioned above the label.
See also
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.
See also
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.
See also
VERTICAL_ALIGN_BOTTOM | Constant |
public static const VERTICAL_ALIGN_BOTTOM:String = bottom
The icon and label will be aligned vertically to the bottom edge of the button.
See also
VERTICAL_ALIGN_MIDDLE | Constant |
public static const VERTICAL_ALIGN_MIDDLE:String = middle
The icon and label will be aligned vertically to the middle of the button.
See also
VERTICAL_ALIGN_TOP | Constant |
public static const VERTICAL_ALIGN_TOP:String = top
The icon and label will be aligned vertically to the top edge of the button.
See also