org.eclipse.nebula.widgets.compositetable

Interface IRowFocusListener

All Known Implementing Classes:

AbstractSelectableRow, RowFocusAdapter

public interface IRowFocusListener

Interface IRowFocusListener. An interface for objects that want to listen to and have the possibility of vetoing row change events on a CompositeTable. This interface is not intended to be implemented except within the CompositeTable implementation. Extend RowFocusAdapter instead.

Method Summary

Modifier and Type	Method and Description
void	arrive(CompositeTable sender, int currentObjectOffset, org.eclipse.swt.widgets.Control newRow) Method arrive.
void	depart(CompositeTable sender, int currentObjectOffset, org.eclipse.swt.widgets.Control row) Method depart.
boolean	requestRowChange(CompositeTable sender, int currentObjectOffset, org.eclipse.swt.widgets.Control row) Method requestRowChange.

Method Detail

requestRowChange

boolean requestRowChange(CompositeTable sender,
                         int currentObjectOffset,
                         org.eclipse.swt.widgets.Control row)

Method requestRowChange. Requests permission to change rows. This method is called immediately before a row change occurs. Listeners must return true to grant permission for the row change to occur or return false to veto it. If any listener returns false, the entire row change operation is aborted.

Parameters:

sender - The CompositeTable sending the event.

currentObjectOffset - The offset of the current object in the data structure.

row - The row control that is losing focus.

Returns:

true to permit the row change to occur; false otherwise.

depart

void depart(CompositeTable sender,
            int currentObjectOffset,
            org.eclipse.swt.widgets.Control row)

Method depart. Called after requstRowChange has been called to indicate that the focus is departing the specified row.

Parameters:

sender -

currentObjectOffset -

row -

arrive

void arrive(CompositeTable sender,
            int currentObjectOffset,
            org.eclipse.swt.widgets.Control newRow)

Method arrive. Notifies receiver that the current row has just been changed.

Parameters:

sender - The CompositeTable sending the event.

currentObjectOffset - The 0-based offset to the row that should be populated

newRow - The actual SWT row object that needs to be populated with data