The AFXTable constructor is defined by the following prototype:

AFXTable(p, numVisRows, numVisColumns, numRows, numColumns,
    tgt=None, sel=0, opts=AFXTABLE_NORMAL,
    x=0, y=0, w=0, h=0,
    pl= DEFAULT_MARGIN, pr=DEFAULT_MARGIN,
    pt=DEFAULT_MARGIN, pb=DEFAULT_MARGIN)

# Tables do not draw a frame around their border. 
# Therefore, add a frame widget with zero padding.

vf = FXVerticalFrame(gb, FRAME_SUNKEN|FRAME_THICK,
    0,0,0,0, 0,0,0,0)
table = AFXTable(vf, 4, 2, 4, 2)

The table supports leading rows and columns. Leading rows and columns are displayed as buttons using a bold text. Leading rows are displayed at the top of the table, and leading columns are displayed on the left side of the table.

The number of rows and columns that you specify in the table constructor are the total number of rows and columns, including the leading rows and columns. By default, the table has no leading rows or columns—you must set the leading rows and columns after the table is constructed using the appropriate table methods. You can also specify the labels to be displayed in these rows and columns. If you do not specify any labels for a leading row or column, it will be numbered automatically. You can set more than one label at once in a heading by using “\t” to separate the labels in a single string.

By default, no gridlines are drawn around items. You can control the visibility of the horizontal and vertical gridlines individually by using the following table methods:

• showHorizontalGrid(True|False)

• showVerticalGrid(True|False)

• setRowHeight( row, height) # Height is in pixels

• setColumnWidth(column, width) # Width is in pixels

The following example illustrates the use of some of these methods:

vf = FXVerticalFrame(parent, FRAME_SUNKEN|FRAME_THICK,
    0,0,0,0,0,0,0,0) 
table = AFXTable(vf, 4, 3, 4, 3)
table.setLeadingColumns(1)
table.setLeadingRows(1)
table.setLeadingRowLabels('X\tY')
table.showHorizontalGrid(True)
table.showVerticalGrid(True)
table.setColumnWidth(0, 30)

You can make an item in a header row or column span more than one row or column, as shown in the following example:

vf = FXVerticalFrame(parent, FRAME_SUNKEN|FRAME_THICK,
     0,0,0,0, 0,0,0,0)
table = AFXTable(vf, 4, 3, 4, 3)
table.setLeadingColumns(1)
table.setLeadingRows(2)

# Corner item
table.setItemSpan(0, 0, 2, 1)

# Span top row item over 2 columns
table.setItemSpan(0, 1, 1, 2)
table.setLeadingRowLabels('Coordinates')
table.setLeadingRowLabels('X\tY', 1)

table.showHorizontalGrid(True)
table.showVerticalGrid(True)

table.setColumnWidth(0, 30)

By default, the table displays entries left justified. You can change how items are justified by using the following table methods:

• setColumnJustify(column, justify)

• setItemJustify(row, column, justify)

The following table shows the possible values for the justify argument:

vf = FXVerticalFrame(gb, FRAME_SUNKEN|FRAME_THICK,
    0,0,0,0, 0,0,0,0)
table = AFXTable(vf, 4, 3, 4, 3)
table.setLeadingColumns(1)
table.setLeadingRows(1)
table.setLeadingRowLabels('X\tY')
table.showHorizontalGrid(True)
table.showVerticalGrid(True)
table.setColumnWidth(0, 30)  

# Center all columns
table.setColumnJustify(-1, AFXTable.CENTER)  

By default, no items in a table are editable. To make all items in a table editable, you must specify AFXTABLE_EDITABLE in the table constructor. To change the editability of some items in a table, you can use the following table methods:

• setColumnEditable(column, True|False)

• setItemEditable(row, column, True|False)

By default, all items in a table are text items. However, the table widget also supports the other types of items shown in the following table:

• setColumnType(column, type)

• setItemType(row, column, type)

If you want to allow the user to specify a value in a column by selecting from a list of items, you must first set the column to be of type LIST. You then create a list and assign it to that column. When the user clicks on an item in that column, the table will display a noneditable combo box that contains the entries from the list. The following example illustrates how you can create a combo box within a table cell:

vf = FXVerticalFrame(gb, FRAME_SUNKEN|FRAME_THICK,
    0,0,0,0, 0,0,0,0)
table = AFXTable(vf, 4, 2, 4, 2, None, 0,
    AFXTABLE_NORMAL|AFXTABLE_EDITABLE)
table.setLeadingRows(1)
table.setLeadingRowLabels('Size\tQuantity')
table.showHorizontalGrid(True)
table.showVerticalGrid(True)

listId = table.addList('Small\tMedium\tLarge')
table.setColumnType(0, AFXTable.LIST)
table.setColumnListId(0, listId)

You can also add list items that contain icons using the appendListItem method of the table.

icon = createGIFIcon('myIcon.gif')
table.appendListItem(listId, 'Extra large', icon) 

