BBjSlider::setLabels


Description

In BBj 10.0 and higher, this method sets the custom labels for a BBjSlider.

Syntax

Return Value

Method

void

setLabels(Map<Integer,String> labels)

Parameters

Variable

Description

labels

A Java Map<Integer,String> structure, where the Integer key is the slider position of the corresponding String label.

Return Value

None.

Remarks

If custom labels are not defined, the slider generates labels corresponding to the integer values of the major ticks. The labels are reset if setMajorTickSpacing() is called.

Example

REM Set and Get BBjSlider Labels
REM Obtain the instance of the BBjAPI object
LET myAPI!=BBjAPI()
REM Open the SysGui device
SYSGUI=UNT
OPEN (SYSGUI) "X0"
REM Obtain the instance of the BBjSysGui object
LET mySysGui!=myAPI!.getSysGui()
REM Set addWindow param values
X=100
Y=100
WIDTH=200
HEIGHT=300
TITLE$="BBjSlider"
REM Set the current context
mySysGui!.setContext(0)
REM Create a window
myWindow! = mySysGui!.addWindow(X,Y,WIDTH,HEIGHT,TITLE$)
REM Add a vertical slider on the window
mySlider! = myWindow!.addVerticalSlider(101,50,25,100,250,$0000$)
mySlider!.focus()
mySlider!.setMinimum(0)
mySlider!.setMaximum(3)
mySlider!.setPaintTicks(1)
mySlider!.setMajorTickSpacing(1)
mySlider!.setPaintLabels(1)
labels! = new java.util.TreeMap()
labels!.put(0,"Off")
labels!.put(1,"Small")
labels!.put(2,"Medium")
labels!.put(3,"Large")
print "Default labels: ",mySlider!.getLabels()
mySlider!.setLabels(labels!)
print " Custom labels: ",mySlider!.getLabels()
REM Register the CALLBACK routines
CALLBACK(ON_CONTROL_SCROLL,SLIDER_SCROLLED,mySysGui!.getContext(),mySlider!.getID())
CALLBACK(ON_CLOSE,APP_CLOSE,mySysGui!.getContext())
REM Process Events
PROCESS_EVENTS
REM Callback routine called when the slider is used to scroll
SLIDER_SCROLLED:
REM Get the new value of the slider
VAL = mySlider!.getValue()
MIN = mySlider!.getMinimum()
MAX = mySlider!.getMaximum()
RETURN
REM Callback routine called when the user closes the application window
APP_CLOSE:
RELEASE

See Also

BBjAPI

BBjSysGui

BBjControl

BBjWindow

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.