Package | km.components |
Class | public class ScrollPane |
Inheritance | ScrollPane ![]() ![]() |
Subclasses | ContentPane, List |
Property | Defined by | ||
---|---|---|---|
background : Image
[read-only] >> Reference to the background image.
| ScrollPane | ||
content : * [read-only] Returns a reference to the content of the scrollPane.
| ScrollPane | ||
![]() | duotone : Array The duotone property can be used to convert the colors of the component into duotone.
| UIComponent | |
![]() | enabled : Boolean Specifies if the component is enabled.
If a component is disabled, it will be turned into grayscale and become partly transparent. | UIComponent | |
![]() | height : Number | UIComponent | |
hScrollBar : ScrollBar
[read-only] >> Reference to the horizontal scrollBar.
| ScrollPane | ||
innerHeight : int [read-only] Returns the inner height of the scrollPane.
| ScrollPane | ||
innerWidth : int [read-only] Returns the inner width of the scrollPane.
| ScrollPane | ||
loadIconColor : uint [write-only] Sets the ARGB color value of the icon shown when the scroll pane is loading external content.
| ScrollPane | ||
margin : int The margin between the bounding box of the background and the sub components inside.
| ScrollPane | ||
![]() | toolTip : String Text to use as toolTip when ToolTip is enabled.
| UIComponent | |
vScrollBar : ScrollBar
[read-only] >> Reference to the vertical scrollBar.
| ScrollPane | ||
![]() | width : Number | UIComponent | |
![]() | x : Number | UIComponent | |
![]() | y : Number | UIComponent |
Method | Defined by | ||
---|---|---|---|
ScrollPane | |||
![]() |
clone():*
Returns a clone of the component.
The skin of the component is cloned but other things like the text of a label or the items of a list aren't. | UIComponent | |
contentResized(newWidth:int, newHeight:int, resetScrollPos:Boolean = false):void
Use this function to manually inform the component about changes in size of the content.
| ScrollPane | ||
![]() |
move(x:int, y:int, animationMode:int = 0, animationFrames:int = 12, easeInOut:Boolean = false):void
Moves the component to the specified coordinates.
| UIComponent | |
setContent(content:*, usePrefix:Boolean = true):void
Sets the content for the scrollPane.
| ScrollPane | ||
![]() |
setProperties(o:Object):void
Sets a number of properties at once.
| UIComponent | |
![]() |
setSize(w:int, h:int):void
Sets the size width and height.
| UIComponent |
background | property |
background:Image
[read-only]>> Reference to the background image.
Implementation public function get background():Image
content | property |
content:*
[read-only]Returns a reference to the content of the scrollPane.
Implementation public function get content():*
hScrollBar | property |
hScrollBar:ScrollBar
[read-only]>> Reference to the horizontal scrollBar.
Implementation public function get hScrollBar():ScrollBar
innerHeight | property |
innerHeight:int
[read-only]Returns the inner height of the scrollPane.
Implementation public function get innerHeight():int
innerWidth | property |
innerWidth:int
[read-only]Returns the inner width of the scrollPane.
Implementation public function get innerWidth():int
loadIconColor | property |
loadIconColor:uint
[write-only]Sets the ARGB color value of the icon shown when the scroll pane is loading external content.
Implementation public function set loadIconColor(value:uint):void
margin | property |
public var margin:int
The margin between the bounding box of the background and the sub components inside.
vScrollBar | property |
vScrollBar:ScrollBar
[read-only]>> Reference to the vertical scrollBar.
Implementation public function get vScrollBar():ScrollBar
ScrollPane | () | constructor |
public function ScrollPane()
contentResized | () | method |
public function contentResized(newWidth:int, newHeight:int, resetScrollPos:Boolean = false):void
Use this function to manually inform the component about changes in size of the content.
ParametersnewWidth:int |
|
newHeight:int |
|
resetScrollPos:Boolean (default = false )
|
setContent | () | method |
public function setContent(content:*, usePrefix:Boolean = true):void
Sets the content for the scrollPane. Content can be an asset, DisplayObject or BitmapData object.
Parameterscontent:* |
|
usePrefix:Boolean (default = true )
|