Packagedigicrafts.flash.core
Classpublic class RotatorComponentBase
InheritanceRotatorComponentBase Inheritance digicrafts.flash.core.UIComponentBase
SubclassesBarTransformBannerRotator, CubeTransformBannerRotator, DoorTransformBannerRotator, FadeBannerRotator, FlipTransformBannerRotator, FlyTransformBannerRotator, SwapTransformBannerRotator, TileTransformBannerRotator, TwistTransformBannerRotator

Base class for all BannerRotator.


Public Properties
 PropertyDefined by
  autoZoom : Number
Gets or sets the autoZoom property.
RotatorComponentBase
  autoZoomDuration : Number
Gets or sets the autoZoomDuration property.
RotatorComponentBase
  captionTextTarget : String
Gets or sets the captionTextTarget property.
RotatorComponentBase
  currentItemData : Object
[read-only] Gets or sets the currentItemData property.
RotatorComponentBase
  dataProvider : Array
[read-only] DataProvider
RotatorComponentBase
  keyboardScrollEnabled : Boolean
Gets or sets the keyboardScrollEnabled property.
RotatorComponentBase
  loaderSkin : String
Gets or sets the defaultLoaderSkin property.
RotatorComponentBase
  nextButtonTarget : String
Gets or sets the nextButtonTarget property.
RotatorComponentBase
  prevButtonTarget : String
Gets or sets the prevButtonTarget property.
RotatorComponentBase
  resizeMode : uint
Gets or sets the resizeMode property.
RotatorComponentBase
  scrollerTarget : String
Gets or sets the scrollerTarget property.
RotatorComponentBase
  selectedItemIndex : Number
Gets or sets the currentItemIndex property.
RotatorComponentBase
  slideShowDirection : uint
Gets or sets the slideShowDirection property.
RotatorComponentBase
  slideShowEnabled : Boolean
Gets or sets the slideShowEnabled property.
RotatorComponentBase
  slideShowInterval : Number
Gets or sets the slideShowInterval property.
RotatorComponentBase
  slideShowManager : SlideShowManager
[read-only]
RotatorComponentBase
  slideShowType : Number
Gets or sets the slideShowType property.
RotatorComponentBase
  source : Object
Gets or sets the source property.
RotatorComponentBase
  thumbnailAlign : uint
Gets or sets the thumbnailAlign property.
RotatorComponentBase
  thumbnailAnimation : uint
RotatorComponentBase
  thumbnailBackgroundColor : uint
Gets or sets the thumbnailBackgroundColor property.
RotatorComponentBase
  thumbnailHeight : Number
Gets or sets the thumbnailHeight property.
RotatorComponentBase
  thumbnailMouseScroll : Boolean
Gets or sets the thumbnailMouseScroll property.
RotatorComponentBase
  thumbnailOverColor : uint
Gets or sets the thumbnailOverColor property.
RotatorComponentBase
  thumbnailOverColorSize : uint
Gets or sets the thumbnailOverColorSize property.
RotatorComponentBase
  thumbnailOverGlowEnabled : Boolean
Gets or sets the thumbnailOverGlowEnabled property.
RotatorComponentBase
  thumbnailResizeMode : uint
Gets or sets the thumbnailResizeMode property.
RotatorComponentBase
  thumbnailWidth : Number
Gets or sets the thumbnailWidth property.
RotatorComponentBase
  titleAlign : uint
Gets or sets the titleAlign property.
RotatorComponentBase
  titleBackgroundAlpha : Number
Gets or sets the titleBackgroundAlpha property.
RotatorComponentBase
  titleBackgroundColor : uint
Gets or sets the titleBackgroundColor property.
RotatorComponentBase
  titleLabel : String
Gets or sets the titleLabel property.
RotatorComponentBase
  titleTextColor : uint
Gets or sets the titleTextColor property.
RotatorComponentBase
  transitionDuration : Number
Gets or sets the transitionDuration property.
RotatorComponentBase
Public Methods
 MethodDefined by
  
RotatorComponentBase()
Constructor
RotatorComponentBase
  
load(source:*):void
Load source and start the component
RotatorComponentBase
  
next():void
Select next item
RotatorComponentBase
  
prev():void
Select prev item
RotatorComponentBase
  
unload():void
Unload the items and delete all object
RotatorComponentBase
Events
 EventSummaryDefined by
  
