|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.gnu.glib.Struct
org.gnu.glib.GObject
org.gnu.gtk.TreeViewColumn
public class TreeViewColumn
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,
DataColumn dataBlock)
TreeView widgets contain TreeViewColumn objects. |
void |
addListener(TreeViewColumnListener listener)
Register an object to handle events on the column header. |
void |
clear()
Removes all the renderers from the column. |
void |
clearAttributeMappings(CellRenderer renderer)
Clears all attribute mappings |
void |
click()
Creates a Clicked event. |
void |
focusCell(CellRenderer cell)
Sets the current keyboard focus to be at cell, if the column contains 2 or more editable and activatable cells. |
double |
getAlignment()
|
CellRenderer[] |
getCellRenderers()
Returns an array of CellRenderers in the column in no particular order. |
boolean |
getClickable()
|
java.lang.Class |
getEventListenerClass(java.lang.String signal)
|
EventType |
getEventType(java.lang.String signal)
|
boolean |
getExpand()
Return TRUE if the column expands to take any available space. |
int |
getFixedWidth()
|
boolean |
getIsVisible()
Returns TRUE if any of the cells packed into the column are visible. |
int |
getMaxWidth()
|
int |
getMinWidth()
|
boolean |
getReorderable()
|
boolean |
getResizable()
|
TreeViewColumnSizing |
getSizing()
|
boolean |
getSortIndicator()
|
SortType |
getSortOrder()
|
int |
getSpacing()
|
java.lang.String |
getTitle()
|
static Type |
getType()
Retrieve the runtime type used by the GLib library. |
boolean |
getVisible()
|
Widget |
getWidget()
|
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 |
setExpand(boolean expand)
Sets the column to take available extra space. |
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 |
setSortColumn(DataColumn column)
Sets the logical DataColumn 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.Struct |
---|
equals, getHandle, getNullHandle, hashCode |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TreeViewColumn()
Method Detail |
---|
public void packStart(CellRenderer cell, boolean expand)
cell
- The CellRenderer.expand
- TRUE if cell is to be given extra space allocated to box.public void packEnd(CellRenderer cell, boolean expand)
cell
- The CellRenderer.expand
- TRUE if cell is to be given extra space allocated to box.public void clear()
public CellRenderer[] getCellRenderers()
public void setSpacing(int spacing)
spacing
- Distance between cell renderers in pixels.public int getSpacing()
public void setVisible(boolean visible)
visible
- If true, the column s visible.public boolean getVisible()
public void setResizable(boolean resizable)
resizable
- TRUE, if the column can be resized.public boolean getResizable()
public void setSizing(TreeViewColumnSizing type)
type
- The TreeViewColumnSizing.public TreeViewColumnSizing getSizing()
public int getWidth()
public void setFixedWidth(int fixedWidth)
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.public int getFixedWidth()
public void setMinWidth(int minWidth)
minWidth
- The minimum width of the column in pixels, or -1.public int getMinWidth()
public void setMaxWidth(int maxWidth)
maxWidth
- The maximum width of the column in pixels, or -1.public int getMaxWidth()
public void click()
public void setTitle(java.lang.String title)
title
- The title of the columnpublic java.lang.String getTitle()
public void setClickable(boolean clickable)
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.public boolean getClickable()
public void setWidget(Widget widget)
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.
public Widget getWidget()
public void setAlignment(double align)
align
- :
The alignment, which is between [0.0 and 1.0] inclusive.public double getAlignment()
public void setReorderable(boolean reorderable)
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.public boolean getReorderable()
public void setSortColumn(DataColumn column)
column
- The DataColumn of the model to sort on.public void setSortIndicator(boolean setting)
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 sortedpublic boolean getSortIndicator()
public void setSortOrder(SortType order)
This does not actually sort the model. Use setSortColumn(org.gnu.gtk.DataColumn)
if you
want automatic sorting support. This function is primarily for custom
sorting behavior, and should be used in conjunction with
setSortColumn(org.gnu.gtk.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 indicatesetSortIndicator(boolean)
,
setSortColumn(org.gnu.gtk.DataColumn)
public SortType getSortOrder()
public boolean getIsVisible()
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.public void clearAttributeMappings(CellRenderer renderer)
addAttributeMapping(CellRenderer, CellRendererAttribute,
DataColumn)
public void setExpand(boolean expand)
expand
- public boolean getExpand()
public void focusCell(CellRenderer cell)
public void addListener(TreeViewColumnListener listener)
TreeViewColumnListener
public void removeListener(TreeViewColumnListener listener)
addListener(TreeViewColumnListener)
public java.lang.Class getEventListenerClass(java.lang.String signal)
getEventListenerClass
in class GObject
public EventType getEventType(java.lang.String signal)
getEventType
in class GObject
public static Type getType()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |