org.gnu.gtk
Class HandleBox

java.lang.Object
  |
  +--org.gnu.glib.GObject
        |
        +--org.gnu.gtk.GtkObject
              |
              +--org.gnu.gtk.Widget
                    |
                    +--org.gnu.gtk.Container
                          |
                          +--org.gnu.gtk.Bin
                                |
                                +--org.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.


Constructor Summary
HandleBox()
          Create a new HandleBox object.
HandleBox(int handle)
          Construct a HandleBox using a handle to a native resource.
 
Method Summary
 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.
 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
 
Methods inherited from class org.gnu.gtk.Container
add, addListener, getBorderWidth, getEventListenerClass, getEventType, getResizeMode, remove, removeListener, resizeChildren, setBorderWidth, setResizeMode
 
Methods inherited from class org.gnu.gtk.Widget
activate, addListener, addListener, addListener, addListener, addListener, addListener, createContext, createLayout, destroy, draw, drawArea, drawArea, getAccessible, getColormap, getContext, getModifierStyle, getName, getParent, getParentWindow, getPointer, getSensitive, getStyle, getToplevel, grabDefault, grabFocus, hasFocus, hide, hideAll, intersect, isAncestor, makeWidget, modifyStyle, popColormap, pushColormap, realize, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, reparent, setBackgroundColor, setBaseColor, setColormap, setDoubleBuffered, setDragDestination, setDragSource, setFont, setForegroundColor, setMinimumSize, setName, setNoDragDestination, setNoDragSource, setSensitive, setTextColor, shapeCombineMask, show, showAll
 
Methods inherited from class org.gnu.glib.GObject
addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, equals, getData, getHandle, removeEventHandler, setData
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HandleBox

public HandleBox()
Create a new HandleBox object.


HandleBox

public HandleBox(int 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.


getType

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


Please send any bug reports, comments, or suggestions for the API or documentation to java-gnome-developer@lists.sf.net