/******************************************************************************* * Copyright (c) 2000, 2009 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ package org.eclipse.swt.widgets; import org.eclipse.swt.internal.photon.*; import org.eclipse.swt.*; import org.eclipse.swt.graphics.*; import org.eclipse.swt.events.*; /** * 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: *

    *
  1. an arrow button for decrementing the value
    2. *
  2. a page decrement area for decrementing the value by a larger amount
    3. *
  3. a thumb for modifying the value by mouse dragging
    4. *
  4. a page increment area for incrementing the value by a larger amount
    5. *
  5. an arrow button for incrementing the value
    6. *
* 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. *

* * @see Slider * @see Scrollable * @see Scrollable#getHorizontalBar * @see Scrollable#getVerticalBar * @see SWT Example: ControlExample * @see Sample code and further information * @noextend This class is not intended to be subclassed by clients. */ public class ScrollBar extends Widget { Scrollable parent; ScrollBar (Scrollable parent, int style, int handle) { super (parent, checkStyle (style)); this.parent = parent; this.handle = handle; state |= HANDLE; createWidget (0); } ScrollBar (Scrollable parent, int style) { super (parent, checkStyle (style)); this.parent = parent; createWidget (0); } static int checkStyle (int style) { return checkBits (style, SWT.HORIZONTAL, SWT.VERTICAL, 0, 0, 0, 0); } /** * Adds the listener to the collection of listeners who will * be notified when the user changes the receiver's value, 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: * SWT.NONE - 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. *

* * @param listener the listener which should be notified when the user changes the receiver's value * * @exception IllegalArgumentException * @exception SWTException * * @see SelectionListener * @see #removeSelectionListener * @see SelectionEvent */ public void addSelectionListener (SelectionListener listener) { checkWidget(); if (listener == null) error (SWT.ERROR_NULL_ARGUMENT); TypedListener typedListener = new TypedListener(listener); addListener (SWT.Selection,typedListener); addListener (SWT.DefaultSelection,typedListener); } void createHandle (int index) { state |= HANDLE; if (handle != 0) return; int parentHandle = parent.scrolledHandle; int orientation, sizeArg, size, basicFlags; if ((style & SWT.HORIZONTAL) != 0) { orientation = OS.Pt_HORIZONTAL; sizeArg = OS.Pt_ARG_HEIGHT; size = display.SCROLLBAR_HEIGHT; basicFlags = display.SCROLLBAR_HORIZONTAL_BASIC_FLAGS; } else { orientation = OS.Pt_VERTICAL; sizeArg = OS.Pt_ARG_WIDTH; size = display.SCROLLBAR_WIDTH; basicFlags = display.SCROLLBAR_VERTICAL_BASIC_FLAGS; } int [] args = { sizeArg, size, 0, OS.Pt_ARG_MAXIMUM, 99, 0, OS.Pt_ARG_PAGE_INCREMENT, 10, 0, OS.Pt_ARG_SLIDER_SIZE, 10, 0, OS.Pt_ARG_BASIC_FLAGS, basicFlags, ~0, OS.Pt_ARG_ORIENTATION, orientation, 0, OS.Pt_ARG_FLAGS, 0, OS.Pt_GETS_FOCUS, OS.Pt_ARG_RESIZE_FLAGS, 0, OS.Pt_RESIZE_XY_BITS, }; handle = OS.PtCreateWidget (OS.PtScrollbar (), parentHandle, args.length / 3, args); if (handle == 0) error (SWT.ERROR_NO_HANDLES); } /** * 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. * * @return the receiver's enabled state * * @exception SWTException * * @see #isEnabled */ public boolean getEnabled () { checkWidget (); int topHandle = topHandle (); return (OS.PtWidgetFlags (topHandle) & OS.Pt_BLOCKED) == 0; } /** * Returns the amount that the receiver's value will be * modified by when the up/down (or right/left) arrows * are pressed. * * @return the increment * * @exception SWTException */ public int getIncrement () { checkWidget(); int [] args = {OS.Pt_ARG_INCREMENT, 0, 0}; OS.PtGetResources (handle, args.length / 3, args); return args [1]; } /** * Returns the minimum value which the receiver will allow. * * @return the minimum * * @exception SWTException */ public int getMinimum () { checkWidget(); int [] args = {OS.Pt_ARG_MINIMUM, 0, 0}; OS.PtGetResources (handle, args.length / 3, args); return args [1]; } /** * Returns the maximum value which the receiver will allow. * * @return the maximum * * @exception SWTException */ public int getMaximum () { checkWidget(); int [] args = {OS.Pt_ARG_MAXIMUM, 0, 0}; OS.PtGetResources (handle, args.length / 3, args); return args [1] + 1; } /** * Returns the amount that the receiver's value will be * modified by when the page increment/decrement areas * are selected. * * @return the page increment * * @exception SWTException */ public int getPageIncrement () { checkWidget(); int [] args = {OS.Pt_ARG_PAGE_INCREMENT, 0, 0}; OS.PtGetResources (handle, args.length / 3, args); return args [1]; } /** * Returns the receiver's parent, which must be a Scrollable. * * @return the receiver's parent * * @exception SWTException */ public Scrollable getParent () { checkWidget(); return parent; } /** * Returns the single 'selection' that is the receiver's value. * * @return the selection * * @exception SWTException */ public int getSelection () { checkWidget(); int [] args = {OS.Pt_ARG_GAUGE_VALUE, 0, 0}; OS.PtGetResources (handle, args.length / 3, args); return args [1]; } /** * 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. * * @return the receiver's size * * @exception SWTException */ public Point getSize () { checkWidget(); int [] args = {OS.Pt_ARG_WIDTH, 0, 0, OS.Pt_ARG_HEIGHT, 0, 0}; OS.PtGetResources (handle, args.length / 3, args); return new Point (args [1], args [4]); } /** * Returns the size of the receiver's thumb relative to the * difference between its maximum and minimum values. * * @return the thumb value * * @exception SWTException * * @see ScrollBar */ public int getThumb () { checkWidget(); int [] args = {OS.Pt_ARG_SLIDER_SIZE, 0, 0}; OS.PtGetResources (handle, args.length / 3, args); return args [1]; } /** * 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. *

* * @return the receiver's visibility state * * @exception SWTException */ public boolean getVisible () { checkWidget (); int topHandle = topHandle (); return (OS.PtWidgetFlags (topHandle) & OS.Pt_DELAY_REALIZE) == 0; } void hookEvents () { int windowProc = display.windowProc; OS.PtAddCallback (handle, OS.Pt_CB_SCROLL_MOVE, windowProc, OS.Pt_CB_SCROLL_MOVE); } /** * 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. * * @return the receiver's enabled state * * @exception SWTException * * @see #getEnabled */ public boolean isEnabled () { checkWidget(); return getEnabled () && parent.isEnabled (); } /** * Returns true if the receiver is visible and all * of the receiver's ancestors are visible and false * otherwise. * * @return the receiver's visibility state * * @exception SWTException * * @see #getVisible */ public boolean isVisible () { checkWidget(); return OS.PtWidgetIsRealized (handle); } int Pt_CB_SCROLL_MOVE (int widget, int info) { if (info == 0) return OS.Pt_CONTINUE; PtCallbackInfo_t cbinfo = new PtCallbackInfo_t (); OS.memmove (cbinfo, info, PtCallbackInfo_t.sizeof); if (cbinfo.cbdata == 0) return OS.Pt_CONTINUE; PtScrollbarCallback_t cb = new PtScrollbarCallback_t (); OS.memmove (cb, cbinfo.cbdata, PtScrollbarCallback_t.sizeof); Event event = new Event (); switch (cb.action) { case OS.Pt_SCROLL_DRAGGED: event.detail = SWT.DRAG; break; case OS.Pt_SCROLL_TO_MIN: event.detail = SWT.HOME; break; case OS.Pt_SCROLL_TO_MAX: event.detail = SWT.END; break; case OS.Pt_SCROLL_INCREMENT: event.detail = SWT.ARROW_DOWN; break; case OS.Pt_SCROLL_DECREMENT : event.detail = SWT.ARROW_UP; break; case OS.Pt_SCROLL_PAGE_DECREMENT: event.detail = SWT.PAGE_UP; break; case OS.Pt_SCROLL_PAGE_INCREMENT: event.detail = SWT.PAGE_DOWN; break; } sendEvent(SWT.Selection, event); return OS.Pt_CONTINUE; } /** * Removes the listener from the collection of listeners who will * be notified when the user changes the receiver's value. * * @param listener the listener which should no longer be notified * * @exception IllegalArgumentException * @exception SWTException * * @see SelectionListener * @see #addSelectionListener */ public void removeSelectionListener (SelectionListener listener) { checkWidget(); if (listener == null) error (SWT.ERROR_NULL_ARGUMENT); if (eventTable == null) return; eventTable.unhook (SWT.Selection, listener); eventTable.unhook (SWT.DefaultSelection,listener); } void releaseParent () { super.releaseParent (); if (parent.horizontalBar == this) parent.horizontalBar = null; if (parent.verticalBar == this) parent.verticalBar = null; } void setBounds (int x, int y, int width, int height) { PhArea_t area = new PhArea_t (); area.pos_x = (short) x; area.pos_y = (short) y; area.size_w = (short) (Math.max (width, 0)); area.size_h = (short) (Math.max (height, 0)); int ptr = OS.malloc (PhArea_t.sizeof); OS.memmove (ptr, area, PhArea_t.sizeof); OS.PtSetResource (handle, OS.Pt_ARG_AREA, ptr, 0); OS.free (ptr); } /** * 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. * * @param enabled the new enabled state * * @exception SWTException */ public void setEnabled (boolean enabled) { checkWidget (); int topHandle = topHandle (); int flags = enabled ? 0 : OS.Pt_BLOCKED | OS.Pt_GHOST; OS.PtSetResource (topHandle, OS.Pt_ARG_FLAGS, flags, OS.Pt_BLOCKED | OS.Pt_GHOST); } /** * 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. * * @param value the new increment (must be greater than zero) * * @exception SWTException */ public void setIncrement (int value) { checkWidget(); OS.PtSetResource (handle, OS.Pt_ARG_INCREMENT, value, 0); } /** * 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. * * @param value the new maximum * * @exception SWTException */ public void setMaximum (int value) { checkWidget(); int [] args = { OS.Pt_ARG_MAXIMUM, 0, 0, OS.Pt_ARG_MINIMUM, 0, 0, OS.Pt_ARG_SLIDER_SIZE, 0, 0, OS.Pt_ARG_GAUGE_VALUE, 0, 0, }; OS.PtGetResources (handle, args.length / 3, args); int minimum = args [4]; if (value <= minimum) return; int thumb = args [7]; thumb = Math.min (thumb, value - minimum); int selection = args [10]; selection = Math.min (selection, value - thumb); args [1] = value - 1; args [7] = thumb; args [10] = selection; OS.PtSetResources (handle, args.length / 3, args); } /** * 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. * * @param value the new minimum * * @exception SWTException */ public void setMinimum (int value) { checkWidget(); if (value < 0) return; int [] args = { OS.Pt_ARG_MAXIMUM, 0, 0, OS.Pt_ARG_MINIMUM, 0, 0, OS.Pt_ARG_SLIDER_SIZE, 0, 0, OS.Pt_ARG_GAUGE_VALUE, 0, 0, }; OS.PtGetResources (handle, args.length / 3, args); int maximum = args [1] + 1; if (value >= maximum) return; int thumb = args [7]; thumb = Math.min (thumb, maximum - value); int selection = args [10]; selection = Math.max (selection, value); args [4] = value; args [7] = thumb; args [10] = selection; OS.PtSetResources (handle, args.length / 3, args); } /** * 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. * * @param value the page increment (must be greater than zero) * * @exception SWTException */ public void setPageIncrement (int value) { checkWidget(); OS.PtSetResource (handle, OS.Pt_ARG_PAGE_INCREMENT, value, 0); } /** * Sets the single selection that is the receiver's * value to the argument which must be greater than or equal * to zero. * * @param selection the new selection (must be zero or greater) * * @exception SWTException */ public void setSelection (int value) { checkWidget(); OS.PtSetResource (handle, OS.Pt_ARG_GAUGE_VALUE, value, 0); } /** * 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. * * @param value the new thumb value, which must be at least one and not * larger than the size of the current range * * @exception SWTException */ public void setThumb (int value) { checkWidget(); if (value < 1) return; int [] args = {OS.Pt_ARG_MINIMUM, 0, 0, OS.Pt_ARG_MAXIMUM, 0, 0}; OS.PtGetResources (handle, args.length / 3, args); int minimum = args [1]; int maximum = args [4] + 1; value = Math.min (value, maximum - minimum); OS.PtSetResource (handle, OS.Pt_ARG_SLIDER_SIZE, value, 0); } /** * Sets the receiver's selection, minimum value, maximum * value, thumb, increment and page increment all at once. *

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

* * @param selection the new selection value * @param minimum the new minimum value * @param maximum the new maximum value * @param thumb the new thumb value * @param increment the new increment value * @param pageIncrement the new pageIncrement value * * @exception SWTException */ public void setValues (int selection, int minimum, int maximum, int thumb, int increment, int pageIncrement) { checkWidget(); if (minimum < 0) return; if (maximum < 0) return; if (thumb < 1) return; if (increment < 1) return; if (pageIncrement < 1) return; thumb = Math.min (thumb, maximum - minimum); int [] args = { OS.Pt_ARG_MAXIMUM, maximum - 1, 0, OS.Pt_ARG_MINIMUM, minimum, 0, OS.Pt_ARG_SLIDER_SIZE, thumb, 0, OS.Pt_ARG_GAUGE_VALUE, selection, 0, OS.Pt_ARG_INCREMENT, increment, 0, OS.Pt_ARG_PAGE_INCREMENT, pageIncrement, 0, }; OS.PtSetResources (handle, args.length / 3, args); } /** * 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. *

* * @param visible the new visibility state * * @exception SWTException */ public void setVisible (boolean visible) { checkWidget (); int topHandle = topHandle (); int oldFlags = OS.PtWidgetFlags (topHandle); int flags = visible ? 0 : OS.Pt_DELAY_REALIZE; OS.PtSetResource (topHandle, OS.Pt_ARG_FLAGS, flags, OS.Pt_DELAY_REALIZE); if ((oldFlags & OS.Pt_DELAY_REALIZE) == flags) return; parent.resizeClientArea (); if (visible) { sendEvent (SWT.Show); OS.PtRealizeWidget (topHandle); } else { OS.PtUnrealizeWidget (topHandle); sendEvent(SWT.Hide); } } }