Packagecom.pcthomatos.components.swfscroll
Classpublic class SWFScrollFrame
InheritanceSWFScrollFrame Inheritance flash.display.Sprite

The SWFScrollFrame class is a wrapper class of SWFScroll. It is recommended you use this class unless the size of your "frame" will be constantly changing. Note: If you want to mimic browser scrollbars use com.pcthomatos.components.swfscroll.SWFScroll instead.

See also

com.pcthomatos.components.swfscroll.SWFScroll
com.pcthomatos.components.swfscroll.SWFScrollStaticSettings


Public Properties
 PropertyDefined by
  buttonBgColor : uint
[write-only] Sets the button background color.
SWFScrollFrame
  buttonBgColorActive : uint
[write-only] Sets the button background color active state.
SWFScrollFrame
  buttonBgColorOn : uint
[write-only] Sets the button background color on state.
SWFScrollFrame
  buttonBgColorOver : uint
[write-only] Sets the button background color over state.
SWFScrollFrame
  buttonTriangleColor : uint
[write-only] Sets the color of the triangle arrow inside the scroll button.
SWFScrollFrame
  graceArea : int
[write-only] Sets the grace area of the scrubber in case a user's mouse isn't directly on the scrubber.
SWFScrollFrame
  scrollbarSize : int
[write-only] Sets the thickness of the scrollbar.
SWFScrollFrame
  scrubberBgColor : uint
[write-only] Sets the scrubber background color Applies to the current instance only.
SWFScrollFrame
  scrubberBgColorActive : uint
[write-only] Sets the scrubber background color active state.
SWFScrollFrame
  scrubberBgColorOn : uint
[write-only] Sets the scrubber background color on state.
SWFScrollFrame
  scrubberBgColorOver : uint
[write-only] Sets the scrubber background color over state.
SWFScrollFrame
  trackBgColor : uint
[write-only] Sets the scroll track background color.
SWFScrollFrame
Public Methods
 MethodDefined by
  
SWFScrollFrame(scrollingArea:Sprite, frameWidth:int, frameHeight:int, stageP:Stage)
Creates the SWFScrollFrame object.
SWFScrollFrame
  
clean():void
Destructor method.
SWFScrollFrame
  
render():void
Once all of your properties are set.
SWFScrollFrame
  
Forces scrubbers to update.
SWFScrollFrame
Property detail
buttonBgColorproperty
buttonBgColor:uint  [write-only]

Sets the button background color. Applies to the current instance only.

The default value is 0xD5D5D5.

Implementation
    public function set buttonBgColor(value:uint):void

See also

buttonBgColorActiveproperty 
buttonBgColorActive:uint  [write-only]

Sets the button background color active state. Applies to the current instance only.

The default value is 0x9EC7D9.

Implementation
    public function set buttonBgColorActive(value:uint):void

See also

buttonBgColorOnproperty 
buttonBgColorOn:uint  [write-only]

Sets the button background color on state. Applies to the current instance only.

The default value is 0xC5C5C5.

Implementation
    public function set buttonBgColorOn(value:uint):void

See also

buttonBgColorOverproperty 
buttonBgColorOver:uint  [write-only]

Sets the button background color over state. Applies to the current instance only.

The default value is 0xD6EEFB.

Implementation
    public function set buttonBgColorOver(value:uint):void

See also

buttonTriangleColorproperty 
buttonTriangleColor:uint  [write-only]

Sets the color of the triangle arrow inside the scroll button. Applies to the current instance only.

The default value is 0x252525.

Implementation
    public function set buttonTriangleColor(value:uint):void

See also

graceAreaproperty 
graceArea:int  [write-only]

Sets the grace area of the scrubber in case a user's mouse isn't directly on the scrubber. Applies to the current instance only.

The default value is 60.

Implementation
    public function set graceArea(value:int):void

See also

scrollbarSizeproperty 
scrollbarSize:int  [write-only]

Sets the thickness of the scrollbar. Applies to the current instance only.

The default value is 20.

Implementation
    public function set scrollbarSize(value:int):void

See also

scrubberBgColorproperty 
scrubberBgColor:uint  [write-only]

Sets the scrubber background color Applies to the current instance only.

The default value is 0xD5D5D5.

Implementation
    public function set scrubberBgColor(value:uint):void

See also

scrubberBgColorActiveproperty 
scrubberBgColorActive:uint  [write-only]

Sets the scrubber background color active state. Applies to the current instance only.

The default value is 0x9EC7D9.

Implementation
    public function set scrubberBgColorActive(value:uint):void

See also

scrubberBgColorOnproperty 
scrubberBgColorOn:uint  [write-only]

Sets the scrubber background color on state. Applies to the current instance only.

The default value is 0xC5C5C5.

Implementation
    public function set scrubberBgColorOn(value:uint):void

See also

scrubberBgColorOverproperty 
scrubberBgColorOver:uint  [write-only]

Sets the scrubber background color over state. Applies to the current instance only.

The default value is 0xD6EEFB.

Implementation
    public function set scrubberBgColorOver(value:uint):void

See also

trackBgColorproperty 
trackBgColor:uint  [write-only]

Sets the scroll track background color. Applies to the current instance only.

The default value is 0xE0E0E0.

Implementation
    public function set trackBgColor(value:uint):void

See also

Constructor detail
SWFScrollFrame()constructor
public function SWFScrollFrame(scrollingArea:Sprite, frameWidth:int, frameHeight:int, stageP:Stage)

Creates the SWFScrollFrame object.

Parameters
scrollingArea:Sprite — Area to be scrolled.
 
frameWidth:int — Width of your frame area.
 
frameHeight:int — Height of your frame area.
 
stageP:Stage — An instance of Stage.
Method detail
clean()method
public function clean():void

Destructor method. In order to properly destroy SWFScrollFrame this method must be run first. Otherwise a memory leak will occur.

render()method 
public function render():void

Once all of your properties are set. Call this method to render your frame. If default properties are used, call this method right after the instance of SWFScrollFrame is created.

updateScrubbers()method 
public function updateScrubbers():void

Forces scrubbers to update.