org.eclipse.swt.widgets.ProgressBar Maven / Gradle / Ivy
The newest version!
/*******************************************************************************
* Copyright (c) 2000, 2009, 2012 IBM Corporation, Gerhardt Informatics Kft. 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
* Gerhardt Informatics Kft. - GEFGWT port
*******************************************************************************/
package org.eclipse.swt.widgets;
import org.eclipse.swt.SWT;
import org.eclipse.swt.SWTException;
/**
* Instances of the receiver represent an unselectable user interface object
* that is used to display progress, typically in the form of a bar.
*
* - Styles:
* - SMOOTH, HORIZONTAL, VERTICAL, INDETERMINATE
* - Events:
* - (none)
*
*
* Note: Only one of the styles HORIZONTAL and VERTICAL may be specified.
*
*
* IMPORTANT: This class is not intended to be subclassed.
*
*
* @see ProgressBar
* snippets
* @see SWT Example:
* ControlExample
* @see Sample code and further
* information
* @noextend This class is not intended to be subclassed by clients.
*/
public class ProgressBar extends Control {
int timerId, minimum = 0, maximum = 100, selection = 0;
static final int DELAY = 100;
/**
* 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.
*
*
* @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
*
* - ERROR_NULL_ARGUMENT - if the parent is null
*
* @exception SWTException
*
* - ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the parent
* - ERROR_INVALID_SUBCLASS - if this class is not an
* allowed subclass
*
*
* @see SWT#SMOOTH
* @see SWT#HORIZONTAL
* @see SWT#VERTICAL
* @see SWT#INDETERMINATE
* @see Widget#checkSubclass
* @see Widget#getStyle
*/
public ProgressBar(Composite parent, int style) {
super(parent, checkStyle(style));
}
static int checkStyle(int style) {
style |= SWT.NO_FOCUS;
return checkBits(style, SWT.HORIZONTAL, SWT.VERTICAL, 0, 0, 0, 0);
}
void createHandle(int index) {
}
/**
* Returns the maximum value which the receiver will allow.
*
* @return the maximum
*
* @exception SWTException
*
* - ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver
*
*/
public int getMaximum() {
checkWidget();
return maximum;
}
/**
* Returns the minimum value which the receiver will allow.
*
* @return the minimum
*
* @exception SWTException
*
* - ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver
*
*/
public int getMinimum() {
checkWidget();
return minimum;
}
/**
* Returns the single 'selection' that is the receiver's position.
*
* @return the selection
*
* @exception SWTException
*
* - ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver
*
*/
public int getSelection() {
checkWidget();
return selection;
}
/**
* Returns the state of the receiver. The value will be one of:
*
* - {@link SWT#NORMAL}
* - {@link SWT#ERROR}
* - {@link SWT#PAUSED}
*
*
* @return the state
*
* @exception SWTException
*
* - ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver
*
*
* @since 3.4
*/
public int getState() {
checkWidget();
return SWT.NORMAL;
}
void releaseWidget() {
}
/**
* Sets the maximum value that the receiver will allow. This new value will
* be ignored if it is not greater than the receiver's current minimum
* value. If the new maximum is applied then the receiver's selection value
* will be adjusted if necessary to fall within its new range.
*
* @param value
* the new maximum, which must be greater than the current
* minimum
*
* @exception SWTException
*
* - ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver
*
*/
public void setMaximum(int value) {
checkWidget();
if (value <= minimum)
return;
maximum = value;
selection = Math.min(selection, maximum);
updateBar(selection, minimum, maximum);
}
/**
* Sets the minimum value that the receiver will allow. This new value will
* be ignored if it is negative or is not less than the receiver's current
* maximum value. If the new minimum is applied then the receiver's
* selection value will be adjusted if necessary to fall within its new
* range.
*
* @param value
* the new minimum, which must be nonnegative and less than the
* current maximum
*
* @exception SWTException
*
* - ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver
*
*/
public void setMinimum(int value) {
checkWidget();
if (value < 0 || value >= maximum)
return;
minimum = value;
selection = Math.max(selection, minimum);
updateBar(selection, minimum, maximum);
}
/**
* Sets the single 'selection' that is the receiver's position to the
* argument which must be greater than or equal to zero.
*
* @param value
* the new selection (must be zero or greater)
*
* @exception SWTException
*
* - ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver
*
*/
public void setSelection(int value) {
checkWidget();
selection = Math.max(minimum, Math.min(maximum, value));
updateBar(selection, minimum, maximum);
}
/**
* Sets the state of the receiver. The state must be one of these values:
*
* - {@link SWT#NORMAL}
* - {@link SWT#ERROR}
* - {@link SWT#PAUSED}
*
*
* @param state
* the new state
*
* @exception SWTException
*
* - ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver
*
*
* @since 3.4
*/
public void setState(int state) {
checkWidget();
}
void updateBar(int selection, int minimum, int maximum) {
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy