JClass LiveTable

PreviousNextIndex

Appendix  B

JClass LiveTable Property Listing

Properties of com.klg.jclass.table.JCTable  Properties of com.klg.jclass.table.CellStyleModel

Properties of com.klg.jclass.table.beans.LiveTable  Properties of com.klg.jclass.table.db.jbuilder.JBdbTable

Properties of com.klg.jclass.table.db.datasource.DSdbTable

The following lists summarize all of the JClass LiveTable properties. Each of these properties have two accessor methods: set and get. Methods are instantiated using set(PropertyName), and you can retrieve the current value of any property using the property's get method.

The lists below are organized by the class that their accessor methods are called in, and further by the type of property. The lists show the property, a brief description, and either its enumerable value, defined by JCTableEnum or an example of a value for setting the property. Default values are marked with an asterisk (*).

B.1 Properties of com.klg.jclass.table.JCTable

Name

Description

Values/Examples

AllowCellResize

The AllowCellResize property specifies whether and how an end user is able to resize rows and columns.

JCTableEnum.RESIZE_ALL*

JCTableEnum.RESIZE_NONE

JCTableEnum.RESIZE_COLUMN

JCTableEnum.RESIZE_ROW

AllowResizeBy

This property determines whether row heights and column widths can be resized by labels.

JCTableEnum.RESIZE_BY_LABELS*

JCTableEnum.RESIZE_BY_CELLS

JCTableEnum.RESIZE_BY_ALL

AutoEdit

Determines whether an editor is automatically displayed in a cell when it is entered.

boolean value: default false

AutoScroll

This property sets how the table scrolls when the user moves out of the bounds of the displayed table.

JCTableEnum.AUTO_SCROLL_NONE*

JCTableEnum.AUTO_SCROLL_ROW

JCTableEnum.AUTO_SCROLL_COLUMN

JCTableEnum.AUTO_SCROLL_BOTH

CellBorderWidth

Sets the shadow thickness around each cell.

integer: number of pixels

CharHeight

Height in characters of individual cells.

specific row number,

JCTableEnum.LABEL, or JCTableEnum.ALL, plus the number of characters

CharWidth

Width of column in characters.

specific column number, JCTableEnum.LABEL, or JCTableEnum.ALL, plus the number of characters

ColumnHidden

Determines if the column is hidden.

boolean value: default false

ColumnLabelDisplay

Determines whether the column labels display in the table.

boolean value: default false

ColumnLabelOffset

Distance between column labels and table cells.

pixels (default: 0). For example:

setColumnLabelOffset(4)

ColumnLabel

Placement

Location of the column labels (top or bottom of the table).

JCTableEnum.PLACE_TOP*

JCTableEnum.PLACE_BOTTOM

ColumnSelection

Selects a range of columns.

int column range

Component

Swing and lightweight AWT components in individual cells.

row and column index, component

ComponentBorder

Width

This property determines the spacing between the border of a cell and the cell component.

integer value (pixels)

Cursor

Creates a cursor and determines the cursor type.

Cursor.CROSSHAIR_CURSOR

Cursor.DEFAULT_CURSOR

Cursor.E_RESIZE_CURSOR

Cursor.HAND_CURSOR

Cursor.MOVE_CURSOR

Cursor.N_RESIZE_CURSOR

Cursor.NE_RESIZE_CURSOR

Cursor.NW_RESIZE_CURSOR

Cursor.S_RESIZE_CURSOR

Cursor.SE_RESIZE_CURSOR

Cursor.SW_RESIZE_CURSOR

Cursor.TEXT_CURSOR

Cursor.W_RESIZE_CURSOR

Cursor.WAIT_CURSOR

EditHeightPolicy

Vertical sizing policy for cell editors.

JCTableEnum.EDIT_SIZE_TO_CELL*

JCTableEnum.EDIT_ENSURE_
         MINIMUM_SIZE

JCTableEnum.EDIT_ENSURE_
         PREFERRED_SIZE

EditWidthPolicy

Horizontal sizing policy for cell editors.

JCTableEnum.EDIT_SIZE_TO_CELL*

JCTableEnum.EDIT_ENSURE_

         MINIMUM_SIZE

JCTableEnum.EDIT_ENSURE_

         PREFERRED_SIZE

FocusColor

Determines the color of the focus indicator.

Any java.awt.Color object.

FocusIndicator

This property sets the focus indicator.

JCTableEnum.FOCUS_RECTANGLE*

JCTableEnum.FOCUS_DASHED_

         RECTANGLE

