Getting Started

Platform

• alert()
• browse()
• confirm()
• loadMedia()

• environment

Utilities

• getFlashHeader()
• getInternetConnection()
• getURL()
• loadMovieInSandBox()

Widget

• onClose()
• onDropFile()
• onDropString()
• onMemoryUpdate()
• onMenuCommand()
• onPaste()
• onResize()
• onSettings()

• addMenuItem()
• bounce()
• center()
• close()
• deleteMenu()
• dock()
• getMemory()
• getParameter()
• setFrameRate()
• setMaximumSize()
• setMemory()
• setMinimumSize()
• setParameter()
• setSize()
• setUtilityOffset()
• setMetadata()
• shake()
• startDrag()
• stopDrag()
• trace()

• allowDocking
• allowScaling
• allowSettings
• allowUtility
• height
• isDocked
• width

Widget.onSettings

Availability

Flash Player 7 + TheSpringBox V1

Usage

Widget.onSettings = function(isOpen:Boolean) : Void {
  // your statements here
}

Parameters

isOpen - A Boolean value set to true when the settings panel should be opened, false when it should be closed.

Returns

Nothing.

Description

Event handler; invoked when the user clicks on the settings button in the utility navigation of the desktop wrapper. You should respond to this handler by either opening or closing the settings panel of your widget.

NOTE: Widget.onSettings is not needed if your main timeline contains a "Widget" and "Settings" framelabel under which the widget and settings are housed.

Example

The function below could be used to toggle the settings panel of the widget instance:

Widget.onSettings = function(isOpen:Boolean) {
  mcSetting._visible = activity;
};

See Also

Widget.showSettingsButton