3.10.11 - Slider - JdlSlider

John W. Campbell

3.10.11.1 Introduction

Class, fields, constructor and methods:

3.10.11.2 Class Details

Package:

Jdl.JdlView;

Class name:

JdlSlider

Class definition:

public class JdlSlider

Extends:

JdlFramedPanel

Implements:

MouseListener
MouseMotionListener

Actions:

An action event will be generated when the slider has been moved and the mouse button released. If required action events may also be generated which track the slider movement continuously. The associated object is the string "slider input" in the former case and "slider motion" in the latter case.

3.10.11.3 Accessible Fields

public final static int PREFERRED

Size Constraint: preferred size.

public final static int FREE

Size/Location Constraint: free.

static final long serialVersionUID

JdlFramedPanel grip

Color grip_bg_colr

3.10.11.4 Constructor

3.10.11.4.1 Introduction

Constructor:

3.10.11.4.2 Default constructor

Constructor Definition:

public JdlSlider()

Parameters List:

none

3.10.11.5 Operational Methods

3.10.11.5.1 Introduction

Methods:

3.10.11.5.2 Set travel length - setTravelLength

Method Definition:

public void setTravelLength (int tlen)

Parameters List:

tlen

The travel length of the slider. The slider travels from 0 to 'tlen' i.e. there will be 'tlen+1' distinct slider positions possible.

3.10.11.5.3 Set values - setSliderValues

Method Definition:

public void setSliderValues (int min, int max, int val)

Parameters List:

min

The minimum value for the slider range (default = 0).

max

The maximum value for the slider range (default = 100) - must be greater than 'min'.

val

The currently required slider value (default = 50) - must be within the range 'min' to 'max'. The slider value resource changes as the slider is moved. This method sets the three resources to ensure consistency. Separate methods return each of the three values.

3.10.11.5.4 Set value - setValue

Method Definition:

public void setValue (int val)

Parameters List:

val

The required slider value. This must be in the range 0 to 100 or the range 'min' to 'max' as set by the setSliderValues(..) method.

3.10.11.5.5 Get value - getSliderValue

Method Definition:

public int getSliderValue()

Parameters List:

none

Method Return:

Returns the current slider value.

3.10.11.6 Resource Methods

3.10.11.6.1 Introduction

Methods:

3.10.11.6.2 Set monitor mode - setContinuousMonitor

Method Definition:

public void setContinuousMonitor(boolean flag)

Parameters List:

flag

Set to true for continuous monitoring of slider value (via action events) as the slider grip is dragged (default = false).

3.10.11.6.3 Get monitor mode - getContinuousMonitor

Method Definition:

public boolean getContinuousMonitor()

Parameters List:

none

Method Return:

Returns the current value of the continuous monitor resource flag.

3.10.11.6.4 Set grip border - setGripBorder

Method Definition:

public void setGripBorder(int width)

Parameters List:

width

The width of the slider grip border in pixels (default = 2, minimum = 2).

3.10.11.6.5 Get grip border - getGripBorder

Method Definition:

public int getGripBorder()

Parameters List:

none

Method Return:

Returns the slider grip border width in pixels.

3.10.11.6.6 Set grip height - setGripHeight

Method Definition:

public void setGripHeight(int height)

Parameters List:

height

The height of the slider grip in pixels (default = 16).

3.10.11.6.7 Get grip height - getGripHeight

Method Definition:

public int getGripHeight()

Parameters List:

none

Method Return:

Returns the slider grip height in pixels.

3.10.11.6.8 Set grip width - setGripWidth

Method Definition:

public void setGripWidth(int width)

Parameters List:

width

The width of the slider grip in pixels (default = 12, minimum = 10).

3.10.11.6.9 Get grip width - getGripWidth

Method Definition:

public int getGripWidth()

Parameters List:

none

Method Return:

Returns the slider grip width in pixels.

3.10.11.6.10 Get maximum value - getSliderMaximum

Method Definition:

public int getSliderMaximum()

Parameters List:

none

Method Return:

Returns the slider maximum value resource (note - set via setSliderValues)

3.10.11.6.11 Get minimum value - getSliderMinimum

Method Definition:

public int getSliderMinimum()

Parameters List:

none

Method Return:

Returns the slider minimum value resource (note - set via setSliderValues)

3.10.11.7 Standard Positioning and Sizing

3.10.11.7.1 Introduction

Methods:

3.10.11.7.2 Set position constraints - setLocationConstraints

Method Definition:

public void setLocationConstraints (int constraint_x, int constraint_y)

Parameters List:

constraint_x

Constrain the Jdl Object 'x' position = the required Jdl Object 'x' position (overrides setLocation method) or FREE if the 'x' position may be set by the setLocation method and hence possibly by the layout manager.

constraint_y

Constrain the Jdl Object 'y' position = the required the Jdl Object 'y'position (overrides setLocation method) or FREE if the 'y' position may be set by the setLocation method and hence possibly by the layout manager.

3.10.11.7.3 Set size constraints - setSizeConstraints

Method Definition:

public void setSizeConstraints (int constraint_w, int constraint_h)

Parameters List:

constraint_w

Constrain the Jdl Object width = the required Jdl Object width, or PREFERRED (default) if the width is to be calculated from the current resources, or FREE if the width may be resized to anything greater than the minimum width required.

constraint_h

Constrain the Jdl Object height = the required Jdl Object height, or PREFERRED (default) if the height is to be calculated from the current resources, or FREE if the height may be resized to anything greater than the minimum height required.

3.10.11.7.4 Set minimum height - setMinimumHeight

Method Definition:

public void setMinimumHeight(int minh)

Parameters List:

minh

The minimum height required for the object (ignored if less than that required by the minimum layout) (default = 0).

3.10.11.7.5 Set minimum width - setMinimumWidth

Method Definition:

public void setMinimumWidth(int minw)

Parameters List:

minh

The minimum width required for the object (ignored if less than that required by the minimum layout) (default = 0).

3.10.11.8 Add/Remove Action Listener

3.10.11.8.1 Introduction

Methods:

3.10.11.8.2 Add action listener - addActionListener

Method Definition:

public void addActionListener(ActionListener listener)

Parameters List:

listener

The action listener to be added.

3.10.11.8.3 Remove action listener - removeActionListener

Method Definition:

public void removeActionListener(ActionListener listener)

Parameters List:

listener

The action listener to be removed.

3.10.11.9 Overriden Superclass Methods

3.10.11.9.1 Introduction

Methods:

3.10.11.9.2 Set background - setBackground

Method Definition:

public void setBackground (Color c)

Parameters List:

c

The color to become this object's background color.

3.10.11.9.3 Set background colours - setBackground

Method Definition:

public void setBackground (Color c, Color brighter, Color darker)

Parameters List:

c

The background colour.

brighter

A brighter shade of the background colour.

darker

A darker shade of the background colour.

3.10.11.9.4 Set foreground - setForeground

Method Definition:

public void setForeground (Color c)

Parameters List:

c

The color to become this object's foreground color.

3.10.11.9.5 Get minimum size - getMinimumSize

Method Definition:

public Dimension getMinimumSize()

Parameters List:

none

3.10.11.9.6 Get preferred size - getPreferredSize

Method Definition:

public Dimension getPreferredSize()

Parameters List:

none