ScrollBar

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.ScrollBar

SOURCE |

Download org.eclipse.swt.widgets.ScrollBar

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.swt.widgets
Class ScrollBar

java.lang.Object
  org.eclipse.swt.widgets.Widget
      org.eclipse.swt.widgets.ScrollBar

public class ScrollBar
extends Widget

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

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

Typically, scroll bars 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, scroll bars 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 scroll bar'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 scroll bar will not change.

Scroll bars are created by specifying either H_SCROLL, V_SCROLL or both when creating a Scrollable. They are accessed from the Scrollable using getHorizontalBar and getVerticalBar.

Note: Scroll bars are not Controls. On some platforms, scroll bars that appear as part of some standard controls such as a text or list have no operating system resources and are not children of the control. For this reason, scroll bars are treated specially. To create a control that looks like a scroll bar but has operating system resources, use Slider.

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

(package private) Scrollable parent


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

(package private) ScrollBar()


(package private) ScrollBar(Scrollable parent, int style)
          Creates a new instance of the widget.

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)


boolean getEnabled()
          Returns true if the receiver is enabled, and false otherwise.

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.

Scrollable getParent()
          Returns the receiver's parent, which must be scrollable.

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

org.eclipse.swt.graphics.Point getSize()
          Returns a point describing the receiver's size.

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

boolean getVisible()
          Returns true if the receiver is visible, and false otherwise.

(package private) long gtk_value_changed(long adjustment)


(package private) void hookEvents()


boolean isEnabled()
          Returns true if the receiver is enabled and all of the receiver's ancestors are enabled, and false otherwise.

boolean isVisible()
          Returns true if the receiver is visible and all of the receiver's ancestors are visible and false otherwise.

(package private) void releaseChild()


(package private) void releaseWidget()


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 setEnabled(boolean enabled)
          Enables the receiver if the argument is true, and disables it otherwise.

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.

void setVisible(boolean visible)
          Marks the receiver as visible if the argument is true, and marks it invisible otherwise.

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

addDisposeListener, addListener, checkBits, checkOrientation, checkParent, checkSubclass, checkWidget, createHandle, createWidget, deregister, destroyWidget, dispose, error, filterProc, filters, fixMnemonic, fontHeight, getData, getData, getDisplay, getName, getNameText, getStyle, gtk_activate, gtk_button_press_event, gtk_button_release_event, gtk_changed, gtk_clicked, gtk_commit, gtk_configure_event, gtk_delete_event, gtk_delete_range, gtk_delete_text, gtk_enter_notify_event, gtk_event_after, gtk_event, gtk_expose_event, gtk_focus_in_event, gtk_focus_out_event, gtk_focus, gtk_hide, gtk_insert_text, gtk_key_press_event, gtk_key_release_event, gtk_leave_notify_event, gtk_map_event, gtk_mnemonic_activate, gtk_motion_notify_event, gtk_popup_menu, gtk_preedit_changed, gtk_realize, gtk_row_activated, gtk_scroll_child, gtk_select, gtk_show_help, 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_unrealize, gtk_visibility_notify_event, gtk_window_state_event, hooks, hoverProc, isDisposed, isListening, isValidSubclass, isValidThread, isValidWidget, menuPositionProc, mnemonicHit, mnemonicMatch, notifyListeners, pixbufCellDataProc, postEvent, postEvent, register, releaseHandle, releaseResources, removeDisposeListener, removeListener, removeListener, sendEvent, sendEvent, sendEvent, sendEvent, setData, setData, setInputState, setKeyState, setOrientation, shellMapProc, textCellDataProc, timerProc, topHandle, toString, translateTraversal, treeSelectionProc, windowProc, windowProc, windowProc, windowProc

Methods inherited from class java.lang.Object

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

Field Detail

parent

Scrollable parent

Constructor Detail

ScrollBar

ScrollBar()

ScrollBar

ScrollBar(Scrollable parent,
          int style)

