org.gnu.gtk
Class Scale

java.lang.Object
  extended byorg.gnu.glib.GObject
      extended byorg.gnu.gtk.GtkObject
          extended byorg.gnu.gtk.Widget
              extended byorg.gnu.gtk.Range
                  extended byorg.gnu.gtk.Scale
Direct Known 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

Field Summary
 
Fields inherited from class org.gnu.glib.GObject
eventsInitialized
 
Constructor Summary
protected Scale(Handle handle)
           
 
Method Summary
 boolean getDrawValue()
          Returns whether the current value is displayed as a string next to the slider.
 java.lang.Class getEventListenerClass(java.lang.String signal)
           
 EventType getEventType(java.lang.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.
protected static int gtk_scale_get_digits(Handle scale)
           
protected static boolean gtk_scale_get_draw_value(Handle scale)
           
protected static int gtk_scale_get_type()
           
protected static int gtk_scale_get_value_pos(Handle scale)
           
protected static void gtk_scale_set_digits(Handle scale, int digits)
           
protected static void gtk_scale_set_draw_value(Handle scale, boolean drawValue)
           
protected static void gtk_scale_set_value_pos(Handle scale, int pos)
           
 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, fireRangeEvent, getAdjustment, getInverted, getUpdatePolicy, getValue, gtk_range_get_adjustment, gtk_range_get_inverted, gtk_range_get_type, gtk_range_get_update_policy, gtk_range_get_value, gtk_range_set_adjustment, gtk_range_set_increments, gtk_range_set_inverted, gtk_range_set_range, gtk_range_set_update_policy, gtk_range_set_value, removeRangeListener, setAdjustment, setIncrements, setInverted, setRange, setUpdatePolicy, setValue
 
Methods inherited from class org.gnu.gtk.Widget
activate, addListener, addListener, addListener, addListener, addListener, addListener, addListener, addListener, canActivateAccel, createContext, createLayout, destroy, draw, drawArea, drawArea, findListener, finish, fireBooleanLifeCycleEvent, fireDragDestinationEvent, fireDragSourceEvent, fireExposeEvent, fireFocusEvent, fireKeyEvent, fireLifeCycleEvent, fireMouseEvent, fireMouseMotionEvent, getAccessible, getColormap, getContext, getData, getDisplay, getModifierStyle, getName, getParent, getParentWindow, getPointer, getRootWindow, getScreen, getSensitive, getStyle, getToplevel, getWindow, grabDefault, grabFocus, gtk_drag_dest_set, gtk_drag_dest_unset, gtk_drag_finish, gtk_drag_get_data, gtk_drag_highlight, gtk_drag_source_set_icon_pixbuf, gtk_drag_source_set_icon_stock, gtk_drag_source_set_icon, gtk_drag_source_set, gtk_drag_source_unset, gtk_drag_unhighlight, gtk_widget_activate, gtk_widget_add_accelerator, gtk_widget_add_events, gtk_widget_add_mnemonic_label, gtk_widget_can_activate_accel, gtk_widget_child_focus, gtk_widget_child_notify, gtk_widget_class_path, gtk_widget_create_pango_context, gtk_widget_create_pango_layout, gtk_widget_destroy, gtk_widget_destroyed, gtk_widget_ensure_style, gtk_widget_event, gtk_widget_freeze_child_notify, gtk_widget_get_accessible, gtk_widget_get_ancestor, gtk_widget_get_child_requisition, gtk_widget_get_child_visible, gtk_widget_get_colormap, gtk_widget_get_composite_name, gtk_widget_get_default_colormap, gtk_widget_get_default_direction, gtk_widget_get_default_style, gtk_widget_get_default_visual, gtk_widget_get_direction, gtk_widget_get_display, gtk_widget_get_events, gtk_widget_get_extension_events, gtk_widget_get_modifier_style, gtk_widget_get_name, gtk_widget_get_pango_context, gtk_widget_get_parent_window, gtk_widget_get_parent, gtk_widget_get_pointer, gtk_widget_get_root_window, gtk_widget_get_screen, gtk_widget_get_sensitive, gtk_widget_get_settings, gtk_widget_get_size_request, gtk_widget_get_style, gtk_widget_get_toplevel, gtk_widget_get_type, gtk_widget_get_visual, gtk_widget_get_window, gtk_widget_grab_default, gtk_widget_grab_focus, gtk_widget_has_screen, gtk_widget_hide_all, gtk_widget_hide_on_delete, gtk_widget_hide, gtk_widget_intersect, gtk_widget_is_ancestor, gtk_widget_is_focus, gtk_widget_list_accel_closures, gtk_widget_list_mnemonic_labels, gtk_widget_map, gtk_widget_mnemonic_activate, gtk_widget_modify_base, gtk_widget_modify_bg, gtk_widget_modify_fg, gtk_widget_modify_font, gtk_widget_modify_style, gtk_widget_modify_text, gtk_widget_path, gtk_widget_pop_colormap, gtk_widget_pop_composite_child, gtk_widget_push_colormap, gtk_widget_push_composite_child, gtk_widget_queue_draw_area, gtk_widget_queue_draw, gtk_widget_queue_resize, gtk_widget_realize, gtk_widget_ref, gtk_widget_region_intersect, gtk_widget_remove_accelerator, gtk_widget_remove_mnemonic_label, gtk_widget_render_icon, gtk_widget_reparent, gtk_widget_reset_rc_styles, gtk_widget_send_expose, gtk_widget_set_accel_path, gtk_widget_set_app_paintable, gtk_widget_set_child_visible, gtk_widget_set_colormap, gtk_widget_set_composite_name, gtk_widget_set_default_colormap, gtk_widget_set_default_direction, gtk_widget_set_direction, gtk_widget_set_double_buffered, gtk_widget_set_events, gtk_widget_set_extension_events, gtk_widget_set_name, gtk_widget_set_parent_window, gtk_widget_set_parent, gtk_widget_set_redraw_on_allocate, gtk_widget_set_scroll_adjustments, gtk_widget_set_sensitive, gtk_widget_set_size_request, gtk_widget_set_state, gtk_widget_set_style, gtk_widget_shape_combine_mask, gtk_widget_show_all, gtk_widget_show_now, gtk_widget_show, gtk_widget_size_allocate, gtk_widget_size_request, gtk_widget_style_get_property, gtk_widget_thaw_child_notify, gtk_widget_translate_coordinates, gtk_widget_unmap, gtk_widget_unparent, gtk_widget_unrealize, gtk_widget_unref, handleButtonPressed, handleButtonReleased, handleDelete, handleDragDataGet, handleDragDestination, handleExpose, handleFocusIn, handleFocusOut, handleHide, handleKeyPressed, handleKeyReleased, handleMap, handleMouseEnter, handleMouseLeave, handleMouseMotion, handleNoExpose, handleRealize, handleScroll, handleShow, handleUnmap, hasFocus, hasScreen, hide, hideAll, highlight, intersect, isAncestor, makeWidget, modifyStyle, popColormap, pushColormap, realize, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, reparent, setBackgroundColor, setBaseColor, setColormap, setDoubleBuffered, setDragDestination, setDragIcon, setDragIconPixbuf, setDragIconStock, setDragSource, setFont, setForegroundColor, setMinimumSize, setName, setNoDragDestination, setNoDragSource, setSensitive, setTextColor, shapeCombineMask, show, showAll, unHighlight
 
Methods inherited from class org.gnu.gtk.GtkObject
getFlags, gtk_object_destroy, gtk_object_get_type, gtk_object_sink, setFlags, sink
 
Methods inherited from class org.gnu.glib.GObject
addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, addListener, equals, freezeNotify, getBooleanProperty, getData, getData, getDoubleProperty, getFloatProperty, getGObjectFromHandle, getHandle, getIntFromHandle, getIntProperty, getJavaObjectProperty, getLongProperty, getNullHandle, getPixbufProperty, getProperty, getStringFromHandle, getStringProperty, hashCode, hasProperty, instantiateJGObjectFromGType, notify, removeEventHandler, removeListener, retrieveGObject, setBooleanProperty, setData, setData, setDoubleProperty, setFloatProperty, setHandle, setIntProperty, setJavaObjectProperty, setLongProperty, setPixbufProperty, setProperty, setStringProperty, thawNotify
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Scale

protected Scale(Handle handle)
Method Detail

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.

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.

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.

getDrawValue

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


setFormatListener

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


removeFormatListener

public void removeFormatListener()
Removes the format listener


getEventListenerClass

public java.lang.Class getEventListenerClass(java.lang.String signal)
Overrides:
getEventListenerClass in class Range

getEventType

public EventType getEventType(java.lang.String signal)
Overrides:
getEventType in class 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.


gtk_scale_get_type

protected static final int gtk_scale_get_type()

gtk_scale_set_digits

protected static final void gtk_scale_set_digits(Handle scale,
                                                 int digits)

gtk_scale_get_digits

protected static final int gtk_scale_get_digits(Handle scale)

gtk_scale_set_draw_value

protected static final void gtk_scale_set_draw_value(Handle scale,
                                                     boolean drawValue)

gtk_scale_get_draw_value

protected static final boolean gtk_scale_get_draw_value(Handle scale)

gtk_scale_set_value_pos

protected static final void gtk_scale_set_value_pos(Handle scale,
                                                    int pos)

gtk_scale_get_value_pos

protected static final int gtk_scale_get_value_pos(Handle scale)