| Package | feathers.controls |
| Class | public class Panel |
| Inheritance | Panel  ScrollContainer Scroller FeathersControl Sprite DisplayObjectContainer DisplayObject EventDispatcher Object |
| Subclasses | PanelScreen |
Default MXML PropertymxmlContent
| Property | Defined By | ||
|---|---|---|---|
 | alpha : Number The opacity of the object. | DisplayObject | |
| backgroundDisabledSkin : DisplayObject
A background to display when the container is disabled. | Scroller | |
| backgroundSkin : DisplayObject
The default background to display. | Scroller | |
| base : DisplayObject [read-only] The topmost object in the display tree the object is part of. | DisplayObject | |
| blendMode : String The blend mode determines how the object is blended with the objects underneath. | DisplayObject | |
| bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject | |
| clipContent : Boolean
If true, the viewport will be clipped to the scroller's bounds. | Scroller | |
| clipRect : Rectangle [override] | FeathersControl | |
| customHeaderName : String
A name to add to the panel's header sub-component. | Panel | ||
| 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 | |
| elasticity : Number
If the scroll position goes outside the minimum or maximum bounds,
the scrolling will be constrained using this multiplier. | Scroller | |
| elasticSnapDuration : Number
The duration, in seconds, of the animation when a the scroller snaps
back to the minimum or maximum position after going out of bounds. | Scroller | |
| filter : FragmentFilter The filter that is attached to the display object. | DisplayObject | |
| focusManager : IFocusManager
The current focus manager for this component. | FeathersControl | |
| hasElasticEdges : Boolean
Determines if the scrolling can go beyond the edges of the viewport. | Scroller | |
| hasVisibleArea : Boolean [read-only] Indicates if an object occupies any visible area. | DisplayObject | |
| headerFactory : Function
A function used to generate the panel's header sub-component. | Panel | ||
| headerProperties : Object
A set of key/value pairs to be passed down to the container's
header sub-component. | Panel | ||
| height : Number [override]
The height of the component, in pixels. | FeathersControl | |
| hideScrollBarAnimationDuration : Number
The duration, in seconds, of the animation when a scroll bar fades
out. | Scroller | |
| hideScrollBarAnimationEase : Object
The easing function used for hiding the scroll bars, if applicable. | Scroller | |
| horizontalPageIndex : int [read-only]
The index of the horizontal page, if snapping is enabled. | Scroller | |
| horizontalScrollBarFactory : Function
Creates the horizontal scroll bar. | Scroller | |
| horizontalScrollBarProperties : Object
A set of key/value pairs to be passed down to the scroller's
horizontal scroll bar instance (if it exists). | Scroller | |
| horizontalScrollPolicy : String
Determines whether the scroller may scroll horizontally (on the
x-axis) or not. | Scroller | |
| horizontalScrollPosition : Number
The number of pixels the scroller has been scrolled horizontally (on
the x-axis). | Scroller | |
| horizontalScrollStep : Number
The number of pixels the scroller can be stepped horizontally. | Scroller | |
| includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
| interactionMode : String
Determines how the user may interact with the scroller. | Scroller | |
| isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
| isFlattened : Boolean [read-only] Indicates if the sprite was flattened. | Sprite | |
| isFocusEnabled : Boolean
Determines if this component can receive focus. | FeathersControl | |
| isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
| isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
| layout : ILayout
Controls the way that the container's children are positioned and
sized. | ScrollContainer | |
| layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
| maxHeight : Number
The maximum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| maxHorizontalScrollPosition : Number [read-only]
The maximum number of pixels the scroller may be scrolled
horizontally (on the x-axis). | Scroller | |
| maxVerticalScrollPosition : Number [read-only]
The maximum number of pixels the scroller may be scrolled vertically
(on the y-axis). | Scroller | |
| 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 | |
| mouseWheelScrollDuration : Number
The duration, in seconds, of the animation when the mouse wheel
initiates a scroll action. | Scroller | |
| name : String [override]
The concatenated nameList, with each name separated by
spaces. | FeathersControl | |
| nameList : TokenList [read-only]
Contains a list of all "names" assigned to this control. | FeathersControl | |
| nextTabFocus : IFocusDisplayObject
The next object that will receive focus when the tab key is pressed. | FeathersControl | |
| numChildren : int [read-only] The number of children of this container. | DisplayObjectContainer | |
| padding : Number
Quickly sets all padding properties to the same value. | Scroller | |
| paddingBottom : Number
The minimum space, in pixels, between the container's bottom edge and
the container's content. | Scroller | |
| paddingLeft : Number
The minimum space, in pixels, between the container's left edge and the
container's content. | Scroller | |
| paddingRight : Number
The minimum space, in pixels, between the container's right edge and
the container's content. | Scroller | |
| paddingTop : Number
The minimum space, in pixels, between the container's top edge and the
container's content. | Scroller | |
| pageThrowDuration : Number
The duration, in seconds, of the animation when the scroller is
thrown to a page. | Scroller | |
| parent : DisplayObjectContainer [read-only] The display object container that contains this display object. | DisplayObject | |
| pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| root : DisplayObject [read-only] The root object the display object is connected to (i.e. | DisplayObject | |
| rotation : Number The rotation of the object in radians. | DisplayObject | |
| scaleX : Number The horizontal scale factor. | DisplayObject | |
| scaleY : Number The vertical scale factor. | DisplayObject | |
| scrollBarDisplayMode : String
Determines how the scroll bars are displayed. | Scroller | |
| scrollerProperties : Object
DEPRECATED: A set of key/value pairs to be passed down to the
container's scroller sub-component. | Scroller | |
| skewX : Number The horizontal skew angle in radians. | DisplayObject | |
| skewY : Number The vertical skew angle in radians. | DisplayObject | |
| snapScrollPositionsToPixels : Boolean
If enabled, the scroll position will always be adjusted to whole
pixels. | Scroller | |
| snapToPages : Boolean
Determines if scrolling will snap to the nearest page. | Scroller | |
| stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected
to the stage. | DisplayObject | |
| throwEase : Object
The easing function used for "throw" animations. | Scroller | |
| touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject | |
| transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject | |
| useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite. | DisplayObject | |
| verticalPageIndex : int [read-only]
The index of the vertical page, if snapping is enabled. | Scroller | |
| verticalScrollBarFactory : Function
Creates the vertical scroll bar. | Scroller | |
| verticalScrollBarProperties : Object
A set of key/value pairs to be passed down to the scroller's
vertical scroll bar instance (if it exists). | Scroller | |
| verticalScrollPolicy : String
Determines whether the scroller may scroll vertically (on the
y-axis) or not. | Scroller | |
| verticalScrollPosition : Number
The number of pixels the scroller has been scrolled vertically (on
the y-axis). | Scroller | |
| verticalScrollStep : Number
The number of pixels the scroller can be stepped vertically. | Scroller | |
| viewPort : IViewPort
The display object displayed and scrolled within the Scroller. | Scroller | |
| visible : Boolean The visibility of the object. | DisplayObject | |
| width : Number [override]
The width of the component, in pixels. | FeathersControl | |
| x : Number The x coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| y : Number The y coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| 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 | |
| displayListBypassEnabled : Boolean = true | ScrollContainer | |
| 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 | |
| header : IFeathersControl
The header sub-component. | Panel | ||
| headerName : String = feathers-panel-header
The default value added to the nameList of the header. | Panel | ||
| horizontalScrollBar : IScrollBar
The horizontal scrollbar instance. | Scroller | |
| horizontalScrollBarName : String = feathers-scroller-horizontal-scroll-bar
The value added to the nameList of the horizontal scroll
bar. | Scroller | |
| pendingHorizontalPageIndex : int = -1
The pending horizontal page index to scroll to after validating. | Scroller | |
| pendingHorizontalScrollPosition : Number = NaN
The pending horizontal scroll position to scroll to after validating. | Scroller | |
| pendingScrollDuration : Number
The duration of the pending scroll action. | Scroller | |
| pendingVerticalPageIndex : int = -1
The pending vertical page index to scroll to after validating. | Scroller | |
| pendingVerticalScrollPosition : Number = NaN
The pending vertical scroll position to scroll to after validating. | Scroller | |
| verticalScrollBar : IScrollBar
The vertical scrollbar instance. | Scroller | |
| verticalScrollBarName : String = feathers-scroller-vertical-scroll-bar
The value added to the nameList of the vertical scroll
bar. | Scroller | |
| Method | Defined By | ||
|---|---|---|---|
Panel()
Constructor. | Panel | ||
| Adds a child to the container. | DisplayObjectContainer | |
| Adds a child to the container at a certain index. | DisplayObjectContainer | |
| addEventListener(type:String, listener:Function):void [override] | DisplayObject | |
| alignPivot(hAlign:String = center, vAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system
of the object. | DisplayObject | |
| broadcastEvent(event:Event):void Dispatches an event on all children (recursively). | DisplayObjectContainer | |
| broadcastEventWith(type:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively). | DisplayObjectContainer | |
| contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively). | DisplayObjectContainer | |
| dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher | |
| dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered
listeners for the given type. | EventDispatcher | |
| dispose():void [override] Disposes the resources of all children. | Sprite | |
| flatten():void Optimizes the sprite for optimal rendering performance. | Sprite | |
| getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Returns a rectangle that completely encloses the object as it appears in another
coordinate system. | Sprite | |
| getChildAt(index:int):DisplayObject Returns a child object at a certain index. | DisplayObjectContainer | |
| getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively). | DisplayObjectContainer | |
| getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found. | DisplayObjectContainer | |
| getClipRect(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle Returns the bounds of the container's clipRect in the given coordinate space, or
null if the sprite doens't have a clipRect. | Sprite | |
| getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
| globalToLocal(globalPoint:Point, resultPoint:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject | |
| hasEventListener(type:String):Boolean Returns if there are listeners registered for a certain event type. | EventDispatcher | |
| hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil if
the test fails. | Sprite | |
| invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending. | FeathersControl | |
| isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not. | FeathersControl | |
| localToGlobal(localPoint:Point, resultPoint:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
| Removes a child from the container. | DisplayObjectContainer | |
| removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index. | DisplayObjectContainer | |
| removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included). | DisplayObjectContainer | |
| removeEventListener(type:String, listener:Function):void [override] | DisplayObject | |
| removeEventListeners(type:String = null):void [override] | DisplayObject | |
| removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject | |
| render(support:RenderSupport, parentAlpha:Number):void [override] Renders the display object with the help of a support object. | Sprite | |
| scrollToPageIndex(horizontalPageIndex:int, verticalPageIndex:int, animationDuration:Number = 0):void
After the next validation, scrolls to a specific page index. | Scroller | |
| scrollToPosition(horizontalScrollPosition:Number, verticalScrollPosition:Number, animationDuration:Number = 0):void
After the next validation, scrolls to a specific position. | Scroller | |
| setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer | |
| setSize(width:Number, height:Number):void
Sets both the width and the height of the control. | FeathersControl | |
| sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function
of the Vector class). | DisplayObjectContainer | |
| stopScrolling():void
If the user is scrolling with touch or if the scrolling is animated,
calling stopScrolling() will cause the scroller to ignore the drag
and stop animations. | Scroller | |
| Swaps the indexes of two children. | DisplayObjectContainer | |
| swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer | |
| unflatten():void Removes the rendering optimizations that were created when flattening the sprite. | Sprite | |
| validate():void [override] | ScrollContainer | |
| Constant | Defined By | ||
|---|---|---|---|
| DEFAULT_CHILD_NAME_HEADER : String = feathers-panel-header [static]
The default value added to the nameList of the header. | Panel | ||
| DEFAULT_CHILD_NAME_HORIZONTAL_SCROLL_BAR : String = feathers-scroller-horizontal-scroll-bar [static]
The default value added to the nameList of the
horizontal scroll bar. | Scroller | |
| DEFAULT_CHILD_NAME_VERTICAL_SCROLL_BAR : String = feathers-scroller-vertical-scroll-bar [static]
The default value added to the nameList of the vertical
scroll bar. | Scroller | |
| INTERACTION_MODE_MOUSE : String = mouse [static]
The user may interact with the scroll bars to scroll. | Panel | ||
| INTERACTION_MODE_TOUCH : String = touch [static]
The user may touch anywhere on the scroller and drag to scroll. | Panel | ||
| 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_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 | |
| SCROLL_BAR_DISPLAY_MODE_FIXED : String = fixed [static]
The scroll bars are always visible and appear next to the scroller's
view port, making the view port smaller than the scroller. | Panel | ||
| SCROLL_BAR_DISPLAY_MODE_FLOAT : String = float [static]
The scroll bars appear above the scroller's view port, and fade out
when not in use. | Panel | ||
| SCROLL_BAR_DISPLAY_MODE_NONE : String = none [static]
The scroll bars are never visible. | Panel | ||
| SCROLL_POLICY_AUTO : String = auto [static]
The scroller may scroll if the view port is larger than the
scroller's bounds. | Panel | ||
| SCROLL_POLICY_OFF : String = off [static]
The scroller does not scroll at all. | Panel | ||
| SCROLL_POLICY_ON : String = on [static]
The scroller will always scroll. | Panel | ||
| customHeaderName | property |
Hide Inherited Public Properties
Show Inherited Public PropertiescustomHeaderName:StringA name to add to the panel's header sub-component. Typically used by a theme to provide different skins to different panels.
public function get customHeaderName():String public function set customHeaderName(value:String):voidSee also
| header | property |
protected var header:IFeathersControlThe header sub-component.
| headerFactory | property |
headerFactory:Function
A function used to generate the panel's header sub-component.
This 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 headerFactory to set
skins and text styles on the header.
The function should have the following signature:
function():IFeathersControl
public function get headerFactory():Function public function set headerFactory(value:Function):voidSee also
| headerName | property |
protected var headerName:String = feathers-panel-header
The default value added to the nameList of the header.
| headerProperties | property |
headerProperties:Object
A set of key/value pairs to be passed down to the container's
header sub-component. The header may be any
feathers.core.IFeathersControl instance, but the default
is a feathers.controls.Header instance.
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 of a SimpleScrollBar
which is in a Scroller which is in a List,
you can use the following syntax:
list.scrollerProperties.@verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);
public function get headerProperties():Object public function set headerProperties(value:Object):voidSee also
| Panel | () | Constructor |
public function Panel()Constructor.
| DEFAULT_CHILD_NAME_HEADER | Constant |
public static const DEFAULT_CHILD_NAME_HEADER:String = feathers-panel-header
The default value added to the nameList of the header.
| INTERACTION_MODE_MOUSE | Constant |
public static const INTERACTION_MODE_MOUSE:String = mouseThe user may interact with the scroll bars to scroll.
| INTERACTION_MODE_TOUCH | Constant |
public static const INTERACTION_MODE_TOUCH:String = touchThe user may touch anywhere on the scroller and drag to scroll.
| SCROLL_BAR_DISPLAY_MODE_FIXED | Constant |
public static const SCROLL_BAR_DISPLAY_MODE_FIXED:String = fixedThe scroll bars are always visible and appear next to the scroller's view port, making the view port smaller than the scroller.
| SCROLL_BAR_DISPLAY_MODE_FLOAT | Constant |
public static const SCROLL_BAR_DISPLAY_MODE_FLOAT:String = floatThe scroll bars appear above the scroller's view port, and fade out when not in use.
| SCROLL_BAR_DISPLAY_MODE_NONE | Constant |
public static const SCROLL_BAR_DISPLAY_MODE_NONE:String = noneThe scroll bars are never visible.
| SCROLL_POLICY_AUTO | Constant |
public static const SCROLL_POLICY_AUTO:String = autoThe scroller may scroll if the view port is larger than the scroller's bounds. If the interaction mode is touch, the elastic edges will only be active if the maximum scroll position is greater than zero. If the scroll bar display mode is fixed, the scroll bar will only be visible when the maximum scroll position is greater than zero.
| SCROLL_POLICY_OFF | Constant |
public static const SCROLL_POLICY_OFF:String = offThe scroller does not scroll at all. If the scroll bar display mode is fixed or float, the scroll bar will never be visible.
| SCROLL_POLICY_ON | Constant |
public static const SCROLL_POLICY_ON:String = onThe scroller will always scroll. If the interaction mode is touch, elastic edges will always be active, even when the maximum scroll position is zero. If the scroll bar display mode is fixed, the scroll bar will always be visible.