JCTableEnum.FOCUS_NONE

JCTableEnum.FOCUS_HIGHLIGHT

Font

Sets the font for the entire table.

array of colors

Foreground

Sets the foreground color for the entire table.

array of colors

FrameBorder

Sets the border for the frame around the table.

CellBorderModel

FrameBorderWidth

Sets the thickness of the frame around the entire table.

pixels (default:0). For example:

setFrameBorderWidth(5);

FrozenColumn
Placement

Sets the location of all frozen columns within the component display. Changing the placement of frozen columns does not change the location of the columns in the table's internal CellValues.

JCTableEnum.PLACE_LEFT*

JCTableEnum.PLACE_RIGHT

FrozenColumns

Specifies the number of columns from the start of the table that are not horizontally scrollable.

number of columns to freeze. For example: setFrozenColumns(3);

FrozenRow
Placement

Specifies the location of all frozen rows.

JCTableEnum.PLACE_TOP*

JCTableEnum.PLACE_BOTTOM

FrozenRows

Specifies the number of rows from the start of the table that are not vertically scrollable.

number of rows to freeze. For example: setFrozenRows(2);

HorizSBAttachment

Attach point for horizontal scrollbar. When set to SIZE_TO_CELLS, the scrollbar ends at the edge of the visible cells. When set to SIZE_TO_TABLES, the scrollbar is attached to the whole side of the table.

JCTableEnum.SIZE_TO_CELLS*

JCTableEnum.SIZE_TO_TABLE

HorizSBDisplay

Determines when to display horizontal scrollbar.

JCTableEnum.SBDISPLAY_ALWAYS

JCTableEnum.SBDISPLAY_NEVER

JCTableEnum.SBDISPLAY_AS_

         NEEDED*

HorizSBOffset

Distance between the table and horizontal scrollbar in pixels.

integer: number of pixels. For example:

setHorizSBOffset(3);

HorizSBPosition

Position of horizontal scrollbar. When set to POSITION_BY_CELLS, the scrollbar is attached to the visible cells. When set to POSITION_AT_SIDE, the scrollbar is attached to the whole side of the table.

JCTableEnum.POSITION_BY_CELLS*

JCTableEnum.POSITION__AT_SIDE

HorizSBTrack

Determines how the horizontal scrollbar acts during scroll tracking.

JCTableEnum.TRACK_LIVE*

JCTableEnum.TRACK_COLUMN_
         NUMBER

JCTableEnum.TRACK_ROW

HorizSBTrackRow

Determines the row number whose text is displayed when JCTableEnum.TRACK_
ROW
is used with setHorizSBTrack()

JCTableEnum.LABEL

or