bufferComplete
Dispatched when the buffering of resource completed This event will dispatch just after all resource buffereing completed.RotatorComponentBase
  
bufferComplete
Dispatched when the buffering of resource completed This event will dispatch just after all resource buffereing completed.RotatorComponentBase
  
bufferComplete
Dispatched when the buffering of resource completed This event will dispatch just after all resource buffereing completed.RotatorComponentBase
  
bufferComplete
Dispatched when the buffering of resource completed This event will dispatch just after all resource buffereing completed.RotatorComponentBase
  
bufferStart
Dispatched when the component start buffering resource.RotatorComponentBase
  
xmlLoadComplete
Dispatched when the source xml load complete.RotatorComponentBase
  
xmlLoadError
Dispatched when error occur when loading xml.RotatorComponentBase
Property detail
autoZoomproperty
autoZoom:Number  [read-write]

Gets or sets the autoZoom property. autoZoom property determine the scale of the auto zoom.

The default value is 2.

Implementation
    public function get autoZoom():Number
    public function set autoZoom(value:Number):void
autoZoomDurationproperty 
autoZoomDuration:Number  [read-write]

Gets or sets the autoZoomDuration property. autoZoomDuration property determine the duration of the auto zoom. (Value in second)

The default value is 2.

Implementation
    public function get autoZoomDuration():Number
    public function set autoZoomDuration(value:Number):void
captionTextTargetproperty 
captionTextTarget:String  [read-write]

Gets or sets the captionTextTarget property. captionTextTarget property determinethe the instance name of dynamic text use to hold the caption.

The default value is .

Implementation
    public function get captionTextTarget():String
    public function set captionTextTarget(value:String):void
currentItemDataproperty 
currentItemData:Object  [read-only]

Gets or sets the currentItemData property. currentItemData property is the data object for corresponding selected item.

Implementation
    public function get currentItemData():Object
dataProviderproperty 
dataProvider:Array  [read-only]

DataProvider

Implementation
    public function get dataProvider():Array
keyboardScrollEnabledproperty 
keyboardScrollEnabled:Boolean  [read-write]

Gets or sets the keyboardScrollEnabled property. keyboardScrollEnabled property determine if keyboard control enabled.

The default value is true.

Implementation
    public function get keyboardScrollEnabled():Boolean
    public function set keyboardScrollEnabled(value:Boolean):void
loaderSkinproperty 
loaderSkin:String  [read-write]

Gets or sets the defaultLoaderSkin property. defaultLoaderSkin property determine the skin value of loader. Value should be linkage name of movieclip.

The default value is 3.

Implementation
    public function get loaderSkin():String
    public function set loaderSkin(value:String):void
nextButtonTargetproperty 
nextButtonTarget:String  [read-write]

Gets or sets the nextButtonTarget property. nextButtonTarget property determinethe the instance name of button/movieclip which acts as a control to toggle the next item action.

The default value is .

Implementation
    public function get nextButtonTarget():String
    public function set nextButtonTarget(value:String):void
prevButtonTargetproperty 
prevButtonTarget:String  [read-write]

Gets or sets the prevButtonTarget property. prevButtonTarget property determinethe the instance name of button/movieclip which acts as a control to toggle the previous item action.

The default value is .

Implementation
    public function get prevButtonTarget():String
    public function set prevButtonTarget(value:String):void
resizeModeproperty 
resizeMode:uint  [read-write]

Gets or sets the resizeMode property. resizeMode property determine the resize mode of the loaded image.

Possible Value
1: AUTO_WIDTH
2: AUTO_HEIGHT
3: STRETCH
5: AUTO_FILL

The default value is 5.

Implementation
    public function get resizeMode():uint
    public function set resizeMode(value:uint):void
scrollerTargetproperty 
scrollerTarget:String  [read-write]

Gets or sets the scrollerTarget property. scrollerTarget property determinethe the instance name of slider/scrollbar which use to control the position of current item.

The default value is .

Implementation
    public function get scrollerTarget():String
    public function set scrollerTarget(value:String):void
selectedItemIndexproperty 
selectedItemIndex:Number  [read-write]

Gets or sets the currentItemIndex property. currentItemIndex property determine the source of the component. The source can be path to xml, XML Object or Array Object.

The default value is "".

Implementation
    public function get selectedItemIndex():Number
    public function set selectedItemIndex(value:Number):void
slideShowDirectionproperty 
slideShowDirection:uint  [read-write]