Creates a new instance of the widget.

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)

getEnabled

public boolean getEnabled()

Returns true if the receiver is enabled, and false otherwise. A disabled control is typically not selectable from the user interface and draws with an inactive or "grayed" look.

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.

getParent

public Scrollable getParent()

Returns the receiver's parent, which must be scrollable.

getSelection

public int getSelection()

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

getSize

public org.eclipse.swt.graphics.Point getSize()

Returns a point describing the receiver's size. The x coordinate of the result is the width of the receiver. The y coordinate of the result is the height of the receiver.

getThumb

public int getThumb()

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

getVisible

public boolean getVisible()

Returns true if the receiver is visible, and false otherwise.

If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, this method may still indicate that it is considered visible even though it may not actually be showing.

gtk_value_changed

long gtk_value_changed(long adjustment)

Overrides:: gtk_value_changed in class Widget

hookEvents

void hookEvents()

Overrides:: hookEvents in class Widget

isEnabled

public boolean isEnabled()

Returns true if the receiver is enabled and all of the receiver's ancestors are enabled, and false otherwise. A disabled control is typically not selectable from the user interface and draws with an inactive or "grayed" look.

isVisible

public boolean isVisible()

Returns true if the receiver is visible and all of the receiver's ancestors are visible and false otherwise.

releaseChild

void releaseChild()

Overrides:: releaseChild in class Widget

releaseWidget

void releaseWidget()

Overrides:: releaseWidget in class Widget

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.

setEnabled

public void setEnabled(boolean enabled)

Enables the receiver if the argument is true, and disables it otherwise. A disabled control is typically not selectable from the user interface and draws with an inactive or "grayed" look.

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.

setVisible

public void setVisible(boolean visible)

Marks the receiver as visible if the argument is true, and marks it invisible otherwise.

If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, marking it visible may not actually cause it to be displayed.

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
`(package private)`	`ScrollBar()`
`(package private)`	`ScrollBar(Scrollable parent, int style)` Creates a new instance of the widget.

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)`
`boolean`	`getEnabled()` Returns `true` if the receiver is enabled, and `false` otherwise.
`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.
`Scrollable`	`getParent()` Returns the receiver's parent, which must be scrollable.
`int`	`getSelection()` Returns the single selection that is the receiver's value.
`org.eclipse.swt.graphics.Point`	`getSize()` Returns a point describing the receiver's size.
`int`	`getThumb()` Answers the size of the receiver's thumb relative to the difference between its maximum and minimum values.
`boolean`	`getVisible()` Returns `true` if the receiver is visible, and `false` otherwise.
`(package private) long`	`gtk_value_changed(long adjustment)`
`(package private) void`	`hookEvents()`
`boolean`	`isEnabled()` Returns `true` if the receiver is enabled and all of the receiver's ancestors are enabled, and `false` otherwise.
`boolean`	`isVisible()` Returns `true` if the receiver is visible and all of the receiver's ancestors are visible and `false` otherwise.
`(package private) void`	`releaseChild()`
`(package private) void`	`releaseWidget()`
`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`	`setEnabled(boolean enabled)` Enables the receiver if the argument is `true`, and disables it otherwise.
`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.
`void`	`setVisible(boolean visible)` Marks the receiver as visible if the argument is `true`, and marks it invisible otherwise.

org.eclipse.swt.widgets Class ScrollBar

parent

ScrollBar

ScrollBar

addSelectionListener

checkStyle

getEnabled

getIncrement

getMaximum

getMinimum

getPageIncrement

getParent

getSelection

getSize

getThumb

getVisible

gtk_value_changed

hookEvents

isEnabled

isVisible

releaseChild

releaseWidget

removeSelectionListener

setEnabled

setIncrement

setMaximum

setMinimum

setPageIncrement

setSelection

setThumb

setValues

setVisible

org.eclipse.swt.widgets
Class ScrollBar