Class YAHOO.widget.Column
The Column class defines and manages attributes of DataTable Columns
Constructor
YAHOO.widget.Column
(
oConfigs
)
- Parameters:
-
oConfigs
<Object>
Object literal of definitions.
Properties
_dd
- private YAHOO.util.DragDrop
For unreg() purposes, a reference to the Column's DragDrop instance.
_ddResizer
- private YAHOO.util.DragDrop
For unreg() purposes, a reference to the Column resizer's DragDrop instance.
_elResizer
- private HTMLElement
The DOM reference to the associated resizerelement (if any).
_elTh
- private HTMLElement
The DOM reference to the associated TH element.
Number of table cells the Column spans.
Reference to Column's current position index within its ColumnSet's keys
array, if applicable. This property only applies to non-nested and bottom-
level child Columns.
Number of table rows the Column spans.
Reference to Column's current position index within its ColumnSet's tree
array, if applicable. This property only applies to non-nested and top-
level parent Columns.
Object literal definition
_oParent
- private YAHOO.widget.Column
Column's parent Column instance, or null.
_sId
- private String
Unique String identifier assigned at instantiation.
abbr
- String
Column head cell ABBR for accessibility.
Array of object literals that define children (nested headers) of a Column.
className
- String || String[]
Custom CSS class or array of classes to be applied to every cell in the Column.
Internal class variable to index multiple Column instances.
editor
- String || HTMLFunction
Defines an editor function, otherwise Column is not editable.
Defines editor options for Column in an object literal of param:value pairs.
formatter
- String || HTMLFunction
Defines a format function.
True if Column is in hidden state.
Default Value: false
key
- String
Associated database field, or null.
Text or HTML for display as Column's label in the TH element.
Minimum Column width (in pixels).
Default Value: 10
True if Column is resizeable, false otherwise. The Drag & Drop Utility is
required to enable this feature. Only bottom-level and non-nested Columns are
resizeble.
Default Value: false
True if Column is in selected state.
Default Value: false
True if Column is sortable, false otherwise.
Default Value: false
Default sort direction for Column: YAHOO.widget.DataTable.CLASS_ASC or YAHOO.widget.DataTable.CLASS_DESC.
Default Value: null
Deprecated: Use sortOptions.defaultDir.
Column width (in pixels).
Methods
void
getColEl
(
)
- Returns:
void
Deprecated Use getThEl
Number
getColspan
(
)
Public accessor returns Column's calculated COLSPAN value.
- Returns:
Number
- Column's COLSPAN value.
Object
getDefinition
(
)
Returns object literal definition.
- Returns:
Object
- Object literal definition.
String
getId
(
)
Returns unique ID string.
- Returns:
String
- Unique ID string.
String
getKey
(
)
Returns unique Column key.
- Returns:
String
- Column key.
Number
getKeyIndex
(
)
Public accessor returns Column's current position index within its
ColumnSet's keys array, if applicable. Only non-nested and bottom-level
child Columns will return a value.
- Returns:
Number
- Position index, or null.
YAHOO.widget.Column
getParent
(
)
Public accessor returns Column's parent instance if any, or null otherwise.
- Returns:
YAHOO.widget.Column
- Column's parent instance.
HTMLElement
getResizerEl
(
)
Returns DOM reference to the resizer element, or null.
- Returns:
HTMLElement
- DIV element.
Number
getRowspan
(
)
Public accessor returns Column's calculated ROWSPAN value.
- Returns:
Number
- Column's ROWSPAN value.
HTMLElement
getThEl
(
)
Returns DOM reference to the key TH element.
- Returns:
HTMLElement
- TH element.
Number
getTreeIndex
(
)
Public accessor returns Column's current position index within its
ColumnSet's tree array, if applicable. Only non-nested and top-level parent
Columns will return a value;
- Returns:
Number
- Position index, or null.
String
toString
(
)
Column instance name, for logging.
- Returns:
String
- Column's unique name.