Java™ Platform
Standard Ed. 6

javax.swing.event
Class RowSorterEvent

java.lang.Object
  extended by java.util.EventObject
      extended by javax.swing.event.RowSorterEvent
All Implemented Interfaces:
Serializable

public class RowSorterEvent
extends EventObject

RowSorterEvent provides notification of changes to a RowSorter. Two types of notification are possible:

Since:
1.6
See Also:
RowSorter

Nested Class Summary
static class RowSorterEvent.Type
          Enumeration of the types of RowSorterEvents.
 
Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
RowSorterEvent(RowSorter source)
          Creates a RowSorterEvent of type SORT_ORDER_CHANGED.
RowSorterEvent(RowSorter source, RowSorterEvent.Type type, int[] previousRowIndexToModel)
          Creates a RowSorterEvent.
 
Method Summary
 int convertPreviousRowIndexToModel(int index)
          Returns the location of index in terms of the model prior to the sort.
 int getPreviousRowCount()
          Returns the number of rows before the sort.
 RowSorter getSource()
          Returns the source of the event as a RowSorter.
 RowSorterEvent.Type getType()
          Returns the type of event.
 
Methods inherited from class java.util.EventObject
toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RowSorterEvent

public RowSorterEvent(RowSorter source)
Creates a RowSorterEvent of type SORT_ORDER_CHANGED.

Parameters:
source - the source of the change
Throws:
IllegalArgumentException - if source is null

RowSorterEvent

public RowSorterEvent(RowSorter source,
                      RowSorterEvent.Type type,
                      int[] previousRowIndexToModel)
Creates a RowSorterEvent.

Parameters:
source - the source of the change
type - the type of event
previousRowIndexToModel - the mapping from model indices to view indices prior to the sort, may be null
Throws:
IllegalArgumentException - if source or type is null
Method Detail

getSource

public RowSorter getSource()
Returns the source of the event as a RowSorter.

Overrides:
getSource in class EventObject
Returns:
the source of the event as a RowSorter

getType

public RowSorterEvent.Type getType()
Returns the type of event.

Returns:
the type of event

convertPreviousRowIndexToModel

public int convertPreviousRowIndexToModel(int index)
Returns the location of index in terms of the model prior to the sort. This method is only useful for events of type SORTED. This method will return -1 if the index is not valid, or the locations prior to the sort have not been provided.

Parameters:
index - the index in terms of the view
Returns:
the index in terms of the model prior to the sort, or -1 if the location is not valid or the mapping was not provided.

getPreviousRowCount

public int getPreviousRowCount()
Returns the number of rows before the sort. This method is only useful for events of type SORTED and if the last locations have not been provided will return 0.

Returns:
the number of rows in terms of the view prior to the sort

Java™ Platform
Standard Ed. 6

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.