Package | feathers.controls.renderers |
Class | public class DefaultGroupedListHeaderOrFooterRenderer |
Inheritance | DefaultGroupedListHeaderOrFooterRenderer ![]() ![]() |
Implements | IGroupedListHeaderOrFooterRenderer |
See also
Property | Defined By | ||
---|---|---|---|
backgroundDisabledSkin : DisplayObject
A background to display when the component is disabled. | DefaultGroupedListHeaderOrFooterRenderer | ||
backgroundSkin : DisplayObject
A background to behind the component's content. | DefaultGroupedListHeaderOrFooterRenderer | ||
contentField : String
The field in the item that contains a display object to be positioned
in the content position of the renderer. | DefaultGroupedListHeaderOrFooterRenderer | ||
contentFunction : Function
A function that returns a display object to be positioned in the
content position of the renderer. | DefaultGroupedListHeaderOrFooterRenderer | ||
contentLabelFactory : Function
A function that generates an ITextRenderer that uses the result
of contentLabelField or contentLabelFunction. | DefaultGroupedListHeaderOrFooterRenderer | ||
contentLabelField : String
The field in the item that contains a string to be displayed in a
renderer-managed Label in the content position of the
renderer. | DefaultGroupedListHeaderOrFooterRenderer | ||
contentLabelFunction : Function
A function that returns a string to be displayed in a
renderer-managed Label in the content position of the
renderer. | DefaultGroupedListHeaderOrFooterRenderer | ||
contentLabelProperties : Object
An object that stores properties for the content label text renderer
sub-component, and the properties will be passed down to the
text renderer when this component validates. | DefaultGroupedListHeaderOrFooterRenderer | ||
contentLoaderFactory : Function
A function that generates an ImageLoader that uses the result
of contentSourceField or contentSourceFunction. | DefaultGroupedListHeaderOrFooterRenderer | ||
contentSourceField : String
The field in the data that contains a starling.textures.Texture
or a URL that points to a bitmap to be used as the renderer's
content. | DefaultGroupedListHeaderOrFooterRenderer | ||
contentSourceFunction : Function
A function used to generate a starling.textures.Texture
or a URL that points to a bitmap to be used as the renderer's
content. | DefaultGroupedListHeaderOrFooterRenderer | ||
data : Object
Data for a header or footer from the grouped list's data provider. | DefaultGroupedListHeaderOrFooterRenderer | ||
![]() | 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 | |
![]() | depth : int [read-only]
The component's depth in the display list, relative to the stage. | FeathersControl | |
![]() | 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 | |
globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all DefaultGroupedListHeaderOrFooterRenderer
components. | DefaultGroupedListHeaderOrFooterRenderer | ||
groupIndex : int
The index of the group within the data provider of the grouped list. | DefaultGroupedListHeaderOrFooterRenderer | ||
![]() | height : Number [override]
The height of the component, in pixels. | FeathersControl | |
horizontalAlign : String
The location where the renderer's content is aligned horizontally
(on the x-axis). | DefaultGroupedListHeaderOrFooterRenderer | ||
![]() | includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
![]() | 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 | |
![]() | isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
![]() | 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. | DefaultGroupedListHeaderOrFooterRenderer | ||
![]() | 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 | |
![]() | nextTabFocus : IFocusDisplayObject | FeathersControl | |
owner : GroupedList
The grouped list that contains this header or footer renderer. | DefaultGroupedListHeaderOrFooterRenderer | ||
padding : Number
Quickly sets all padding properties to the same value. | DefaultGroupedListHeaderOrFooterRenderer | ||
paddingBottom : Number
The minimum space, in pixels, between the component's bottom edge
and the component's content. | DefaultGroupedListHeaderOrFooterRenderer | ||
paddingLeft : Number
The minimum space, in pixels, between the component's left edge
and the component's content. | DefaultGroupedListHeaderOrFooterRenderer | ||
paddingRight : Number
The minimum space, in pixels, between the component's right edge
and the component's content. | DefaultGroupedListHeaderOrFooterRenderer | ||
paddingTop : Number
The minimum space, in pixels, between the component's top edge and
the component's content. | DefaultGroupedListHeaderOrFooterRenderer | ||
![]() | previousTabFocus : IFocusDisplayObject | FeathersControl | |
![]() | 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 | |
verticalAlign : String
The location where the renderer's content is aligned vertically (on
the y-axis). | DefaultGroupedListHeaderOrFooterRenderer | ||
![]() | width : Number [override]
The width of the component, in pixels. | FeathersControl |
Property | Defined By | ||
---|---|---|---|
![]() | 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 | |
contentLabelName : String
DEPRECATED: Replaced by contentLabelStyleName. | DefaultGroupedListHeaderOrFooterRenderer | ||
contentLabelStyleName : String = feathers-header-footer-renderer-content-label
The value added to the styleNameList of the content
label text renderer. | DefaultGroupedListHeaderOrFooterRenderer | ||
![]() | 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 |
Method | Defined By | ||
---|---|---|---|
Constructor. | DefaultGroupedListHeaderOrFooterRenderer | ||
![]() | 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 | |
![]() | 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
If the component's dimensions have not been set explicitly, it will
measure its content and determine an ideal size for itself. | DefaultGroupedListHeaderOrFooterRenderer | ||
![]() | clearInvalidationFlag(flag:String):void
Clears an invalidation flag. | FeathersControl | |
![]() | 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 | |
itemToContent(item:Object):DisplayObject
Uses the content fields and functions to generate content for a
specific group header or footer. | DefaultGroupedListHeaderOrFooterRenderer | ||
![]() | refreshFocusIndicator():void
Updates the focus indicator skin by showing or hiding it and
adjusting its position and dimensions. | FeathersControl | |
![]() | 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 |
Constant | Defined By | ||
---|---|---|---|
DEFAULT_CHILD_NAME_CONTENT_LABEL : String = feathers-header-footer-renderer-content-label [static]
DEPRECATED: Replaced by DefaultGroupedListHeaderOrFooterRenderer.DEFAULT_CHILD_STYLE_NAME_CONTENT_LABEL. | DefaultGroupedListHeaderOrFooterRenderer | ||
DEFAULT_CHILD_STYLE_NAME_CONTENT_LABEL : String = feathers-header-footer-renderer-content-label [static]
The default value added to the styleNameList of the
content label. | DefaultGroupedListHeaderOrFooterRenderer | ||
HORIZONTAL_ALIGN_CENTER : String = center [static]
The content will be aligned horizontally to the center of the renderer. | DefaultGroupedListHeaderOrFooterRenderer | ||
HORIZONTAL_ALIGN_JUSTIFY : String = justify [static]
The content will be justified horizontally, filling the entire width
of the renderer, minus padding. | DefaultGroupedListHeaderOrFooterRenderer | ||
HORIZONTAL_ALIGN_LEFT : String = left [static]
The content will be aligned horizontally to the left edge of the renderer. | DefaultGroupedListHeaderOrFooterRenderer | ||
HORIZONTAL_ALIGN_RIGHT : String = right [static]
The content will be aligned horizontally to the right edge of the renderer. | DefaultGroupedListHeaderOrFooterRenderer | ||
![]() | 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 | |
VERTICAL_ALIGN_BOTTOM : String = bottom [static]
The content will be aligned vertically to the bottom edge of the renderer. | DefaultGroupedListHeaderOrFooterRenderer | ||
VERTICAL_ALIGN_JUSTIFY : String = justify [static]
The content will be justified vertically, filling the entire height
of the renderer, minus padding. | DefaultGroupedListHeaderOrFooterRenderer | ||
VERTICAL_ALIGN_MIDDLE : String = middle [static]
The content will be aligned vertically to the middle of the renderer. | DefaultGroupedListHeaderOrFooterRenderer | ||
VERTICAL_ALIGN_TOP : String = top [static]
The content will be aligned vertically to the top edge of the renderer. | DefaultGroupedListHeaderOrFooterRenderer |
backgroundDisabledSkin | property |
backgroundDisabledSkin:DisplayObject
A background to display when the component is disabled.
In the following example, the header renderers is given a disabled background skin:
renderer.backgroundDisabledSkin = new Image( texture );
The default value is null
.
public function get backgroundDisabledSkin():DisplayObject
public function set backgroundDisabledSkin(value:DisplayObject):void
backgroundSkin | property |
backgroundSkin:DisplayObject
A background to behind the component's content.
In the following example, the header renderers is given a background skin:
renderer.backgroundSkin = new Image( texture );
The default value is null
.
public function get backgroundSkin():DisplayObject
public function set backgroundSkin(value:DisplayObject):void
contentField | property |
contentField:String
The field in the item that contains a display object to be positioned
in the content position of the renderer. If you wish to display a
texture in the content position, it's better for performance to use
contentSourceField
instead.
All of the content fields and functions, ordered by priority:
contentSourceFunction
contentSourceField
contentLabelFunction
contentLabelField
contentFunction
contentField
In the following example, the content field is customized:
renderer.contentField = "header";
The default value is "content"
.
public function get contentField():String
public function set contentField(value:String):void
See also
contentFunction | property |
contentFunction:Function
A function that returns a display object to be positioned in the
content position of the renderer. If you wish to display a texture in
the content position, it's better for performance to use
contentSourceFunction
instead.
The function is expected to have the following signature:
function( item:Object ):DisplayObject
All of the content fields and functions, ordered by priority:
contentSourceFunction
contentSourceField
contentLabelFunction
contentLabelField
contentFunction
contentField
In the following example, the content function is customized:
renderer.contentFunction = function( item:Object ):DisplayObject { if(item in cachedContent) { return cachedContent[item]; } var content:DisplayObject = createContentForHeader( item ); cachedContent[item] = content; return content; };
The default value is null
.
public function get contentFunction():Function
public function set contentFunction(value:Function):void
See also
contentLabelFactory | property |
contentLabelFactory:Function
A function that generates an ITextRenderer
that uses the result
of contentLabelField
or contentLabelFunction
.
Can be used to set properties on the ITextRenderer
.
In the following example, a custom content label factory is passed to the renderer:
renderer.contentLabelFactory = 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 contentLabelFactory():Function
public function set contentLabelFactory(value:Function):void
See also
contentLabelField | property |
contentLabelField:String
The field in the item that contains a string to be displayed in a
renderer-managed Label
in the content position of the
renderer. The renderer will automatically reuse an internal
Label
and swap the text when the data changes. This
Label
may be skinned by changing the
contentLabelFactory
.
Using an content label will result in better performance than
passing in a Label
through a contentField
or contentFunction
because the renderer can avoid
costly display list manipulation.
All of the content fields and functions, ordered by priority:
contentTextureFunction
contentTextureField
contentLabelFunction
contentLabelField
contentFunction
contentField
In the following example, the content label field is customized:
renderer.contentLabelField = "text";
The default value is "label"
.
public function get contentLabelField():String
public function set contentLabelField(value:String):void
See also
contentLabelFunction | property |
contentLabelFunction:Function
A function that returns a string to be displayed in a
renderer-managed Label
in the content position of the
renderer. The renderer will automatically reuse an internal
Label
and swap the text when the data changes. This
Label
may be skinned by changing the
contentLabelFactory
.
Using an content label will result in better performance than
passing in a Label
through a contentField
or contentFunction
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 content fields and functions, ordered by priority:
contentTextureFunction
contentTextureField
contentLabelFunction
contentLabelField
contentFunction
contentField
In the following example, the content label function is customized:
renderer.contentLabelFunction = function( item:Object ):String { return item.category + " > " + item.subCategory; };
The default value is null
.
public function get contentLabelFunction():Function
public function set contentLabelFunction(value:Function):void
See also
contentLabelName | property |
contentLabelName:String
DEPRECATED: Replaced by contentLabelStyleName
.
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 contentLabelName():String
protected function set contentLabelName(value:String):void
See also
contentLabelProperties | property |
contentLabelProperties:Object
An object that stores properties for the content label text renderer
sub-component, 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 contentLabelFactory
. 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);
In the following example, a custom content label properties are customized:
renderer.contentLabelProperties.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 ); renderer.contentLabelProperties.embedFonts = true;
The default value is null
.
public function get contentLabelProperties():Object
public function set contentLabelProperties(value:Object):void
See also
contentLabelStyleName | property |
protected var contentLabelStyleName:String = feathers-header-footer-renderer-content-label
The value added to the styleNameList
of the content
label text renderer.
See also
contentLoaderFactory | property |
contentLoaderFactory:Function
A function that generates an ImageLoader
that uses the result
of contentSourceField
or contentSourceFunction
.
Useful for transforming the ImageLoader
in some way. For
example, you might want to scale it for current screen density or
apply pixel snapping.
In the following example, a custom content loader factory is passed to the renderer:
renderer.contentLoaderFactory = function():ImageLoader { var loader:ImageLoader = new ImageLoader(); loader.snapToPixels = true; return loader; };
The default value is function():ImageLoader { return new ImageLoader(); }
.
public function get contentLoaderFactory():Function
public function set contentLoaderFactory(value:Function):void
See also
contentSourceField | property |
contentSourceField:String
The field in the data that contains a starling.textures.Texture
or a URL that points to a bitmap to be used as the renderer's
content. 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 contentLoaderFactory
.
Using an content source will result in better performance than
passing in an ImageLoader
or Image
through
contentField
or contentFunction
because the
renderer can avoid costly display list manipulation.
All of the content fields and functions, ordered by priority:
contentSourceFunction
contentSourceField
contentLabelFunction
contentLabelField
contentFunction
contentField
In the following example, the content source field is customized:
renderer.contentSourceField = "texture";
The default value is "source"
.
public function get contentSourceField():String
public function set contentSourceField(value:String):void
See also
contentSourceFunction | property |
contentSourceFunction:Function
A function used to generate a starling.textures.Texture
or a URL that points to a bitmap to be used as the renderer's
content. 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 contentLoaderFactory
.
Using an content source will result in better performance than
passing in an ImageLoader
or Image
through
contentField
or contentFunction
because the
renderer can avoid costly display list manipulation.
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 content fields and functions, ordered by priority:
contentSourceFunction
contentSourceField
contentLabelFunction
contentLabelField
contentFunction
contentField
In the following example, the content source function is customized:
renderer.contentSourceFunction = function( item:Object ):Object { return "http://www.example.com/thumbs/" + item.name + "-thumb.png"; };
The default value is null
.
public function get contentSourceFunction():Function
public function set contentSourceFunction(value:Function):void
See also
data | property |
data:Object
Data for a header or footer from the grouped list's data provider. The data may change if this renderer is reused for a new header or footer because it's no longer needed for the original data.
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
globalStyleProvider | property |
public static var globalStyleProvider:IStyleProvider
The default IStyleProvider
for all DefaultGroupedListHeaderOrFooterRenderer
components.
The default value is null
.
See also
groupIndex | property |
groupIndex:int
The index of the group within the data provider of the grouped list.
This property is set by the list, and should not be set manually.
public function get groupIndex():int
public function set groupIndex(value:int):void
horizontalAlign | property |
horizontalAlign:String
The location where the renderer's content is aligned horizontally (on the x-axis).
In the following example, the horizontal alignment is changed to right:
renderer.horizontalAlign = DefaultGroupedListHeaderOrFooterRenderer.HORIZONTAL_ALIGN_RIGHT;
The default value is DefaultGroupedListHeaderOrFooterRenderer.HORIZONTAL_ALIGN_LEFT
.
public function get horizontalAlign():String
public function set horizontalAlign(value:String):void
See also
layoutIndex | property |
layoutIndex:int
The index of the item within the layout.
This property is set by the list, and should not be set manually.
public function get layoutIndex():int
public function set layoutIndex(value:int):void
owner | property |
owner:GroupedList
The grouped list that contains this header or footer renderer.
This property is set by the list, and should not be set manually.
public function get owner():GroupedList
public function set owner(value:GroupedList):void
padding | property |
padding:Number
Quickly sets all padding properties to the same value. The
padding
getter always returns the value of
paddingTop
, but the other padding values may be
different.
In the following example, the padding is set to 20 pixels:
renderer.padding = 20;
The default value is 0
.
public function get padding():Number
public function set padding(value:Number):void
paddingBottom | property |
paddingBottom:Number
The minimum space, in pixels, between the component's bottom edge and the component's content.
In the following example, the bottom padding is set to 20 pixels:
renderer.paddingBottom = 20;
The default value is 0
.
public function get paddingBottom():Number
public function set paddingBottom(value:Number):void
paddingLeft | property |
paddingLeft:Number
The minimum space, in pixels, between the component's left edge and the component's content.
In the following example, the left padding is set to 20 pixels:
renderer.paddingLeft = 20;
The default value is 0
.
public function get paddingLeft():Number
public function set paddingLeft(value:Number):void
paddingRight | property |
paddingRight:Number
The minimum space, in pixels, between the component's right edge and the component's content.
In the following example, the right padding is set to 20 pixels:
renderer.paddingRight = 20;
The default value is 0
.
public function get paddingRight():Number
public function set paddingRight(value:Number):void
paddingTop | property |
paddingTop:Number
The minimum space, in pixels, between the component's top edge and the component's content.
In the following example, the top padding is set to 20 pixels:
renderer.paddingTop = 20;
The default value is 0
.
public function get paddingTop():Number
public function set paddingTop(value:Number):void
verticalAlign | property |
verticalAlign:String
The location where the renderer's content is aligned vertically (on the y-axis).
In the following example, the vertical alignment is changed to bottom:
renderer.verticalAlign = DefaultGroupedListHeaderOrFooterRenderer.HORIZONTAL_ALIGN_BOTTOM;
The default value is DefaultGroupedListHeaderOrFooterRenderer.VERTICAL_ALIGN_MIDDLE
.
public function get verticalAlign():String
public function set verticalAlign(value:String):void
See also
DefaultGroupedListHeaderOrFooterRenderer | () | Constructor |
public function DefaultGroupedListHeaderOrFooterRenderer()
Constructor.
autoSizeIfNeeded | () | method |
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 |
itemToContent | () | method |
protected function itemToContent(item:Object):DisplayObject
Uses the content fields and functions to generate content for a specific group header or footer.
All of the content fields and functions, ordered by priority:
contentTextureFunction
contentTextureField
contentLabelFunction
contentLabelField
contentFunction
contentField
Parameters
item:Object |
DisplayObject |
DEFAULT_CHILD_NAME_CONTENT_LABEL | Constant |
public static const DEFAULT_CHILD_NAME_CONTENT_LABEL:String = feathers-header-footer-renderer-content-label
DEPRECATED: Replaced by DefaultGroupedListHeaderOrFooterRenderer.DEFAULT_CHILD_STYLE_NAME_CONTENT_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_CONTENT_LABEL | Constant |
public static const DEFAULT_CHILD_STYLE_NAME_CONTENT_LABEL:String = feathers-header-footer-renderer-content-label
The default value added to the styleNameList
of the
content label.
See also
HORIZONTAL_ALIGN_CENTER | Constant |
public static const HORIZONTAL_ALIGN_CENTER:String = center
The content will be aligned horizontally to the center of the renderer.
See also
HORIZONTAL_ALIGN_JUSTIFY | Constant |
public static const HORIZONTAL_ALIGN_JUSTIFY:String = justify
The content will be justified horizontally, filling the entire width of the renderer, minus padding.
See also
HORIZONTAL_ALIGN_LEFT | Constant |
public static const HORIZONTAL_ALIGN_LEFT:String = left
The content will be aligned horizontally to the left edge of the renderer.
See also
HORIZONTAL_ALIGN_RIGHT | Constant |
public static const HORIZONTAL_ALIGN_RIGHT:String = right
The content will be aligned horizontally to the right edge of the renderer.
See also
VERTICAL_ALIGN_BOTTOM | Constant |
public static const VERTICAL_ALIGN_BOTTOM:String = bottom
The content will be aligned vertically to the bottom edge of the renderer.
See also
VERTICAL_ALIGN_JUSTIFY | Constant |
public static const VERTICAL_ALIGN_JUSTIFY:String = justify
The content will be justified vertically, filling the entire height of the renderer, minus padding.
See also
VERTICAL_ALIGN_MIDDLE | Constant |
public static const VERTICAL_ALIGN_MIDDLE:String = middle
The content will be aligned vertically to the middle of the renderer.
See also
VERTICAL_ALIGN_TOP | Constant |
public static const VERTICAL_ALIGN_TOP:String = top
The content will be aligned vertically to the top edge of the renderer.
See also