< prev index next >
src/java.desktop/share/classes/javax/swing/event/RowSorterEvent.java
Print this page
*** 25,40 ****
package javax.swing.event;
import javax.swing.RowSorter;
/**
! * <code>RowSorterEvent</code> provides notification of changes to
! * a <code>RowSorter</code>. Two types of notification are possible:
* <ul>
! * <li><code>Type.SORT_ORDER_CHANGED</code>: indicates the sort order has
* changed. This is typically followed by a notification of:
! * <li><code>Type.SORTED</code>: indicates the contents of the model have
* been transformed in some way. For example, the contents may have
* been sorted or filtered.
* </ul>
*
* @see javax.swing.RowSorter
--- 25,40 ----
package javax.swing.event;
import javax.swing.RowSorter;
/**
! * {@code RowSorterEvent} provides notification of changes to
! * a {@code RowSorter}. Two types of notification are possible:
* <ul>
! * <li>{@code Type.SORT_ORDER_CHANGED}: indicates the sort order has
* changed. This is typically followed by a notification of:
! * <li>{@code Type.SORTED}: indicates the contents of the model have
* been transformed in some way. For example, the contents may have
* been sorted or filtered.
* </ul>
*
* @see javax.swing.RowSorter
*** 44,54 ****
public class RowSorterEvent extends java.util.EventObject {
private Type type;
private int[] oldViewToModel;
/**
! * Enumeration of the types of <code>RowSorterEvent</code>s.
*
* @since 1.6
*/
public enum Type {
/**
--- 44,54 ----
public class RowSorterEvent extends java.util.EventObject {
private Type type;
private int[] oldViewToModel;
/**
! * Enumeration of the types of {@code RowSorterEvent}s.
*
* @since 1.6
*/
public enum Type {
/**
*** 62,91 ****
*/
SORTED
}
/**
! * Creates a <code>RowSorterEvent</code> of type
! * <code>SORT_ORDER_CHANGED</code>.
*
* @param source the source of the change
! * @throws IllegalArgumentException if <code>source</code> is
! * <code>null</code>
*/
public RowSorterEvent(RowSorter<?> source) {
this(source, Type.SORT_ORDER_CHANGED, null);
}
/**
! * Creates a <code>RowSorterEvent</code>.
*
* @param source the source of the change
* @param type the type of event
* @param previousRowIndexToModel the mapping from model indices to
! * view indices prior to the sort, may be <code>null</code>
! * @throws IllegalArgumentException if source or <code>type</code> is
! * <code>null</code>
*/
public RowSorterEvent(RowSorter<?> source, Type type,
int[] previousRowIndexToModel) {
super(source);
if (type == null) {
--- 62,91 ----
*/
SORTED
}
/**
! * Creates a {@code RowSorterEvent} of type
! * {@code SORT_ORDER_CHANGED}.
*
* @param source the source of the change
! * @throws IllegalArgumentException if {@code source} is
! * {@code null}
*/
public RowSorterEvent(RowSorter<?> source) {
this(source, Type.SORT_ORDER_CHANGED, null);
}
/**
! * Creates a {@code RowSorterEvent}.
*
* @param source the source of the change
* @param type the type of event
* @param previousRowIndexToModel the mapping from model indices to
! * view indices prior to the sort, may be {@code null}
! * @throws IllegalArgumentException if source or {@code type} is
! * {@code null}
*/
public RowSorterEvent(RowSorter<?> source, Type type,
int[] previousRowIndexToModel) {
super(source);
if (type == null) {
*** 94,106 ****
this.type = type;
this.oldViewToModel = previousRowIndexToModel;
}
/**
! * Returns the source of the event as a <code>RowSorter</code>.
*
! * @return the source of the event as a <code>RowSorter</code>
*/
@Override
public RowSorter<?> getSource() {
return (RowSorter)super.getSource();
}
--- 94,106 ----
this.type = type;
this.oldViewToModel = previousRowIndexToModel;
}
/**
! * Returns the source of the event as a {@code RowSorter}.
*
! * @return the source of the event as a {@code RowSorter}
*/
@Override
public RowSorter<?> getSource() {
return (RowSorter)super.getSource();
}
*** 113,125 ****
public Type getType() {
return type;
}
/**
! * Returns the location of <code>index</code> in terms of the
* model prior to the sort. This method is only useful for events
! * of type <code>SORTED</code>. This method will return -1 if the
* index is not valid, or the locations prior to the sort have not
* been provided.
*
* @param index the index in terms of the view
* @return the index in terms of the model prior to the sort, or -1 if
--- 113,125 ----
public Type getType() {
return type;
}
/**
! * Returns the location of {@code index} in terms of the
* model prior to the sort. This method is only useful for events
! * of type {@code SORTED}. This method will return -1 if the
* index is not valid, or the locations prior to the sort have not
* been provided.
*
* @param index the index in terms of the view
* @return the index in terms of the model prior to the sort, or -1 if
*** 133,143 ****
return -1;
}
/**
* Returns the number of rows before the sort. This method is only
! * useful for events of type <code>SORTED</code> and if the
* last locations have not been provided will return 0.
*
* @return the number of rows in terms of the view prior to the sort
*/
public int getPreviousRowCount() {
--- 133,143 ----
return -1;
}
/**
* Returns the number of rows before the sort. This method is only
! * useful for events of type {@code SORTED} and if the
* last locations have not been provided will return 0.
*
* @return the number of rows in terms of the view prior to the sort
*/
public int getPreviousRowCount() {
< prev index next >