WkTableColumn

Widget Encyclopedia : WkTableColumn

WkTableColumn

The WkTableColumn class defines a single column in an WkTableWidget or WkColumnarListBox widget. In addition to details about the look and feel of the column, it also provides get and set selectors which the application may use to specify the cell value for an item in that column and a list selector for specifying a dropdown list of values for a cell. The cell values may be further augmented through a cell value callback. The column also provides callbacks to notify the application when a cell is about to be edited and when the edit is about to end.

Note: WkTableColumn objects may only be created from within the WkTableWidget or WkColumnarListBox editors.

Protocol

autosize: aBoolean
Specifies whether the column width should be autosized.

characterValidation: aSymbol
Specifies the character validation function to use with values entered into cells within the column.

Default: #okAny: (Any)

Valid resource values:

#ok20Comma10: (20Comma10) - Validates whether each character is a valid for a 20,10 field.

#ok7Comma2: (7Comma2) - Validates whether each character is a valid for a 7,2 field.

#ok7Comma4: (7Comma4) - Validates whether each character is a valid for a 7,4 field.

#okAlpha: (Alpha) - Validates whether each character is a valid alpha character ($A - $Z, $a - $z or space).

#okAlphaNoSpace: (AlphaNoSpace) - Validates whether each character is a valid alpha character ($A - $Z, $a - $z).

#okAlphaNumeric: (AlphaNumeric) - Validates whether each character is a valid alpha-numeric character ($A - $Z, $a - $z, $0 - $9, or space).

#okAlphaNumericNoSpace: (AlphaNumericNoSpace) - Validates whether each character is a valid alpha character ($A - $Z, $a - $z, $0 - $9).

#okAny: (Any) - Any character is valid.

#okBoolean: (Boolean) - Validates whether each character is a valid Boolean value (e.g., T, t, F, f, Y, y, N, or n).

#okCurrency: (Currency) - Validates whether each character is a valid currency value.

#okInteger: (Integer) - Validates whether each character is a valid Integer value.

#okNumeric: (Numeric) - Validates whether each character is a valid numeric value.

#okPositive10Comma10: (Positive10Comma10) - Validates whether each character is a valid for a positive 10,10 field.

#okPositiveInteger: (PositiveInteger) - Validates whether each character is a valid positive Integer.

#okPositiveNumeric: (PositiveNumeric) - Validates whether each character is a valid positive numeric value.

disabledSelector: aSymbol
Specifies selector sent to the row object to determine whether a cell should be disabled.

editable: aBoolean
Specifies whether the cells in this column are editable.

etched: aBoolean
Specifies whether this column is to be etched.

fieldValidation: aSymbol
Specifies the field validation function to use with values entered into cells within the column.

Default: #okAny (Any)

Valid resource values:

#okAny (Any) - Any characters are valid.

#okCurrency (Currency) - Formats the contents of the field to be a currency value.

#okCurrencyNoDecimal (CurrencyNoDecimal) - Formats the contents of the field to be a currency value without decimal places.

#okDate (Date) - Validates whether the contents of the field are a valid Date value and then formats the Date using the system Date format.

#okInteger (Integer) - Formats the contents of the field to be an Integer value.

#okNumber (Number) - Formats the contents of the field to be a numeric (e.g., Float) value.

#okPhoneNumberExtUS (PhoneNumberExtUS) - Validates and formats the contents of the field to be a US phone number with optional extension. Valid formats are: (999) 999-9999, 999-9999, x999, (999) 999-9999 x999.

#okPhoneNumberUS (PhoneNumberUS) - Validates and formats the contents of the field to be a US phone number. Valid formats are: (999) 999-9999, 999-9999.

#okRound2 (Round2) - Formats the contents of the field to be rounded to 2 decimal places.

#okRound3 (Round3) - Formats the contents of the field to be rounded to 3 decimal places.

#okSSN (SSN) - Validates and formats the contents of the field to be a US Social Security Number. Format is: 999-99-9999.

#okZipCodeUS (ZipCodeUS) - Validates and formats the contents of the field to be a US Zip Code. Valid format are: 99999 or 99999-9999.

getSelector: aSymbol
Specifies selector sent to the row object to retrieve the data for the cell.

heading: aString
Specifies the heading object to be displayed at the top of the column.

horizontalAlignment: anInteger
Specifies how the cells in this column should be aligned horizontally.

Default: XmALIGNMENTBEGINNING (Left)

Valid resource values:

XmALIGNMENTBEGINNING (Left) - Align the cells to the left.

XmALIGNMENTCENTER (Center) - Align the cells to the center.

XmALIGNMENTEND (Right) - Align the cells to the right.

horizontalHeadingAlignment: anInteger
Specifies how this column’s heading should be aligned horizontally.

Default: XmALIGNMENTBEGINNING (Left)

Valid resource values:

XmALIGNMENTBEGINNING (Left) - Align the heading to the left.

XmALIGNMENTCENTER (Center) - Align the heading to the center.

XmALIGNMENTEND (Right) - Align the heading to the right.

listSelector: aSymbol
Specifies selector sent to the row object to retrieve a list of values to populate the drop down list in the cell.

minWidth: anInteger
Specifies the minimum width of the column in pixels. This minimum applys to autosizing and user resizing operations.

name: aString
Specifies the name of the column. This name may be used to programatically access the column. Note that this is distint from the heading of the column.

reorderable: aBoolean
Specifies whether the column is reorderable (can be draged left and right).

resizable: aBoolean
Specifies whether the column is resizable by the user. If so, the user can drag the right side of the column heading to change the column width

setSelector: aSymbol
Specifies selector sent to the row object to store data entered into the cell.

showInUse: aBoolean
Specifies whether the column should show the inUse emphasis for each item.

sortable: aBoolean
Specifies whether the column is sortable.

verticalAlignment: anInteger
Specifies how the cells and heading in this column should be aligned vertically.

Default: XmALIGNMENTBEGINNING (Top)

Valid resource values:

XmALIGNMENTBEGINNING (Top) - Align the cells to the top.

XmALIGNMENTCENTER (Center) - Align the cells to the vertical center.

XmALIGNMENTEND (Bottom) - Align the cells to the bottom.

verticalSeparatorThickness: anInteger
Specifies the thickness of the line shown to the right of each cell in the column.

width: anInteger
Specifies the width of the column in pixels. This does not includes the width of any emphasis or vertical separator.

Callbacks & Events

Begin Edit Callback
These callbacks are triggered when an item is about to be edited.

Call data arguments:

item - the item which is the selected item.

itemPosition - the integer position of the selected item in the list.

doit - indicates whether the action that invoked the callback is performed.

editPolicy - the edit policy to be used to edit the cell value.

value - the value of the cell which is about to be edited.

Cell Value Callback
These callbacks are triggered when an item’s cell value is needed for this column.

Call data arguments:

item - the item which is the selected item.

itemPosition - the integer position of the selected item in the list.

column - the EwTableColumn for which a cell value is needed.

value - the value of the cell which is about to be edited.

End Edit Callback
These callbacks are triggered when an item is done being edited.

Call data arguments:

item - the item which is the selected item.

itemPosition - the integer position of the selected item in the list.

doit - indicates whether the action that invoked the callback is performed.

editPolicy - the edit policy to be used to edit the cell value.

value - the value of the cell which is about to be edited.