com.klg.jclass.higrid
Class HiGridAction

java.lang.Object
  |
  +--com.klg.jclass.higrid.HiGridAction

All Implemented Interfaces:

Serializable

public class HiGridAction

extends Object

implements Serializable

HiGridAction is responsible for defining a mapping from a user event to an action performed on HiGrid. For example, HiGridAction can be used to map a Control LeftClick to a selection event.

See Also:

Serialized Form

Field Summary

protected int	action action property.
static int	CANCEL_EDIT_ACTION Action constant for cancelling all edits in the current editor.
static int	CLOSE_TABLE_ACTION Action constant for collapsing the current row.
static int	COLUMN_SELECT_ACTION Action constant for column selection.
static int	COPY_ACTION Action constant for copy rows.
static int	GROUP_ROW_SELECT_ACTION Action constant for contiguous group row selection.
static int	IGNORE_ACTION Action constant to ignore keys.
protected com.klg.jclass.higrid.ActionInitiator	initiator initiator property.
static int	MOVE_DOWN_ACTION Action constant for moving the editor down one cell.
static int	MOVE_END_ACTION Action constant for moving the editor to the last column on the current row.
static int	MOVE_GRID_END_ACTION Action constant for moving the editor to the last row and column of the grid.
static int	MOVE_GRID_HOME_ACTION Action constant for moving the editor to the first row and column of the grid.
static int	MOVE_HOME_ACTION Action constant for moving the editor to the first column on the current row.
static int	MOVE_LEFT_ACTION Action constant for moving the editor left one cell.
static int	MOVE_NEXT_ACTION Action constant for moving the editor to the next cell.
static int	MOVE_PAGE_DOWN_ACTION Action constant for moving the editor one page down.
static int	MOVE_PAGE_LEFT_ACTION Action constant for scrolling the grid one page left.
static int	MOVE_PAGE_RIGHT_ACTION Action constant for scrolling the grid one page right.
static int	MOVE_PAGE_UP_ACTION Action constant for moving the editor one page up.
static int	MOVE_PREVIOUS_ACTION Action constant for moving the editor to the previous cell.
static int	MOVE_RIGHT_ACTION Action constant for moving the editor right one cell.
static int	MOVE_UP_ACTION Action constant for moving the editor up one cell.
static int	NO_ACTION Action constant for no matching action.
static int	OPEN_TABLE_ACTION Action constant for expanding the current row.
static int	PASTE_ACTION Action constant for paste range.
static int	POPUP_MENU_ACTION Action constant for invoking the popup menu.
static int	SINGLE_ROW_SELECT_ACTION Action constant for row selection/deselection.
static int	STOP_EDIT_ACTION Action constant for saving all edits in the current editor.

Constructor Summary

HiGridAction(com.klg.jclass.higrid.ActionInitiator initiator, int action)
A public constructor that creates a mapping from a series of modifiers to a action.

Method Summary

int	getAction() Gets the value of the Action property for this ActionInitiator instance.
com.klg.jclass.higrid.ActionInitiator	getInitiator() Gets the ActionInitiator for this HiGridAction.
boolean	isMatch(com.klg.jclass.higrid.HiGrid grid, AWTEvent event) Returns true if the event has a matching action set.
void	setAction(int action) Sets the value of the Action property for this HiGridAction instance.
void	setInitiator(com.klg.jclass.higrid.ActionInitiator initiator) Sets the ActionInitiator for this HiGridAction.
String	toString() Convert to a string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

initiator

protected com.klg.jclass.higrid.ActionInitiator initiator

initiator property.

action

protected int action

action property.

NO_ACTION

public static final int NO_ACTION

Action constant for no matching action.

See Also:

Constant Field Values

MOVE_LEFT_ACTION

public static final int MOVE_LEFT_ACTION

Action constant for moving the editor left one cell.

See Also:

Constant Field Values

MOVE_RIGHT_ACTION

public static final int MOVE_RIGHT_ACTION

Action constant for moving the editor right one cell.

See Also:

Constant Field Values

MOVE_UP_ACTION

public static final int MOVE_UP_ACTION

Action constant for moving the editor up one cell.

See Also:

Constant Field Values

MOVE_DOWN_ACTION

public static final int MOVE_DOWN_ACTION

Action constant for moving the editor down one cell.

See Also:

Constant Field Values

MOVE_PAGE_UP_ACTION

public static final int MOVE_PAGE_UP_ACTION

Action constant for moving the editor one page up.

