KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > enhydra > xml > io > PreFormattedText


1 /*
2  * Enhydra Java Application Server Project
3  *
4  * The contents of this file are subject to the Enhydra Public License
5  * Version 1.1 (the "License"); you may not use this file except in
6  * compliance with the License. You may obtain a copy of the License on
7  * the Enhydra web site ( http://www.enhydra.org/ ).
8  *
9  * Software distributed under the License is distributed on an "AS IS"
10  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
11  * the License for the specific terms governing rights and limitations
12  * under the License.
13  *
14  * The Initial Developer of the Enhydra Application Server is Lutris
15  * Technologies, Inc. The Enhydra Application Server and portions created
16  * by Lutris Technologies, Inc. are Copyright Lutris Technologies, Inc.
17  * All Rights Reserved.
18  *
19  * Contributor(s):
20  *
21  * $Id: PreFormattedText.java,v 1.1.1.1 2003/03/10 16:36:17 taweili Exp $
22  */
23
24 package org.enhydra.xml.io;
25
26 /**
27  * Interface that nodes of a document must implement if they have formatted
28  * text. Formatted text can be available on:
29  * <UL>
30  * <LI> Text nodes - Formatted text is a string with entity references already
31  * expanded.
32  * <LI> Element nodes - Formatted text is the opening tag, with entity
33  * references in attribute-values expanded.
34  * </UL>
35  */
36 public interface PreFormattedText {
37     /**
38      * Get the pre-formatted text for a node.
39      *
40      * @return The pre-formatted text string, or null if no formatted
41      * text is available or the text is no longer valid.
42      */
43     public String JavaDoc getPreFormattedText();
44
45     // FIXME: set might not be needed (DOM specific).
46 /**
47      * Set the pre-formatted text for a node.
48      */
49     public void setPreFormattedText(String JavaDoc text);
50 }
51
Popular Tags