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 128 129 130
/* * @(#)NavigationFilter.java 1.6 06/04/07 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.swing.text; import java.awt.Shape; /** * <code>NavigationFilter</code> can be used to restrict where the cursor can * be positioned. When the default cursor positioning actions attempt to * reposition the cursor they will call into the * <code>NavigationFilter</code>, assuming * the <code>JTextComponent</code> has a non-null * <code>NavigationFilter</code> set. In this manner * the <code>NavigationFilter</code> can effectively restrict where the * cursor can be positioned. Similarly <code>DefaultCaret</code> will call * into the <code>NavigationFilter</code> when the user is changing the * selection to further restrict where the cursor can be positioned. * <p> * Subclasses can conditionally call into supers implementation to restrict * where the cursor can be placed, or call directly into the * <code>FilterBypass</code>. * * @see javax.swing.text.Caret * @see javax.swing.text.DefaultCaret * @see javax.swing.text.View * * @version 1.6 04/07/06 * @since 1.4 */ public class NavigationFilter { /** * Invoked prior to the Caret setting the dot. The default implementation * calls directly into the <code>FilterBypass</code> with the passed * in arguments. Subclasses may wish to conditionally * call super with a different location, or invoke the necessary method * on the <code>FilterBypass</code> * * @param fb FilterBypass that can be used to mutate caret position * @param dot the position >= 0 * @param bias Bias to place the dot at */ public void setDot(FilterBypass fb, int dot, Position.Bias bias) { fb.setDot(dot, bias); } /** * Invoked prior to the Caret moving the dot. The default implementation * calls directly into the <code>FilterBypass</code> with the passed * in arguments. Subclasses may wish to conditionally * call super with a different location, or invoke the necessary * methods on the <code>FilterBypass</code>. * * @param fb FilterBypass that can be used to mutate caret position * @param dot the position >= 0 * @param bias Bias for new location */ public void moveDot(FilterBypass fb, int dot, Position.Bias bias) { fb.moveDot(dot, bias); } /** * Returns the next visual position to place the caret at from an * existing position. The default implementation simply forwards the * method to the root View. Subclasses may wish to further restrict the * location based on additional criteria. * * @param text JTextComponent containing text * @param pos Position used in determining next position * @param bias Bias used in determining next position * @param direction the direction from the current position that can * be thought of as the arrow keys typically found on a keyboard. * This will be one of the following values: * <ul> * <li>SwingConstants.WEST * <li>SwingConstants.EAST * <li>SwingConstants.NORTH * <li>SwingConstants.SOUTH * </ul> * @param biasRet Used to return resulting Bias of next position * @return the location within the model that best represents the next * location visual position * @exception BadLocationException * @exception IllegalArgumentException if <code>direction</code> * doesn't have one of the legal values above */ public int getNextVisualPositionFrom(JTextComponent text, int pos, Position.Bias bias, int direction, Position.Bias[] biasRet) throws BadLocationException { return text.getUI().getNextVisualPositionFrom(text, pos, bias, direction, biasRet); } /** * Used as a way to circumvent calling back into the caret to * position the cursor. Caret implementations that wish to support * a NavigationFilter must provide an implementation that will * not callback into the NavigationFilter. * @since 1.4 */ public static abstract class FilterBypass { /** * Returns the Caret that is changing. * * @return Caret that is changing */ public abstract Caret getCaret(); /** * Sets the caret location, bypassing the NavigationFilter. * * @param dot the position >= 0 * @param bias Bias to place the dot at */ public abstract void setDot(int dot, Position.Bias bias); /** * Moves the caret location, bypassing the NavigationFilter. * * @param dot the position >= 0 * @param bias Bias for new location */ public abstract void moveDot(int dot, Position.Bias bias); } }