001: /*BEGIN_COPYRIGHT_BLOCK
002: *
003: * Copyright (c) 2001-2007, JavaPLT group at Rice University (javaplt@rice.edu)
004: * All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions are met:
008: * * Redistributions of source code must retain the above copyright
009: * notice, this list of conditions and the following disclaimer.
010: * * Redistributions in binary form must reproduce the above copyright
011: * notice, this list of conditions and the following disclaimer in the
012: * documentation and/or other materials provided with the distribution.
013: * * Neither the names of DrJava, the JavaPLT group, Rice University, nor the
014: * names of its contributors may be used to endorse or promote products
015: * derived from this software without specific prior written permission.
016: *
017: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
018: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
019: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
020: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
021: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
022: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
023: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
024: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
025: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
026: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
027: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
028: *
029: * This software is Open Source Initiative approved Open Source Software.
030: * Open Source Initative Approved is a trademark of the Open Source Initiative.
031: *
032: * This file is part of DrJava. Download the current version of this project
033: * from http://www.drjava.org/ or http://sourceforge.net/projects/drjava/
034: *
035: * END_COPYRIGHT_BLOCK*/
036:
037: package edu.rice.cs.util.text;
038:
039: import java.awt.print.Pageable;
040: import java.awt.print.PrinterException;
041: import java.io.Serializable;
042:
043: /** A GUI toolkit agnostic interface for a console document. The anticipated implementations are wrappers around
044: * documents generated by Swing, SWT (Eclipse), or other toolkits. This interface also provides a mechanism for
045: * restricting edits based on a conditional object, unless a separate method is called to force the edit.
046: *
047: * @version $Id: EditDocumentInterface.java 4255 2007-08-28 19:17:37Z mgricken $
048: */
049: public interface EditDocumentInterface extends ReadersWritersLocking,
050: Serializable {
051:
052: /** Gets the object which can determine whether an insert or remove edit should be applied, based on the inputs.
053: * @return an Object to determine legality of inputs
054: */
055: public DocumentEditCondition getEditCondition();
056:
057: /** Provides an object which can determine whether an insert or remove edit should be applied, based on the inputs.
058: * @param condition Object to determine legality of inputs
059: */
060: public void setEditCondition(DocumentEditCondition condition);
061:
062: /** Inserts a string into the document at the given offset and the given named style, if the edit condition allows it.
063: * @param offs Offset into the document
064: * @param str String to be inserted
065: * @param style Name of the style to use. Must have been added using addStyle.
066: * @throws EditDocumentException if the offset is illegal
067: */
068: public void insertText(int offs, String str, String style);
069:
070: /** Inserts a string into "this" exactly like insertText except that it assumes the WriteLock is already held. */
071: public void _insertText(int offs, String str, String style);
072:
073: /** Inserts a string into the document at the given offset and style, regardless of the edit condition.
074: * @param offs Offset into the document
075: * @param str String to be inserted
076: * @param style Name of the style to use. Must have been
077: * added using addStyle.
078: * @throws EditDocumentException if the offset is illegal
079: */
080: public void forceInsertText(int offs, String str, String style);
081:
082: /** Inserts a string into "this" exactly like forceInsertText except that it assumes the WriteLock is already held. */
083: public void _forceInsertText(int offs, String str, String style);
084:
085: /** Removes a portion of the document, if the edit condition allows it.
086: * @param offs Offset to start deleting from
087: * @param len Number of characters to remove
088: * @throws EditDocumentException if the offset or length are illegal
089: */
090: public void removeText(int offs, int len);
091:
092: /** Removes a portion of the document, if the edit condition allows it, as above. Assumes that WriteLock is held. */
093: public void _removeText(int offs, int len);
094:
095: /** Removes a portion of the document, regardless of the edit condition.
096: * @param offs Offset to start deleting from
097: * @param len Number of characters to remove
098: * @throws EditDocumentException if the offset or length are illegal
099: */
100: public void forceRemoveText(int offs, int len);
101:
102: /** Returns the length of the document. */
103: public int getLength();
104:
105: /** Returns a portion of the document. Differs from getText in AbstractDocumentInterface by throwing
106: * EditDocumentException instead of BadLocationException. (Why bother? It avoids referencing a Swing class.)
107: * @param offs First offset of the desired text
108: * @param len Number of characters to return
109: * @throws EditDocumentException if the offset or length are illegal
110: */
111: public String getDocText(int offs, int len);
112:
113: /** Appends a string to this in the given named style, if the edit condition allows it.
114: * @param str String to be inserted
115: * @param style Name of the style to use. Must have been added using addStyle.
116: * @throws EditDocumentException if the offset is illegal
117: */
118: public void append(String str, String style);
119:
120: /** Gets the String identifying the default style for this document if one exists; null otherwise. */
121: public String getDefaultStyle();
122:
123: /** Returns the Pageable object for printing.
124: * @return A Pageable representing this document.
125: */
126: public Pageable getPageable() throws IllegalStateException;
127:
128: /** Prints the given console document */
129: public void print() throws PrinterException;
130: }
|