When you connect a table keyword to a table that contains lists, you must set the column type of the table keyword appropriately. If the list contains only text, you can set the column type to AFXTABLE_TYPE_STRING, which sets the value of the keyword to the text of the item selected in the list. Similarly, if the list contains only icons, you can set the column type to AFXTABLE_TYPE_INT, which sets the value of the keyword to the index of the item selected in the list. If the list contains both text and icons, you can use either setting for the column type.

If you want to allow the user to specify a value in a table be either True or False, you must set the type of the column to be BOOL. The value of a Boolean item is toggled each time the user clicks the item. By default, a blank icon represents False and a check mark icon represents True. The following example illustrates how you can include Boolean items in a table:

vf = FXVerticalFrame(gb, FRAME_SUNKEN|FRAME_THICK,
    0,0,0,0, 0,0,0,0)
table = AFXTable(vf, 4, 2, 4, 2, None, 0,
    AFXTABLE_NORMAL|AFXTABLE_EDITABLE)
table.setLeadingRows(1)
table.setLeadingRowLabels('Nlgeom\tStep')
table.showHorizontalGrid(True)
table.showVerticalGrid(True)
table.setColumnType(0, table.BOOL)
table.setColumnWidth(0, 50)
table.setColumnJustify(0, AFXTable.CENTER)

If you do not want to use the default icons, you can set your own true and false icons, as shown in the following example:

vf = FXVerticalFrame(gb, FRAME_SUNKEN|FRAME_THICK,
    0,0,0,0, 0,0,0,0)
table = AFXTable(vf, 4, 2, 4, 2, None, 0,
    AFXTABLE_NORMAL|AFXTABLE_EDITABLE)
table.setLeadingRows(1)
table.setLeadingRowLabels('State\tLayer')
table.showHorizontalGrid(True)
table.showVerticalGrid(True)     
table.setColumnType(0, table.BOOL)
table.setColumnWidth(0, 50)
table.setColumnJustify(0, AFXTable.CENTER)

from appIcons import lockedData, unlockedData
trueIcon = FXXPMIcon(getAFXApp(), lockedData)
falseIcon = FXXPMIcon(getAFXApp(), unlockedData)
table.setDefaultBoolIcons(trueIcon, falseIcon)

If you want to display an icon in an item, you must set the type of the column to be ICON and assign the icons to be shown. This type of column is not editable by the user. The following example shows how you can include an icon in a table cell:

vf = FXVerticalFrame(parent, FRAME_SUNKEN|FRAME_THICK,
    0,0,0,0, 0,0,0,0)
table = AFXTable(vf, 4, 2, 4, 2, None, 0,
    AFXTABLE_NORMAL|AFXTABLE_EDITABLE)
table.setLeadingRows(1) table.setLeadingRowLabels(' \tStatus') 
table.showHorizontalGrid(True)
table.showVerticalGrid(True)      
table.setColumnType(0, table.ICON)
table.setColumnWidth(0, 30)
table.setColumnJustify(0, AFXTable.CENTER)

from appIcons import circleData, squareData 
circleIcon = FXXPMIcon(getAFXApp(), circleData)
squareIcon = FXXPMIcon(getAFXApp(), squareData)
table.setItemIcon(1, 0, circleIcon)
table.setItemIcon(2, 0, squareIcon)
table.setItemIcon(3, 0, circleIcon)

If you want to display a color button in a table, you must set the type to COLOR. If the table is editable, the user can use the color button to change the color via the color selection dialog box. The color button is a flyout button that can have up to three flyout items, one for a specific color, one for a default color, and one for an “as-is” color. Refer to the Color Code dialog box in Abaqus/CAE to see examples of how these options may be used. The options are specified using the flags in the following table:

vf = FXVerticalFrame(
    gb, FRAME_SUNKEN|FRAME_THICK, 0,0,0,0, 0,0,0,0)
table = AFXTable(
    vf, 4, 2, 4, 2, None, 0, AFXTABLE_NORMAL|AFXTABLE_EDITABLE)
table.setLeadingRows(1)
table.setLeadingRowLabels('Name\tColor')
table.setColumnType(1,AFXTable.COLOR)
table.setColumnColorOptions(
    1, AFXTable.COLOR_INCLUDE_COLOR_ONLY)
table.setItemText(1, 0, 'Part-1')
table.setItemText(2, 0, 'Part-2')
table.setItemText(3, 0, 'Part-3')
table.setItemColor(1,1, '#FF0000')
table.setItemColor(2,1, '#00FF00')
table.setItemColor(3,1, '#0000FF')

You can add a popup menu to the table by specifying the appropriate flags using the setPopupOptions method. The menu will be posted when the user clicks mouse button 3 anywhere over the table. The following options are supported in the popup menu:

vf = FXVerticalFrame(parent, FRAME_SUNKEN|FRAME_THICK,
     0,0,0,0, 0,0,0,0)
