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