BiGridHeaders
This class represents the headers for a grid
or a tree.
The headers contain several header cells.
This class extends
BiComponent
and therefore all methods and fields available for
BiComponent
are also available for
BiGridHeaders
.
Constructor
new
BiGridHeaders
(
)
Parameters
No parameters.
Properties
| Name | Type | get | set | Descripton |
ascending |
Boolean |
![]() |
![]() |
If this is true then the sorting should be done
ascending, if false descending and if null
no sort. This is also reflected on the ascending property for the
header this applies to. |
columnCount |
Number |
![]() |
![]() |
The number of columns in the header |
columnOrders |
Number[] |
![]() |
![]() |
The order in which the cell headers should be displayed in. A
value of [2,0,1] means that the third cell comes first,
then comes the first cell and last the second. |
columnWidths |
Number[] |
![]() |
![]() |
The widths of the cell headers in the headers |
filler |
|
![]() |
Returns the header acting as the filler. This is the part that is shown after the last column if the grid is wider than all the columns combined. | |
fitColumnWidths |
Boolean |
![]() |
![]() |
When this is true the column widths are distributed so that the fill the width of the grid |
sortColumn |
Number |
![]() |
![]() |
The index of the column that should show the sort arrow. |
Methods
None.
Events
| Name | Type | Bubbles | Descripton |
ascendingchanged |
|
Fired when the ascending property changes. This happens when either
the user clicks on a column header cell that is already sorted or
this property is changed through script. Note that if the ascending property changed due to
a change of the sortColumn this event is not fired.
This is by design to prevent preformance issues. |
|
columnorderschanged |
|
Fired when the column orders are changed. This happens when either the user has reordered the columns or the order is changed through script. | |
columnwidthschanged |
|
Fired when the column widths are changed. This happens when either the user has finished resized a column or the column widths are changed through script. | |
columnwidthschanging |
|
Fired when the column widths are changing. This happens when the user is resizing a column. | |
sortcolumnchanged |
|
Fired when the sort column is changed. This happens when either
the user has clicks on a sortable column or the sort column is
changed through script. Note that when the user clicks on the currently sorted column this event is not fired. Instead the ascendingchanged event
is triggered because the sorting is changed from ascending to
descending or the other way around. |
Static Methods
None.
Static Fields
None.
Remarks
When working with grids there is no need to manually use this class.