integer value (row number's cell data)

JumpScroll

Determines whether the table will visually scroll smoothly or whether the display will `jump' to display the cells scrolled to.

JCTableEnum.JUMP_NONE*

JCTableEnum.JUMP_HORIZONTAL

JCTableEnum.JUMP_VERTICAL

JCTableEnum.JUMP_ALL

LeftColumn

Indicates the non-frozen column at least partially visible at the left side of the window.

integer: column number

MarginHeight

Specifies the distance (in pixels) between the inside edge of the cell border.

integer: pixels. For example: setMarginHeight(4);

MarginWidth

Specifies the distance (in pixels) between the inside edge of the cell border and the left/right edge of the cell's contents.

integer: pixels. For example:

setMarginWidth(3);

MaxHeight

Sets the maximum number of pixels for a row's height.

integer value (pixels)

MaxWidth

Sets the maximum number of pixels for a column's width.

integer value (pixels)

MinCellVisibility

Minimum visible percentage of a cell.

integer: 1 to 100

MinHeight

Sets the minimum number of pixels for a row's height.

integer value (pixels)

MinWidth

Sets the minimum number of pixels for column's width.

integer value (pixels)

PixelHeight

Row height in pixels. This property controls the height unless set to JCTableEnum.NOVALUE.

integer value (pixels)
Special values:

JCTableEnum.VARIABLE

JCTableEnum.AS_IS

JCTableEnum.VARIABLE_ESTIMATE

PixelWidth

Column width in pixels. This property controls the width unless set to JCTableEnum.NOVALUE.

integer value (pixels)
Special values:

JCTableEnum.VARIABLE

JCTableEnum.AS_IS

JCTableEnum.VARIABLE_ESTIMATE

PopupMenuEnabled

Determines whether or not to display the table popup menu.

boolean value

default: false for LiveTable

default: true for JBdbTable and DSdbTable

RepaintEnabled

Sets whether the table should be redrawn and recomputed whenever one of its properties is set.

boolean value (default: true)

ResizeEven

Specifies that when a user resizes a row or column, all of the rows or columns also resize the same amount.

boolean value (default: false)

ResizeInteractive

Determines if a table is repainted to reflect column width or row height changes if they are resized interactively.

boolean value (default: false)

RowHidden

Determines if the row is hidden.

boolean value (default: false)

RowLabelDisplay

This property has a boolean value to determine whether the row labels display in the table

boolean value (default: true)

RowLabelOffset

Offset between row labels and table.

integer: number of pixels

RowLabelPlacement

Location of the row labels.

JCTableEnum.PLACE_LEFT*

JCTableEnum.PLACE_RIGHT

RowSelection

Selects a range of rows.

integer range

SelectIncludeLabels

Sets the selection behavior for row and column labels. When true, full column or row selections do not change the visible properties of the label. When false, the row or column label is changed.

boolean (default: true)

SelectedBackground

Background color for cells that have been selected. The default is the cells' foreground color.

Color value. For example:

setSelectedBackground(Color.

         yellow);

SelectedBackground
Mode

Sets the table's background color for selected cells.

JCTableEnum.USE_SELECTED_

         BACKGROUND

JCTableEnum.USE_CELL_

         BACKGROUND

JCTableEnum.USE_CELL_

         FOREGROUND

SelectedCells

List of selected cells.

Vector or JCCellRange

SelectedForeground

Foreground color for cells that have been selected. The default is the cells' background color.

Color value. For example:

setSelectedForeground

         (Color.blue);

SelectedForeground
Mode

Sets the table's foreground color for selected cells.

JCTableEnum.USE_SELECTED_

         FOREGROUND

JCTableEnum.USE_CELL_

         BACKGROUND

JCTableEnum.USE_CELL_

         FOREGROUND

SelectionModel

Specifies the mode for selecting, based on cells, rows, or columns.

SelectionModel

SelectionPolicy

Sets the type of allowable selection.

JCTableEnum.SELECT_NONE

JCTableEnum.SELECT_SINGLE

JCTableEnum.SELECT_RANGE

JCTableEnum.SELECT_MULTIRANGE

SeriesDataSorted

Specifies if series are sorted when the table is sorted. If set as true, the series information sorts with the table data.

boolean (default: true)

StoreImageEnabled

Determines whether an image of the table is maintained off-screen.

boolean (default: false)

TopRow

Indicates the non-frozen row at least partially visible at the top of the table.

integer: row number

TrackBackground

Determines the background color of the track component.

Color value

TrackCursor

Determines whether the cursor changes.

boolean (default: true)

TrackForeground

Determines the foreground color of the track component.

Color value

TrackSize

Returns the size of the track component.

Dimension value

TraverseCycle

Specifies that when a user traverses to past the top, bottom, left, or right of the table, the traversal wraps to the opposite side.

boolean (default: true)

VariableEstimate
Count

Sets the number of cells to use in estimating variable pixel calculations.

default: JCTableEnum.ALL

VertSBAttachment

Attach point for vertical scrollbar. When set to SIZE_TO_CELLS, the scrollbar ends at the edge of the visible cells. When set to SIZE_TO_TABLE, the scrollbar is attached to the whole side of the table.

JCTableEnum.SIZE_TO_CELLS

JCTableEnum.SIZE_TO_TABLE

VertSBDisplay

Determines when to display vertical scrollbar.

JCTableEnum.SBDISPLAY_AS_

         NEEDED*

JCTableEnum.SBDISPLAY_ALWAYS

JCTableEnum.SBDISPLAY_NEVER

VertSBOffset

Distance between the table and vertical scrollbar.

integer: number of pixels. For example:

setVertSBOffset(4);

VertSBPosition

Position of vertical scrollbar. When set to POSITION_BY_CELLS, the scrollbar is attached to the visible cells. When set to POSITION__AT_SIDE, the scrollbar is attached to the whole side of the table.

JCTableEnum.POSITION_BY_CELLS

JCTableEnum.POSITION_AT_SIDE

VertSBTrack

This property determines how the vertical scrollbar acts during scroll tracking.

JCTableEnum.TRACK_LIVE*

JCTableEnum.TRACK_ROW_NUMBER

JCTableEnum.TRACK_COLUMN

VertSBTrackColumn

Determines the column number whose text is displayed when JCTableEnum.TRACK_

ROW is used with setVertSBTrack().

JCTableEnum.LABEL

or

integer value (row number's cell data)

VisibleColumns

Sets the number of columns used to determine the initial table size. This value is not updated when columns or the table are resized.

integer: number of visible columns

VisibleRows

Sets the number of rows used to determine the initial table size. This value is not updated when rows or the table are resized.

integer: number of visible rows

B.2 Properties of com.klg.jclass.table.CellStyleModel

Name

Description

Values/Examples

Background

Sets the background color of the cell.

Color value

CellBorder

Sets the cell border object for the cell.

CellBorderModel

CellBorderColor

Sets the cell's border color.

Color value

CellBorderColorMode

Sets the mode used to determine cell border color.

JCTableEnum.USE_CELL_
         BORDER_COLOR

JCTableEnum.BASE_ON_

         BACKGROUND

JCTableEnum.BASE_ON_

         FOREGROUND

CellBorderSides

Visible border sides (defined by CellBorderType) for individual cells.

JCTableEnum.BORDERSIDE_NONE

JCTableEnum.BORDERSIDE_ALL*

JCTableEnum.BORDERSIDE_LEFT

JCTableEnum.BORDERSIDE_

         RIGHT

JCTableEnum.BORDERSIDE_TOP

JCTableEnum.BORDERSIDE_

         BOTTOM

ClipHints

Determines whether clip arrows are shown, and where, when the contents of the cell do not fit in the cell frame.

JCTableEnum.SHOW_NONE

JCTableEnum.SHOW_HORIZONTAL

JCTableEnum.SHOW_VERTICAL

JCTableEnum.SHOW_ALL

Editable

Editable attribute for individual cells.

boolean value (default: true)

Font

Sets the cell's font.

Font value

Foreground

Sets the foreground color of the cell.

Color value

HorizontalAlignment

Sets the horizontal alignment for the contents of the cell.

JCTableEnum.LEFT*

JCTableEnum.CENTER

JCTableEnum.RIGHT

RepeatBackground

Determines if the background color repeats for rows or columns.

JCTableEnum.REPEAT_NONE*

JCTableEnum.REPEAT_ROW

JCTableEnum.REPEAT_COLUMN

RepeatBackground

Colors

Repeats pattern for background colors.

array of colors

RepeatForeground

Determines if the foreground color repeats for rows or columns.

JCTableEnum.REPEAT_NONE*

JCTableEnum.REPEAT_ROW

JCTableEnum.REPEAT_COLUMN

RepeatForeground

Colors

Repeats pattern for foreground colors.

array of colors

Traversable

Allows traversal of individual cells.

boolean (default: true)

VerticalAlignment

Sets the vertical alignment for the contents of the cell.

JCTableEnum.TOP*

JCTableEnum.CENTER

JCTableEnum.RIGHT

B.3 Properties of com.klg.jclass.table.beans.LiveTable

Name

Description

about

Displays component version and contact information.

allowCellResize

Determines whether end-user can resize cells at run-time.

allowResizeBy

Sets how cells can be resized.

autoEdit

Determines whether the table automatically displays an editor when entering a cell.

autoScroll

Determines whether table scrolls during selection/traversal.

cellBorderWidth

Specifies width of cell/label borders.

cellSize

Specifies row heights and column widths.

data

Specifies table data, data source, and row/column labels.

editHeightPolicy

Determines height control of cell editing components.

editWidthPolicy

Determines width control of cell editing components.

frameBorderType

Specifies frame border type.

frameBorderWidth

Specifies frame border width.

frozenCellLayout

Determines the position of frozen rows/columns.

focusColor

Sets the color of the focus indicator.

focusIndicator

Determines the type of focus indicator used.

jumpScroll

Determines whether jump scrolling is turned on.

labelLayout

Determines the position of row/column labels.

leftColumn

Specifies first column displayed on screen.

marginHeight

Specifies top and bottom cell margins.

marginWidth

Specifies left and right cell margins.

minCellVisibility

Determines amount of cell scrolled into view during traversal.

popupMenuEnabled

Determines whether the pop-up menu is enabled.

resizeEven

Determines whether cell resizing is applied evenly to non-label cells.

resizeInteractive

Determines whether cell resizing is interactively displayed.

sBLayout

Determines the space between scrollbars and cells.

selectedBackground

Determines the background color of selected cells.

selectedForeground

Determines the foreground color of selected cells.

selectIncludeLabels

Determines whether selection includes row and column labels.

selectionPolicy

Determines type of cell selection allowed.

spannedCells

Specifies cell ranges to treat as spanned cells.

styles

Sets the styles property, which defines visual aspects of the table.

swingDataModel

Sets the table's data source to use a specified Swing TableModel object, instead of using the data property.

topRow

Specifies first row displayed on screen.

trackCursor

Sets whether the mouse pointer movements are tracked.

traverseCycle

Determines whether cell traversal cycles on the same row or moves to the next row.

B.4 Properties of com.klg.jclass.table.db.jbuilder.JBdbTable

Name

Description

about

Displays component version and contact information.

allowCellResize

Determines whether end-user can resize cells at run-time.

allowResizeBy

Sets how cells can be resized.

autoEdit

Determines whether the table automatically displays an editor when entering a cell.

autoScroll

Determines whether table scrolls during selection/traversal.

cellBorderWidth

Specifies width of cell/label borders.

cellSize

Specifies row heights and column widths.

dataSet

Specifies the table data source.

editHeightPolicy

Determines height control of cell editing components.

editWidthPolicy

Determines width control of cell editing components.

frameBorderType

Specifies frame border type.

frameBorderWidth

Specifies frame border width.

frozenCellLayout

Determines the position of frozen rows/columns.

focusColor

Sets the color of the focus indicator.

focusIndicator

Determines the type of focus indicator used.

labelLayout

Determines the position of row/column labels.

leftColumn

Specifies first column displayed on screen.

marginHeight

Specifies top and bottom cell margins.

marginWidth

Specifies left and right cell margins.

minCellVisibility

Determines amount of cell scrolled into view during traversal.

popupMenuEnabled

Determines whether the pop-up menu is enabled.

resizeEven

Determines whether cell resizing is applied evenly to non-label cells.

resizeInteractive

Determines whether cell resizing is interactively displayed.

sBLayout

Determines the space between scrollbars and cells.

selectedBackground

Determines the background color of selected cells.

selectedForeground

Determines the foreground color of selected cells.

selectIncludeLabels

Determines whether selection includes row and column labels.

selectionPolicy

Determines type of cell selection allowed.

spannedCells

Specifies cell ranges to treat as spanned cells.

styles

Sets the styles property, which defines visual aspects of the table.

swingDataModel

Sets the table's data source to use a specified Swing TableModel object, instead of using the data property.

topRow

Specifies first row displayed on screen.

trackCursor

Sets whether the mouse pointer movements are tracked.

traverseCycle

Determines whether cell traversal cycles on the same row or moves to the next row.

B.5 Properties of com.klg.jclass.table.db.datasource.DSdbTable

Name

Description

about

Displays component version and contact information.

allowCellResize

Determines whether end-user can resize cells at run-time.

allowResizeBy

Sets how cells can be resized.

autoEdit

Determines whether the table automatically displays an editor when entering a cell.

autoScroll

Determines whether table scrolls during selection/traversal.

cellBorderWidth

Specifies width of cell/label borders.

cellSize

Specifies row heights and column widths.

dataBinding

Specifies the table data source.

editHeightPolicy

Determines height control of cell editing components.

editWidthPolicy

Determines width control of cell editing components.

frameBorderType

Specifies frame border type.

frameBorderWidth

Specifies frame border width.

frozenCellLayout

Determines the position of frozen rows/columns.

focusColor

Sets the color of the focus indicator.

focusIndicator

Determines the type of focus indicator used.

labelLayout

Determines the position of row/column labels.

leftColumn

Specifies first column displayed on screen.

marginHeight

Specifies top and bottom cell margins.

marginWidth

Specifies left and right cell margins.

minCellVisibility

Determines amount of cell scrolled into view during traversal.

popupMenuEnabled

Determines whether the pop-up menu is enabled.

resizeEven

Determines whether cell resizing is applied evenly to non-label cells.

resizeInteractive

Determines whether cell resizing is interactively displayed.

sBLayout

Determines the space between scrollbars and cells.

selectedBackground

Determines the background color of selected cells.

selectedForeground

Determines the foreground color of selected cells.

selectIncludeLabels

Determines whether selection includes row and column labels.

selectionPolicy

Determines type of cell selection allowed.

styles

Sets the styles property, which defines visual aspects of the table.

swingDataModel

Sets the table's data source to use a specified Swing TableModel object, instead of using the data property.

topRow

Specifies first row displayed on screen.

trackCursor

Sets whether the mouse pointer movements are tracked.

traverseCycle

Determines whether cell traversal cycles on the same row or moves to the next row.

useDatasourceEditable

Determines whether the editable column state is defined by the data source or the table.


PreviousNextIndex