| Previous | Next |
STF.isSettingsWindow
Availability
| Support | PC | Mac | Package |
|---|---|---|---|
| ActionScript 3.0 |
4.0 |
4.0 |
stm.screentime.STF stm.screentime.STFEvent |
| ActionScript 2.0 |
4.0 |
4.0 |
global |
* Add the Screentime screensaver component to your Flash FLA or Flex project before using Screentime classes.
Usage
STF.isSettingsWindowParameters
None.
Returns
Nothing.
Description
Event handler; This property indicates whether the SWF is running as the Settings window. This property contains valid information ONLY when the SWF is running as a screensaver and the ScreentimeScreensaver component has been initialized. To be notified when the STF class has been initialized, add an event listener for the STFEvent.INITIALIZATION_COMPLETE event.
You can use this property to trigger a different your animation for Settings mode -- an animation that enables the user to personlize the screensaver's speed, color, content; or enter user name and password to connect to the user's online preferences. Whatever is possible in Flash is possible in the Settings window.
ActionScript 3.0 Example:
The following example plays different content depending on whether the SWF is playing as the screensaver, preview monitor, installer, or settings window.
import stm.screentime.STF;
import stm.screentime.STFEvent;
function onInitializationCompleteEvent(initialized:Boolean) {
var mode:uint;
mode = STF.playMode;
STF.trace("The Mode we are playing on is: " + mode);
STF.trace("Playing as Screensaver: " + STF.isScreensaver);
STF.trace("Playing as Settings Win: " + STF.isSettingsWindow);
STF.trace("Playing as Preview Monitor: " + STF.isPreviewMonitor);
STF.trace("Playing as Installer: " + STF.isInstaller);
switch (STF.playMode) {
case ScreensaverPlayMode.SCREENSAVER:
// do something here to play the screensaver animation
break;
case ScreensaverPlayMode.SETTINGS_WINDOW:
// do something here to play the settings window animation
break;
case ScreensaverPlayMode.PREVIEW_MONITOR:
// do something here to play the smaller / abbreviated animation
break;
case ScreensaverPlayMode.INSTALLER:
// do something here to play the installer animation
break;
}
}
STF.addEventListener(STFEvent.INITIALIZATION_COMPLETE, onInitializationCompleteEvent);
ActionScript 2.0 Example:
The following example plays different content depending on whether the SWF is playing as the screensaver, preview monitor, installer, or settings window.
function onInitializationCompleteEvent(initialized:Boolean) {
var mode:uint;
mode = STF.playMode;
STF.trace("The Mode we are playing on is: " + mode);
STF.trace("Playing as Screensaver: " + STF.isScreensaver);
STF.trace("Playing as Settings Win: " + STF.isSettingsWindow);
STF.trace("Playing as Preview Monitor: " + STF.isPreviewMonitor);
STF.trace("Playing as Installer: " + STF.isInstaller);
switch (STF.playMode) {
case ScreensaverPlayMode.SCREENSAVER:
// do something here to play the screensaver animation
break;
case ScreensaverPlayMode.SETTINGS_WINDOW:
// do something here to play the settings window animation
break;
case ScreensaverPlayMode.PREVIEW_MONITOR:
// do something here to play the smaller / abbreviated animation
break;
case ScreensaverPlayMode.INSTALLER:
// do something here to play the installer animation
break;
}
}
STF.registerCallBack("onInitializationComplete", onInitializationCompleteEvent);
See Also
STF.isScreensaver, STF.isPreviewMonitor, STF.isInstaller
| Questions or Feedback? | Previous | Next |