Packagede.mightypirates.asul.interfaces
Interfacepublic interface IScrollPane extends IAsulObject, flash.events.IEventDispatcher, IDisposable
ImplementorsScrollPane, ScrollPaneControl

Interface for the ScrollPane component.



Public Properties
 PropertyDefined by
 InheritedclipChildren : Boolean
Clip children of this element (true) or not (false).
IAsulObject
 InheritedmaxHeight : Number
The maximum height of this object.
IAsulObject
 InheritedmaxWidth : Number
The maximum width of this object.
IAsulObject
 InheritedminHeight : Number
The minimum height of this object.
IAsulObject
 InheritedminWidth : Number
The minimum width of this object.
IAsulObject
  mouseMode : String
Mouse interaction scroll mode.
IScrollPane
 Inheritedname : String
The name of this object.
IAsulObject
  scrollX : Number
The current horizontal scroll offset of the scrolling pane, as a percentual value.
IScrollPane
  scrollY : Number
The current vertical scroll offset of the scrolling pane, as a percentual value.
IScrollPane
 Inheritedstyle : Array
A list of style names applicant to this object.
IAsulObject
 Inheritedtagname : String
The XML tagname of the element, e.g.
IAsulObject
Public Methods
 MethodDefined by
 Inherited
Adds another ASUL object as a virtual child to this one.
IAsulObject
 Inherited
clone():DisplayObject
Clones the ASUL object, creating an exact copy of it (based on its ORIGINAL data! Later attribute changes will be discarded.).
IAsulObject
 Inherited
deepGetChildByName(name:String, container:DisplayObjectContainer = null):DisplayObject
This searches the object's children through all child containers until a node with the given name was found.
IAsulObject
 Inherited
dispose():void
Cleans upd the object, removing all listeners, timers and references that might keep the object from being garbage collected.
IDisposable
 Inherited
Removes a virtual child from this ASUL object.
IAsulObject
 Inherited
setAttribute(name:String, value:*):void
Sets an attribute for this element.
IAsulObject
Property detail
mouseModeproperty
mouseMode:String  [read-write]

Mouse interaction scroll mode.

This determines whether the mouse can be used directly to scroll the content. Available modes are none, mouse move and dragging.

Mouse movement ("mouse_move") makes the the scroll position update whenever the mouse is moved, and sets the scroll value relative to the mouse position in the viewport (i.e. if its to the top it's 0, if it's to the bottom it's 1). In this mode it makes no sense to display scroll bars.

Mouse dragging ("mouse_drag") allows the user to "drag" the viewport around.

Implementation
    public function get mouseMode():String
    public function set mouseMode(value:String):void
scrollXproperty 
scrollX:Number  [read-write]

The current horizontal scroll offset of the scrolling pane, as a percentual value.

Implementation
    public function get scrollX():Number
    public function set scrollX(value:Number):void
scrollYproperty 
scrollY:Number  [read-write]

The current vertical scroll offset of the scrolling pane, as a percentual value.

Implementation
    public function get scrollY():Number
    public function set scrollY(value:Number):void