Slider Widget (Slider.class)

The Slider Widget invokes a function (or set of functions) either upon 1) any movement of the handle (onChange) or 2) only when the handle has been released (onPenUp). The argument is determined by the location of the handle and the limits setup with the min and max attributes. The location of the min value is determined by the minAt attribute(left, right, top or bottom). The height and width dimensions determines whether the slider is horizontal or vertical. The longer dimension establishes the path that the slider travels, while the shorter dimension determines the maximum handle size. In addition, the widget creates a 3-pixel wide "channel" along the slider path. To move the slider, touch the handle and drag it along the channel. If hrefEvent is setup as onChange, the slider invokes the function(s) whenever the handle moves. If hrefEvent is setup as onPenUp, the slider invokes the function(s) only upon releasing the handle. Touching anywhere on the channel causes the handle to snap to that location and invoke the function(s) with the corresponding argument. Tick marks are optional. As an option, you can specify the offset of the handle from the center of the channel by using the handleOffset parameter.

Slider Parameter Attributes:

Parameter="invisible" value="CHECKED" or "UNCHECKED" — Specifies if the Slider is to start out invisible or not. If the attribute is not CHECKED, then by default the Slider is visible. If the Slider starts out invisible, the only way to make it visible again is via the IWC method reappear().

Parameter="channelColor" value= See color entry conventions — Specifies the color of the channel the handle slides along. See section on colors for more information. If no channel color is specified, the default color is black. If the alpha is FF, then the channel color is fully opaque.

Parameter="handleColor" value= See color entry conventions — Specifies the color inside of the handle. See section on colors for more information. If no handle color is specified, the default color is white. If the alpha is FF, then the handle color is fully opaque.

Parameter="handleFrameColor" value= See color entry conventions — Specifies the color of the handle frame. See section on colors for more information. If no handle frame color is specified, the default color is black. If the alpha is FF, then the handle frame color is fully opaque.

Parameter="handleTrackingColor" value= See color entry conventions — Specifies the color of the handle when being touched. See section on colors for more information. If no handle frame color is specified, the default color is black. If the alpha is FF, then the handle tracking color is fully opaque.

Parameter="href" value="function(s)" — The function (or multiple/sequenced functions) invoked upon the event specified in hrefEvent. See Appendix B for all available functions for the Slider widget.

Parameter="hrefEvent" value="On Change" or "On Release" — The event which triggers the launching of the href function. If set to On Change, the slider will launch the function call whenever the handle is moved. If set to On Release, the slider will only launch the function call upon the releasing of the slider handle. If hrefEvent is not specified, the default is On Change.

Parameter="initialCondition" value="number" or "FromInitHref" — Specifies handle position when the page is loaded. The position value becomes the argument given to the href function(s). If FromInitHref is selected, the function specified by the InitHref attribute is called. The returned value determines the handle position. [The range is 0 - 65535 (0x00 - 0xFFFF).]

Parameter="max" value="number" — The maximum value used as the argument given to the function(s) specified in href. Maximum value is achieved when handle is full-right on a horizontal slider, or full-top on a vertical slider. The range is 1 - 65535 (0x01 - 0xFFFF).

Parameter="min" value="number" — The minimum value used as the argument given to the function(s) specified in href. Minimum value is achieved when handle is full-left on a horizontal slider, or full-bottom on a vertical slider. The range is 0 - 65534 (0x00 - 0xFFFE).

Parameter="minAt" value=""LEFT" or "RIGHT" or "TOP" or "BOTTOM"" — Determines where the minimum value of the slider is located. As the handle sweeps from the minAt location, the value increases until the maximum value is reached at the opposite extreme of the minAt location. Default values are LEFT for horizontal sliders and BOTTOM for vertical sliders. The options are:

• LEFT — The slider value increases from left to right. (horizontal slider only)
• RIGHT — The slider value increases from right to left. (horizontal slider only)
• TOP — The slider value increases from top to bottom. (vertical slider only)
• BOTTOM — The slider value increases from bottom to top. (vertical slider only)

Parameter="tickColor" value= See color entry conventions — Specifies the color of the ticks drawn on the channel. See section on colors for more information. If no tick color is specified, the default color is black. If the alpha is FF, then the tick color is fully opaque.

Parameter="tickCount" value="number" — The total number of tick marks along the slider channel. If 0, no tick marks are visible. If tickCount is not given, the default is 0. The range is 0 - 255 (0x00 - 0xFF).

Optional Slider Parameter Attributes:

Parameter="handleOffset" value="number" — Specifies the number of pixels from the center of the channel the handle is located. If a vertical slider, positive numbers shift the handle to the right and negative numbers shift it to the left. If a horizontal slider, positive numbers shift the handle to the bottom and negative numbers shift it to the top. [The range is -100 through 100]

Parameter="handleThickness" value="number" — The width (in pixels) of the handle if a horizontal slider, or the height of the handle if a vertical slider. If handleThickness is not given, the default is 11 pixels. The range is 4 - 255 (0x04 - 0xFF).

Parameter="hrefOnHitOnly" value="CHECKED" or "UNCHECKED" — Specifies if the slider href function(s) is launched only upon a "hit" or not. By default, hrefOnHitOnly is UNCHECKED, which means the slider will launch its href upon loading the page. The href is also launched after a forceUpdate() call. By setting hrefOnHitOnly to CHECKED, the href will only be launched upon the slider physically being selected or upon a forceHit() call.

Parameter="initHref" value="function" — Only valid if FromInitHref is used as the initialCondition. Specifies the function called when the page is loaded. The value returned from this function call will be used as the initial condition of the Slider handle. See Appendix B for all available functions.

Parameter="orientation" value="HORIZONTAL" or "VERTICAL" — Specifies if the handle is to travel horizontally or vertically. The orientation parameter will override the orientation determined by the height and width dimensions.

Parameter="tickLength" value="number" — The length (size) of each tick mark, in pixels. The range is 1 - 255 (0x01 - 0xFF). If tickLength is not given, the default is 9 pixels.

Parameter="tickPosition" value="CENTER" or "TOP" or "BOTTOM" or "LEFT" or "RIGHT" — The position of the tick marks in relation to the channel. . The range for a horizontal slider is CENTER, TOP or BOTTOM. The range for a vertical slider is CENTER, LEFT or RIGHT. If tickPosition is not given, the default is CENTER (inside the channel).

Parameter="waitForInit" value="CHECKED" or "UNCHECKED" — Only valid if FromInitHref is used as the initialCondition. Specifies if the Slider handle will wait for valid data before being displayed on the channel. If CHECKED, the Slider handle will not display until the data from the initHref function is received. If UNCHECKED, or the attribute is not present, the Slider handle momentarily starts at the minAt location until the initHref function receives its data.