org.gnu.gtk
Class TreeViewColumn

java.lang.Object
  |
  +--org.gnu.glib.GObject
        |
        +--org.gnu.gtk.TreeViewColumn

public class TreeViewColumn
extends GObject

The TreeViewColumn object is a visible column in a TreeView widget, which is the base widget for all Tree, list and table widgets.


Constructor Summary
TreeViewColumn()
          Creates a new Column
 
Method Summary
 void addAttributeMapping(CellRenderer renderer, CellRendererAttribute attribute, DataBlock dataBlock)
          TreeView widgets contain TreeViewColumn objects.
 void addListener(TreeViewColumnListener listener)
          Register an object to handle Selection change events which are emitted whenever the selection has (possibly) changed
 void clear()
          Removes all the renderers from the column.
 void clearAttributeMappings(CellRenderer renderer)
          Clears all attribute mappings
 void click()
          Creates a Clicked event.
 java.lang.Class getEventListenerClass(java.lang.String signal)
           
 GtkEventType getEventType(java.lang.String signal)
           
 boolean getIsVisible()
          Returns TRUE if any of the cells packed into the column are visible.
 int getSortColumnID()
          Gets the logical sortColumnId that the model sorts on when this column is selected for sorting.
static Type getType()
          Retrieve the runtime type used by the GLib library.
 int getWidth()
          Returns the current size of the column in pixels
 void packEnd(CellRenderer cell, boolean expand)
          Packs the cell into the column.
 void packStart(CellRenderer cell, boolean expand)
          Packs the cell into the beginning column.
 void removeListener(TreeViewColumnListener listener)
          Removes a listener
 void setAlignment(double align)
          Sets the alignment of the title or custom widget inside the column header.
 void setClickable(boolean clickable)
          Sets the header to be active if active is TRUE.
 void setFixedWidth(int fixedWidth)
          Sets the size of the column in pixels.
 void setMaxWidth(int maxWidth)
          Sets the maximum width of the column.
 void setMinWidth(int minWidth)
          Sets the minimum width of the column.
 void setReorderable(boolean reorderable)
          If reorderable is TRUE, then the column can be reordered by the end user dragging the header.
 void setResizable(boolean resizable)
          If resizable is TRUE, then the user can explicitly resize the column by grabbing the outer edge of the column button.
 void setSizing(TreeViewColumnSizing type)
          Sets the growth behavior of the column
 void setSortColumnID(int sortColumnID)
          Sets the logical sortColumnId that this column sorts on when this column is selected for sorting.
 void setSortIndicator(boolean setting)
          Call this function with a setting of TRUE to display an arrow in the header button indicating the column is sorted.
 void setSortOrder(SortType order)
          Changes the appearance of the sort indicator.
 void setSpacing(int spacing)
          Sets the spacing field of the column, which is the number of pixels to place between cell renderers packed into it.
 void setTitle(java.lang.String title)
          Sets the title of the column.
 void setVisible(boolean visible)
          Sets the visibility of the column
 void setWidget(Widget widget)
          Sets the widget in the header to be widget.
 
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

TreeViewColumn

public TreeViewColumn()
Creates a new Column

Method Detail

packStart

public void packStart(CellRenderer cell,
                      boolean expand)
Packs the cell into the beginning column. If expand is TRUE, then the cell is allocated a share of all available space that the column has.

Parameters:
cell - The CellRenderer.
expand - TRUE if cell is to be given extra space allocated to box.

packEnd

public void packEnd(CellRenderer cell,
                    boolean expand)
Packs the cell into the column. If expand is TRUE, then the cell is allocated a share of all available space that the column has.

Parameters:
cell - The CellRenderer.
expand - TRUE if cell is to be given extra space allocated to box.

clear

public void clear()
Removes all the renderers from the column.


setSpacing

public void setSpacing(int spacing)
Sets the spacing field of the column, which is the number of pixels to place between cell renderers packed into it.

Parameters:
spacing - Distance between cell renderers in pixels.

setVisible

public void setVisible(boolean visible)
Sets the visibility of the column

Parameters:
visible - If true, the column s visible.

setResizable

public void setResizable(boolean resizable)
If resizable is TRUE, then the user can explicitly resize the column by grabbing the outer edge of the column button.

Parameters:
resizable - TRUE, if the column can be resized.

setSizing

public void setSizing(TreeViewColumnSizing type)
Sets the growth behavior of the column

Parameters:
type - The TreeViewColumnSizing.

getWidth

public int getWidth()
Returns the current size of the column in pixels

Returns:
The current width, in pizels.

setFixedWidth

