org.gnu.gtk

Class Scale

Known Direct Subclasses:
HScale, VScale

public abstract class Scale
extends Range

A Scale is a slider control used to select a numeric value. To use it, you'll probably want to investigate the methods on its base class, Range, in addition to the methods for Scale itself. To set the value of a scale, you would normally use Range.setValue(double). To detect changes to the value, add RangeListener object to the widget.

The GtkScale widget is an abstract class, used only for deriving the subclasses HScale and VScale.

See Also:
HScale, VScale

Method Summary

boolean
getDrawValue()
Returns whether the current value is displayed as a string next to the slider.
Class
getEventListenerClass(String signal)
EventType
getEventType(String signal)
Layout
getLayout()
Gets the Layout used to display the scale.
int
getLayoutOffsetX()
Obtains the X coordinate where the scale will draw the Layout representing the text in the scale.
int
getLayoutOffsetY()
Obtains the Y coordinate where the scale will draw the Layout representing the text in the scale.
static Type
getType()
Retrieve the runtime type used by the GLib library.
void
removeFormatListener()
Removes the format listener
void
setDigits(int digits)
Sets the number of decimal places that are displayed in the value.
void
setDrawValue(boolean setting)
Specifies whether the current value is displayed as a string next to the slider.
void
setFormatListener(ScaleListener listener)
Sets a listener to be used when a format-value request is called.
void
setValuePosition(PositionType pos)
Sets the position in which the current value is displayed.

Methods inherited from class org.gnu.gtk.Range

addListener, addRangeListener, getAdjustment, getEventListenerClass, getEventType, getInverted, getType, getUpdatePolicy, getValue, removeRangeListener, setAdjustment, setIncrements, setInverted, setRange, setUpdatePolicy, setValue

Methods inherited from class org.gnu.gtk.Widget

activate, addAccelerator, addEvents, addListener, addListener, addListener, addListener, addListener, addListener, addListener, addListener, addListener, addListener, addListener, canActivateAccel, createContext, createLayout, draw, drawArea, drawArea, finish, getAccessible, getAllocation, getColormap, getContext, getData, getDisplay, getDragData, getEventListenerClass, getEventType, getExtensionEvents, getModifierStyle, getName, getParent, getParentWindow, getPointer, getRootWindow, getScreen, getSensitive, getStyle, getToplevel, getType, getWidget, getWindow, grabDefault, grabFocus, hasFocus, hasScreen, hide, hideAll, highlight, highlight, intersect, isAncestor, makeWidget, modifyStyle, popColormap, pushColormap, realize, removeAccelerator, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, reparent, setBackgroundColor, setBaseColor, setColormap, setDoubleBuffered, setDragDestination, setDragIcon, setDragIconPixbuf, setDragIconStock, setDragSource, setEvents, setExtensionEvents, setFont, setForegroundColor, setMinimumSize, setName, setNoDragDestination, setNoDragSource, setSensitive, setTextColor, shapeCombineMask, show, showAll, unHighlight, unHighlight

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

Method Details

getDrawValue

public boolean getDrawValue()
Returns whether the current value is displayed as a string next to the slider.

getEventListenerClass

public Class getEventListenerClass(String signal)
Overrides:
getEventListenerClass in interface Range

getEventType

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

getLayout

public Layout getLayout()
Gets the Layout used to display the scale.
Returns:
The Layout for this scale, or NULL if the getDrawValue() is FALSE.

getLayoutOffsetX

public int getLayoutOffsetX()
Obtains the X coordinate where the scale will draw the Layout representing the text in the scale.

If getDrawValue() is FALSE, the return value is undefined.


getLayoutOffsetY

public int getLayoutOffsetY()
Obtains the Y coordinate where the scale will draw the Layout representing the text in the scale.

If getDrawValue() is FALSE, the return value is undefined.


getType

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

removeFormatListener

public void removeFormatListener()
Removes the format listener

setDigits

public void setDigits(int digits)
Sets the number of decimal places that are displayed in the value. Also causes the value of the adjustment to be rounded off to this number of digits, so the retrieved value matches the value the user saw.
Parameters:
digits - The number of decimal places to display, e.g. use 1 to display 1.0, 2 to display 1.00 etc.

setDrawValue

public void setDrawValue(boolean setting)
Specifies whether the current value is displayed as a string next to the slider.
Parameters:
setting - If true, the value is displayed.

setFormatListener

public void setFormatListener(ScaleListener listener)
Sets a listener to be used when a format-value request is called.

setValuePosition

public void setValuePosition(PositionType pos)
Sets the position in which the current value is displayed.
Parameters:
pos - The position in which the current value is displayed.