org.gnu.gtk

Class Adjustment


public class Adjustment
extends GtkObject

This object stores geometry information, such as upper and lower bounds, step and page increments, and the size of a page. Other objects use an Adjustment object to store their internal dimension settings. It also is passed as an argument to specify geometry.
See Also:
SpinButton, Range, HScrollBar, VScrollBar, HScale, VScale

Constructor Summary

Adjustment(Handle handle)
Construct a new Adjustment from a handle to a native resource.
Adjustment(double value, double lower, double upper, double stepIncrement, double pageIncrement, double pageSize)
Constructs a new adjustment

Method Summary

void
addListener(AdjustmentListener listener)
Register an object to handle spin events.
void
clampPage(double lower, double upper)
Updates the GtkAdjustment value to ensure that the range between lower and upper is in the current page (ie between value and value + pageSize).
static Adjustment
getAdjustment(Handle handle)
Internal static factory method to be used by Java-Gnome only.
Class
getEventListenerClass(String signal)
Event Handling
EventType
getEventType(String signal)
double
getLower()
Gets the minimum value of the adjustment
double
getPageIncrement()
Gets the page increment of the adjustment.
double
getPageSize()
Gets the page size of the adjustment.
double
getStepIncrement()
Gets the step increment of the adjustment.
static Type
getType()
Retrieve the runtime type used by the GLib library.
double
getUpper()
Gets the maximum value of the adjustment.
double
getValue()
Gets the current value of the adjustment.
void
handleChanged()
void
removeListener(AdjustmentListener listener)
Removes a listener
void
setLower(double lower)
void
setPageIncrement(double pageIncrement)
void
setPageSize(double pageSize)
void
setStepIncrement(double stepIncrement)
void
setUpper(double upper)
void
setValue(double value)
Sets the GtkAdjustment value.

Methods inherited from class org.gnu.gtk.GtkObject

destroy, getType, sink

Methods inherited from class org.gnu.glib.GObject

addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, addListener, collect, freezeNotify, getBooleanProperty, getData, getDoubleProperty, getEventListenerClass, getEventType, getFloatProperty, getGObjectFromHandle, getIntProperty, getJavaObjectProperty, getLongProperty, getPixbufProperty, getProperty, getStringProperty, hasProperty, notify, removeEventHandler, removeListener, setBooleanProperty, setData, setDoubleProperty, setFloatProperty, setIntProperty, setJavaObjectProperty, setLongProperty, setPixbufProperty, setProperty, setStringProperty, thawNotify

Constructor Details

Adjustment

public Adjustment(Handle handle)
Construct a new Adjustment from a handle to a native resource.

Adjustment

public Adjustment(double value,
                  double lower,
                  double upper,
                  double stepIncrement,
                  double pageIncrement,
                  double pageSize)
Constructs a new adjustment
Parameters:
value - The initial value.
lower - The minimum value.
upper - The maximum value.
stepIncrement - The step increment.
pageIncrement - The page increment.
pageSize - The page size.

Method Details

addListener

public void addListener(AdjustmentListener listener)
Register an object to handle spin events.
See Also:
SpinListener

clampPage

public void clampPage(double lower,
                      double upper)
Updates the GtkAdjustment value to ensure that the range between lower and upper is in the current page (ie between value and value + pageSize). If the range is larger than the page size, then only the start of it will be in the current page. A "changed" signal will be emitted if the value is changed.

getAdjustment

public static Adjustment getAdjustment(Handle handle)
Internal static factory method to be used by Java-Gnome only.

getEventListenerClass

public Class getEventListenerClass(String signal)
Event Handling
Overrides:
getEventListenerClass in interface GObject

getEventType

public EventType getEventType(String signal)
Overrides:
getEventType in interface GObject

getLower

public double getLower()
Gets the minimum value of the adjustment
Returns:
The minimum value of the adjustment.

getPageIncrement

public double getPageIncrement()
Gets the page increment of the adjustment.
Returns:
The page increment of the adjustment.

getPageSize

public double getPageSize()
Gets the page size of the adjustment. Note that the page-size is irrelevant and should be set to zero if the adjustment is used for a simple scalar value, e.g. in a SpinButton.
Returns:
The page size of the adjustment.

getStepIncrement

public double getStepIncrement()
Gets the step increment of the adjustment.
Returns:
The step increment of the adjustment.

getType

public static Type getType()
Retrieve the runtime type used by the GLib library.
Overrides:
getType in interface GtkObject

getUpper

public double getUpper()
Gets the maximum value of the adjustment. Note that values will be restricted by upper - page-size if the page-size property is nonzero.
Returns:
The maximum value of the adjustment.

getValue

public double getValue()
Gets the current value of the adjustment.
Returns:
The current value of the adjustment.

handleChanged

public void handleChanged()

removeListener

public void removeListener(AdjustmentListener listener)
Removes a listener

setLower

public void setLower(double lower)

setPageIncrement

public void setPageIncrement(double pageIncrement)

setPageSize

public void setPageSize(double pageSize)

setStepIncrement

public void setStepIncrement(double stepIncrement)

setUpper

public void setUpper(double upper)

setValue

public void setValue(double value)
Sets the GtkAdjustment value.