Gets or sets the slideShowDirection property. slideShowDirection property use to determine the direction of slide show. 0:left 2:right

The default value is 2.

Implementation
    public function get slideShowDirection():uint
    public function set slideShowDirection(value:uint):void
slideShowEnabledproperty 
slideShowEnabled:Boolean  [read-write]

Gets or sets the slideShowEnabled property. slideShowEnabled property use to enable/disable the auto slideshow.

The default value is false.

Implementation
    public function get slideShowEnabled():Boolean
    public function set slideShowEnabled(value:Boolean):void
slideShowIntervalproperty 
slideShowInterval:Number  [read-write]

Gets or sets the slideShowInterval property. slideShowInterval property use to determine the interval between each slideshow move.

The default value is 10.

Implementation
    public function get slideShowInterval():Number
    public function set slideShowInterval(value:Number):void
slideShowManagerproperty 
slideShowManager:SlideShowManager  [read-only]Implementation
    public function get slideShowManager():SlideShowManager
slideShowTypeproperty 
slideShowType:Number  [read-write]

Gets or sets the slideShowType property. slideShowType property use to determine the behavior of the slide show when slideshow reach the end. 0: contiune. Move to start position when reach the end.
1: yoyo. Move in opposit direction when reach the end.

The default value is true.

Implementation
    public function get slideShowType():Number
    public function set slideShowType(value:Number):void
sourceproperty 
source:Object  [read-write]

Gets or sets the source property. source property determine the source of the component. The source can be path to xml, XML Object or Array Object.

The default value is "".

Implementation
    public function get source():Object
    public function set source(value:Object):void
thumbnailAlignproperty 
thumbnailAlign:uint  [read-write]

Gets or sets the thumbnailAlign property. thumbnailAlign property detecmine the position of the thumbnail.

Possible Value 0: Top
1: Right
2: Bottom
3: Left
7: Hide

The default value is 2.

Implementation
    public function get thumbnailAlign():uint
    public function set thumbnailAlign(value:uint):void
thumbnailAnimationproperty 
thumbnailAnimation:uint  [read-write]

Implementation
    public function get thumbnailAnimation():uint
    public function set thumbnailAnimation(value:uint):void
thumbnailBackgroundColorproperty 
thumbnailBackgroundColor:uint  [read-write]

Gets or sets the thumbnailBackgroundColor property. thumbnailBackgroundColor property determine background color of the thumbnail.

The default value is #000000.

Implementation
    public function get thumbnailBackgroundColor():uint
    public function set thumbnailBackgroundColor(value:uint):void
thumbnailHeightproperty 
thumbnailHeight:Number  [read-write]

Gets or sets the thumbnailHeight property. thumbnailHeight property determine the height of the thumbnails.

The default value is 60.

Implementation
    public function get thumbnailHeight():Number
    public function set thumbnailHeight(value:Number):void
thumbnailMouseScrollproperty 
thumbnailMouseScroll:Boolean  [read-write]

Gets or sets the thumbnailMouseScroll property. thumbnailMouseScroll property determine if the mouse scroll for thumbnail is enabled

The default value is true.

Implementation
    public function get thumbnailMouseScroll():Boolean
    public function set thumbnailMouseScroll(value:Boolean):void
thumbnailOverColorproperty 
thumbnailOverColor:uint  [read-write]

Gets or sets the thumbnailOverColor property. thumbnailOverColor property contain the color value of mouse over glow effect. The value should be int value.

The default value is 0xFFFFFF.

Implementation
    public function get thumbnailOverColor():uint
    public function set thumbnailOverColor(value:uint):void
thumbnailOverColorSizeproperty 
thumbnailOverColorSize:uint  [read-write]

Gets or sets the thumbnailOverColorSize property. thumbnailOverColorSize property determine the size of glow effect.

The default value is 10.

Implementation
    public function get thumbnailOverColorSize():uint
    public function set thumbnailOverColorSize(value:uint):void
thumbnailOverGlowEnabledproperty 
thumbnailOverGlowEnabled:Boolean  [read-write]

Gets or sets the thumbnailOverGlowEnabled property. thumbnailOverGlowEnabled property determine if the item over glow effect enabled.

The default value is true.

Implementation
    public function get thumbnailOverGlowEnabled():Boolean
    public function set thumbnailOverGlowEnabled(value:Boolean):void
