blob: c6bfd60bbaa4a38148048aa0f12eb5bfcfdcff2a [file] [log] [blame]
J. Duke319a3b92007-12-01 00:00:00 +00001/*
2 * Copyright 1997-1998 Sun Microsystems, Inc. All Rights Reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25package javax.swing.text.rtf;
26
27import javax.swing.text.AttributeSet;
28import javax.swing.text.MutableAttributeSet;
29import java.io.IOException;
30
31/**
32 * This interface describes a class which defines a 1-1 mapping between
33 * an RTF keyword and a SwingText attribute.
34 */
35interface RTFAttribute
36{
37 static final int D_CHARACTER = 0;
38 static final int D_PARAGRAPH = 1;
39 static final int D_SECTION = 2;
40 static final int D_DOCUMENT = 3;
41 static final int D_META = 4;
42
43 /* These next three should really be public variables,
44 but you can't declare public variables in an interface... */
45 /* int domain; */
46 public int domain();
47 /* String swingName; */
48 public Object swingName();
49 /* String rtfName; */
50 public String rtfName();
51
52 public boolean set(MutableAttributeSet target);
53 public boolean set(MutableAttributeSet target, int parameter);
54
55 public boolean setDefault(MutableAttributeSet target);
56
57 /* TODO: This method is poorly thought out */
58 public boolean write(AttributeSet source,
59 RTFGenerator target,
60 boolean force)
61 throws IOException;
62
63 public boolean writeValue(Object value,
64 RTFGenerator target,
65 boolean force)
66 throws IOException;
67}