The TreeViewColumn object is a visible column in a
TreeView
widget,
which is the base widget for all Tree, list and table widgets.
addAttributeMapping
public void addAttributeMapping(CellRenderer renderer,
CellRendererAttribute attribute,
DataColumn dataBlock)
TreeView
widgets contain
TreeViewColumn
objects. These
contain
CellRenderer
s 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.
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.
addListener
public void addListener(TreeViewColumnListener listener)
Register an object to handle events on the column header.
clear
public void clear()
Removes all the renderers from the column.
clearAttributeMappings
public void clearAttributeMappings(CellRenderer renderer)
Clears all attribute mappings
click
public void click()
Creates a Clicked event. This function will only work if tree_column is
clickable.
focusCell
public void focusCell(CellRenderer cell)
Sets the current keyboard focus to be at cell, if the column contains 2
or more editable and activatable cells.
getAlignment
public double getAlignment()
getCellRenderers
public CellRenderer[] getCellRenderers()
Returns an array of CellRenderers in the column in no particular order.
getClickable
public boolean getClickable()
getExpand
public boolean getExpand()
Return TRUE if the column expands to take any available space.
- true, if the column expands
getFixedWidth
public int getFixedWidth()
getIsVisible
public boolean getIsVisible()
Returns TRUE if any of the cells packed into the column are visible.
getMaxWidth
public int getMaxWidth()
getMinWidth
public int getMinWidth()
getReorderable
public boolean getReorderable()
getResizable
public boolean getResizable()
getSortIndicator
public boolean getSortIndicator()
getSortOrder
public SortType getSortOrder()
getSpacing
public int getSpacing()
getTitle
public String getTitle()
getType
public static Type getType()
Retrieve the runtime type used by the GLib library.
getVisible
public boolean getVisible()
getWidget
public Widget getWidget()
getWidth
public int getWidth()
Returns the current size of the column in pixels
- The current width, in pizels.
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.
cell
- The CellRenderer.expand
- TRUE if cell is to be given extra space allocated to box.
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.
cell
- The CellRenderer.expand
- TRUE if cell is to be given extra space allocated to box.
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.
align
- :
The alignment, which is between [0.0 and 1.0] inclusive.
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.
clickable
- TRUE if the header is active.
setExpand
public void setExpand(boolean expand)
Sets the column to take available extra space. This space is shared
equally amongst all columns that have the expand set to TRUE. If no
column has this option set, then the last column gets all extra space. By
default, every column is created with this FALSE.
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.
fixedWidth
- The size to set the column to. Must be greater than 0.
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.
maxWidth
- The maximum width of the column in pixels, or -1.
setMinWidth
public void setMinWidth(int minWidth)
Sets the minimum width of the column. If minWidth is -1, then the minimum
width is unset.
minWidth
- The minimum width of the column in pixels, or -1.
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.
reorderable
- TRUE, if the column can be reordered.
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.
resizable
- TRUE, if the column can be resized.
setSizing
public void setSizing(TreeViewColumnSizing type)
Sets the growth behavior of the column
type
- The TreeViewColumnSizing.
setSortColumn
public void setSortColumn(DataColumn column)
Sets the logical DataColumn that this column sorts on when this column is
selected for sorting. Doing so makes the column header clickable.
column
- The DataColumn of the model to sort on.
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.
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
setSortColumn(DataColumn)
if you
want automatic sorting support. This function is primarily for custom
sorting behavior, and should be used in conjunction with
setSortColumn(DataColumn)
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;
order
- Sort order that the sort indicator should indicate
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.
spacing
- Distance between cell renderers in pixels.
setTitle
public void setTitle(String title)
Sets the title of the column. If a custom widget has been set, then this
value is ignored.
title
- The title of the column
setVisible
public void setVisible(boolean visible)
Sets the visibility of the column
visible
- If true, the column s visible.
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.
widget
- : A child Widget
, or null.