org.gnu.gtk

Class Frame

Known Direct Subclasses:
AspectFrame

public class Frame
extends Bin

The Frame widget is a Bin that surrounds its child with a decorative frame and an optional label. If present, the label is drawn in the gap in the top side of the frame by default.

Field Summary

Fields inherited from class org.gnu.glib.GObject

eventsInitialized

Constructor Summary

Frame()
Creates a new frame with no label
Frame(String label)
Creates a new frame, with the text of label being displayed in the top left.
Frame(Handle handle)
Construct a frame using a handle to a native resource.

Method Summary

String
getLabel()
Returns the text of the label which is being displayed at the top of the frame.
double
getLabelAlign()
Returns a number representing the alignment of the label
Widget
getLabelWidget()
Returns the widget being used as the label of the frame.
ShadowType
getShadow()
Returns the shadow type in use
static Type
getType()
Retrieve the runtime type used by the GLib library.
protected static String
gtk_frame_get_label(Handle frame)
protected static void
gtk_frame_get_label_align(Handle frame, double[] xalign, double[] yalign)
protected static Handle
gtk_frame_get_label_widget(Handle frame)
protected static int
gtk_frame_get_shadow_type(Handle frame)
protected static int
gtk_frame_get_type()
protected static Handle
gtk_frame_new(String label)
protected static void
gtk_frame_set_label(Handle frame, String label)
protected static void
gtk_frame_set_label_align(Handle frame, double xalign, double yalign)
protected static void
gtk_frame_set_label_widget(Handle frame, Handle labelWidget)
protected static void
gtk_frame_set_shadow_type(Handle frame, int type)
void
removeLabel()
Removes the label from the frame
void
setLabel(String label)
Changes the label which is displayed in the frame border.
void
setLabelAlign(double align)
Sets the alignment of the label widget along the top edge of the frame.
void
setLabelWidget(Widget labelWidget)
Sets the widget to use as the label for the frame.
void
setShadow(ShadowType shadowType)
Sets the ShadowType to be displayed for the frame.

Methods inherited from class org.gnu.gtk.Bin

getChild, getType, gtk_bin_get_child, gtk_bin_get_type

Methods inherited from class org.gnu.gtk.Container

add, addListener, fireContainerEvent, getBorderWidth, getChildren, getEventListenerClass, getEventType, getResizeMode, getType, 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, getEventListenerClass, getEventType, getModifierStyle, getName, getParent, getParentWindow, getPointer, getRootWindow, getScreen, getSensitive, getStyle, getToplevel, getType, 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, gtk_drag_source_set_icon, gtk_drag_source_set_icon_pixbuf, gtk_drag_source_set_icon_stock, 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, gtk_widget_get_parent_window, 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, gtk_widget_hide_all, gtk_widget_hide_on_delete, 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, gtk_widget_queue_draw_area, 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, gtk_widget_set_parent_window, 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, gtk_widget_show_all, gtk_widget_show_now, 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

destroy, getFlags, getType, 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, getEventListenerClass, getEventType, getFloatProperty, getGObjectFromHandle, getHandle, getIntFromHandle, getIntProperty, getJavaObjectProperty, getLongProperty, getNullHandle, getPixbufProperty, getProperty, getStringFromHandle, getStringProperty, hasProperty, hashCode, instantiateJGObjectFromGType, notify, removeEventHandler, removeListener, retrieveGObject, setBooleanProperty, setData, setData, setDoubleProperty, setFloatProperty, setHandle, setIntProperty, setJavaObjectProperty, setLongProperty, setPixbufProperty, setProperty, setStringProperty, thawNotify

Constructor Details

Frame

public Frame()
Creates a new frame with no label


Frame

public Frame(String label)
Creates a new frame, with the text of label being displayed in the top left.

Parameters:
label - Text to be displayed in the border of the frame.


Frame

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

Method Details

getLabel

public String getLabel()
Returns the text of the label which is being displayed at the top of the frame.

Returns:
The text of the label for the frame, if any.


getLabelAlign

public double getLabelAlign()
Returns a number representing the alignment of the label

Returns:
The alignment of the label on the top of the frame.

See Also:
setLabelAlign(double)


getLabelWidget

public Widget getLabelWidget()
Returns the widget being used as the label of the frame. If the frame has just been constructed with a label string, then this will be a Label widget. This method allows you to customise the widget.

Returns:
The widget currently being used as the label.


getShadow

public ShadowType getShadow()
Returns the shadow type in use

Returns:
shadowType the shadow tyoe being displayed


getType

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


gtk_frame_get_label

protected static final String gtk_frame_get_label(Handle frame)


gtk_frame_get_label_align

protected static final void gtk_frame_get_label_align(Handle frame,
                                                      double[] xalign,
                                                      double[] yalign)


gtk_frame_get_label_widget

protected static final Handle gtk_frame_get_label_widget(Handle frame)


gtk_frame_get_shadow_type

protected static final int gtk_frame_get_shadow_type(Handle frame)


gtk_frame_get_type

protected static final int gtk_frame_get_type()


gtk_frame_new

protected static final Handle gtk_frame_new(String label)


gtk_frame_set_label

protected static final void gtk_frame_set_label(Handle frame,
                                                String label)


gtk_frame_set_label_align

protected static final void gtk_frame_set_label_align(Handle frame,
                                                      double xalign,
                                                      double yalign)


gtk_frame_set_label_widget

protected static final void gtk_frame_set_label_widget(Handle frame,
                                                       Handle labelWidget)


gtk_frame_set_shadow_type

protected static final void gtk_frame_set_shadow_type(Handle frame,
                                                      int type)


removeLabel

public void removeLabel()
Removes the label from the frame


setLabel

public void setLabel(String label)
Changes the label which is displayed in the frame border.

Parameters:
label - The text to display


setLabelAlign

public void setLabelAlign(double align)
Sets the alignment of the label widget along the top edge of the frame. A vale of 0.0 means full left align; 0.5 means centered; 1.0 is full right align

Parameters:
align - A number representing the alignment of the label.


setLabelWidget

public void setLabelWidget(Widget labelWidget)
Sets the widget to use as the label for the frame. If you want a simple label, use the setLabel(String) method

Parameters:
labelWidget - The widget to use in the label position of the frame.


setShadow

public void setShadow(ShadowType shadowType)
Sets the ShadowType to be displayed for the frame.

Parameters:
shadowType - the shadow type to be used.