old-autovect-branch/libjava/classpath/javax/swing/text/StyledDocument.java

   1 /* StyledDcoument.java --
   2    Copyright (C) 2002, 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 package javax.swing.text;
  39
  40 import java.awt.Color;
  41 import java.awt.Font;
  42
  43 /**
  44  * StyledDocument
  45  * @author      Andrew Selkirk
  46  * @version     1.0
  47  */
  48 public interface StyledDocument extends Document
  49 {
  50   /**
  51    * addStyle
  52    * @param nm TODO
  53    * @param parent TODO
  54    * @returns Style
  55    */
  56   Style addStyle(String nm, Style parent);
  57
  58   /**
  59    * removeStyle
  60    * @param nm TODO
  61    */
  62   void removeStyle(String nm);
  63
  64   /**
  65    * getStyle
  66    * @param nm TODO
  67    * @returns Style
  68    */
  69   Style getStyle(String nm);
  70
  71   /**
  72    * setCharacterAttributes
  73    * @param offset TODO
  74    * @param length TODO
  75    * @param set TODO
  76    * @param replace TODO
  77    */
  78   void setCharacterAttributes(int offset, int length, AttributeSet set,
  79                               boolean replace);
  80
  81   /**
  82    * setParagraphAttributes
  83    * @param offset TODO
  84    * @param length TODO
  85    * @param set TODO
  86    * @param replace TODO
  87    */
  88   void setParagraphAttributes(int offset, int length, AttributeSet set,
  89                               boolean replace);
  90
  91   /**
  92    * getLogicalStyle
  93    * @param position TODO
  94    * @returns Style
  95    */
  96   Style getLogicalStyle(int position);
  97
  98   /**
  99    * setLogicalStyle
 100    * @param position TODO
 101    * @param style TODO
 102    */
 103   void setLogicalStyle(int position, Style style);
 104
 105   /**
 106    * getParagraphElement
 107    * @param position TODO
 108    * @returns Element
 109    */
 110   Element getParagraphElement(int position);
 111
 112   /**
 113    * getCharacterElement
 114    * @param position TODO
 115    * @returns Element
 116    */
 117   Element getCharacterElement(int position);
 118
 119   /**
 120    * getForeground
 121    * @param set TODO
 122    * @returns Color
 123    */
 124   Color getForeground(AttributeSet set);
 125
 126   /**
 127    * getBackground
 128    * @param set TODO
 129    * @returns Color
 130    */
 131   Color getBackground(AttributeSet set);
 132
 133   /**
 134    * getFont
 135    * @param set TODO
 136    * @returns Font
 137    */
 138   Font getFont(AttributeSet set);
 139
 140 }