package org.eclipse.swt.widgets; | |
/* | |
* (c) Copyright IBM Corp. 2000, 2001. | |
* All Rights Reserved | |
*/ | |
import org.eclipse.swt.internal.motif.*; | |
import org.eclipse.swt.*; | |
import org.eclipse.swt.events.*; | |
import org.eclipse.swt.graphics.*; | |
/** | |
* Instances of the receiver represent a selectable user | |
* interface object that present a range of continuous | |
* numeric values. | |
* <dl> | |
* <dt><b>Styles:</b></dt> | |
* <dd> HORIZONTAL, VERTICAL</dd> | |
* <dt><b>Events:</b></dt> | |
* <dd>Selection</dd> | |
* </dl> | |
* <p> | |
* IMPORTANT: This class is intended to be subclassed <em>only</em> | |
* within the SWT implementation. | |
* </p> | |
*/ | |
public class Scale extends Control { | |
/** | |
* Constructs a new instance of this class given its parent | |
* and a style value describing its behavior and appearance. | |
* <p> | |
* The style value is either one of the style constants defined in | |
* class <code>SWT</code> which is applicable to instances of this | |
* class, or must be built by <em>bitwise OR</em>'ing together | |
* (that is, using the <code>int</code> "|" operator) two or more | |
* of those <code>SWT</code> style constants. The class description | |
* for all SWT widget classes should include a comment which | |
* describes the style constants which are applicable to the class. | |
* </p> | |
* | |
* @param parent a composite control which will be the parent of the new instance (cannot be null) | |
* @param style the style of control to construct | |
* | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_NULL_ARGUMENT - if the parent is null</li> | |
* </ul> | |
* @exception SWTException <ul> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li> | |
* <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li> | |
* </ul> | |
* | |
* @see SWT | |
* @see Widget#checkSubclass | |
* @see Widget#getStyle | |
*/ | |
public Scale (Composite parent, int style) { | |
super (parent, checkStyle (style)); | |
} | |
/** | |
* 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 <code>SelectionListener</code> | |
* interface. | |
* | |
* @param listener the listener which should be notified | |
* | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li> | |
* </ul> | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* | |
* @see SelectionListener | |
* @see #removeSelectionListener | |
*/ | |
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); | |
} | |
public Point computeSize (int wHint, int hHint, boolean changed) { | |
checkWidget(); | |
int border = getBorderWidth (); | |
int width = border * 2, height = border * 2; | |
Display display = getDisplay (); | |
int hScroll = display.scrolledMarginX; | |
int vScroll = display.scrolledMarginY; | |
if ((style & SWT.HORIZONTAL) != 0) { | |
width += hScroll * 10; | |
height += vScroll; | |
} else { | |
width += hScroll; | |
height += vScroll * 10; | |
} | |
if (wHint != SWT.DEFAULT) width = wHint + (border * 2); | |
if (hHint != SWT.DEFAULT) height = hHint + (border * 2); | |
return new Point (width, height); | |
} | |
void createHandle (int index) { | |
state |= HANDLE; | |
int [] argList = { | |
OS.XmNtitleString, 0, | |
OS.XmNborderWidth, (style & SWT.BORDER) != 0 ? 1 : 0, | |
OS.XmNorientation, ((style & SWT.H_SCROLL) != 0) ? OS.XmHORIZONTAL : OS.XmVERTICAL, | |
OS.XmNprocessingDirection, ((style & SWT.H_SCROLL) != 0) ? OS.XmMAX_ON_RIGHT : OS.XmMAX_ON_BOTTOM, | |
OS.XmNancestorSensitive, 1, | |
}; | |
int parentHandle = parent.handle; | |
handle = OS.XmCreateScale (parentHandle, null, argList, argList.length / 2); | |
if (handle == 0) error (SWT.ERROR_NO_HANDLES); | |
} | |
/** | |
* 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 <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public int getIncrement () { | |
checkWidget(); | |
return 1; | |
} | |
/** | |
* Returns the maximum value which the receiver will allow. | |
* | |
* @return the maximum | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public int getMaximum () { | |
checkWidget(); | |
int [] argList = {OS.XmNmaximum, 0}; | |
OS.XtGetValues (handle, argList, argList.length / 2); | |
return argList [1]; | |
} | |
/** | |
* Returns the minimum value which the receiver will allow. | |
* | |
* @return the minimum | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public int getMinimum () { | |
checkWidget(); | |
int [] argList = {OS.XmNminimum, 0}; | |
OS.XtGetValues (handle, argList, argList.length / 2); | |
return argList [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 <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public int getPageIncrement () { | |
checkWidget(); | |
int [] argList = {OS.XmNscaleMultiple, 0}; | |
OS.XtGetValues (handle, argList, argList.length / 2); | |
return argList [1]; | |
} | |
/** | |
* Returns the single <em>selection</em> that is the receiver's position. | |
* | |
* @return the selection | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public int getSelection () { | |
checkWidget(); | |
int [] argList = {OS.XmNvalue, 0}; | |
OS.XtGetValues (handle, argList, argList.length / 2); | |
return argList [1]; | |
} | |
void hookEvents () { | |
super.hookEvents (); | |
int windowProc = getDisplay ().windowProc; | |
OS.XtAddCallback (handle, OS.XmNvalueChangedCallback, windowProc, SWT.Selection); | |
OS.XtAddCallback (handle, OS.XmNdragCallback, windowProc, SWT.Selection); | |
} | |
/** | |
* Removes the listener from the collection of listeners who will | |
* be notified when the receiver's value changes. | |
* | |
* @param listener the listener which should no longer be notified | |
* | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li> | |
* </ul> | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* | |
* @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); | |
} | |
/** | |
* 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 <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void setIncrement (int increment) { | |
checkWidget(); | |
} | |
/** | |
* Sets the maximum value which the receiver will allow | |
* to be the argument which must be greater than or | |
* equal to zero. | |
* | |
* @param value the new maximum (must be zero or greater) | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void setMaximum (int value) { | |
checkWidget(); | |
if (value < 0) return; | |
int [] argList = {OS.XmNmaximum, value}; | |
Display display = getDisplay (); | |
boolean warnings = display.getWarnings (); | |
display.setWarnings (false); | |
OS.XtSetValues (handle, argList, argList.length / 2); | |
display.setWarnings (warnings); | |
} | |
/** | |
* Sets the minimum value which the receiver will allow | |
* to be the argument which must be greater than or | |
* equal to zero. | |
* | |
* @param value the new minimum (must be zero or greater) | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void setMinimum (int value) { | |
checkWidget(); | |
if (value < 0) return; | |
int [] argList = {OS.XmNminimum, value}; | |
Display display = getDisplay (); | |
boolean warnings = display.getWarnings (); | |
display.setWarnings (false); | |
OS.XtSetValues (handle, argList, argList.length / 2); | |
display.setWarnings (warnings); | |
} | |
/** | |
* 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. | |
* | |
* @return the page increment (must be greater than zero) | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void setPageIncrement (int pageIncrement) { | |
checkWidget(); | |
if (pageIncrement < 1) return; | |
int [] argList = {OS.XmNscaleMultiple, pageIncrement}; | |
Display display = getDisplay (); | |
boolean warnings = display.getWarnings (); | |
display.setWarnings (false); | |
OS.XtSetValues (handle, argList, argList.length / 2); | |
display.setWarnings (warnings); | |
} | |
/** | |
* Sets the single <em>selection</em> that is the receiver's | |
* value to the argument which must be greater than or equal | |
* to zero. | |
* | |
* @param value the new selection (must be zero or greater) | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void setSelection (int selection) { | |
checkWidget(); | |
if (selection < 0) return; | |
int [] argList = {OS.XmNvalue, selection}; | |
Display display = getDisplay (); | |
boolean warnings = display.getWarnings (); | |
display.setWarnings (false); | |
OS.XtSetValues (handle, argList, argList.length / 2); | |
display.setWarnings (warnings); | |
} | |
} |