thumbnailResizeModeproperty 
thumbnailResizeMode:uint  [read-write]

Gets or sets the thumbnailResizeMode property. thumbnailResizeMode property determine the resize mode of the thumbnail image.

Possible Value

Possible Value
1: AUTO_WIDTH
2: AUTO_HEIGHT
3: STRETCH
5: AUTO_FILL

The default value is 5.

Implementation
    public function get thumbnailResizeMode():uint
    public function set thumbnailResizeMode(value:uint):void
thumbnailWidthproperty 
thumbnailWidth:Number  [read-write]

Gets or sets the thumbnailWidth property. thumbnailWidth property determine the width of the thumbnails.

The default value is 100.

Implementation
    public function get thumbnailWidth():Number
    public function set thumbnailWidth(value:Number):void
titleAlignproperty 
titleAlign:uint  [read-write]

Gets or sets the titleAlign property. titleAlign property detecmine the position of the title.

Possible Value 0: Top
1: Right
2: Bottom
3: Left
/p>

The default value is 2.

Implementation
    public function get titleAlign():uint
    public function set titleAlign(value:uint):void
titleBackgroundAlphaproperty 
titleBackgroundAlpha:Number  [read-write]

Gets or sets the titleBackgroundAlpha property. titleBackgroundAlpha property determine the alpha value of the title background

The default value is 0.6.

Implementation
    public function get titleBackgroundAlpha():Number
    public function set titleBackgroundAlpha(value:Number):void
titleBackgroundColorproperty 
titleBackgroundColor:uint  [read-write]

Gets or sets the titleBackgroundColor property. titleBackgroundColor property determine background color of the title.

The default value is #000000.

Implementation
    public function get titleBackgroundColor():uint
    public function set titleBackgroundColor(value:uint):void
titleLabelproperty 
titleLabel:String  [read-write]

Gets or sets the titleLabel property. titleLabel property determine the data name use in xml for title text

The default value is "title".

Implementation
    public function get titleLabel():String
    public function set titleLabel(value:String):void
titleTextColorproperty 
titleTextColor:uint  [read-write]

Gets or sets the titleTextColor property. titleTextColor property determine text color of title.

The default value is #FFFFFF.

Implementation
    public function get titleTextColor():uint
    public function set titleTextColor(value:uint):void
transitionDurationproperty 
transitionDuration:Number  [read-write]

Gets or sets the transitionDuration property. transitionDuration property determine the duration of the transition. (Value in second)

The default value is 2.

Implementation
    public function get transitionDuration():Number
    public function set transitionDuration(value:Number):void
Constructor detail
RotatorComponentBase()constructor
public function RotatorComponentBase()

Constructor

Method detail
load()method
public function load(source:*):void

Load source and start the component

Parameters
source:*
next()method 
public function next():void

Select next item

prev()method 
public function prev():void

Select prev item

unload()method 
public function unload():void

Unload the items and delete all object

Event detail
bufferCompleteevent 
Event object type: digicrafts.events.RotatorEvent.TRANSITION_COMPLETE

Dispatched when the buffering of resource completed This event will dispatch just after all resource buffereing completed.

bufferCompleteevent  
Event object type: digicrafts.events.RotatorEvent.TRANSITION_STRAT

Dispatched when the buffering of resource completed This event will dispatch just after all resource buffereing completed.

bufferCompleteevent  
Event object type: digicrafts.events.RotatorEvent.BUFFER_COMPLETE

Dispatched when the buffering of resource completed This event will dispatch just after all resource buffereing completed.

bufferCompleteevent  
Event object type: digicrafts.events.RotatorEvent.BUFFER_START

Dispatched when the buffering of resource completed This event will dispatch just after all resource buffereing completed.

bufferStartevent  
Event object type: digicrafts.events.RotatorEvent.READY

Dispatched when the component start buffering resource. This event will dispatch just before buffering of image or other resource.

xmlLoadCompleteevent  
Event object type: digicrafts.events.DataSourceEvent.XML_LOAD_COMPLETE

Dispatched when the source xml load complete. This event will dispatch after the xml have loaded and paser complete.

xmlLoadErrorevent  
Event object type: digicrafts.events.DataSourceEvent.XML_LOAD_ERROR

Dispatched when error occur when loading xml. This event will dispatch when an error occur when loading xml. e.g. The path of the xml not found.




@Copyrights digicrafts 2010. All rights reserved. 1283870730174