001/* StyledDcoument.java -- 002 Copyright (C) 2002, 2004 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038package javax.swing.text; 039 040import java.awt.Color; 041import java.awt.Font; 042 043/** 044 * StyledDocument 045 * @author Andrew Selkirk 046 * @version 1.0 047 */ 048public interface StyledDocument extends Document 049{ 050 /** 051 * addStyle 052 * @param nm TODO 053 * @param parent TODO 054 * @returns Style 055 */ 056 Style addStyle(String nm, Style parent); 057 058 /** 059 * removeStyle 060 * @param nm TODO 061 */ 062 void removeStyle(String nm); 063 064 /** 065 * getStyle 066 * @param nm TODO 067 * @returns Style 068 */ 069 Style getStyle(String nm); 070 071 /** 072 * setCharacterAttributes 073 * @param offset TODO 074 * @param length TODO 075 * @param set TODO 076 * @param replace TODO 077 */ 078 void setCharacterAttributes(int offset, int length, AttributeSet set, 079 boolean replace); 080 081 /** 082 * setParagraphAttributes 083 * @param offset TODO 084 * @param length TODO 085 * @param set TODO 086 * @param replace TODO 087 */ 088 void setParagraphAttributes(int offset, int length, AttributeSet set, 089 boolean replace); 090 091 /** 092 * getLogicalStyle 093 * @param position TODO 094 * @returns Style 095 */ 096 Style getLogicalStyle(int position); 097 098 /** 099 * 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}