ActionScript Documentation
| Inheritance | MovieClip > ScreenBannerRotator class |
Methods unique to the ScreenBannerRotator class
The following table lists methods of the ScreenBannerRotator class.
Properties unique to the ScreenBannerRotator class
The following table lists properties of the ScreenBannerRotator class.
my_banner.autoPlay
Property; specifies whether the banner should start rotating images automatically ("true") or not ("false"). The default value is "false".
The following example sets the autoPlay property to "true":
my_banner.autoPlay = true;
my_banner.controlsAutoHide
Property; determines whether to show (hide) the controls automatically when the mouse is over (out of) the banner. The default value is "false".
The following example sets the controlsAutoHide property to "true":
my_banner.controlsAutoHide = true;
my_banner.controlsOrder
Property; specifies which navigation buttons to show in the controls, and defines the order in which the buttons are displayed (separated by commas). This property can be any combination of the following values: "playpause", "previous", "next", "timer". The default value is undefined.
The following example sets the controlsOrder property to "playpause,timer":
my_banner.controlsOrder = "playpause,timer";
my_banner.delayTime
Property; amount of delay between images, in seconds. This property can be any positive number or 0. The default value is 5.
The following example sets the delayTime property to 3:
my_banner.delayTime = 3;
my_banner.gotoImageAt(index)
index An integer indicating the index of the image in the gallery. This is a zero-based index, so 0 retrieves the first image, 1 retrieves the second image, and so on.
Nothing.
Method; navigates to the image with the specified index.
The following example demonstrates how to navigate to the image with index 5:
my_banner.gotoImageAt(5);
my_banner.gotoNextImage()
Nothing.
Method; navigates to the next image in the gallery.
The following example demonstrates how to navigate to the next image in the gallery:
my_banner.gotoNextImage();
my_banner.gotoPreviousImage()
Nothing.
Method; navigates to the previous image in the gallery.
The following example demonstrates how to navigate to the previous image in the gallery:
my_banner.gotoPreviousImage();
my_banner.pauseOnMouseOver
Property; specifies whether the banner should pause rotating images when the mouse is over its area ("true") or not ("false"). The default value is "false".
The following example sets the pauseOnMouseOver property to "true":
my_banner.pauseOnMouseOver = true;
my_banner.randomImages
Property; determines whether to display images in sequential ("false") or random ("true") order. The default value is "false".
The following example sets the randomImages property to "true":
my_banner.randomImages = true;
my_banner.randomTransitions
Property; determines whether to apply transition types (if multiple values are selected) in sequential ("false") or random ("true") order. The default value is "true".
The following example sets the randomTransitions property to "false":
my_banner.randomTransitions = false;
my_banner.repeatMode
Property; defines the banner behavior when it reaches the last image. This property can be either "true" or "false". The default value is "true".
The following example sets the repeatMode property to "false":
my_banner.repeatMode = false;
my_banner.showControls
Property; determines if the controls are visible. The default value is "true".
The following example sets the showControls property to "false":
my_banner.showControls = false;
my_banner.showControlsScreen
Property; determines whether to show the background (screen) of the controls ("true") or not ("false"). The default value is "true".
The following example sets the showControlsScreen property to "false":
my_banner.showControlsScreen = false;
my_banner.showDescription
Property; determines if the description area is visible. The default value is "true".
The following example sets the showDescription property to "false":
my_banner.showDescription = false;
my_banner.showNumberButtons
Property; determines whether to show the number buttons in the controls ("true") or not ("false"). The default value is "true".
The following example sets the showNumberButtons property to "false":
my_banner.showNumberButtons = false;
my_banner.transitionType
Property; specifies the type of transition to be applied when rotating images. Multiple values should be separated by commas, without blank space after commas. This property can be any combination of the following values: "fade", "blinds", "windows". The default value is "fade,blinds,windows".
The following example sets the transitionType property to "fade,blinds":
my_banner.transitionType = "fade,blinds";
my_banner.xmlFileURL
Property; the path to the XML file. The default value is "settings.xml".
The following example sets the xmlFileURL property to "data/banner.xml":
my_banner.xmlFileURL = "data/banner.xml";
|
