org.gnu.gtk
Class HandleBox

java.lang.Object
  extended byorg.gnu.glib.GObject
      extended byorg.gnu.gtk.GtkObject
          extended byorg.gnu.gtk.Widget
              extended byorg.gnu.gtk.Container
                  extended byorg.gnu.gtk.Bin
                      extended byorg.gnu.gtk.HandleBox

public class HandleBox
extends Bin

The HandleBox widget allows a portion of the window to be "torn-off". It is a bin widget which displays its children and a handle that the user can drag to tear off a separate window containing the child widget. A thin ghost is drawn in the original location of the handlebox. By dragging the separate window back to its original location it can be reattached.


Field Summary
 
Fields inherited from class org.gnu.glib.GObject
eventsInitialized
 
Constructor Summary
HandleBox()
          Create a new HandleBox object.
HandleBox(Handle handle)
          Construct a HandleBox using a handle to a native resource.
 
Method Summary
 void addListener(HandleBoxListener listener)
          Register an object to handle dialog events.
protected  void fireHandleBoxEvent(HandleBoxEvent event)
           
 java.lang.Class getEventListenerClass(java.lang.String signal)
           
 EventType getEventType(java.lang.String signal)
           
 PositionType getHandlePosition()
          Retrieves the handle position.
 ShadowType getShadowType()
          Retrieves the shadow type used by this widget.
 PositionType getShapEdge()
          Retrieves the snap edge of the widget.
static Type getType()
          Retrieve the runtime type used by the GLib library.
protected static int gtk_handle_box_get_handle_position(Handle handle_box)
           
protected static int gtk_handle_box_get_shadow_type(Handle handle_box)
           
protected static int gtk_handle_box_get_snap_edge(Handle handle_box)
           
protected static int gtk_handle_box_get_type()
           
protected static Handle gtk_handle_box_new()
           
protected static void gtk_handle_box_set_handle_position(Handle handle_box, int position)
           
protected static void gtk_handle_box_set_shadow_type(Handle handle_box, int type)
           
protected static void gtk_handle_box_set_snap_edge(Handle handle_box, int edge)
           
 void removeListener(HandleBoxListener listener)
          Removes a listener
 void setHandlePosition(PositionType position)
          Sets the side of the handle box where the handle is drawn.
 void setShadowType(ShadowType type)
          Set the shadow type to be drawn around the border of the handle box.
 void setShapEdge(PositionType edge)
          Sets the snap edge of the handle box.
 
Methods inherited from class org.gnu.gtk.Bin
getChild, gtk_bin_get_child, gtk_bin_get_type
 
Methods inherited from class org.gnu.gtk.Container
add, addListener, fireContainerEvent, getBorderWidth, getChildren, getResizeMode, gtk_container_add, gtk_container_check_resize, gtk_container_child_type, gtk_container_get_border_width, gtk_container_get_children, gtk_container_get_focus_chain, gtk_container_get_focus_hadjustment, gtk_container_get_focus_vadjustment, gtk_container_get_resize_mode, gtk_container_get_type, gtk_container_propagate_expose, gtk_container_remove, gtk_container_resize_children, gtk_container_set_border_width, gtk_container_set_focus_chain, gtk_container_set_focus_child, gtk_container_set_focus_hadjustment, gtk_container_set_focus_vadjustment, gtk_container_set_reallocate_redraws, gtk_container_set_resize_mode, gtk_container_unset_focus_chain, remove, removeListener, resizeChildren, setBorderWidth, setResizeMode
 
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

HandleBox

public HandleBox()
Create a new HandleBox object.


HandleBox

public HandleBox(Handle handle)
Construct a HandleBox using a handle to a native resource.

Method Detail

setShadowType

public void setShadowType(ShadowType type)
Set the shadow type to be drawn around the border of the handle box.

Parameters:
type - The ShadowType to use for the shadow.

getShadowType

public ShadowType getShadowType()
Retrieves the shadow type used by this widget.


setHandlePosition

public void setHandlePosition(PositionType position)
Sets the side of the handle box where the handle is drawn.

Parameters:
position - Defines the position of the handle.

getHandlePosition

public PositionType getHandlePosition()
Retrieves the handle position.


setShapEdge

public void setShapEdge(PositionType edge)
Sets the snap edge of the handle box. The snap edge is the edge of the detached child that must be aligned with the corresponding edge of the ghost left behind when the child was detached to reattach the torn-off window.

Parameters:
edge - The side for the snap edge.

getShapEdge

public PositionType getShapEdge()
Retrieves the snap edge of the widget.


addListener

public void addListener(HandleBoxListener listener)
Register an object to handle dialog events.

See Also:
HandleBoxListener

removeListener

public void removeListener(HandleBoxListener listener)
Removes a listener

See Also:
addListener(HandleBoxListener)

fireHandleBoxEvent

protected void fireHandleBoxEvent(HandleBoxEvent event)

getEventListenerClass

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

getEventType

public EventType getEventType(java.lang.String signal)
Overrides:
getEventType in class Container

getType

public static Type getType()
Retrieve the runtime type used by the GLib library.


gtk_handle_box_get_type

protected static final int gtk_handle_box_get_type()

gtk_handle_box_new

protected static final Handle gtk_handle_box_new()

gtk_handle_box_set_shadow_type

protected static final void gtk_handle_box_set_shadow_type(Handle handle_box,
                                                           int type)

gtk_handle_box_get_shadow_type

protected static final int gtk_handle_box_get_shadow_type(Handle handle_box)

gtk_handle_box_set_handle_position

protected static final void gtk_handle_box_set_handle_position(Handle handle_box,
                                                               int position)

gtk_handle_box_get_handle_position

protected static final int gtk_handle_box_get_handle_position(Handle handle_box)

gtk_handle_box_set_snap_edge

protected static final void gtk_handle_box_set_snap_edge(Handle handle_box,
                                                         int edge)

gtk_handle_box_get_snap_edge

protected static final int gtk_handle_box_get_snap_edge(Handle handle_box)