Source for javax.swing.text.NavigationFilter

   1: /* NavigationFilter.java --
   2:    Copyright (C) 2003, 2004 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.swing.text;
  40: 
  41: public class NavigationFilter
  42: {
  43:   public abstract static class FilterBypass
  44:   {
  45:     public FilterBypass()
  46:     {
  47:       // Do nothing here.
  48:     }
  49: 
  50:     public abstract Caret getCaret();
  51:     public abstract void moveDot(int dot, Position.Bias bias);
  52:     public abstract void setDot(int dot, Position.Bias bias);
  53:   }
  54:   
  55:   public NavigationFilter()
  56:   {
  57:     // Do nothing here.
  58:   }
  59: 
  60:   public void moveDot(NavigationFilter.FilterBypass fb, int dot,
  61:               Position.Bias bias)
  62:   {
  63:     fb.moveDot(dot, bias);
  64:   }
  65: 
  66:   public void setDot(NavigationFilter.FilterBypass fb, int dot,
  67:              Position.Bias bias)
  68:   {
  69:     fb.setDot(dot, bias);
  70:   }
  71: 
  72:   /**
  73:    * Returns the next visual position in the specified direction at which one
  74:    * would place a caret. The default implementation forwards to the text
  75:    * component's root view. Subclasses may wish to restrict that more.
  76:    *
  77:    * @param c the text component
  78:    * @param pos the current model position
  79:    * @param bias the bias of <code>pos</code>
  80:    * @param dir the direction, one of {@link javax.swing.SwingConstants#NORTH},
  81:    *        {@link javax.swing.SwingConstants#SOUTH},
  82:    *        {@link javax.swing.SwingConstants#WEST} or
  83:    *        {@link javax.swing.SwingConstants#EAST}
  84:    * @param retBias the bias of the returned position
  85:    *
  86:    * @return the next model location to place the caret
  87:    *
  88:    * @throws BadLocationException when <code>pos</code> is not a valid model
  89:    *         position
  90:    */
  91:   public int getNextVisualPositionFrom(JTextComponent c, int pos,
  92:                                        Position.Bias bias, int dir,
  93:                                        Position.Bias[] retBias)
  94:     throws BadLocationException
  95:   {
  96:     return c.getUI().getNextVisualPositionFrom(c, pos, bias, dir, retBias);
  97:   }
  98: }