/******************************************************************************* * 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.carbon.CGPoint; import org.eclipse.swt.internal.carbon.CGRect; import org.eclipse.swt.internal.carbon.HIThemeTrackDrawInfo; import org.eclipse.swt.internal.carbon.OS; import org.eclipse.swt.internal.carbon.Rect; import org.eclipse.swt.internal.carbon.ScrollBarTrackInfo; import org.eclipse.swt.*; import org.eclipse.swt.events.*; import org.eclipse.swt.graphics.*; /** * 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 { int handle; int visibleRgn, oldActionProc; Scrollable parent; boolean dragging; int increment = 1; int pageIncrement = 10; ScrollBar () { /* Do nothing */ } ScrollBar (Scrollable parent, int style) { super (parent, checkStyle (style)); this.parent = parent; createWidget (); } /** * 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); } static int checkStyle (int style) { return checkBits (style, SWT.HORIZONTAL, SWT.VERTICAL, 0, 0, 0, 0); } int actionProc (int theControl, int partCode) { int result = super.actionProc (theControl, partCode); if (result == OS.noErr) return result; Event event = new Event (); int inc = 0; switch (partCode) { case OS.kControlUpButtonPart: inc -= increment; event.detail = SWT.ARROW_UP; break; case OS.kControlPageUpPart: inc -= pageIncrement; event.detail = SWT.PAGE_UP; break; case OS.kControlPageDownPart: inc += pageIncrement; event.detail = SWT.PAGE_DOWN; break; case OS.kControlDownButtonPart: inc += increment; event.detail = SWT.ARROW_DOWN; break; case OS.kControlIndicatorPart: dragging = true; event.detail = SWT.DRAG; break; default: return result; } if (oldActionProc != 0) { OS.Call (oldActionProc, theControl, partCode); parent.redrawBackgroundImage (); } else { int value = OS.GetControl32BitValue (handle) + inc; OS.SetControl32BitValue (handle, value); } sendSelectionEvent (SWT.Selection, event, true); return result; } void destroyHandle () { int theControl = handle; releaseHandle (); if (theControl != 0) { OS.DisposeControl (theControl); } } void destroyWidget () { parent.destroyScrollBar (this); releaseHandle (); //parent.sendEvent (SWT.Resize); } void enableWidget (boolean enabled) { if (enabled) { OS.EnableControl (handle); } else { OS.DisableControl (handle); } } void createHandle () { int actionProc = display.actionProc; int [] outControl = new int [1]; int window = OS.GetControlOwner (parent.scrolledHandle); OS.CreateScrollBarControl (window, null, 0, 0, 90, 10, true, actionProc, outControl); if (outControl [0] == 0) error (SWT.ERROR_NO_HANDLES); handle = outControl [0]; } void createWidget () { super.createWidget (); setZOrder (); } void deregister () { super.deregister (); display.removeWidget (handle); } boolean getDrawing () { return parent.getDrawing (); } /** * 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(); return (state & DISABLED) == 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(); return increment; } /** * Returns the maximum value which the receiver will allow. * * @return the maximum * * @exception SWTException */ public int getMaximum () { checkWidget(); int maximum = OS.GetControl32BitMaximum (handle) & 0x7FFFFFFF; int viewSize = OS.GetControlViewSize (handle); return maximum + viewSize; } /** * Returns the minimum value which the receiver will allow. * * @return the minimum * * @exception SWTException */ public int getMinimum () { checkWidget(); return OS.GetControl32BitMinimum (handle) & 0x7FFFFFFF; } /** * 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(); return pageIncrement; } /** * 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(); return OS.GetControl32BitValue (handle) & 0x7FFFFFFF; } /** * 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(); return getControlSize (handle); } /** * Returns the receiver's thumb value. * * @return the thumb value * * @exception SWTException * * @see ScrollBar */ public int getThumb () { checkWidget(); return OS.GetControlViewSize (handle); } /** * Returns a rectangle describing the size and location of the * receiver's thumb relative to its parent. * * @return the thumb bounds, relative to the {@link #getParent() parent} * * @exception SWTException * * @since 3.6 */ public Rectangle getThumbBounds () { checkWidget(); int rgnHandle = OS.NewRgn (); OS.GetControlRegion (handle, (short)OS.kControlIndicatorPart, rgnHandle); Rect rect = new Rect (); OS.GetRegionBounds (rgnHandle, rect); OS.DisposeRgn (rgnHandle); CGPoint pt = new CGPoint (); OS.HIViewConvertPoint (pt, handle, parent.handle); Rectangle result = new Rectangle(rect.left, rect.top, (rect.right - rect.left), (rect.bottom - rect.top)); result.x += (int) pt.x; result.y += (int) pt.y; return result; } /** * Returns a rectangle describing the size and location of the * receiver's thumb track relative to its parent. This rectangle * comprises the areas 2, 3, and 4 as described in {@link ScrollBar}. * * @return the thumb track bounds, relative to the {@link #getParent() parent} * * @exception SWTException * * @since 3.6 */ public Rectangle getThumbTrackBounds () { checkWidget(); HIThemeTrackDrawInfo info = new HIThemeTrackDrawInfo(); info.min = OS.GetControl32BitMinimum (handle); info.max = OS.GetControl32BitMaximum (handle); info.value = OS.GetControl32BitValue (handle); info.kind = OS.kThemeScrollBarMedium; info.attributes = OS.kThemeTrackShowThumb; if ((style & SWT.HORIZONTAL) != 0) info.attributes |= OS.kThemeTrackHorizontal; info.enableState = OS.kThemeTrackActive; info.scrollbar = new ScrollBarTrackInfo(); info.scrollbar.viewsize = OS.GetControlViewSize (handle); CGRect rect = new CGRect (); OS.HIViewGetFrame (handle, rect); info.bounds_x = rect.x; info.bounds_y = rect.y; info.bounds_width = rect.width; info.bounds_height = rect.height; OS.HIThemeGetTrackPartBounds(info, (short) OS.kControlPageDownPart, rect); CGRect rect1 = new CGRect (); OS.HIThemeGetTrackPartBounds(info, (short) OS.kControlPageUpPart, rect1); OS.CGRectUnion(rect, rect1, rect); return new Rectangle((int) rect.x, (int) rect.y, (int) rect.width, (int) rect.height); } /** * 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(); return (state & HIDDEN) == 0; } int getVisibleRegion (int control, boolean clipChildren) { if (visibleRgn == 0) { visibleRgn = OS.NewRgn (); calculateVisibleRegion (control, visibleRgn, clipChildren); } int result = OS.NewRgn (); OS.CopyRgn (visibleRgn, result); return result; } void hookEvents () { super.hookEvents (); int controlProc = display.controlProc; int [] mask = new int [] { OS.kEventClassControl, OS.kEventControlTrack, }; int controlTarget = OS.GetControlEventTarget (handle); OS.InstallEventHandler (controlTarget, controlProc, mask.length / 2, mask, handle, null); if ((parent.state & CANVAS) == 0) { oldActionProc = OS.GetControlAction (handle); OS.SetControlAction (handle, display.actionProc); } } void invalidateVisibleRegion (int control) { resetVisibleRegion (control); parent.resetVisibleRegion (control); } void invalWindowRgn (int window, int rgn) { parent.invalWindowRgn (window, rgn); } boolean isDrawing () { return getDrawing() && parent.isDrawing(); } /** * 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 (); } boolean isTrimHandle (int trimHandle) { return handle == trimHandle; } /** * 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 getVisible () && parent.isVisible (); } int kEventMouseDown (int nextHandler, int theEvent, int userData) { int status = super.kEventMouseDown (nextHandler, theEvent, userData); if (status == OS.noErr) return status; dragging = false; status = OS.CallNextEventHandler (nextHandler, theEvent); if (dragging) { Event event = new Event (); sendSelectionEvent (SWT.Selection, event, true); } dragging = false; return status; } int kEventMouseWheelMoved (int nextHandler, int theEvent, int userData) { return parent.kEventMouseWheelMoved (nextHandler, theEvent, userData); } void redraw () { redrawWidget (handle, false); } /** * 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 register () { super.register (); display.addWidget (handle, this); } void releaseHandle () { super.releaseHandle (); handle = 0; } void releaseParent () { super.releaseParent (); if (parent.horizontalBar == this) parent.horizontalBar = null; if (parent.verticalBar == this) parent.verticalBar = null; parent.resizeClientArea (); } void releaseWidget () { super.releaseWidget (); if (visibleRgn != 0) OS.DisposeRgn (visibleRgn); visibleRgn = 0; } void resetVisibleRegion (int control) { if (visibleRgn != 0) { OS.DisposeRgn (visibleRgn); visibleRgn = 0; } } /** * 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(); if (value < 1) return; increment = value; } /** * 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(); if (enabled) { if ((state & DISABLED) == 0) return; state &= ~DISABLED; OS.EnableControl (handle); } else { if ((state & DISABLED) != 0) return; state |= DISABLED; OS.DisableControl (handle); } } /** * 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(); if (value < 0) return; int minimum = OS.GetControl32BitMinimum (handle); if (value <= minimum) return; int viewSize = OS.GetControlViewSize (handle); if (value - minimum < viewSize) { viewSize = value - minimum; OS.SetControlViewSize (handle, viewSize); } OS.SetControl32BitMaximum (handle, value - viewSize); } /** * 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 viewSize = OS.GetControlViewSize (handle); int maximum = OS.GetControl32BitMaximum (handle) + viewSize; if (value >= maximum) return; if (maximum - value < viewSize) { viewSize = maximum - value; OS.SetControl32BitMaximum (handle, maximum - viewSize); OS.SetControlViewSize (handle, viewSize); } OS.SetControl32BitMinimum (handle, 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. * * @param value the page increment (must be greater than zero) * * @exception SWTException */ public void setPageIncrement (int value) { checkWidget(); if (value < 1) return; pageIncrement = value; } /** * 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.SetControl32BitValue (handle, value); } /** * Sets the thumb value. The thumb value should be used to represent * the size of the visual portion of the current range. This value is * usually the same as the page increment value. *

* 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 minimum = OS.GetControl32BitMinimum (handle); int viewSize = OS.GetControlViewSize (handle); int maximum = OS.GetControl32BitMaximum (handle) + viewSize; value = Math.min (value, maximum - minimum); OS.SetControl32BitMaximum (handle, maximum - value); OS.SetControlViewSize (handle, value); } /** * 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); OS.SetControl32BitMinimum (handle, minimum); OS.SetControl32BitMaximum (handle, maximum - thumb); OS.SetControlViewSize (handle, thumb); OS.SetControl32BitValue (handle, selection); this.increment = increment; this.pageIncrement = pageIncrement; } /** * 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(); if (visible) { if ((state & HIDDEN) == 0) return; state &= ~HIDDEN; } else { if ((state & HIDDEN) != 0) return; state |= HIDDEN; } if (parent.setScrollBarVisible (this, visible)) { sendEvent (visible ? SWT.Show : SWT.Hide); parent.sendEvent (SWT.Resize); } } void setZOrder () { OS.HIViewAddSubview (parent.scrolledHandle, handle); } }