001: /*
002: * Copyright (c) 2002-2008 Gargoyle Software Inc. All rights reserved.
003: *
004: * Redistribution and use in source and binary forms, with or without
005: * modification, are permitted provided that the following conditions are met:
006: *
007: * 1. Redistributions of source code must retain the above copyright notice,
008: * this list of conditions and the following disclaimer.
009: * 2. Redistributions in binary form must reproduce the above copyright notice,
010: * this list of conditions and the following disclaimer in the documentation
011: * and/or other materials provided with the distribution.
012: * 3. The end-user documentation included with the redistribution, if any, must
013: * include the following acknowledgment:
014: *
015: * "This product includes software developed by Gargoyle Software Inc.
016: * (http://www.GargoyleSoftware.com/)."
017: *
018: * Alternately, this acknowledgment may appear in the software itself, if
019: * and wherever such third-party acknowledgments normally appear.
020: * 4. The name "Gargoyle Software" must not be used to endorse or promote
021: * products derived from this software without prior written permission.
022: * For written permission, please contact info@GargoyleSoftware.com.
023: * 5. Products derived from this software may not be called "HtmlUnit", nor may
024: * "HtmlUnit" appear in their name, without prior written permission of
025: * Gargoyle Software Inc.
026: *
027: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
028: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
029: * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARGOYLE
030: * SOFTWARE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
031: * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
032: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
033: * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
034: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
035: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
036: * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
037: */
038: package com.gargoylesoftware.htmlunit.html;
039:
040: import java.io.PrintWriter;
041:
042: import org.apache.commons.lang.StringEscapeUtils;
043:
044: import com.gargoylesoftware.htmlunit.Page;
045:
046: /**
047: * representation of a text node in the Html DOM
048: *
049: * @version $Revision: 2132 $
050: * @author David K. Taylor
051: * @author <a href="mailto:cse@dynabean.de">Christian Sell</a>
052: * @author Rodney Gitzel
053: * @author Ahmed Ashour
054: */
055: public class DomText extends DomCharacterData {
056:
057: private static final long serialVersionUID = 6589779086230288951L;
058:
059: /** the symbolic node name */
060: public static final String NODE_NAME = "#text";
061:
062: /**
063: * Create an instance of DomText
064: *
065: * @param page The Page that contains this element.
066: * @param data the string data held by this node
067: */
068: public DomText(final Page page, final String data) {
069: super (page, data);
070: }
071:
072: /**
073: * Split a Text node in two.
074: * @param offset The character position at which to split the Text node.
075: * @return The Text node that was split from this node.
076: * @deprecated This method conflicts with the W3C DOM API since the return values are
077: * different. Use splitDomText instead.
078: */
079: public DomText splitText(final int offset) {
080: return splitDomText(offset);
081: }
082:
083: /**
084: * Split a DomText node in two.
085: * @param offset The character position at which to split the DomText node.
086: * @return The DomText node that was split from this node.
087: */
088: public DomText splitDomText(final int offset) {
089: if (offset < 0 || offset > getLength()) {
090: throw new IllegalArgumentException("offset: " + offset
091: + " data.length: " + getLength());
092: }
093:
094: // split text into two separate nodes
095: final DomText newText = new DomText(getPage(), getData()
096: .substring(offset));
097: setData(getData().substring(0, offset));
098:
099: // insert new text node
100: if (getParentDomNode() != null) {
101: newText.setParentNode(getParentDomNode());
102: newText.setPreviousSibling(this );
103: newText.setNextSibling(getNextDomSibling());
104: setNextSibling(newText);
105: }
106:
107: return newText;
108: }
109:
110: /**
111: * {@inheritDoc}
112: */
113: public String asText() {
114: String text = getData();
115: if (!(getParentDomNode() instanceof HtmlTextArea)) {
116: // Remove extra whitespace
117: text = reduceWhitespace(text);
118: }
119: return text;
120: }
121:
122: /**
123: * @return the node type constant, in this case {@link org.w3c.dom.Node#TEXT_NODE}
124: */
125: public short getNodeType() {
126: return org.w3c.dom.Node.TEXT_NODE;
127: }
128:
129: /**
130: * @return the node name, in this case {@link #NODE_NAME}
131: */
132: public String getNodeName() {
133: return NODE_NAME;
134: }
135:
136: /**
137: * recursively write the XML data for the node tree starting at <code>node</code>
138: *
139: * @param indent white space to indent child nodes
140: * @param printWriter writer where child nodes are written
141: */
142: protected void printXml(final String indent,
143: final PrintWriter printWriter) {
144: printWriter.print(indent);
145: printWriter.println(StringEscapeUtils.escapeXml(getData()));
146: printChildrenAsXml(indent, printWriter);
147: }
148:
149: /**
150: * Gives a simple representation to facilitate debugging
151: * @return a simple representation
152: */
153: public String toString() {
154: return asText();
155: }
156:
157: /**
158: * {@inheritDoc}
159: */
160: protected boolean isTrimmedText() {
161: return false;
162: }
163: }
|