public void setFixedWidth(int fixedWidth)
Sets the size of the column in pixels. This is meaningful only if the sizing type is TreeViewColumnSizing.FIXED. The size of the column is clamped to the min/max width for the column. Please note that the min/max width of the column doesn't actually affect the "fixedWidth" property of the widget, just the actual size when displayed.

Parameters:
fixedWidth - The size to set the column to. Must be greater than 0.

setMinWidth

public void setMinWidth(int minWidth)
Sets the minimum width of the column. If minWidth is -1, then the minimum width is unset.

Parameters:
minWidth - The minimum width of the column in pixels, or -1.

setMaxWidth

public void setMaxWidth(int maxWidth)
Sets the maximum width of the column. If maxWidth is -1, then the maximum width is unset. Note, the column can actually be wider than max width if it's the last column in a view. In this case, the column expands to fill any extra space.

Parameters:
maxWidth - The maximum width of the column in pixels, or -1.

click

public void click()
Creates a Clicked event. This function will only work if tree_column is clickable.


setTitle

public void setTitle(java.lang.String title)
Sets the title of the column. If a custom widget has been set, then this value is ignored.

Parameters:
title - The title of the column

setClickable

public void setClickable(boolean clickable)
Sets the header to be active if active is TRUE. When the header is active, then it can take keyboard focus, and can be clicked.

Parameters:
clickable - TRUE if the header is active.

setWidget

public void setWidget(Widget widget)
Sets the widget in the header to be widget. If widget is null, then the header button is set with a Label set to the title of column.

Parameters:
widget - : A child Widget, or null.

setAlignment

public void setAlignment(double align)
Sets the alignment of the title or custom widget inside the column header. The alignment determines its location inside the button -- 0.0 for left, 0.5 for center, 1.0 for right.

Parameters:
align - : The alignment, which is between [0.0 and 1.0] inclusive.

setReorderable

public void setReorderable(boolean reorderable)
If reorderable is TRUE, then the column can be reordered by the end user dragging the header. By using this method, the developer does not have to deal with the drag events.

Parameters:
reorderable - TRUE, if the column can be reordered.

setSortColumnID

public void setSortColumnID(int sortColumnID)
Sets the logical sortColumnId that this column sorts on when this column is selected for sorting. Doing so makes the column header clickable.


getSortColumnID

public int getSortColumnID()
Gets the logical sortColumnId that the model sorts on when this column is selected for sorting.


setSortIndicator

public void setSortIndicator(boolean setting)
Call this function with a setting of TRUE to display an arrow in the header button indicating the column is sorted. Call setSortOrder(SortType) to change the direction of the arrow.

Parameters:
setting - TRUE to display an indicator that the column is sorted

setSortOrder

public void setSortOrder(SortType order)
Changes the appearance of the sort indicator.

This does not actually sort the model. Use setSortColumnID(int) if you want automatic sorting support. This function is primarily for custom sorting behavior, and should be used in conjunction with setSortColumnID(int) to do that. For custom models, the mechanism will vary.

The sort indicator changes direction to indicate normal sort or reverse sort. Note that you must have the sort indicator enabled to see anything when calling this function;

Parameters:
order - Sort order that the sort indicator should indicate
See Also:
setSortIndicator(boolean)

getIsVisible

public boolean getIsVisible()
Returns TRUE if any of the cells packed into the column are visible.


addAttributeMapping

public void addAttributeMapping(CellRenderer renderer,
                                CellRendererAttribute attribute,
                                DataBlock dataBlock)
TreeView widgets contain TreeViewColumn objects. These contain CellRenderers to display data on the screen. This data is stored in a ListStore or TreeStore. In order for data to be displayed, a mapping has to be made between the data in the data store and the attributes of the CellRenderers which determine what they render. This method creates those mappings.

Parameters:
renderer - The cell renderer to add the mapping to. This must have been addded to this column.
attribute - The attribute to be mapped. This must be one of the attributes for the given renderer.
dataBlock - the dataBlock in the store in which the data is contained. This should be of the type required by the renderer attribute.

clearAttributeMappings

public void clearAttributeMappings(CellRenderer renderer)
Clears all attribute mappings

See Also:
#addAttributeMapping(CellRenderer, CellRendererAttribute, int)

addListener

public void addListener(TreeViewColumnListener listener)
Register an object to handle Selection change events which are emitted whenever the selection has (possibly) changed

See Also:
TreeViewColumnListener

removeListener

public void removeListener(TreeViewColumnListener listener)
Removes a listener

See Also:
addListener(TreeViewColumnListener)

getEventListenerClass

public java.lang.Class getEventListenerClass(java.lang.String signal)

getEventType

public GtkEventType getEventType(java.lang.String signal)

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