Top Description Fields Constructors Methods
org.eclipse.swt.custom

public Class TableCursor

extends Canvas
Class Inheritance
Imports
org.eclipse.swt.*, org.eclipse.swt.accessibility.*, org.eclipse.swt.events.*, org.eclipse.swt.graphics.*, org.eclipse.swt.widgets.*
A TableCursor provides a way for the user to navigate around a Table using the keyboard. It also provides a mechanism for selecting an individual cell in a table.

For a detailed example of using a TableCursor to navigate to a cell and then edit it see https://github.com/eclipse-platform/eclipse.platform.swt/tree/master/examples/org.eclipse.swt.snippets/src/org/eclipse/swt/snippets/Snippet96.java .

Styles:
BORDER
Events:
Selection, DefaultSelection
Since
2.0
See Also
TableCursor snippets, Sample code and further information

Field Summary

Modifier and TypeField and Description
pack-priv Color
background

pack-priv static final int
BACKGROUND

Hides org.eclipse.swt.widgets.Widget.BACKGROUND.

pack-priv TableColumn
column

pack-priv Listener
disposeColumnListener

pack-priv Listener
disposeItemListener

pack-priv Color
foreground

pack-priv static final int
FOREGROUND

Hides org.eclipse.swt.widgets.Widget.FOREGROUND.

pack-priv Listener
listener

pack-priv Listener
resizeListener

pack-priv TableItem
row

pack-priv Table
table

pack-priv Listener
tableListener

Constructor Summary

AccessConstructor and Description
public
TableCursor(Table
a Table control which will be the parent of the new instance (cannot be null)
parent, int
the style of control to construct
style)

Constructs a new instance of this class given its parent table and a style value describing its behavior and appearance.

Method Summary

Modifier and TypeMethod and Description
pack-priv void
_resize()

public void
addSelectionListener(SelectionListener
the listener which should be notified when the user changes the receiver's selection
listener)

Adds the listener to the collection of listeners who will be notified when the user changes the receiver's selection, by sending it one of the messages defined in the SelectionListener interface.

public Color

Returns:

the receiver's background color
getBackground()

Overrides org.eclipse.swt.widgets.Control.getBackground.

Returns the background color that the receiver will use to draw.
public int

Returns:

the column index for the current position
getColumn()

Returns the index of the column over which the TableCursor is positioned.

public Color

Returns:

the receiver's foreground color
getForeground()

Overrides org.eclipse.swt.widgets.Control.getForeground.

Returns the foreground color that the receiver will use to draw.
public TableItem

Returns:

the item for the current position, or null if none
getRow()

Returns the row over which the TableCursor is positioned.

pack-priv void
keyDown(Event event)

pack-priv void
onDispose(Event event)

pack-priv void
paint(Event event)

public void
removeSelectionListener(SelectionListener
the listener which should no longer be notified
listener)

Removes the listener from the collection of listeners who will be notified when the user changes the receiver's selection.

public void
setBackground(Color
the new color (or null)
color)

Overrides org.eclipse.swt.widgets.Control.setBackground.

Sets the receiver's background color to the color specified by the argument, or to the default system color for the control if the argument is null.
public void
setForeground(Color
the new color (or null)
color)

Overrides org.eclipse.swt.widgets.Control.setForeground.

Sets the receiver's foreground color to the color specified by the argument, or to the default system color for the control if the argument is null.
pack-priv void
setRowColumn(int row, int column, boolean notify)

pack-priv void
setRowColumn(TableItem row, TableColumn column, boolean notify)

public void
setSelection(int
the index of the row for the cell to select
row, int
the index of column for the cell to select
column)

Positions the TableCursor over the cell at the given row and column in the parent table.

public void
setSelection(TableItem
the TableItem of the row for the cell to select
row, int
the index of column for the cell to select
column)

Positions the TableCursor over the cell at the given row and column in the parent table.

public void
setVisible(boolean
the new visibility state
visible)

Overrides org.eclipse.swt.widgets.Control.setVisible.

Marks the receiver as visible if the argument is true, and marks it invisible otherwise.
pack-priv void
tableFocusIn(Event event)

pack-priv void
tableMouseDown(Event event)

pack-priv void
unhookRowColumnListeners()

Inherited from org.eclipse.swt.widgets.Canvas:
drawBackgroundgetCaretgetIMEscrollsetCaretsetFontsetIME

Field Detail

backgroundback to summary
pack-priv Color background
BACKGROUNDback to summary
pack-priv static final int BACKGROUND

Hides org.eclipse.swt.widgets.Widget.BACKGROUND.

columnback to summary
pack-priv TableColumn column
disposeColumnListenerback to summary
pack-priv Listener disposeColumnListener
disposeItemListenerback to summary
pack-priv Listener disposeItemListener
foregroundback to summary
pack-priv Color foreground
FOREGROUNDback to summary
pack-priv static final int FOREGROUND

Hides org.eclipse.swt.widgets.Widget.FOREGROUND.

listenerback to summary
pack-priv Listener listener
resizeListenerback to summary
pack-priv Listener resizeListener
rowback to summary
pack-priv TableItem row
tableback to summary
pack-priv Table table
tableListenerback to summary
pack-priv Listener tableListener

