Packagekm.components
Classpublic class ScrollPane
InheritanceScrollPane Inheritance UIComponent Inheritance flash.display.Sprite
SubclassesContentPane, List

The ScrollPane component class.


Public Properties
 PropertyDefined by
  background : Image
[read-only] >> Reference to the background image.
ScrollPane
  content : *
[read-only] Returns a reference to the content of the scrollPane.
ScrollPane
 Inheritedduotone : Array
The duotone property can be used to convert the colors of the component into duotone.
UIComponent
 Inheritedenabled : Boolean
Specifies if the component is enabled.
If a component is disabled, it will be turned into grayscale and become partly transparent.
UIComponent
 Inheritedheight : 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
 InheritedtoolTip : String
Text to use as toolTip when ToolTip is enabled.
UIComponent
  vScrollBar : ScrollBar
[read-only] >> Reference to the vertical scrollBar.
ScrollPane
 Inheritedwidth : Number
UIComponent
 Inheritedx : Number
UIComponent
 Inheritedy : Number
UIComponent
Public Methods
 MethodDefined by
  
ScrollPane()
ScrollPane
 Inherited
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
 Inherited
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
 Inherited
setProperties(o:Object):void
Sets a number of properties at once.
UIComponent
 Inherited
setSize(w:int, h:int):void
Sets the size width and height.
UIComponent
Events
 EventSummaryDefined by
 Inherited
animationComplete
The animationComplete event is broadcasted when an animated move is completed.UIComponent
Property detail
backgroundproperty
background:Image  [read-only]

>> Reference to the background image.

Implementation
    public function get background():Image
contentproperty 
content:*  [read-only]

Returns a reference to the content of the scrollPane.

Implementation
    public function get content():*
hScrollBarproperty 
hScrollBar:ScrollBar  [read-only]

>> Reference to the horizontal scrollBar.

Implementation
    public function get hScrollBar():ScrollBar
innerHeightproperty 
innerHeight:int  [read-only]

Returns the inner height of the scrollPane.

Implementation
    public function get innerHeight():int
innerWidthproperty 
innerWidth:int  [read-only]

Returns the inner width of the scrollPane.

Implementation
    public function get innerWidth():int
loadIconColorproperty 
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
marginproperty 
public var margin:int

The margin between the bounding box of the background and the sub components inside.

vScrollBarproperty 
vScrollBar:ScrollBar  [read-only]

>> Reference to the vertical scrollBar.

Implementation
    public function get vScrollBar():ScrollBar
Constructor detail
ScrollPane()constructor
public function ScrollPane()
Method detail
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.

Parameters
newWidth: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.

Parameters
content:*
 
usePrefix:Boolean (default = true)



Last update : 08/31/2009