| Package | com.pcthomatos.components.swfscroll |
| Class | public class SWFScroll |
| Inheritance | SWFScroll  flash.display.Sprite |
See also
| Property | Defined by | ||
|---|---|---|---|
| buttonBgColor : uint [write-only] Sets the button background color.
| SWFScroll | ||
| buttonBgColorActive : uint [write-only] Sets the button background color active state.
| SWFScroll | ||
| buttonBgColorOn : uint [write-only] Sets the button background color on state.
| SWFScroll | ||
| buttonBgColorOver : uint [write-only] Sets the button background color over state.
| SWFScroll | ||
| buttonTriangleColor : uint [write-only] Sets the color of the triangle arrow inside the scroll button.
| SWFScroll | ||
| graceArea : int [write-only] Sets the grace area of the scrubber in case a user's mouse isn't directly on the scrubber.
| SWFScroll | ||
| scrollbarSize : int [write-only] Sets the thickness of the scrollbar.
| SWFScroll | ||
| scrollingArea : Sprite
Gives direct access to the scrolling area for x, y manipulation or scrolling area swapping.
| SWFScroll | ||
| scrubberBgColor : uint [write-only] Sets the scrubber background color Applies to the current instance only.
| SWFScroll | ||
| scrubberBgColorActive : uint [write-only] Sets the scrubber background color active state.
| SWFScroll | ||
| scrubberBgColorOn : uint [write-only] Sets the scrubber background color on state.
| SWFScroll | ||
| scrubberBgColorOver : uint [write-only] Sets the scrubber background color over state.
| SWFScroll | ||
| trackBgColor : uint [write-only] Sets the scroll track background color.
| SWFScroll | ||
| Method | Defined by | ||
|---|---|---|---|
|
SWFScroll(frameAreaP:Sprite, scrollingAreaP:Sprite, minWidthP:int, minHeightP:int, stageP:Stage, browserScrollMimicP:Boolean = false)
Creates the SWFScroll Object
| SWFScroll | ||
|
clean():void
Destructor method.
| SWFScroll | ||
|
hideScrollBars():void
Hides scrollbars until a showOrHide method is called again.
| SWFScroll | ||
|
originalframeAreaSize(frameWidthP:int, frameHeightP:int):void
Reverts to the original minimum width and minimum height properties.
| SWFScroll | ||
|
originalframeAreaSizeH(frameWidthP:int, frameHeightP:int):void
Reverts to the original minimum width and minimum height properties.
| SWFScroll | ||
|
originalframeAreaSizeV(frameWidthP:int, frameHeightP:int):void
Reverts to the original minimum width and minimum height properties.
| SWFScroll | ||
|
resetframeAreaSize(newMinWidthP:int, newMinHeightP:int, frameWidthP:int, frameHeightP:int):void
Updates the minimum width and minimum height properties.
| SWFScroll | ||
|
resetframeAreaSizeH(newMinWidthP:int, newMinHeightP:int, frameWidthP:int, frameHeightP:int):void
Updates the minimum width and minimum height properties.
| SWFScroll | ||
|
resetframeAreaSizeV(newMinWidthP:int, newMinHeightP:int, frameWidthP:int, frameHeightP:int):void
Updates the minimum width and minimum height properties.
| SWFScroll | ||
|
showOrHideScrollBarH(frameWidthP:int, frameHeightP:int):void
Displays a horizontal scrollbar depending on if the scrolling area width exceeds the frame width.
| SWFScroll | ||
|
showOrHideScrollBars(frameWidthP:int, frameHeightP:int):void
Displays a horizontal scrollbar depending on if the scrolling area width exceeds the frame width.
| SWFScroll | ||
|
showOrHideScrollBarV(frameWidthP:int, frameHeightP:int):void
Displays a vertical scrollbar depending on if the scrolling area height exceeds the frame height.
| SWFScroll | ||
|
updateScrubbers():void
Forces scrubbers to update.
| SWFScroll | ||
| buttonBgColor | property |
buttonBgColor:uint [write-only]Sets the button background color. Applies to the current instance only.
The default value is 0xD5D5D5.
public function set buttonBgColor(value:uint):void
See also
| buttonBgColorActive | property |
buttonBgColorActive:uint [write-only]Sets the button background color active state. Applies to the current instance only.
The default value is 0x9EC7D9.
public function set buttonBgColorActive(value:uint):void
See also
| buttonBgColorOn | property |
buttonBgColorOn:uint [write-only]Sets the button background color on state. Applies to the current instance only.
The default value is 0xC5C5C5.
public function set buttonBgColorOn(value:uint):void
See also
| buttonBgColorOver | property |
buttonBgColorOver:uint [write-only]Sets the button background color over state. Applies to the current instance only.
The default value is 0xD6EEFB.
public function set buttonBgColorOver(value:uint):void
See also
| buttonTriangleColor | property |
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.
public function set buttonTriangleColor(value:uint):void
See also
| graceArea | property |
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.
public function set graceArea(value:int):void
See also
| scrollbarSize | property |
scrollbarSize:int [write-only]Sets the thickness of the scrollbar. Applies to the current instance only.
The default value is 20.
public function set scrollbarSize(value:int):void
See also
| scrollingArea | property |
public var scrollingArea:SpriteGives direct access to the scrolling area for x, y manipulation or scrolling area swapping.
| scrubberBgColor | property |
scrubberBgColor:uint [write-only]Sets the scrubber background color Applies to the current instance only.
The default value is 0xD5D5D5.
public function set scrubberBgColor(value:uint):void
See also
| scrubberBgColorActive | property |
scrubberBgColorActive:uint [write-only]Sets the scrubber background color active state. Applies to the current instance only.
The default value is 0x9EC7D9.
public function set scrubberBgColorActive(value:uint):void
See also
| scrubberBgColorOn | property |
scrubberBgColorOn:uint [write-only]Sets the scrubber background color on state. Applies to the current instance only.
The default value is 0xC5C5C5.
public function set scrubberBgColorOn(value:uint):void
See also
| scrubberBgColorOver | property |
scrubberBgColorOver:uint [write-only]Sets the scrubber background color over state. Applies to the current instance only.
The default value is 0xD6EEFB.
public function set scrubberBgColorOver(value:uint):void
See also
| trackBgColor | property |
trackBgColor:uint [write-only]Sets the scroll track background color. Applies to the current instance only.
The default value is 0xE0E0E0.
public function set trackBgColor(value:uint):void
See also
| SWFScroll | () | constructor |
public function SWFScroll(frameAreaP:Sprite, scrollingAreaP:Sprite, minWidthP:int, minHeightP:int, stageP:Stage, browserScrollMimicP:Boolean = false)Creates the SWFScroll Object
ParametersframeAreaP:Sprite — Container of the scrolled area. Usually the parent.
|
|
scrollingAreaP:Sprite — Area to be scrolled.
|
|
minWidthP:int — Minimum height before horizontal scrollbar appears.
|
|
minHeightP:int — Minimum width before vertical scrollbar appears.
|
|
stageP:Stage — An instance of Stage.
|
|
browserScrollMimicP:Boolean (default = false) |
| clean | () | method |
public function clean():voidDestructor method. In order to properly destroy SWFScroll this method must be run first. Otherwise a memory leak will occur.
| hideScrollBars | () | method |
public function hideScrollBars():voidHides scrollbars until a showOrHide method is called again.
| originalframeAreaSize | () | method |
public function originalframeAreaSize(frameWidthP:int, frameHeightP:int):voidReverts to the original minimum width and minimum height properties. For use with both vertical and horizontal scrollbars.
ParametersframeWidthP:int — Original minimum width.
|
|
frameHeightP:int — Original minimum height.
|
| originalframeAreaSizeH | () | method |
public function originalframeAreaSizeH(frameWidthP:int, frameHeightP:int):voidReverts to the original minimum width and minimum height properties. For use with horizontal scrollbars.
ParametersframeWidthP:int — Original minimum width.
|
|
frameHeightP:int — Original minimum height.
|
| originalframeAreaSizeV | () | method |
public function originalframeAreaSizeV(frameWidthP:int, frameHeightP:int):voidReverts to the original minimum width and minimum height properties. For use with vertical scrollbars.
ParametersframeWidthP:int — Original minimum width.
|
|
frameHeightP:int — Original minimum height.
|
| resetframeAreaSize | () | method |
public function resetframeAreaSize(newMinWidthP:int, newMinHeightP:int, frameWidthP:int, frameHeightP:int):voidUpdates the minimum width and minimum height properties. For use with both vertical and horizontal scrollbars.
ParametersnewMinWidthP:int — New minimum width.
|
|
newMinHeightP:int — New minimum height.
|
|
frameWidthP:int |
|
frameHeightP:int |
| resetframeAreaSizeH | () | method |
public function resetframeAreaSizeH(newMinWidthP:int, newMinHeightP:int, frameWidthP:int, frameHeightP:int):voidUpdates the minimum width and minimum height properties. For use with horizontal scrollbars.
ParametersnewMinWidthP:int — New minimum width.
|
|
newMinHeightP:int — New minimum height.
|
|
frameWidthP:int |
|
frameHeightP:int |
| resetframeAreaSizeV | () | method |
public function resetframeAreaSizeV(newMinWidthP:int, newMinHeightP:int, frameWidthP:int, frameHeightP:int):voidUpdates the minimum width and minimum height properties. For use with vertical scrollbars.
ParametersnewMinWidthP:int — New minimum width.
|
|
newMinHeightP:int — New minimum height.
|
|
frameWidthP:int |
|
frameHeightP:int |
| showOrHideScrollBarH | () | method |
public function showOrHideScrollBarH(frameWidthP:int, frameHeightP:int):voidDisplays a horizontal scrollbar depending on if the scrolling area width exceeds the frame width.
ParametersframeWidthP:int — Current frame width.
|
|
frameHeightP:int — Current frame height.
|
| showOrHideScrollBars | () | method |
public function showOrHideScrollBars(frameWidthP:int, frameHeightP:int):voidDisplays a horizontal scrollbar depending on if the scrolling area width exceeds the frame width. Displays a vertical scrollbar depending on if the scrolling area height exceeds the frame height.
ParametersframeWidthP:int — Current frame width.
|
|
frameHeightP:int — Current frame height.
|
| showOrHideScrollBarV | () | method |
public function showOrHideScrollBarV(frameWidthP:int, frameHeightP:int):voidDisplays a vertical scrollbar depending on if the scrolling area height exceeds the frame height.
ParametersframeWidthP:int — Current frame width.
|
|
frameHeightP:int — Current frame height.
|
| updateScrubbers | () | method |
public function updateScrubbers():voidForces scrubbers to update.