Package | com.ghostwire.ui.containers |
Class | public class uiScrollPane |
Inheritance | uiScrollPane ![]() ![]() ![]() |
uiScrollPane
component is used to display content within a scrollable area.
"addChild()" and "addChildAt()" Methods
Trying to addChild()
or addChildAt()
on the uiScrollPane
component itself will throw an error.
"content" Property
Note that the uiScrollPane
itself is not the container; the actual container is an
embedded uiPane
instance which you can access via the content
property.
Therefore, to add child objects, you must do so via this uiPane
instance. Example:
scrollpane.content.addChild(childObj);
Alternatively, you could create a new uiPane
, add child objects to it, and then set
that uiPane
instance as the content
of the uiScrollPane
.
Example:
var contentPane:uiPane = new uiPane();
contentPane.addChild(childObject);
scrollpane.content = contentPane;
"skin" Property
The default value is null
. The skins of the embedded scrollbars depend on what
uiScrollBar
and uiVScrollBar
are using and are not affected by what
the "skin"
property of the uiScrollPane
itself.
Default Size
The component has a default desired size of 100 x 100 (width x height).
~ This class is available in Aspire UI Components Lite Edition ~
Property | Defined by | ||
---|---|---|---|
![]() | alignX : Number
Indicates how the component would like to be aligned horizontally within its allocated space.
| uiComponent | |
![]() | alignY : Number
Indicates how the component would like to be aligned vertically within its allocated space.
| uiComponent | |
![]() | background : Object
Indicates the style of the background for this component.
| uiComponent | |
![]() | container : uiComponent
Indicates the
uiComponent instance that contains this instance. | uiComponent | |
content : uiPane
Returns the
uiPane instance that is used as the content container. | uiScrollPane | ||
defaultBackground : Object [static]
Indicates the default background object to use for all new instances of
uiScrollPane . | uiScrollPane | ||
![]() | depth : int
Indicates how deep the component is in the containment hierarchy.
| uiComponent | |
![]() | desiredAllocationHeight : int
Indicates the vertical space this component would like to be allocated.
| uiComponent | |
![]() | desiredAllocationWidth : int
Indicates the horizontal space this component would like to be allocated.
| uiComponent | |
![]() | enabled : Boolean
Indicates whether the component is enabled for user interaction.
| uiComponent | |
![]() | fillX : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated
horizontal space.
| uiComponent | |
![]() | fillY : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated
vertical space.
| uiComponent | |
![]() | focusPadding : Object
Indicates the thickness of the interior space from the edge of the component to the focus
rectangle.
| uiComponent | |
![]() | focusRect : Object
Indicates the class to use when rendering the rectangle around the component to indicate that it
is in focus.
| uiComponent | |
![]() | height : Number
Indicates the current
height of the component. | uiComponent | |
![]() | hScrollPolicy : String
A
String value indicating if the horizontal scroll bar should be shown. | uiScrollable | |
![]() | margin : Object
Indicates the thickness of the space surrounding the component.
| uiComponent | |
![]() | maxHeight : int
Indicates the upper limit for
height . | uiComponent | |
![]() | maxWidth : int
Indicates the upper limit for
width . | uiComponent | |
![]() | minHeight : int
Indicates the lower limit for
height . | uiComponent | |
![]() | minWidth : int
Indicates the lower limit for
width . | uiComponent | |
![]() | padding : Object
Indicates the thickness of the interior space from the edge of the component to the content area,
which is where child components, if any, are contained.
| uiComponent | |
![]() | rangeH : uiRange
Returns the
uiRange object used to represent the horizontal scroll range. | uiScrollable | |
![]() | rangeV : uiRange
Returns the
uiRange object used to represent the vertical scroll range. | uiScrollable | |
![]() | scrollX : Number
Indicates the horizontal scroll position.
| uiScrollable | |
![]() | scrollY : Number
Indicates the vertical scroll position.
| uiScrollable | |
![]() | skin : String
Indicates the name of the skin to use for this component instance.
| uiComponent | |
![]() | stretch : Boolean
Indicates whether surplus space available in the parent container should be allocated to this
component.
| uiComponent | |
![]() | textStyle : String
Indicates the style to use for
uiText instances contained in this component. | uiComponent | |
![]() | toolTip : Object
Indicates the content (text) of the tooltip that should be shown when the mouse hovers
over this control.
| uiComponent | |
![]() | uihscrollbar : uiScrollBar
Returns the
uiScrollBar instance used in this component. | uiScrollable | |
![]() | uiskin : uiBitmapImage
Returns the
uiBitmapImage rendered as the skin - for advanced users only. | uiComponent | |
![]() | uivscrollbar : uiVScrollBar
Returns the
uiVScrollBar instance used in this component. | uiScrollable | |
![]() | visible : Boolean
Indicates whether or not the component is visible within its container.
| uiComponent | |
![]() | vScrollPolicy : String
A
String value indicating if the vertical scroll bar should be shown. | uiScrollable | |
![]() | width : Number
Indicates the current
width of the component. | uiComponent |
Method | Defined by | ||
---|---|---|---|
Constructor - creates a new
uiScrollPane instance. | uiScrollPane | ||
![]() |
invalidate(type:String):void
Invalidates this component's "size", "display", "layout" or "textstyle".
| uiComponent | |
![]() |
move(x:Number, y:Number, noEvent:Boolean = false):void
Moves the component to the specified position, disregarding its allocation.
| uiComponent | |
![]() |
removeAllChildren(all:Boolean = false):void
Removes all children from this component.
| uiComponent | |
![]() |
setFocus(flag:Boolean = true):void
Gives this component instance the focus; the component must be on the display list and has its
tabEnabled property set to true , otherwise this method will fail
silently. | uiComponent | |
![]() |
setScrollPosition(x:int, y:int, noEvent:Boolean = false):void
Sets the
scrollX and scrollY positions, dispatching a "scroll" event. | uiScrollable | |
![]() |
setSize(width:Number, height:Number, noEvent:Boolean = false):void
Sets this component's size to the specified
width and height . | uiComponent | |
![]() |
setVisible(value:Boolean, noEvent:Boolean = false):void
Sets the visibility of this component instance, dispatching a "show" or "hide" event accordingly.
| uiComponent | |
![]() |
validateNow():void
Validates and render the component instance, and any component instances with
depth higher than itself in the validation queue, immediately. | uiComponent |
content | property |
content:uiPane
[read-write]
Returns the uiPane
instance that is used as the content container. Note that this
uiPane
is the actual container, not the uiScrollPane
itself. Therefore,
all DisplayObjectContainer
operations must be done via this content
property.
You may also set this property to a uiPane
instance of your choice thereby replacing
the existing embedded instance.
public function get content():uiPane
public function set content(value:uiPane):void
defaultBackground | property |
public static var defaultBackground:Object
Indicates the default background object to use for all new instances of uiScrollPane
.
The default is an opaque white background, {color:0xFFFFFF}
.
uiScrollPane | () | constructor |
public function uiScrollPane()
Constructor - creates a new uiScrollPane
instance.