A SpinButton widget displays a single numeric value that you can change by
using the two arrow buttons to its right, or by editing the number directly.
SpinButton
public SpinButton(Handle handle)
Construct a new SpinButton from a handle to a native resource.
SpinButton
public SpinButton(double min,
double max,
double step)
Creates a new SpinButton without manually creating an adjustment. The
value is initially set to the minimum value and a page increment of 10 *
step is the default. The precision of the spin button is equivalent to
the precision of step.
min
- Minimum allowable valuemax
- Maximum allowable valuestep
- Increment added or subtracted by spinning the widget
SpinButton
public SpinButton(Adjustment adjustment,
double climbRate,
int digits)
Creates a new SpinButton
adjustment
- The Adjustment
object that this spin button should
use.climbRate
- Specifies how much the spin button changes when an arrow is
clicked on.digits
- The number of decimal places to display.
addListener
public void addListener(SpinListener listener)
Register an object to handle spin events.
configure
public void configure(Adjustment adjustment,
double climbRate,
int digits)
Changes the properties of an existing spin button. The adjustment, climb
rate, and number of decimal places are all changed accordingly, after
this function call.
adjustment
- An Adjustment
object to use.climbRate
- The new climb rate.digits
- The number of decimal places to display in the spin button.
getAdjustment
public Adjustment getAdjustment()
Returns the Adjustment object used with this object.
- the adjustment object for this SpinButton
getIntValue
public int getIntValue()
Returns the current value, as an integer. The value is stored as a double -
this method converts it to an integer. To get the raw double value, use
getValue()
.
- Current value of SpinButton, as an integer
getSpinButton
public static SpinButton getSpinButton(Handle handle)
Internal static factory method to be used by Java-Gnome only.
getType
public static Type getType()
Retrieve the runtime type used by the GLib library.
- getType in interface Entry
getValue
public double getValue()
Get the value of the SpinButton
removeListener
public void removeListener(SpinListener listener)
Removes a listener
setAdjustment
public void setAdjustment(Adjustment adjustment)
Replaces the adjustment object associated with the Spin button
adjustment
- New adjustment object to use
setIncrements
public void setIncrements(double step,
double page)
Sets the step and page increments. This affects how quickly the value
changes when the spin button's arrows are activated.
step
- Increment applied for a button 1 press.page
- Increment applied for a button 2 press.
setNumeric
public void setNumeric(boolean numeric)
Sets the flag that determines if non-numeric text can be typed in the
spin button.
numeric
- Set the flag to true or false.
setPrecision
public void setPrecision(int digits)
Set the precision to be displayed. Up to 20 digit precision is allowed.
digits
- Number of digits to be displayed
setRange
public void setRange(double min,
double max)
Sets the minimum and maximum allowable values
min
- Minimum allowable value.max
- Maximum allowable value.
setSnap
public void setSnap(boolean snapToTicks)
Sets the policy as to whether values are corrected to the nearest step
increment when a spin button is activated after providing an invalid
value.
snapToTicks
- A flag indicating if invalid values should be corrected.
setUpdatePolicy
public void setUpdatePolicy(SpinButtonUpdatePolicy policy)
Sets the update behavior of a spin button. This determines whether the
spin button is always updated or only when a valid value is set.
policy
- An update Policy
setValue
public void setValue(double value)
Sets the value of the spin button
value
- The value for the SpinButton
setWrap
public void setWrap(boolean wrap)
Sets the flag that determines if a spin button value wraps around to the
opposite limit when the upper or lower limit of the range is exceeded.
wrap
- If true, the value will wrap
spin
public void spin(SpinType direction,
double increment)
Increment or decrement a spin button's value in a specified direction by
a specified amount.
direction
- A SpinType
indicating the direction to spin.increment
- Step increment to apply in the specified direction.