borland.jbcl Packages  borland.jbcl Class Hierarchy  borland.jbcl.model 

MatrixSelectionEvent class

java.lang.Object
   +----java.util.EventObject
           +----borland.jbcl.util.DispatchableEvent
                   +----borland.jbcl.model.SelectionEvent
                           +----borland.jbcl.model.MatrixSelectionEvent

About the MatrixSelectionEvent class

Variables  Constructors  Properties  Methods  
Implements Serializable
A MatrixSelectionEvent object is created whenever a matrix-selection event occurs. Matrix-selection events occur when data objects are added or removed from the set of selected locations in a matrix. The ID property specifies what creates the event. The possibilities can be any change in the selection set, a change at a specified location in the selection set, or a change of a range within a selection set.

MatrixSelectionEvent variables

Variables implemented in borland.jbcl.model.SelectionEvent

Variables implemented in java.util.EventObject

MatrixSelectionEvent constructors

MatrixSelectionEvent properties

*Read-only properties **Write-only properties

Properties implemented in this class

Properties implemented in borland.jbcl.model.SelectionEvent

Properties implemented in borland.jbcl.util.DispatchableEvent

Properties implemented in java.lang.Object

Properties implemented in java.util.EventObject

MatrixSelectionEvent methods

Methods implemented in this class

Methods implemented in borland.jbcl.util.DispatchableEvent

Methods implemented in java.lang.Object


MatrixSelectionEvent constructors

MatrixSelectionEvent(borland.jbcl.model.MatrixSelection, int)

  public MatrixSelectionEvent(borland.jbcl.model.MatrixSelection selection, int change)
Constructs a matrix-selection event object using the passed selection object and the type of change that occurred to that selection.

Parameters:

selection
The matrix-selection object, the selection pool, in which a change occurred.
change
The type of change that occurred. The type of change can be one of the selection event variables.

MatrixSelectionEvent(borland.jbcl.model.MatrixSelection, int, borland.jbcl.model.MatrixLocation)

  public MatrixSelectionEvent(borland.jbcl.model.MatrixSelection selection, int change, borland.jbcl.model.MatrixLocation location)
Constructs a matrix-selection event object using the passed selection object, the type of change that occurred to that selection, and the location where the change occurred. Such an event object is used when a data item at the specified location changes.

Parameters:

selection
The matrix-selection object, the selection pool, in which a change occurred.
change
The type of change that occurred. The type of change can be one of the selection event variables.
location
The MatrixLocation object that identifies the location where the change occurred.

MatrixSelectionEvent(borland.jbcl.model.MatrixSelection, int, borland.jbcl.model.MatrixLocation, borland.jbcl.model.MatrixLocation)

  public MatrixSelectionEvent(borland.jbcl.model.MatrixSelection selection, int change, borland.jbcl.model.MatrixLocation rangeStart, borland.jbcl.model.MatrixLocation rangeEnd)
Constructs a matrix-selection event object using the passed selection object , the type of change that occurred to that selection, the beginning of the range that changed, and the end of the range that changed. Such an event object is used when the range of selected locations changes.

Parameters:

selection
The matrix-selection object, the selection pool, in which a change occurred.
change
The type of change that occurred. The type of change can be one of the selection event variables.
rangeStart
The MatrixLocation object that specifies the beginning of the range in the matrix.
rangeEnd
The MatrixLocation object that specifies the end of the range in the matrix.

MatrixSelectionEvent properties

location

 public MatrixLocation getLocation()
Returns the location where the matrix-selection event occurred.

rangeEnd

 public MatrixLocation getRangeEnd()
Returns the final location in the range of locations where the matrix-selection event occurred.

rangeStart

 public MatrixLocation getRangeStart()
Returns the starting location in the range of locations where the matrix-selection event occurred.

selection

 public MatrixSelection getSelection()
Returns the set of currently selected locations within the matrix.

MatrixSelectionEvent methods

dispatch(java.util.EventListener)

  public void dispatch(java.util.EventListener listener)
Calls methods in the listening object passing this matrix-selection event object. Which method is called depends on the type of matrix-selection event that occurred. If the event ID is ITEM_CHANGE, selectionItemChanged() is called. If the event ID is RANGE_CHANGE, selectionRangeChanged() is called. If the event ID is SELECTION_CHANGE, selectionChanged() is called.

Parameters:

listener
The object listening for matrix-selection events.

Overrides: borland.jbcl.util.DispatchableEvent.dispatch(EventListener)

paramString()

  protected String paramString()
Appends the matrix-selection event object's parameter string to the parameter string of the superclass. The string that is appended is:

",selection=" + selection + ",location=" + location + ",rangeStart=" + rangeStart + ",rangeEnd=" + rangeEnd

See also borland.jbcl.model.SelectionEvent.paramString()