Extra display objects that are not accessible through standard display list functions like getChildAt(), but should appear after those children in the focus order. Typically, this is for containers that have chrome that is hidden from the normal display list API.

May return null if there are no extra children.

Extra display objects that are not accessible through standard display list functions like getChildAt(), but should appear before those children in the focus order. Typically, this is for containers that have chrome that is hidden from the normal display list API.

May return null if there are no extra children.

The footer sub-component.

For internal use in subclasses.

See also

A function used to generate the panel's footer sub-component. The footer must be an instance of IFeathersControl, and by default, there is no footer. This factory can be used to change properties on the footer when it is first created. For instance, if you are skinning Feathers components without a theme, you might use this factory to set skins and other styles on the footer.

The function should have the following signature:

function():IFeathersControl

In the following example, a custom footer factory is provided to the panel:

panel.footerFactory = function():IFeathersControl
{
    return new ScrollContainer();
};

The default value is null.

See also

An object that stores properties for the container's footer sub-component, and the properties will be passed down to the footer when the container validates. Any Feathers component may be used as the container's footer, so the available properties depend on which type of component is returned by footerFactory. Refer to the appropriate documentation for details about which properties are available on the component that you're using as the footer.

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 footerFactory function instead of using footerProperties will result in better performance.

In the following example, the footer properties are customized:

panel.footerProperties.verticalScrollPolicy = ScrollPolicy.OFF;

The default value is null.

See also

The default value added to the styleNameList of the footer. This variable is protected so that sub-classes can customize the footer style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_FOOTER.

To customize the footer style name without subclassing, see customFooterStyleName.

See also

The default IStyleProvider for all Panel components.

The default value is null.

See also

The header sub-component.

For internal use in subclasses.

See also

A function used to generate the panel's header sub-component. The header must be an instance of IFeathersControl, but the default is an instance of Header. This factory can be used to change properties on the header when it is first created. For instance, if you are skinning Feathers components without a theme, you might use this factory to set skins and other styles on the header.

The function should have the following signature:

function():IFeathersControl

In the following example, a custom header factory is provided to the panel:

panel.headerFactory = function():IFeathersControl
{
    var header:Header = new Header();
    var closeButton:Button = new Button();
    closeButton.label = "Close";
    closeButton.addEventListener( Event.TRIGGERED, closeButton_triggeredHandler );
    header.rightItems = new <DisplayObject>[ closeButton ];
    return header;
};

The default value is null.

See also

An object that stores properties for the container's header sub-component, and the properties will be passed down to the header when the container validates. Any Feathers component may be used as the container's header, so the available properties depend on which type of component is returned by headerFactory.

By default, the headerFactory will return a Header instance. If you aren't using a different type of component as the container's header, you can refer to feathers.controls.Header for a list of available properties. Otherwise, refer to the appropriate documentation for details about which properties are available on the component that you're using as the header.

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 headerFactory function instead of using headerProperties will result in better performance.

In the following example, the header properties are customized:

var closeButton:Button = new Button();
closeButton.label = "Close";
closeButton.addEventListener( Event.TRIGGERED, closeButton_triggeredHandler );
panel.headerProperties.rightItems = new <DisplayObject>[ closeButton ];

The default value is null.

See also

The default value added to the styleNameList of the header. This variable is protected so that sub-classes can customize the header style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_HEADER.

To customize the header style name without subclassing, see customHeaderStyleName.

See also

A property of the header that should be used to display the panel's title.

By default, this value is passed to the title property of the header, if that property exists. However, if the header is not a feathers.controls.Header instance, changing the value of titleField will allow the panel to pass the title to a different property name instead.

In the following example, a Button is used as a custom header, and the title is passed to its label property:

panel.headerFactory = function():IFeathersControl
{
    return new Button();
};
panel.titleField = "label";

The default value is "title".

See also

The panel's title to display in the header.

By default, this value is passed to the title property of the header, if that property exists. However, if the header is not a feathers.controls.Header instance, changing the value of titleField will allow the panel to pass its title to a different property on the header instead.

In the following example, a custom header factory is provided to the panel:

panel.title = "Settings";

The default value is null.

See also

Constructor.

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 saveMeasurements() 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.

Creates and adds the footer sub-component and removes the old instance, if one exists.

Meant for internal use, and subclasses may override this function with a custom implementation.

See also

Creates and adds the header sub-component and removes the old instance, if one exists.

Meant for internal use, and subclasses may override this function with a custom implementation.

See also

The minimum space, in pixels, between the panel's left edge and the panel's header, middle content, and footer.

Note: The paddingLeft property applies to the middle content only, and it does not affect the header or footer. Use outerPaddingLeft if you want to include padding around the header and footer too. outerPaddingLeft and paddingLeft may be used simultaneously to define padding around the outer edges of the panel and additional padding around its middle content.

In the following example, the left outer padding is set to 20 pixels:

scroller.outerPaddingLeft = 20;

The default value is 0.

See also

The minimum space, in pixels, between the panel's bottom edge and the panel's footer.

Note: The paddingBottom property applies to the middle content only, and it does not affect the footer. Use outerPaddingBottom if you want to include padding below the footer. outerPaddingBottom and paddingBottom may be used simultaneously to define padding around the outer edges of the panel and additional padding around its middle content.

In the following example, the bottom outer padding is set to 20 pixels:

panel.outerPaddingBottom = 20;

The default value is 0.

See also

The minimum space, in pixels, between the panel's right edge and the panel's header, middle content, and footer.

Note: The paddingRight property applies to the middle content only, and it does not affect the header or footer. Use outerPaddingRight if you want to include padding around the header and footer too. outerPaddingRight and paddingRight may be used simultaneously to define padding around the outer edges of the panel plus additional padding around its middle content.

In the following example, the right outer padding is set to 20 pixels:

panel.outerPaddingRight = 20;

The default value is 0.

See also

The minimum space, in pixels, between the panel's top edge and the panel's header.

Note: The paddingTop property applies to the middle content only, and it does not affect the header. Use outerPaddingTop if you want to include padding above the header. outerPaddingTop and paddingTop may be used simultaneously to define padding around the outer edges of the panel and additional padding around its middle content.

In the following example, the top padding is set to 20 pixels:

panel.outerPaddingTop = 20;

The default value is 0.

See also

Quickly sets all outer padding properties to the same value. The outerPadding getter always returns the value of outerPaddingTop, but the other padding values may be different.

In the following example, the outer padding is set to 20 pixels:

panel.outerPadding = 20;

The default value is 0.

See also

A style name to add to the panel's footer sub-component. Typically used by a theme to provide different styles to different panels.

In the following example, a custom footer style name is passed to the panel:

panel.customFooterStyleName = "my-custom-footer";

In your theme, you can target this sub-component style name to provide different styles than the default (this example assumes that the footer is a ScrollContainer, but it can be any IFeathersControl):

getStyleProviderForClass( ScrollContainer ).setFunctionForStyleName( "my-custom-footer", setCustomFooterStyles );

The default value is null.

See also

A style name to add to the panel's header sub-component. Typically used by a theme to provide different styles to different panels.

In the following example, a custom header style name is passed to the panel:

panel.customHeaderStyleName = "my-custom-header";

In your theme, you can target this sub-component style name to provide different styles than the default (this example assumes that the header is a Header, but it can be any IFeathersControl):

getStyleProviderForClass( Header ).setFunctionForStyleName( "my-custom-header", setCustomHeaderStyles );

The default value is null.

See also

The default value added to the styleNameList of the footer.

See also

The default value added to the styleNameList of the header.

See also