AT&T Home | AT&T Labs | Research
AT&T Labs, Inc. - Research

The Yoix® Scripting Language

Home | What's New | Grammar | Documentation | Download | License | YChart | YDAT | YWAIT | Byzgraf | FAQs
JTableColumn typedict
 
A JTableColumn provides a means for specifying and describing the columns in a JTable. Once a column is added to a table, its fields become read-only. The JTable built-in, action, provides ways to write table column fields. Yoix programs normally interact with a JTableColumn by reading or writing the following fields:
alignment An int that reflects the column alignment by means of one of the keyword constants: LEFT, RIGHT or CENTER.
altalignment An int that reflects the column header alignment by means of one of the keyword constants: LEFT, RIGHT or CENTER.
altbackground A Color used to paint the background color of the column header.
altfont A Font, or font name if it is a String, used to paint the text strings displayed by the table header.
altforeground A Color used to paint the foreground color of the column header.
attributes A Dictionary used to determine how numeric fields are displayed. See the SET_COLUMN_FIELD option of the action builtin in the JTable documentation for a description of the available attributes.
background A Color that reflects the background color of the column data.
cellcolors An Array containing from one to four elements that are used to set the background and foreground colors of the column cells. The first and second elements, if present, set the background and foreground when cells are not selected, while the third and fourth elements, if present, set the background and foreground when cells are selected.

Each element can be a Color or an Array of colors. When a single color is provided, it applies to all rows within the column. When an array of colors is provided, each array element applies to a table row in sequence. If there are more rows than array elements, the sequencing restarts at the beginning of the array.

celleditor A JComboBox that is used for selecting and editing values. A NULL indicates the default editor, a JTextField will be used.
disabledbackground A Color used to set the disabled background color.
disabledforeground A Color used to set the disabled foreground color.
edit An int or Array of integers used to set the editability of cells in the column.
editbackground A Color used as the edit background color.
editforeground A Color used as the edit foreground color, usually the font color.
font A Font, or font name if it is a String, used to paint the text of the table data.
foreground A Color used to paint the foreground, usually the font color, table data when the foreground component of cellcolors is NULL.
header A String used as the column header.
headericons An Image, an Array of images, or NULL. When the value is a single image, it is used as the header icon for this column regardless of the sort state of the column. When an array of images is supplied, the images correspond to the unsorted, increasing or decreasing sort state of the column, respectively.
selectionbackground A Color used as the selection background color.
selectionforeground A Color used as the selection foreground color, usually the font color.
selectionmark A String (e.g., "\x25BA") that is automatically displayed in the cells that are currently selected and removed from the cells that are not selected.
state A read-only int that is less that zero when the column is sorted in descending order, greater than zero when the column is sorted in ascending order and zero when the column is unsorted.
tag A String that can be used to refer to the column in lieu of the ordinal column position when using the JTable action builtin.
text A String that describes the table data in the column. Row cells are delimited by the JTable outputfilter field delimiter.
tooltiptext A String or an Array of strings which is displayed as tooltip text within the column when tooltips are active. A string or a single element array affects the whole column, while an array with multiple elements affects the row cells in the column in sequence with no cycling.
type An int that describes the data type displayed in the column. Types are: BOOLEAN_TYPE, DATE_TYPE, DOUBLE_TYPE, HISTOGRAM_TYPE, ICON_TYPE, INTEGER_TYPE, MONEY_TYPE, PERCENT_TYPE, STRING_TYPE TEXT_TYPE and TIMER_TYPE.
value A read-only int indicating the data model position of this column.
values An Array of the data values in the table using the data model perspective.
view A read-only int indicating the table view position of this column.
views A read-only Array of the data values in the table using the table view perspective.
visible An int indicating whether the column is invisible (zero) or visible (non-zero).
width A Number giving the width of the column based on 72 units per inch. Layout managers and table sizing constraints may cause the actual column width to differ from a value assigned via this field.
 
 See Also:   JTable

 

Yoix is a registered trademark of AT&T Inc.