Package | com.ghostwire.ui.core |
Class | public class uiScrollable |
Inheritance | uiScrollable ![]() ![]() |
Subclasses | uiListBox, uiScrollPane, uiTextArea |
uiScrollable
class implements the layout of scrollbars and a content area.
Subclasses have to implement the actual scrolling as well as instantiation of the content area.
~ 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 | |
![]() | 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
[read-only]
Returns the
uiRange object used to represent the horizontal scroll range. | uiScrollable | ||
rangeV : uiRange
[read-only]
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
[read-only]
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
[read-only]
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 | ||
---|---|---|---|
![]() |
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 |
Event | Summary | Defined by | ||
---|---|---|---|---|
![]() |
Dispatched when the component's visible property is changed from true to
false via calling the setVisible() method. | uiComponent | ||
![]() |
Dispatched when the component's position within its parent container has changed via calling the
move() method. | uiComponent | ||
![]() |
Dispatched when the component's size has changed via calling the setSize() method. | uiComponent | ||
Dispatched when the scroll position of a scrollable component has changed. | uiScrollable | |||
![]() |
Dispatched when the component's visible property is changed from false to
true via calling the setVisible() method. | uiComponent |
hScrollPolicy | property |
hScrollPolicy:String
[read-write]
A String
value indicating if the horizontal scroll bar should be shown. Qualified
values are SCROLLBAR.ON (always shown), SCROLLBAR.OFF (never shown), or SCROLLBAR.AUTO
(shown when it is needed). Any other values will set the property to SCROLLBAR.AUTO.
The default value is SCROLLBAR.AUTO
.
public function get hScrollPolicy():String
public function set hScrollPolicy(value:String):void
See also
rangeH | property |
rangeH:uiRange
[read-only]
Returns the uiRange
object used to represent the horizontal scroll range.
public function get rangeH():uiRange
rangeV | property |
rangeV:uiRange
[read-only]
Returns the uiRange
object used to represent the vertical scroll range.
public function get rangeV():uiRange
scrollX | property |
scrollX:Number
[read-write]
Indicates the horizontal scroll position. Setting this property is the same as
calling setScrollPosition()
.
public function get scrollX():Number
public function set scrollX(value:Number):void
scrollY | property |
scrollY:Number
[read-write]
Indicates the vertical scroll position. Setting this property is the same as
calling setScrollPosition()
.
public function get scrollY():Number
public function set scrollY(value:Number):void
uihscrollbar | property |
uihscrollbar:uiScrollBar
[read-only]
Returns the uiScrollBar
instance used in this component. This is exposed mainly to
allow your application to access the scrollbar properties such as minThumbSize
,
repeatDelay
, repeatInterval
and range
.
public function get uihscrollbar():uiScrollBar
uivscrollbar | property |
uivscrollbar:uiVScrollBar
[read-only]
Returns the uiVScrollBar
instance used in this component. This is exposed mainly to
allow your application to access the scrollbar properties such as minThumbSize
,
repeatDelay
, repeatInterval
and range
.
public function get uivscrollbar():uiVScrollBar
vScrollPolicy | property |
vScrollPolicy:String
[read-write]
A String
value indicating if the vertical scroll bar should be shown. Qualified
values are SCROLLBAR.ON (always shown), SCROLLBAR.OFF (never shown), or SCROLLBAR.AUTO
(shown when it is needed). Any other values will set the property to SCROLLBAR.AUTO.
The default value is SCROLLBAR.AUTO
.
public function get vScrollPolicy():String
public function set vScrollPolicy(value:String):void
See also
setScrollPosition | () | method |
public function setScrollPosition(x:int, y:int, noEvent:Boolean = false):void
Sets the scrollX
and scrollY
positions, dispatching a "scroll" event.
x:int |
|
y:int |
|
noEvent:Boolean (default = false )
|
scroll | event |
com.ghostwire.ui.events.uiScrollEvent
com.ghostwire.ui.events.uiScrollEvent.SCROLL
Dispatched when the scroll position of a scrollable component has changed.
This event has the following properties:
Property | Value |
---|---|
bubbles | false |
cancelable | false ; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the event object with an event listener. |
target | The object that dispatched the event. The target is
not always the object listening for the event. Use the currentTarget
property to access the object that is listening for the event. |
oldScrollX | A number indicating the old value of the scrollX property. |
oldScrollY | A number indicating the old value of the scrollY property. |