Interface TableCellCore

All Superinterfaces:

Comparable, TableCell

All Known Subinterfaces:

TableCellSWT

All Known Implementing Classes:

FakeTableCell, TableCellPainted, TableCellSWTBase

public interface TableCellCore
extends TableCell, Comparable

Core Table Cell functions are those available to plugins plus some core-only functions. The core-only functions are listed here.

See Also:

• invalid reference

  com.biglybt.ui.swt.views.table.impl.TableCellImpl

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TOOLTIPLISTENER_HOVER
static final int	TOOLTIPLISTENER_HOVERCOMPLETE

Method Summary

Modifier and Type	Method	Description
void	dispose()	dispose of the cell
int	getCursorID()	Get the cursor ID we are currently using XXX Should NOT be SWT.CURSOR_ constants!
Object	getDefaultToolTip()
String	getObfuscatedText()	Return the text used when generating diagnostics
TableColumnCore	getTableColumnCore()
TableRowCore	getTableRowCore()	Retrieve the row that this cell belongs to
boolean	getVisuallyChangedSinceRefresh()	Returns whether the cell has visually changed since the last refresh call.
void	invalidate(boolean bMustRefresh)
void	invokeMenuListeners(TableCellMenuEvent event)
void	invokeMouseListeners(TableCellMouseEvent event)	Trigger all the mouse listeners that have been addded to this cell
void	invokeToolTipListeners(int type)	Trigger all the tooltip listeners that have been added to this cell
void	invokeVisibilityListeners(int visibility, boolean invokeColumnListeners)	Trigger all the visibility listeners that have been added to this cell.
boolean	isMouseOver()
boolean	isUpToDate()	Returns whether the cell will need updating when it's visible again
void	locationChanged()	Location of the cell has changed
boolean	needsPainting()	Retrieve whether the cell need any paint calls (graphic)
void	redraw()
boolean	refresh()	Refresh the cell, including graphic types
boolean	refresh(boolean bDoGraphics)	Refresh the cell
boolean	refresh(boolean bDoGraphics, boolean bRowVisible)	Refresh the cell.
boolean	refresh(boolean bDoGraphics, boolean bRowVisible, boolean bCellVisible)	Refresh the cell.
void	refreshAsync()
boolean	setCursorID(int cursorID)	Set the cursor ID that should be used for the cell
void	setDefaultToolTip(Object tt)	Sets tooltip to be shown in absence of an explicit one
void	setUpToDate(boolean upToDate)	Sets whether the cell will need updating when it's visible again

Methods inherited from interface Comparable

compareTo

Methods inherited from interface TableCell

addDisposeListener, addListeners, addMenuListener, addMouseListener, addRefreshListener, addToolTipListener, getBackground, getBackgroundGraphic, getClipboardText, getData, getDataSource, getForeground, getGraphic, getHeight, getMarginHeight, getMarginWidth, getMaxLines, getMouseOffset, getNumeric, getSortValue, getTableColumn, getTableID, getTableRow, getText, getTextEquivalent, getTextSupplier, getToolTip, getWidth, invalidate, isDisposed, isSecondarySortEnabled, isShown, isValid, removeDisposeListener, removeMenuListener, removeMouseListener, removeRefreshListener, removeToolTipListener, setData, setFillCell, setForeground, setForeground, setForegroundToErrorColor, setGraphic, setMarginHeight, setMarginWidth, setNumeric, setSortValue, setSortValue, setSortValue, setText, setText, setTextEquivalent, setToolTip, useSimpleSortValue

Field Details

TOOLTIPLISTENER_HOVER

static final int TOOLTIPLISTENER_HOVER

See Also:

• Constant Field Values

TOOLTIPLISTENER_HOVERCOMPLETE

static final int TOOLTIPLISTENER_HOVERCOMPLETE

See Also:

• Constant Field Values

Method Details

invalidate

void invalidate(boolean bMustRefresh)

refresh

boolean refresh(boolean bDoGraphics)

Refresh the cell

Parameters:

bDoGraphics - Whether to update graphic cells

refresh

boolean refresh()

Refresh the cell, including graphic types

refresh

boolean refresh(boolean bDoGraphics,
 boolean bRowVisible,
 boolean bCellVisible)

Refresh the cell. This method overide takes a bRowVisible paramater and a bCellVisible parameter in order to reduce the number of calls to TableRow.isVisible() and calculations of cell visibility.

Parameters:

bDoGraphics - Whether to update graphic cells

bRowVisible - Assumed visibility state of row

bCellVisible - Assumed visibility state of the cell

refresh

boolean refresh(boolean bDoGraphics,
 boolean bRowVisible)

Refresh the cell. This method override takes a bRowVisible parameter in order to reduce the number of calls to TableRow.isVisible() in cases where multiple cells on the same row are being refreshed.

Parameters:

bDoGraphics - Whether to update graphic cells

bRowVisible - Visibility state of row

dispose

void dispose()

dispose of the cell

needsPainting

boolean needsPainting()

Retrieve whether the cell need any paint calls (graphic)

Returns:

whether the cell needs painting

locationChanged

void locationChanged()

Location of the cell has changed

getTableRowCore

TableRowCore getTableRowCore()

Retrieve the row that this cell belongs to

Returns:

the row that this cell belongs to

getTableColumnCore

TableColumnCore getTableColumnCore()

invokeToolTipListeners

void invokeToolTipListeners(int type)

Trigger all the tooltip listeners that have been added to this cell

Parameters:

type - TOOLTIPLISTENER_HOVER, TOOLTIPLISTENER_HOVERCOMPLETE

invokeMouseListeners

void invokeMouseListeners(TableCellMouseEvent event)

Trigger all the mouse listeners that have been addded to this cell

Parameters:

event - event to trigger

invokeMenuListeners

void invokeMenuListeners(TableCellMenuEvent event)

invokeVisibilityListeners

void invokeVisibilityListeners(int visibility,
 boolean invokeColumnListeners)

Trigger all the visibility listeners that have been added to this cell.

Parameters:

visibility - See TableCellVisibilityListener.VISIBILITY_* constants

setUpToDate

void setUpToDate(boolean upToDate)

Sets whether the cell will need updating when it's visible again

Parameters:

upToDate -

isUpToDate

boolean isUpToDate()

Returns whether the cell will need updating when it's visible again

Returns:

getObfuscatedText

String getObfuscatedText()

Return the text used when generating diagnostics

Returns:

getCursorID

int getCursorID()

Get the cursor ID we are currently using XXX Should NOT be SWT.CURSOR_ constants!

Returns:

setCursorID

boolean setCursorID(int cursorID)

Set the cursor ID that should be used for the cell

Parameters:

cursor_hand -

Returns:

changed

isMouseOver

boolean isMouseOver()

Since:

3.0.1.7

getVisuallyChangedSinceRefresh

boolean getVisuallyChangedSinceRefresh()

Returns whether the cell has visually changed since the last refresh call. Could be used to prevent a refresh, or refresh early.

Returns:

visually changed since refresh state

refreshAsync

void refreshAsync()

Since:

3.0.5.3

redraw

void redraw()

Since:

3.1.1.1

setDefaultToolTip

void setDefaultToolTip(Object tt)

Sets tooltip to be shown in absence of an explicit one

Parameters:

str -

getDefaultToolTip

Object getDefaultToolTip()