com.sssw.rt.tview
Class AgoHeaderRowClick

java.lang.Object
 |
 +--com.sssw.rt.tview.AgoHeaderRowClick

public final class AgoHeaderRowClick

extends Object

The AgoHeaderRowClick class encapsulates information about a click on the topmost header row. It is returned as the argument of the AgoEvent parameter on the AgiViewListener's viewHeaderRowClick event.

See Also:

AgiViewListener

Constructor Summary

AgoHeaderRowClick()

Method Summary

boolean	controlDown() Returns true if the control key was held down when the mouse click occurred.
AgoBandFormat	getBandFormat() Returns the band format of the header row.
int	getColumnIndex() Returns the (0-based) index of the column that was clicked.
boolean	shiftDown() Returns true if the shift key was held down when the mouse click occurred.

Methods inherited from class java.lang.Object

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

Constructor Detail

AgoHeaderRowClick

public AgoHeaderRowClick()

Method Detail

controlDown

public boolean controlDown()

Returns true if the control key was held down when the mouse click occurred.

Example:

	// this determines whether the control key was held down when the header
	// row click occurred
	if (hdrRowClick.controlDown())
	{
		// perform appropriate processing: perhaps select the clicked column
		// as a secondary sort column
	}

shiftDown

public boolean shiftDown()

Returns true if the shift key was held down when the mouse click occurred.

Example:

	// this determines whether the shift key was held down when the header
	// row click occurred
	if (hdrRowClick.shiftDown())
	{
		// perform appropriate processing: perhaps change the sort direction
		// on the clicked column from ascending to descending
	}

getColumnIndex

public int getColumnIndex()

Returns the (0-based) index of the column that was clicked.

Example:

	// this example sorts the column that was clicked
	int col = hdrRowClick.getColumnIndex();
	agcView.sort(col, true);

getBandFormat

public AgoBandFormat getBandFormat()

Returns the band format of the header row.

Example:

	AgoBandFormat hdrBandFmt = hdrRowClick.getBandFormat();