See Also:

Constant Field Values

MOVE_PAGE_DOWN_ACTION

public static final int MOVE_PAGE_DOWN_ACTION

Action constant for moving the editor one page down.

See Also:

Constant Field Values

MOVE_PAGE_LEFT_ACTION

public static final int MOVE_PAGE_LEFT_ACTION

Action constant for scrolling the grid one page left.

See Also:

Constant Field Values

MOVE_PAGE_RIGHT_ACTION

public static final int MOVE_PAGE_RIGHT_ACTION

Action constant for scrolling the grid one page right.

See Also:

Constant Field Values

MOVE_HOME_ACTION

public static final int MOVE_HOME_ACTION

Action constant for moving the editor to the first column on the current row.

See Also:

Constant Field Values

MOVE_END_ACTION

public static final int MOVE_END_ACTION

Action constant for moving the editor to the last column on the current row.

See Also:

Constant Field Values

MOVE_GRID_HOME_ACTION

public static final int MOVE_GRID_HOME_ACTION

Action constant for moving the editor to the first row and column of the grid.

See Also:

Constant Field Values

MOVE_GRID_END_ACTION

public static final int MOVE_GRID_END_ACTION

Action constant for moving the editor to the last row and column of the grid.

See Also:

Constant Field Values

MOVE_NEXT_ACTION

public static final int MOVE_NEXT_ACTION

Action constant for moving the editor to the next cell.

See Also:

Constant Field Values

MOVE_PREVIOUS_ACTION

public static final int MOVE_PREVIOUS_ACTION

Action constant for moving the editor to the previous cell.

See Also:

Constant Field Values

OPEN_TABLE_ACTION

public static final int OPEN_TABLE_ACTION

Action constant for expanding the current row.

See Also:

Constant Field Values

CLOSE_TABLE_ACTION

public static final int CLOSE_TABLE_ACTION

Action constant for collapsing the current row.

See Also:

Constant Field Values

STOP_EDIT_ACTION

public static final int STOP_EDIT_ACTION

Action constant for saving all edits in the current editor.

See Also:

Constant Field Values

CANCEL_EDIT_ACTION

public static final int CANCEL_EDIT_ACTION

Action constant for cancelling all edits in the current editor.

See Also:

Constant Field Values

POPUP_MENU_ACTION

public static final int POPUP_MENU_ACTION

Action constant for invoking the popup menu.

See Also:

Constant Field Values

COLUMN_SELECT_ACTION

public static final int COLUMN_SELECT_ACTION

Action constant for column selection.

See Also:

Constant Field Values

SINGLE_ROW_SELECT_ACTION

public static final int SINGLE_ROW_SELECT_ACTION

Action constant for row selection/deselection.

See Also:

Constant Field Values

GROUP_ROW_SELECT_ACTION

public static final int GROUP_ROW_SELECT_ACTION

Action constant for contiguous group row selection.

See Also:

Constant Field Values

IGNORE_ACTION

public static final int IGNORE_ACTION

Action constant to ignore keys.

See Also:

Constant Field Values

COPY_ACTION

public static final int COPY_ACTION

Action constant for copy rows.

See Also:

Constant Field Values

PASTE_ACTION

public static final int PASTE_ACTION

Action constant for paste range.

See Also:

Constant Field Values

Constructor Detail

HiGridAction

public HiGridAction(com.klg.jclass.higrid.ActionInitiator initiator,
                    int action)

A public constructor that creates a mapping from a series of modifiers to a action.

Method Detail

getInitiator

public com.klg.jclass.higrid.ActionInitiator getInitiator()

Gets the ActionInitiator for this HiGridAction.

See Also:

setInitiator(com.klg.jclass.higrid.ActionInitiator)

setInitiator

public void setInitiator(com.klg.jclass.higrid.ActionInitiator initiator)

Sets the ActionInitiator for this HiGridAction.

See Also:

KeyActionInitiator, MouseActionInitiator

getAction

public int getAction()

Gets the value of the Action property for this ActionInitiator instance. The Action property determines what action will be performed when the specified AWT event occurs.

setAction

public void setAction(int action)

Sets the value of the Action property for this HiGridAction instance. The Action property determines what action will be performed when the specified AWT event occurs.

isMatch

public boolean isMatch(com.klg.jclass.higrid.HiGrid grid,
                       AWTEvent event)

Returns true if the event has a matching action set.

toString

public String toString()

Convert to a string.

Overrides:

toString in class Object