KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > gargoylesoftware > htmlunit > html > DomText


1 /*
2  * Copyright (c) 2002, 2005 Gargoyle Software Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice,
8  * this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright notice,
10  * this list of conditions and the following disclaimer in the documentation
11  * and/or other materials provided with the distribution.
12  * 3. The end-user documentation included with the redistribution, if any, must
13  * include the following acknowledgment:
14  *
15  * "This product includes software developed by Gargoyle Software Inc.
16  * (http://www.GargoyleSoftware.com/)."
17  *
18  * Alternately, this acknowledgment may appear in the software itself, if
19  * and wherever such third-party acknowledgments normally appear.
20  * 4. The name "Gargoyle Software" must not be used to endorse or promote
21  * products derived from this software without prior written permission.
22  * For written permission, please contact info@GargoyleSoftware.com.
23  * 5. Products derived from this software may not be called "HtmlUnit", nor may
24  * "HtmlUnit" appear in their name, without prior written permission of
25  * Gargoyle Software Inc.
26  *
27  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
28  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
29  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARGOYLE
30  * SOFTWARE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
31  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
33  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
36  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37  */
38 package com.gargoylesoftware.htmlunit.html;
39
40 import java.io.PrintWriter JavaDoc;
41
42 /**
43  * representation of a text node in the Html DOM
44  *
45  * @version $Revision: 100 $
46  * @author David K. Taylor
47  * @author <a HREF="mailto:cse@dynabean.de">Christian Sell</a>
48  */
49 public class DomText extends DomCharacterData {
50
51     /** the symbolic node name */
52     public static final String JavaDoc NODE_NAME = "#text";
53
54     /**
55      * Create an instance of DomText
56      *
57      * @param page The HtmlPage that contains this element.
58      * @param data the string data held by this node
59      */
60     public DomText( final HtmlPage page, final String JavaDoc data) {
61         super(page, data);
62     }
63
64
65     /**
66      * Split a Text node in two.
67      * @param offset The character position at which to split the Text node.
68      * @return The Text node that was split from this node.
69      */
70     public DomText splitText(final int offset) {
71         if (offset < 0 || offset > getLength() ) {
72             throw new IllegalArgumentException JavaDoc("offset: "+offset+" data.length: "+getLength());
73         }
74
75         // split text into two separate nodes
76 final DomText newText = new DomText(getPage(), getData().substring(offset));
77         setData(getData().substring(0, offset));
78
79         // insert new text node
80 if (getParentNode() != null) {
81             newText.setParentNode(getParentNode());
82             newText.setPreviousSibling(this);
83             newText.setNextSibling(getNextSibling());
84             setNextSibling(newText);
85         }
86
87         return newText;
88     }
89
90     /**
91      * Return a text representation of this element that represents what would
92      * be visible to the user if this page was shown in a web browser. For
93      * example, a select element would return the currently selected value as
94      * text
95      *
96      * @return The element as text
97      */
98     public String JavaDoc asText() {
99         return getData();
100     }
101
102     /**
103      * @return the node type constant, in this case {@link DomNode#TEXT_NODE}
104      */
105     public short getNodeType() {
106         return DomNode.TEXT_NODE;
107     }
108
109     /**
110      * @return the node name, in this case {@link #NODE_NAME}
111      */
112     public String JavaDoc getNodeName() {
113         return NODE_NAME;
114     }
115
116     /**
117      * recursively write the XML data for the node tree starting at <code>node</code>
118      *
119      * @param indent white space to indent child nodes
120      * @param printWriter writer where child nodes are written
121      */
122     protected void printXml( final String JavaDoc indent, final PrintWriter JavaDoc printWriter ) {
123
124         printWriter.print(indent);
125         printWriter.println(getData());
126         printChildrenAsXml( indent, printWriter );
127     }
128 }
129
Popular Tags