1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
/* * @(#)RowSorterEvent.java 1.3 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ 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> * * @version 1.3 11/17/05 * @see javax.swing.RowSorter * @since 1.6 */ 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 { /** * Indicates the sort order has changed. */ SORT_ORDER_CHANGED, /** * Indicates the contents have been newly sorted or * transformed in some way. */ 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) { throw new IllegalArgumentException("type must be non-null"); } 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> */ public RowSorter getSource() { return (RowSorter)super.getSource(); } /** * Returns the type of event. * * @return the type of event */ 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 * the location is not valid or the mapping was not provided. */ public int convertPreviousRowIndexToModel(int index) { if (oldViewToModel != null && index >= 0 && index < oldViewToModel.length) { return oldViewToModel[index]; } 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() { return (oldViewToModel == null) ? 0 : oldViewToModel.length; } }