table = AFXTable(vf, 4, 3, 4, 3, None, 0,
    AFXTABLE_NORMAL|AFXTABLE_EDITABLE)

table.setLeadingColumns(1)
table.setLeadingRows(1)
table.setLeadingRowLabels('X\tY')

table.showHorizontalGrid(True)
table.showVerticalGrid(True)
        
table.setColumnWidth(0, 30)

# Center all columns 
table.setColumnJustify(-1, table.CENTER)
          
table.setPopupOptions(
    AFXTable.POPUP_CUT|AFXTable.POPUP_COPY
   |AFXTable.POPUP_PASTE
   |AFXTable.POPUP_INSERT_ROW
   |AFXTable.POPUP_DELETE_ROW
   |AFXTable.POPUP_CLEAR_CONTENTS
   |AFXTable.POPUP_READ_FROM_FILE
)
table.appendClientPopupItem('My Button', None, self,
    self.ID_MY_BUTTON)
FXMAPFUNC(self, SEL_COMMAND, self.ID_MY_BUTTON, MyDB.onCmdMyBtn)

Items in a table that display characters have two sets of colors—the normal color and the selected color. In addition, each item has a background color and a text color. To change these colors, the table widget provides the following controls:

• Item text color

• Item background color

• Selected item text color

• Selected item background color

• Item color (color button) (The color button is described in “Color buttons,” Section 3.1.10.)

If you do not want the colors to change when the user selects an item, you can set the colors used for items that are selected to be the same as the colors used for items that are not selected. This approach is shown in the following example:

itemColor = table.getItemBackColor(1,1)
table.setSelBackColor(itemColor)
itemTextColor = table.getItemTextColor(1,1)
table.setSelTextColor(itemTextColor)

You can set colors using the color name or by specifying RGB values using the FXRGB function. (For a list of valid color names and their corresponding RGB values, see Appendix B, “Colors and RGB values.”) Both methods are illustrated in the following example:

vf = FXVerticalFrame(parent, FRAME_SUNKEN|FRAME_THICK,
    0,0,0,0, 0,0,0,0)
table = AFXTable(vf, 4, 2, 4, 2, None, 0,
    AFXTABLE_NORMAL|AFXTABLE_EDITABLE)
table.setLeadingRows(1)
table.setLeadingRowLabels('Name\tDescription')

table.showHorizontalGrid(True)
table.showVerticalGrid(True)

table.setItemTextColor(1,0, 'Blue')
table.setItemTextColor(1,1, FXRGB(0, 0, 255))

table.setItemBackColor(3,0, 'Pink')
table.setItemBackColor(3,1, FXRGB(255, 192, 203))

You can set a column in a table to be sortable. If a column is set to be sortable and the user clicks on its heading, a graphic will be displayed in the heading that shows the order of the sort. You must write the code that performs the actual sorting in the table—the table itself provides only the graphical feedback in the heading cell. For example:

class MyDB(AFXDataDialog):

    def __init(self):

        ...     

        # Handle clicks in the table.
        FXMAPFUNC(self, SEL_CLICKED, self.ID_TABLE,
                       MyDB.onClickTable)
        ...     

        # Create a table. 
        vf = FXVerticalFrame(
            parent, FRAME_SUNKEN|FRAME_THICK, 0,0,0,0, 0,0,0,0)
        self.sortTable = AFXTable(vf, 4, 3, 4, 3, self,
            self.ID_TABLE, AFXTABLE_NORMAL|AFXTABLE_EDITABLE)
        self.sortTable.setLeadingRows(1)
        self.sortTable.setLeadingRowLabels('Name\tX\tY')
        self.sortTable.setColumnSortable(1, True)
        self.sortTable.setColumnSortable(2, True)
        ...

    def onClickTable(self, sender, sel, ptr):

        status, x, y, buttons = self.sortTable.getCursorPosition()
        column = self.sortTable.getColumnAtX(x)
        row = self.sortTable.getRowAtY(y)

        # Ignore clicks on table headers.
        if row != 0 or column == 0:
            return

        values = []
        index = 1
        for row in range(1, self.sortTable.getNumRows()):
            values.append( (self.sortTable.getItemFloatValue(
                row, column), index) )
            index += 1

        values.sort()
        if self.sortTable.getColumnSortOrder(column) == \
            AFXTable.SORT_ASCENDING:
                values.reverse()

        items = []
        for value, index in values:
            name = self.sortTable.getItemValue(index, 0)
            xValue = self.sortTable.getItemValue(index, 1)
            yValue = self.sortTable.getItemValue(index, 2)
            items.append( (name, xValue, yValue) )

        row = 1
        for name, xValue, yValue in items:
            self.sortTable.setItemValue(row, 0, name)
            self.sortTable.setItemValue(row, 1, xValue)
            self.sortTable.setItemValue(row, 2, yValue)
            row += 1