david_williams | cfdb2cd | 2004-11-11 08:37:49 +0000 | [diff] [blame] | 1 | /******************************************************************************* |
| 2 | * Copyright (c) 2001, 2004 IBM Corporation and others. |
| 3 | * All rights reserved. This program and the accompanying materials |
| 4 | * are made available under the terms of the Eclipse Public License v1.0 |
| 5 | * which accompanies this distribution, and is available at |
| 6 | * http://www.eclipse.org/legal/epl-v10.html |
| 7 | * |
| 8 | * Contributors: |
| 9 | * IBM Corporation - initial API and implementation |
| 10 | * Jens Lukowski/Innoopract - initial renaming/restructuring |
| 11 | * |
| 12 | *******************************************************************************/ |
david_williams | 4ad020f | 2005-04-18 08:00:30 +0000 | [diff] [blame] | 13 | package org.eclipse.wst.sse.core.internal.provisional.document; |
david_williams | cfdb2cd | 2004-11-11 08:37:49 +0000 | [diff] [blame] | 14 | |
| 15 | import org.eclipse.jface.text.IDocument; |
david_williams | dce4ddd | 2005-03-18 05:35:37 +0000 | [diff] [blame] | 16 | import org.eclipse.wst.sse.core.internal.encoding.EncodingMemento; |
david_williams | cfdb2cd | 2004-11-11 08:37:49 +0000 | [diff] [blame] | 17 | |
david_williams | 7a65dc2 | 2005-04-09 02:19:50 +0000 | [diff] [blame] | 18 | /** |
| 19 | * This interface is strictly to define important "document properties" not |
| 20 | * found in IDocument, but not central to "StructuredDocument". |
| 21 | * |
| 22 | * Its not to be be implmented by clients. |
| 23 | * |
david_williams | 6cb2639 | 2005-06-24 20:13:29 +0000 | [diff] [blame] | 24 | * @plannedfor 1.0 |
david_williams | 7a65dc2 | 2005-04-09 02:19:50 +0000 | [diff] [blame] | 25 | */ |
david_williams | cfdb2cd | 2004-11-11 08:37:49 +0000 | [diff] [blame] | 26 | |
| 27 | public interface IEncodedDocument extends IDocument { |
| 28 | |
david_williams | 7a65dc2 | 2005-04-09 02:19:50 +0000 | [diff] [blame] | 29 | /** |
| 30 | * Returns the encoding memento for this document. |
| 31 | * |
| 32 | * @return the encoding memento for this document. |
| 33 | */ |
david_williams | cfdb2cd | 2004-11-11 08:37:49 +0000 | [diff] [blame] | 34 | EncodingMemento getEncodingMemento(); |
| 35 | |
david_williams | 7a65dc2 | 2005-04-09 02:19:50 +0000 | [diff] [blame] | 36 | /** |
| 37 | * Returns the preferred line delimiter for this document. |
| 38 | */ |
| 39 | String getPreferredLineDelimiter(); |
david_williams | cfdb2cd | 2004-11-11 08:37:49 +0000 | [diff] [blame] | 40 | |
david_williams | 7a65dc2 | 2005-04-09 02:19:50 +0000 | [diff] [blame] | 41 | /** |
| 42 | * Sets the encoding memento for this document. |
| 43 | * |
| 44 | * Is not to be called by clients, only document creation classes. |
| 45 | * |
| 46 | * @param localEncodingMemento |
| 47 | */ |
david_williams | cfdb2cd | 2004-11-11 08:37:49 +0000 | [diff] [blame] | 48 | void setEncodingMemento(EncodingMemento localEncodingMemento); |
| 49 | |
david_williams | 7a65dc2 | 2005-04-09 02:19:50 +0000 | [diff] [blame] | 50 | /** |
| 51 | * Sets the preferredLineDelimiter. Is not to be called by clients, only |
| 52 | * document creation classes. |
| 53 | * |
| 54 | * @param probableLineDelimiter |
| 55 | */ |
| 56 | void setPreferredLineDelimiter(String probableLineDelimiter); |
david_williams | cfdb2cd | 2004-11-11 08:37:49 +0000 | [diff] [blame] | 57 | |
| 58 | } |