FMXISPotentiometer

Availability

Flash Player 6 r65.

Description

This class implements a simple potentiometer. Developers can set the increment, number of values in one cycle, integer vs. continuous values, minimum and maximum values, and whether the jog is adjusted by clicking and dragging, or merely moving in a circular motion (dragOrOver). When the potentiometer is set to integer values, it only can be moved in integer increments. A second option, snap to integer, is used to allow continuous movement, but positions are only reported as integers when reached, and the visual display snaps to the closest integer when the knob is released.

The class has two properties that developers can set in the component property panel:

• "Indicator Linkage ID": Replaces the default indicator graphic with a movie clip from the Library specified by the linkage ID supplied, and
• "Background Linkage ID": Replaces the default background.

The movie clip must have its center at the center of rotation, so if the developer simply wants to change the indicator (notch), then the indicator should be placed in the topmost (pointing up) position at the edge of the background.

For component FLA's, developers can change the appearance by modifying:

• defPotBkgnd - background
• defPotIndicator - indicator clip
• defPotIncr - Increment button (increments by 1 unit)
• defPotDecr - Decrement button (decrements by 1 unit)

The class has one event, by default called "onValChg" (but this can be changed in the property inspector, or by changing the vChg property), and the value is the new value of the potentiometer. If the user does not change values, this component still reports the current knob position when released

The drawTicks property, if true, tells the component to draw numTicks ticks.

The potentiometer value can be set or read using the val property, or set through the setVal() method.

This class inherits from FMXISJog to get most of its functionality.

Code Hinting

The suffix of variables recognized for codehinting purposes as FMXISPotentiometer's is _pot.