Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
GObject
org.gnu.gtk.TreeViewColumn
public class TreeViewColumn
extends GObject
TreeView
widget,
which is the base widget for all Tree, list and table widgets.
Constructor Summary | |
|
Method Summary | |
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
double | |
CellRenderer[] |
|
boolean | |
Class |
|
EventType |
|
boolean |
|
int | |
boolean |
|
int | |
int | |
boolean | |
boolean | |
TreeViewColumnSizing | |
boolean | |
SortType | |
int | |
String |
|
static Type |
|
boolean | |
Widget | |
int |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
public TreeViewColumn()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Creates a new Column
public void addAttributeMapping(CellRenderer renderer, CellRendererAttribute attribute, DataColumn dataBlock)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
TreeView
widgets containTreeViewColumn
objects. These containCellRenderer
s to display data on the screen. This data is stored in aListStore
orTreeStore
. 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.
public void addListener(TreeViewColumnListener listener)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Register an object to handle events on the column header.
- See Also:
TreeViewColumnListener
public void clear()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Removes all the renderers from the column.
public void clearAttributeMappings(CellRenderer renderer)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Clears all attribute mappings
public void click()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Creates a Clicked event. This function will only work if tree_column is clickable.
public void focusCell(CellRenderer cell)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Sets the current keyboard focus to be at cell, if the column contains 2 or more editable and activatable cells.
- Since:
- 2.2
public double getAlignment()
public CellRenderer[] getCellRenderers()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Returns an array of CellRenderers in the column in no particular order.
public boolean getClickable()
public Class getEventListenerClass(String signal)
public EventType getEventType(String signal)
public boolean getExpand()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Return TRUE if the column expands to take any available space.
- Returns:
- true, if the column expands
- Since:
- 2.4
public int getFixedWidth()
public boolean getIsVisible()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Returns TRUE if any of the cells packed into the column are visible.
public int getMaxWidth()
public int getMinWidth()
public boolean getReorderable()
public boolean getResizable()
public boolean getSortIndicator()
public int getSpacing()
public String getTitle()
public static Type getType()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Retrieve the runtime type used by the GLib library.
public boolean getVisible()
public int getWidth()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Returns the current size of the column in pixels
- Returns:
- The current width, in pizels.
public void packEnd(CellRenderer cell, boolean expand)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
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.
public void packStart(CellRenderer cell, boolean expand)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
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.
public void removeListener(TreeViewColumnListener listener)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Removes a listener
- See Also:
addListener(TreeViewColumnListener)
public void setAlignment(double align)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
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.
public void setClickable(boolean clickable)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Sets the header to be active ifactive
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.
public void setExpand(boolean expand)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
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.
- Parameters:
expand
-
- Since:
- 2.4
public void setFixedWidth(int fixedWidth)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Sets the size of the column in pixels. This is meaningful only if the sizing type isTreeViewColumnSizing.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.
public void setMaxWidth(int maxWidth)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
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.
public void setMinWidth(int minWidth)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
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.
public void setReorderable(boolean reorderable)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Ifreorderable
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.
public void setResizable(boolean resizable)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
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.
public void setSizing(TreeViewColumnSizing type)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Sets the growth behavior of the column
- Parameters:
type
- The TreeViewColumnSizing.
public void setSortColumn(DataColumn column)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Sets the logical DataColumn that this column sorts on when this column is selected for sorting. Doing so makes the column header clickable.
- Parameters:
column
- The DataColumn of the model to sort on.
public void setSortIndicator(boolean setting)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Call this function with a setting ofTRUE
to display an arrow in the header button indicating the column is sorted. CallsetSortOrder(SortType)
to change the direction of the arrow.
- Parameters:
setting
- TRUE to display an indicator that the column is sorted
public void setSortOrder(SortType order)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Changes the appearance of the sort indicator. This does not actually sort the model. UsesetSortColumn(DataColumn)
if you want automatic sorting support. This function is primarily for custom sorting behavior, and should be used in conjunction withsetSortColumn(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;
- Parameters:
order
- Sort order that the sort indicator should indicate
public void setSpacing(int spacing)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
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.
public void setTitle(String title)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
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
public void setVisible(boolean visible)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Sets the visibility of the column
- Parameters:
visible
- If true, the column s visible.
public void setWidget(Widget widget)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Sets the widget in the header to bewidget
. If widget is
null
, then the header button is set with aLabel
set to the title of column.
- Parameters:
widget
- : A childWidget
, or null.