Slider

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> eclipse >> swt >> [ widgets overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.eclipse.swt.widgets.Slider

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.swt.widgets
Class Slider

java.lang.Object
  org.eclipse.swt.widgets.Widget
      org.eclipse.swt.widgets.Control
          org.eclipse.swt.widgets.Slider

All Implemented Interfaces:: org.eclipse.swt.graphics.Drawable

public class Slider
extends Control

Instances of this class are selectable user interface objects that represent a range of positive, numeric values.

At any given moment, a given slider will have a single selection that is considered to be its value, which is constrained to be within the range of values the slider represents (that is, between its minimum and maximum values).

Typically, sliders will be made up of five areas:

an arrow button for decrementing the value
a page decrement area for decrementing the value by a larger amount
a thumb for modifying the value by mouse dragging
a page increment area for incrementing the value by a larger amount
an arrow button for incrementing the value

Based on their style, sliders are either HORIZONTAL (which have a left facing button for decrementing the value and a right facing button for incrementing it) or VERTICAL (which have an upward facing button for decrementing the value and a downward facing buttons for incrementing it).

On some platforms, the size of the slider's thumb can be varied relative to the magnitude of the range of values it represents (that is, relative to the difference between its maximum and minimum values). Typically, this is used to indicate some proportional value such as the ratio of the visible area of a document to the total amount of space that it would take to display it. SWT supports setting the thumb size even if the underlying platform does not, but in this case the appearance of the slider will not change.

Styles:: HORIZONTAL, VERTICAL
Events:: Selection

Note: Only one of the styles HORIZONTAL and VERTICAL may be specified.

IMPORTANT: This class is not intended to be subclassed.

Field Summary

Fields inherited from class org.eclipse.swt.widgets.Control

accessible, cursor, drawCount, enableWindow, fixedHandle, font, layoutData, menu, parent, redrawWindow, toolTipText

Fields inherited from class org.eclipse.swt.widgets.Widget

ACTIVATE, BUTTON_PRESS_EVENT, BUTTON_RELEASE_EVENT, CANVAS, CHANGED, CLICKED, COMMIT, CONFIGURE_EVENT, data, DEFAULT_HEIGHT, DEFAULT_WIDTH, DELETE_EVENT, DELETE_RANGE, DELETE_TEXT, DISABLED, display, DISPOSED, ENTER_NOTIFY_EVENT, EVENT, EVENT_AFTER, eventTable, EXPOSE_EVENT, FOCUS, FOCUS_IN_EVENT, FOCUS_OUT_EVENT, handle, HANDLE, HIDE, INSERT_TEXT, KEY_PRESS_EVENT, KEY_RELEASE_EVENT, KEYED_DATA, LEAVE_NOTIFY_EVENT, MAP_EVENT, MENU, MNEMONIC_ACTIVATE, MOTION_NOTIFY_EVENT, OBSCURED, POPUP_MENU, PREEDIT_CHANGED, REALIZE, ROW_ACTIVATED, SCROLL_CHILD, SELECT, SHOW, SHOW_HELP, SIZE_ALLOCATE, state, style, STYLE_SET, SWITCH_PAGE, TEST_COLLAPSE_ROW, TEST_EXPAND_ROW, TOGGLED, UNMAP_EVENT, UNREALIZE, VALUE_CHANGED, VISIBILITY_NOTIFY_EVENT, WINDOW_STATE_EVENT

Constructor Summary

Slider(Composite parent, int style)
          Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

Method Summary

void addSelectionListener(org.eclipse.swt.events.SelectionListener listener)
          Adds the listener to the collection of listeners who will be notified when the receiver's value changes, by sending it one of the messages defined in the SelectionListener interface.

(package private) static int checkStyle(int style)


org.eclipse.swt.graphics.Point computeSize(int wHint, int hHint, boolean changed)
          Returns the preferred size of the receiver.

(package private) void createHandle(int index)


(package private) void deregister()


int getIncrement()
          Returns the amount that the receiver's value will be modified by when the up/down (or right/left) arrows are pressed.

int getMaximum()
          Returns the maximum value which the receiver will allow.

int getMinimum()
          Returns the minimum value which the receiver will allow.

int getPageIncrement()
          Returns the amount that the receiver's value will be modified by when the page increment/decrement areas are selected.

int getSelection()
          Returns the single selection that is the receiver's value.

int getThumb()
          Returns the size of the receiver's thumb relative to the difference between its maximum and minimum values.

(package private) long gtk_value_changed(long adjustment)


(package private) void hookEvents()


(package private) void register()


void removeSelectionListener(org.eclipse.swt.events.SelectionListener listener)
          Removes the listener from the collection of listeners who will be notified when the receiver's value changes.

void setIncrement(int value)
          Sets the amount that the receiver's value will be modified by when the up/down (or right/left) arrows are pressed to the argument, which must be at least one.

void setMaximum(int value)
          Sets the maximum.

void setMinimum(int value)
          Sets the minimum value.

void setPageIncrement(int value)
          Sets the amount that the receiver's value will be modified by when the page increment/decrement areas are selected to the argument, which must be at least one.

void setSelection(int value)
          Sets the single selection that is the receiver's value to the argument which must be greater than or equal to zero.

void setThumb(int value)
          Sets the size of the receiver's thumb relative to the difference between its maximum and minimum values.

void setValues(int selection, int minimum, int maximum, int thumb, int increment, int pageIncrement)
          Sets the receiver's selection, minimum value, maximum value, thumb, increment and page increment all at once.

Methods inherited from class org.eclipse.swt.widgets.Control

_getShell, addControlListener, addFocusListener, addHelpListener, addKeyListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addPaintListener, addTraverseListener, computeNativeSize, computeSize, computeTabGroup, computeTabList, computeTabRoot, createWidget, defaultFont, drawGripper, enableWidget, eventHandle, filterKey, findMenus, fixChildren, fixFocus, focusHandle, fontHandle, forceFocus, forceFocus, getAccessible, getBackground, getBackgroundColor, getBaseColor, getBgColor, getBorderWidth, getBounds, getEnabled, getFgColor, getFont, getFontDescription, getForeground, getForegroundColor, getIMCaretPos, getLayoutData, getLocation, getMenu, getMonitor, getParent, getPath, getShell, getSize, getTextColor, getToolTipText, getVisible, gtk_button_press_event, gtk_button_release_event, gtk_commit, gtk_enter_notify_event, gtk_event_after, gtk_expose_event, gtk_focus_in_event, gtk_focus_out_event, gtk_focus, gtk_key_press_event, gtk_key_release_event, gtk_leave_notify_event, gtk_mnemonic_activate, gtk_motion_notify_event, gtk_popup_menu, gtk_preedit_changed, gtk_realize, gtk_show_help, gtk_unrealize, gtk_visibility_notify_event, hasFocus, hoverProc, imHandle, internal_dispose_GC, internal_new_GC, isEnabled, isFocusAncestor, isFocusControl, isReparentable, isShowing, isTabGroup, isTabItem, isVisible, menuShell, mnemonicHit, mnemonicMatch, moveAbove, moveBelow, moveHandle, pack, pack, paintHandle, paintWindow, redraw, redraw, redrawWidget, releaseChild, releaseHandle, releaseWidget, removeControlListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removePaintListener, removeTraverseListener, resizeHandle, sendFocusEvent, sendHelpEvent, sendIMKeyEvent, sendKeyEvent, sendMouseEvent, setBackground, setBackgroundColor, setBackgroundColor, setBounds, setBounds, setBounds, setCapture, setCursor, setCursor, setEnabled, setFocus, setFont, setFontDescription, setForeground, setForegroundColor, setInitialSize, setLayoutData, setLocation, setLocation, setMenu, setParent, setRadioSelection, setRedraw, setSize, setSize, setTabGroupFocus, setTabItemFocus, setToolTipText, setVisible, setZOrder, setZOrder, showMenu, sort, toControl, toControl, toDisplay, toDisplay, topHandle, translateMnemonic, translateMnemonic, translateTraversal, traversalCode, traverse, traverse, traverseEscape, traverseGroup, traverseItem, traverseMnemonic, traversePage, traverseReturn, update, update

Methods inherited from class org.eclipse.swt.widgets.Widget

addDisposeListener, addListener, checkBits, checkOrientation, checkParent, checkSubclass, checkWidget, destroyWidget, dispose, error, filterProc, filters, fixMnemonic, fontHeight, getData, getData, getDisplay, getName, getNameText, getStyle, gtk_activate, gtk_changed, gtk_clicked, gtk_configure_event, gtk_delete_event, gtk_delete_range, gtk_delete_text, gtk_event, gtk_hide, gtk_insert_text, gtk_map_event, gtk_row_activated, gtk_scroll_child, gtk_select, gtk_show, gtk_size_allocate, gtk_style_set, gtk_switch_page, gtk_test_collapse_row, gtk_test_expand_row, gtk_timer, gtk_toggled, gtk_unmap_event, gtk_window_state_event, hooks, isDisposed, isListening, isValidSubclass, isValidThread, isValidWidget, menuPositionProc, mnemonicHit, mnemonicMatch, notifyListeners, pixbufCellDataProc, postEvent, postEvent, releaseResources, removeDisposeListener, removeListener, removeListener, sendEvent, sendEvent, sendEvent, sendEvent, setData, setData, setInputState, setKeyState, setOrientation, shellMapProc, textCellDataProc, timerProc, toString, translateTraversal, treeSelectionProc, windowProc, windowProc, windowProc, windowProc

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Slider

public Slider(Composite parent,
              int style)

Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Method Detail

addSelectionListener

public void addSelectionListener(org.eclipse.swt.events.SelectionListener listener)

Adds the listener to the collection of listeners who will be notified when the receiver's value changes, by sending it one of the messages defined in the SelectionListener interface.

When widgetSelected is called, the event object detail field contains one of the following values: 0 - for the end of a drag. SWT.DRAG. SWT.HOME. SWT.END. SWT.ARROW_DOWN. SWT.ARROW_UP. SWT.PAGE_DOWN. SWT.PAGE_UP. widgetDefaultSelected is not called.

checkStyle

static int checkStyle(int style)

createHandle

void createHandle(int index)

Overrides:: createHandle in class Widget

gtk_value_changed

long gtk_value_changed(long adjustment)

Overrides:: gtk_value_changed in class Widget

hookEvents

void hookEvents()

Overrides:: hookEvents in class Control

register

void register()

Overrides:: register in class Control

deregister

void deregister()

Overrides:: deregister in class Control

computeSize

public org.eclipse.swt.graphics.Point computeSize(int wHint,
                                                  int hHint,
                                                  boolean changed)

Description copied from class: Control

Returns the preferred size of the receiver.

The preferred size of a control is the size that it would best be displayed at. The width hint and height hint arguments allow the caller to ask a control questions such as "Given a particular width, how high does the control need to be to show all of the contents?" To indicate that the caller does not wish to constrain a particular dimension, the constant SWT.DEFAULT is passed for the hint.

If the changed flag is true, it indicates that the receiver's contents have changed, therefore any caches that a layout manager containing the control may have been keeping need to be flushed. When the control is resized, the changed flag will be false, so layout manager caches can be retained.

Overrides:: computeSize in class Control

getIncrement

public int getIncrement()

Returns the amount that the receiver's value will be modified by when the up/down (or right/left) arrows are pressed.

getMaximum

public int getMaximum()

Returns the maximum value which the receiver will allow.

getMinimum

public int getMinimum()

Returns the minimum value which the receiver will allow.

getPageIncrement

public int getPageIncrement()

Returns the amount that the receiver's value will be modified by when the page increment/decrement areas are selected.

getSelection

public int getSelection()

Returns the single selection that is the receiver's value.

getThumb

public int getThumb()

Returns the size of the receiver's thumb relative to the difference between its maximum and minimum values.

removeSelectionListener

public void removeSelectionListener(org.eclipse.swt.events.SelectionListener listener)

Removes the listener from the collection of listeners who will be notified when the receiver's value changes.

setIncrement

public void setIncrement(int value)

Sets the amount that the receiver's value will be modified by when the up/down (or right/left) arrows are pressed to the argument, which must be at least one.

setMaximum

public void setMaximum(int value)

Sets the maximum. If this value is negative or less than or equal to the minimum, the value is ignored. If necessary, first the thumb and then the selection are adjusted to fit within the new range.

setMinimum

public void setMinimum(int value)

Sets the minimum value. If this value is negative or greater than or equal to the maximum, the value is ignored. If necessary, first the thumb and then the selection are adjusted to fit within the new range.

setPageIncrement

public void setPageIncrement(int value)

Sets the amount that the receiver's value will be modified by when the page increment/decrement areas are selected to the argument, which must be at least one.

setSelection

public void setSelection(int value)

Sets the single selection that is the receiver's value to the argument which must be greater than or equal to zero.

setThumb

public void setThumb(int value)

Sets the size of the receiver's thumb relative to the difference between its maximum and minimum values. This new value will be ignored if it is less than one, and will be clamped if it exceeds the receiver's current range.

setValues

public void setValues(int selection,
                      int minimum,
                      int maximum,
                      int thumb,
                      int increment,
                      int pageIncrement)

Sets the receiver's selection, minimum value, maximum value, thumb, increment and page increment all at once.

Note: This is equivalent to setting the values individually using the appropriate methods, but may be implemented in a more efficient fashion on some platforms.

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> eclipse >> swt >> [ widgets overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Constructor Summary
`Slider(Composite parent, int style)` Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

Method Summary
`void`	`addSelectionListener(org.eclipse.swt.events.SelectionListener listener)` Adds the listener to the collection of listeners who will be notified when the receiver's value changes, by sending it one of the messages defined in the `SelectionListener` interface.
`(package private) static int`	`checkStyle(int style)`
`org.eclipse.swt.graphics.Point`	`computeSize(int wHint, int hHint, boolean changed)` Returns the preferred size of the receiver.
`(package private) void`	`createHandle(int index)`
`(package private) void`	`deregister()`
`int`	`getIncrement()` Returns the amount that the receiver's value will be modified by when the up/down (or right/left) arrows are pressed.
`int`	`getMaximum()` Returns the maximum value which the receiver will allow.
`int`	`getMinimum()` Returns the minimum value which the receiver will allow.
`int`	`getPageIncrement()` Returns the amount that the receiver's value will be modified by when the page increment/decrement areas are selected.
`int`	`getSelection()` Returns the single selection that is the receiver's value.
`int`	`getThumb()` Returns the size of the receiver's thumb relative to the difference between its maximum and minimum values.
`(package private) long`	`gtk_value_changed(long adjustment)`
`(package private) void`	`hookEvents()`
`(package private) void`	`register()`
`void`	`removeSelectionListener(org.eclipse.swt.events.SelectionListener listener)` Removes the listener from the collection of listeners who will be notified when the receiver's value changes.
`void`	`setIncrement(int value)` Sets the amount that the receiver's value will be modified by when the up/down (or right/left) arrows are pressed to the argument, which must be at least one.
`void`	`setMaximum(int value)` Sets the maximum.
`void`	`setMinimum(int value)` Sets the minimum value.
`void`	`setPageIncrement(int value)` Sets the amount that the receiver's value will be modified by when the page increment/decrement areas are selected to the argument, which must be at least one.
`void`	`setSelection(int value)` Sets the single selection that is the receiver's value to the argument which must be greater than or equal to zero.
`void`	`setThumb(int value)` Sets the size of the receiver's thumb relative to the difference between its maximum and minimum values.
`void`	`setValues(int selection, int minimum, int maximum, int thumb, int increment, int pageIncrement)` Sets the receiver's selection, minimum value, maximum value, thumb, increment and page increment all at once.

org.eclipse.swt.widgets Class Slider

Slider

addSelectionListener

checkStyle

createHandle

gtk_value_changed

hookEvents

register

deregister

computeSize

getIncrement

getMaximum

getMinimum

getPageIncrement

getSelection

getThumb

removeSelectionListener

setIncrement

setMaximum

setMinimum

setPageIncrement

setSelection

setThumb

setValues

org.eclipse.swt.widgets
Class Slider