Constructor Detail

TableCursorback to summary
public TableCursor(Table parent, int style)

Constructs a new instance of this class given its parent table and a style value describing its behavior and appearance.

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Parameters
parent:Table

a Table control which will be the parent of the new instance (cannot be null)

style:int

the style of control to construct

Exceptions
IllegalArgumentException:
  • ERROR_NULL_ARGUMENT - if the parent is null
SWTException:
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
  • ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass
See Also
SWT#BORDER, Widget#checkSubclass(), Widget#getStyle()

Method Detail

_resizeback to summary
pack-priv void _resize()
addSelectionListenerback to summary
public void addSelectionListener(SelectionListener listener)

Adds the listener to the collection of listeners who will be notified when the user changes the receiver's selection, by sending it one of the messages defined in the SelectionListener interface.

When widgetSelected is called, the item field of the event object is valid. If the receiver has SWT.CHECK style set and the check selection changes, the event object detail field contains the value SWT.CHECK. widgetDefaultSelected is typically called when an item is double-clicked.

Parameters
listener:SelectionListener

the listener which should be notified when the user changes the receiver's selection

Exceptions
IllegalArgumentException:
  • ERROR_NULL_ARGUMENT - if the listener is null
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
See Also
SelectionListener, SelectionEvent, removeSelectionListener(SelectionListener)
getBackgroundback to summary
public Color getBackground()

Overrides org.eclipse.swt.widgets.Control.getBackground.

Returns the background color that the receiver will use to draw.

Returns:Color

the receiver's background color

Annotations
@Override
getColumnback to summary
public int getColumn()

Returns the index of the column over which the TableCursor is positioned.

Returns:int

the column index for the current position

Exceptions
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
getForegroundback to summary
public Color getForeground()

Overrides org.eclipse.swt.widgets.Control.getForeground.

Returns the foreground color that the receiver will use to draw.

Returns:Color

the receiver's foreground color

Annotations
@Override
getRowback to summary
public TableItem getRow()

Returns the row over which the TableCursor is positioned.

Returns:TableItem

the item for the current position, or null if none

Exceptions
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
keyDownback to summary
pack-priv void keyDown(Event event)
onDisposeback to summary
pack-priv void onDispose(Event event)
paintback to summary
pack-priv void paint(Event event)
removeSelectionListenerback to summary
public void removeSelectionListener(SelectionListener listener)

Removes the listener from the collection of listeners who will be notified when the user changes the receiver's selection.

Parameters
listener:SelectionListener

the listener which should no longer be notified

Exceptions
IllegalArgumentException:
  • ERROR_NULL_ARGUMENT - if the listener is null
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
Since
3.0
See Also
SelectionListener, addSelectionListener(SelectionListener)
setBackgroundback to summary
public void setBackground(Color color)

Overrides org.eclipse.swt.widgets.Control.setBackground.

Sets the receiver's background color to the color specified by the argument, or to the default system color for the control if the argument is null.

Note

This operation is a hint and may be overridden by the platform. For example, on Windows the background of a Button cannot be changed.

Parameters
color:Color

the new color (or null)

Annotations
@Override
Exceptions
IllegalArgumentException:
  • ERROR_INVALID_ARGUMENT - if the argument has been disposed
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
setForegroundback to summary
public void setForeground(Color color)

Overrides org.eclipse.swt.widgets.Control.setForeground.

Sets the receiver's foreground color to the color specified by the argument, or to the default system color for the control if the argument is null.

Note

This operation is a hint and may be overridden by the platform.

Parameters
color:Color

the new color (or null)

Annotations
@Override
Exceptions
IllegalArgumentException:
  • ERROR_INVALID_ARGUMENT - if the argument has been disposed
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
setRowColumnback to summary
pack-priv void setRowColumn(int row, int column, boolean notify)
setRowColumnback to summary
pack-priv void setRowColumn(TableItem row, TableColumn column, boolean notify)
setSelectionback to summary
public void setSelection(int row, int column)

Positions the TableCursor over the cell at the given row and column in the parent table.

Parameters
row:int

the index of the row for the cell to select

column:int

the index of column for the cell to select

Exceptions
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
setSelectionback to summary
public void setSelection(TableItem row, int column)

Positions the TableCursor over the cell at the given row and column in the parent table.

Parameters
row:TableItem

the TableItem of the row for the cell to select

column:int

the index of column for the cell to select

Exceptions
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
setVisibleback to summary
public void setVisible(boolean visible)

Overrides org.eclipse.swt.widgets.Control.setVisible.

Doc from org.eclipse.swt.widgets.Control.setVisible.

Marks the receiver as visible if the argument is true, and marks it invisible otherwise.

If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, marking it visible may not actually cause it to be displayed.

Parameters
visible:boolean

the new visibility state

Annotations
@Override
tableFocusInback to summary
pack-priv void tableFocusIn(Event event)
tableMouseDownback to summary
pack-priv void tableMouseDown(Event event)
unhookRowColumnListenersback to summary
pack-priv void unhookRowColumnListeners()