Classes in this Package | Line Coverage | Branch Coverage | Complexity | ||||||
ITextBox |
|
| 1.0;1 |
1 | /** |
|
2 | * Redistribution and use in source and binary forms, with or without |
|
3 | * modification, are permitted provided that the following conditions are |
|
4 | * met : |
|
5 | * |
|
6 | * . Redistributions of source code must retain the above copyright |
|
7 | * notice, this list of conditions and the following disclaimer. |
|
8 | * |
|
9 | * . Redistributions in binary form must reproduce the above copyright |
|
10 | * notice, this list of conditions and the following disclaimer in the |
|
11 | * documentation and/or other materials provided with the distribution. |
|
12 | * |
|
13 | * . The name of the author may not be used to endorse or promote products |
|
14 | * derived from this software without specific prior written permission. |
|
15 | * |
|
16 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
|
17 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
|
18 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
|
19 | * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, |
|
20 | * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
|
21 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
|
22 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
|
23 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
|
24 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
|
25 | * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
|
26 | * POSSIBILITY OF SUCH DAMAGE. |
|
27 | * |
|
28 | * $Id: ITextBox.java 381 2005-12-30 07:44:33Z mat007 $ |
|
29 | */ |
|
30 | ||
31 | package palmed.edit; |
|
32 | ||
33 | import java.io.IOException; |
|
34 | import java.io.InputStream; |
|
35 | import java.io.OutputStream; |
|
36 | import palmed.io.ISerializable; |
|
37 | ||
38 | /** |
|
39 | * This interface defines a text box. |
|
40 | * |
|
41 | * @author Mathieu Champlon |
|
42 | * @version $Revision: 381 $ $Date: 2005-12-30 16:44:33 +0900 (ven., 30 déc. 2005) $ |
|
43 | */ |
|
44 | public interface ITextBox extends ISerializable |
|
45 | { |
|
46 | /** |
|
47 | * Reset the text box and read text from a stream. |
|
48 | * |
|
49 | * @param stream the stream to read from |
|
50 | * @throws IOException an io exception occurs |
|
51 | */ |
|
52 | void read( InputStream stream ) throws IOException; |
|
53 | ||
54 | /** |
|
55 | * Write text to a stream. |
|
56 | * |
|
57 | * @param stream the stream to write to |
|
58 | * @throws IOException an io exception occurs |
|
59 | */ |
|
60 | void write( OutputStream stream ) throws IOException; |
|
61 | ||
62 | /** |
|
63 | * Test the modification flag. |
|
64 | * |
|
65 | * @return whether the text has been modified since it has been read or written |
|
66 | */ |
|
67 | boolean hasBeenModified(); |
|
68 | ||
69 | /** |
|
70 | * Clear the text box. |
|
71 | */ |
|
72 | void clear(); |
|
73 | ||
74 | /** |
|
75 | * Copy the current selected text. |
|
76 | * |
|
77 | * @param stream the stream to write to |
|
78 | * @throws IOException an io exception occurs |
|
79 | */ |
|
80 | void copy( OutputStream stream ) throws IOException; |
|
81 | ||
82 | /** |
|
83 | * Cut the current selected text. |
|
84 | * |
|
85 | * @param stream the stream to write to |
|
86 | * @throws IOException an io exception occurs |
|
87 | */ |
|
88 | void cut( OutputStream stream ) throws IOException; |
|
89 | ||
90 | /** |
|
91 | * Paste the given text. |
|
92 | * |
|
93 | * @param stream the stream to read from |
|
94 | * @throws IOException an io exception occurs |
|
95 | */ |
|
96 | void paste( InputStream stream ) throws IOException; |
|
97 | ||
98 | /** |
|
99 | * Delete any resource associated to the current content. |
|
100 | */ |
|
101 | void delete(); |
|
102 | ||
103 | /** |
|
104 | * Undo the last action. |
|
105 | */ |
|
106 | void undo(); |
|
107 | ||
108 | /** |
|
109 | * Redo the last undo. |
|
110 | */ |
|
111 | void redo(); |
|
112 | ||
113 | /** |
|
114 | * Change the line separator. |
|
115 | * <p> |
|
116 | * To reset to the default mode preserving file format use null. |
|
117 | * |
|
118 | * @param separator a string value or null to reset |
|
119 | */ |
|
120 | void setLineSeparator( String separator ); |
|
121 | ||
122 | /** |
|
123 | * Change the font. |
|
124 | * |
|
125 | * @param name the font resource name |
|
126 | */ |
|
127 | void setFont( String name ); |
|
128 | } |