/usr/share/doc/libjdom1-java/api/org/jdom/output/Format.html is in libjdom1-java-doc 1.1.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.6.0_27) on Tue Jul 30 04:06:34 UTC 2013 -->
<title>Format (JDOM v1.SNAPSHOT)</title>
<meta name="date" content="2013-07-30">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Format (JDOM v1.SNAPSHOT)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Format.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><b>JDOM<br><font size='-1'>1.SNAPSHOT</font></b></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/jdom/output/EscapeStrategy.html" title="interface in org.jdom.output"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../org/jdom/output/Format.TextMode.html" title="class in org.jdom.output"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/jdom/output/Format.html" target="_top">FRAMES</a></li>
<li><a href="Format.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY: </li>
<li><a href="#nested_class_summary">NESTED</a> | </li>
<li>FIELD | </li>
<li>CONSTR | </li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL: </li>
<li>FIELD | </li>
<li>CONSTR | </li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<p class="subTitle">org.jdom.output</p>
<h2 title="Class Format" class="title">Class Format</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.jdom.output.Format</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Cloneable</dd>
</dl>
<hr>
<br>
<pre>public class <strong>Format</strong>
extends java.lang.Object
implements java.lang.Cloneable</pre>
<div class="block">Class to encapsulate XMLOutputter format options.
Typical users can use the standard format configurations obtained by
<a href="../../../org/jdom/output/Format.html#getRawFormat()"><code>getRawFormat()</code></a> (no whitespace changes),
<a href="../../../org/jdom/output/Format.html#getPrettyFormat()"><code>getPrettyFormat()</code></a> (whitespace beautification), and
<a href="../../../org/jdom/output/Format.html#getCompactFormat()"><code>getCompactFormat()</code></a> (whitespace normalization).
<p>
Several modes are available to effect the way textual content is printed.
See the documentation for <a href="../../../org/jdom/output/Format.TextMode.html" title="class in org.jdom.output"><code>Format.TextMode</code></a> for details.</div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>$Revision: 1.14 $, $Date: 2009/07/23 05:54:23 $</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Jason Hunter</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/output/Format.TextMode.html" title="class in org.jdom.output">Format.TextMode</a></strong></code>
<div class="block">Class to signify how text should be handled on output.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/output/Format.html#clone()">clone</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/jdom/output/Format.html" title="class in org.jdom.output">Format</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/output/Format.html#getCompactFormat()">getCompactFormat</a></strong>()</code>
<div class="block">Returns a new Format object that performs whitespace normalization, uses
the UTF-8 encoding, doesn't expand empty elements, includes the
declaration and encoding, and uses the default entity escape strategy.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/output/Format.html#getEncoding()">getEncoding</a></strong>()</code>
<div class="block">Returns the configured output encoding.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/jdom/output/EscapeStrategy.html" title="interface in org.jdom.output">EscapeStrategy</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/output/Format.html#getEscapeStrategy()">getEscapeStrategy</a></strong>()</code>
<div class="block">Returns the current escape strategy</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/output/Format.html#getExpandEmptyElements()">getExpandEmptyElements</a></strong>()</code>
<div class="block">Returns whether empty elements are expanded.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/output/Format.html#getIgnoreTrAXEscapingPIs()">getIgnoreTrAXEscapingPIs</a></strong>()</code>
<div class="block">Returns whether JAXP TrAX processing instructions for
disabling/enabling output escaping are ignored.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/output/Format.html#getIndent()">getIndent</a></strong>()</code>
<div class="block">Returns the indent string in use.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/output/Format.html#getLineSeparator()">getLineSeparator</a></strong>()</code>
<div class="block">Returns the current line separator.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/output/Format.html#getOmitDeclaration()">getOmitDeclaration</a></strong>()</code>
<div class="block">Returns whether the XML declaration will be omitted.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/output/Format.html#getOmitEncoding()">getOmitEncoding</a></strong>()</code>
<div class="block">Returns whether the XML declaration encoding will be omitted.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../org/jdom/output/Format.html" title="class in org.jdom.output">Format</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/output/Format.html#getPrettyFormat()">getPrettyFormat</a></strong>()</code>
<div class="block">Returns a new Format object that performs whitespace beautification with
2-space indents, uses the UTF-8 encoding, doesn't expand empty elements,
includes the declaration and encoding, and uses the default entity
escape strategy.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/jdom/output/Format.html" title="class in org.jdom.output">Format</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/output/Format.html#getRawFormat()">getRawFormat</a></strong>()</code>
<div class="block">Returns a new Format object that performs no whitespace changes, uses
the UTF-8 encoding, doesn't expand empty elements, includes the
declaration and encoding, and uses the default entity escape strategy.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/jdom/output/Format.TextMode.html" title="class in org.jdom.output">Format.TextMode</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/output/Format.html#getTextMode()">getTextMode</a></strong>()</code>
<div class="block">Returns the current text output style.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/jdom/output/Format.html" title="class in org.jdom.output">Format</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/output/Format.html#setEncoding(java.lang.String)">setEncoding</a></strong>(java.lang.String encoding)</code>
<div class="block">Sets the output encoding.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/jdom/output/Format.html" title="class in org.jdom.output">Format</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/output/Format.html#setEscapeStrategy(org.jdom.output.EscapeStrategy)">setEscapeStrategy</a></strong>(<a href="../../../org/jdom/output/EscapeStrategy.html" title="interface in org.jdom.output">EscapeStrategy</a> strategy)</code>
<div class="block">Sets the <a href="../../../org/jdom/output/EscapeStrategy.html" title="interface in org.jdom.output"><code>EscapeStrategy</code></a> to use for character escaping.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/jdom/output/Format.html" title="class in org.jdom.output">Format</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/output/Format.html#setExpandEmptyElements(boolean)">setExpandEmptyElements</a></strong>(boolean expandEmptyElements)</code>
<div class="block">This will set whether empty elements are expanded from
<code><tagName/></code> to
<code><tagName></tagName></code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/output/Format.html#setIgnoreTrAXEscapingPIs(boolean)">setIgnoreTrAXEscapingPIs</a></strong>(boolean ignoreTrAXEscapingPIs)</code>
<div class="block">This will set whether JAXP TrAX processing instructions for
disabling/enabling output escaping are ignored.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/jdom/output/Format.html" title="class in org.jdom.output">Format</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/output/Format.html#setIndent(java.lang.String)">setIndent</a></strong>(java.lang.String indent)</code>
<div class="block">This will set the indent <code>String</code> to use; this
is usually a <code>String</code> of empty spaces.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/jdom/output/Format.html" title="class in org.jdom.output">Format</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/output/Format.html#setLineSeparator(java.lang.String)">setLineSeparator</a></strong>(java.lang.String separator)</code>
<div class="block">This will set the newline separator (<code>lineSeparator</code>).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/jdom/output/Format.html" title="class in org.jdom.output">Format</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/output/Format.html#setOmitDeclaration(boolean)">setOmitDeclaration</a></strong>(boolean omitDeclaration)</code>
<div class="block">This will set whether the XML declaration
(<code><?xml version="1.0"?gt;</code>)
will be omitted or not.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/jdom/output/Format.html" title="class in org.jdom.output">Format</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/output/Format.html#setOmitEncoding(boolean)">setOmitEncoding</a></strong>(boolean omitEncoding)</code>
<div class="block">This will set whether the XML declaration
(<code><?xml version="1.0"
encoding="UTF-8"?></code>)
includes the encoding of the document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/jdom/output/Format.html" title="class in org.jdom.output">Format</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/output/Format.html#setTextMode(org.jdom.output.Format.TextMode)">setTextMode</a></strong>(<a href="../../../org/jdom/output/Format.TextMode.html" title="class in org.jdom.output">Format.TextMode</a> mode)</code>
<div class="block">This sets the text output style.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getRawFormat()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRawFormat</h4>
<pre>public static <a href="../../../org/jdom/output/Format.html" title="class in org.jdom.output">Format</a> getRawFormat()</pre>
<div class="block">Returns a new Format object that performs no whitespace changes, uses
the UTF-8 encoding, doesn't expand empty elements, includes the
declaration and encoding, and uses the default entity escape strategy.
Tweaks can be made to the returned Format instance without affecting
other instances.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a Format with no whitespace changes</dd></dl>
</li>
</ul>
<a name="getPrettyFormat()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrettyFormat</h4>
<pre>public static <a href="../../../org/jdom/output/Format.html" title="class in org.jdom.output">Format</a> getPrettyFormat()</pre>
<div class="block">Returns a new Format object that performs whitespace beautification with
2-space indents, uses the UTF-8 encoding, doesn't expand empty elements,
includes the declaration and encoding, and uses the default entity
escape strategy.
Tweaks can be made to the returned Format instance without affecting
other instances.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a Format with whitespace beautification</dd></dl>
</li>
</ul>
<a name="getCompactFormat()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCompactFormat</h4>
<pre>public static <a href="../../../org/jdom/output/Format.html" title="class in org.jdom.output">Format</a> getCompactFormat()</pre>
<div class="block">Returns a new Format object that performs whitespace normalization, uses
the UTF-8 encoding, doesn't expand empty elements, includes the
declaration and encoding, and uses the default entity escape strategy.
Tweaks can be made to the returned Format instance without affecting
other instances.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a Format with whitespace normalization</dd></dl>
</li>
</ul>
<a name="setEscapeStrategy(org.jdom.output.EscapeStrategy)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEscapeStrategy</h4>
<pre>public <a href="../../../org/jdom/output/Format.html" title="class in org.jdom.output">Format</a> setEscapeStrategy(<a href="../../../org/jdom/output/EscapeStrategy.html" title="interface in org.jdom.output">EscapeStrategy</a> strategy)</pre>
<div class="block">Sets the <a href="../../../org/jdom/output/EscapeStrategy.html" title="interface in org.jdom.output"><code>EscapeStrategy</code></a> to use for character escaping.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>strategy</code> - the EscapeStrategy to use</dd>
<dt><span class="strong">Returns:</span></dt><dd>a pointer to this Format for chaining</dd></dl>
</li>
</ul>
<a name="getEscapeStrategy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEscapeStrategy</h4>
<pre>public <a href="../../../org/jdom/output/EscapeStrategy.html" title="interface in org.jdom.output">EscapeStrategy</a> getEscapeStrategy()</pre>
<div class="block">Returns the current escape strategy</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the current escape strategy</dd></dl>
</li>
</ul>
<a name="setLineSeparator(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLineSeparator</h4>
<pre>public <a href="../../../org/jdom/output/Format.html" title="class in org.jdom.output">Format</a> setLineSeparator(java.lang.String separator)</pre>
<div class="block">This will set the newline separator (<code>lineSeparator</code>).
The default is <code>\r\n</code>. To make it output
the system default line ending string, call
<code>setLineSeparator(System.getProperty("line.separator"))</code>.
<p>
To output "UNIX-style" documents, call
<code>setLineSeparator("\n")</code>. To output "Mac-style"
documents, call <code>setLineSeparator("\r")</code>. DOS-style
documents use CR-LF ("\r\n"), which is the default.
</p>
<p>
Note that this only applies to newlines generated by the
outputter. If you parse an XML document that contains newlines
embedded inside a text node, and you do not set TextMode.NORMALIZE,
then the newlines will be output
verbatim, as "\n" which is how parsers normalize them.
</p>
<p>
If the format's "indent" property is null (as is the default
for the Raw and Compact formats), then this value only effects the
newlines written after the declaration and doctype.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>separator</code> - <code>String</code> line separator to use.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a pointer to this Format for chaining</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/jdom/output/Format.html#setTextMode(org.jdom.output.Format.TextMode)"><code>setTextMode(org.jdom.output.Format.TextMode)</code></a></dd></dl>
</li>
</ul>
<a name="getLineSeparator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLineSeparator</h4>
<pre>public java.lang.String getLineSeparator()</pre>
<div class="block">Returns the current line separator.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the current line separator</dd></dl>
</li>
</ul>
<a name="setOmitEncoding(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOmitEncoding</h4>
<pre>public <a href="../../../org/jdom/output/Format.html" title="class in org.jdom.output">Format</a> setOmitEncoding(boolean omitEncoding)</pre>
<div class="block">This will set whether the XML declaration
(<code><?xml version="1.0"
encoding="UTF-8"?></code>)
includes the encoding of the document. It is common to omit
this in uses such as WML and other wireless device protocols.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>omitEncoding</code> - <code>boolean</code> indicating whether or not
the XML declaration should indicate the document encoding.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a pointer to this Format for chaining</dd></dl>
</li>
</ul>
<a name="getOmitEncoding()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOmitEncoding</h4>
<pre>public boolean getOmitEncoding()</pre>
<div class="block">Returns whether the XML declaration encoding will be omitted.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>whether the XML declaration encoding will be omitted</dd></dl>
</li>
</ul>
<a name="setOmitDeclaration(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOmitDeclaration</h4>
<pre>public <a href="../../../org/jdom/output/Format.html" title="class in org.jdom.output">Format</a> setOmitDeclaration(boolean omitDeclaration)</pre>
<div class="block">This will set whether the XML declaration
(<code><?xml version="1.0"?gt;</code>)
will be omitted or not. It is common to omit this in uses such
as SOAP and XML-RPC calls.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>omitDeclaration</code> - <code>boolean</code> indicating whether or not
the XML declaration should be omitted.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a pointer to this Format for chaining</dd></dl>
</li>
</ul>
<a name="getOmitDeclaration()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOmitDeclaration</h4>
<pre>public boolean getOmitDeclaration()</pre>
<div class="block">Returns whether the XML declaration will be omitted.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>whether the XML declaration will be omitted</dd></dl>
</li>
</ul>
<a name="setExpandEmptyElements(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExpandEmptyElements</h4>
<pre>public <a href="../../../org/jdom/output/Format.html" title="class in org.jdom.output">Format</a> setExpandEmptyElements(boolean expandEmptyElements)</pre>
<div class="block">This will set whether empty elements are expanded from
<code><tagName/></code> to
<code><tagName></tagName></code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>expandEmptyElements</code> - <code>boolean</code> indicating whether or not
empty elements should be expanded.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a pointer to this Format for chaining</dd></dl>
</li>
</ul>
<a name="getExpandEmptyElements()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpandEmptyElements</h4>
<pre>public boolean getExpandEmptyElements()</pre>
<div class="block">Returns whether empty elements are expanded.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>whether empty elements are expanded</dd></dl>
</li>
</ul>
<a name="setIgnoreTrAXEscapingPIs(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIgnoreTrAXEscapingPIs</h4>
<pre>public void setIgnoreTrAXEscapingPIs(boolean ignoreTrAXEscapingPIs)</pre>
<div class="block">This will set whether JAXP TrAX processing instructions for
disabling/enabling output escaping are ignored. Disabling
output escaping allows using XML text as element content and
outputing it verbatim, i.e. as element children would be.
<p>
When processed, these processing instructions are removed from
the generated XML text and control whether the element text
content is output verbatim or with escaping of the pre-defined
entities in XML 1.0. The text to be output verbatim shall be
surrounded by the
<code><?javax.xml.transform.disable-output-escaping ?></code>
and <code><?javax.xml.transform.enable-output-escaping ?></code>
PIs.</p>
<p>
When ignored, the processing instructions are present in the
generated XML text and the pre-defined entities in XML 1.0 are
escaped.
<p>
Default: <code>false</code>.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ignoreTrAXEscapingPIs</code> - <code>boolean</code> indicating
whether or not TrAX ouput escaping PIs are ignored.</dd><dt><span class="strong">See Also:</span></dt><dd><code>Result.PI_ENABLE_OUTPUT_ESCAPING</code>,
<code>Result.PI_DISABLE_OUTPUT_ESCAPING</code></dd></dl>
</li>
</ul>
<a name="getIgnoreTrAXEscapingPIs()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIgnoreTrAXEscapingPIs</h4>
<pre>public boolean getIgnoreTrAXEscapingPIs()</pre>
<div class="block">Returns whether JAXP TrAX processing instructions for
disabling/enabling output escaping are ignored.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>whether or not TrAX ouput escaping PIs are ignored.</dd></dl>
</li>
</ul>
<a name="setTextMode(org.jdom.output.Format.TextMode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTextMode</h4>
<pre>public <a href="../../../org/jdom/output/Format.html" title="class in org.jdom.output">Format</a> setTextMode(<a href="../../../org/jdom/output/Format.TextMode.html" title="class in org.jdom.output">Format.TextMode</a> mode)</pre>
<div class="block">This sets the text output style. Options are available as static
<a href="../../../org/jdom/output/Format.TextMode.html" title="class in org.jdom.output"><code>Format.TextMode</code></a> instances. The default is <a href="../../../org/jdom/output/Format.TextMode.html#PRESERVE"><code>Format.TextMode.PRESERVE</code></a>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a pointer to this Format for chaining</dd></dl>
</li>
</ul>
<a name="getTextMode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTextMode</h4>
<pre>public <a href="../../../org/jdom/output/Format.TextMode.html" title="class in org.jdom.output">Format.TextMode</a> getTextMode()</pre>
<div class="block">Returns the current text output style.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the current text output style</dd></dl>
</li>
</ul>
<a name="setIndent(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIndent</h4>
<pre>public <a href="../../../org/jdom/output/Format.html" title="class in org.jdom.output">Format</a> setIndent(java.lang.String indent)</pre>
<div class="block">This will set the indent <code>String</code> to use; this
is usually a <code>String</code> of empty spaces. If you pass
the empty string (""), then no indentation will happen but newlines
will still be generated. Passing null will result in no indentation
and no newlines generated. Default: none (null)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>indent</code> - <code>String</code> to use for indentation.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a pointer to this Format for chaining</dd></dl>
</li>
</ul>
<a name="getIndent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIndent</h4>
<pre>public java.lang.String getIndent()</pre>
<div class="block">Returns the indent string in use.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the indent string in use</dd></dl>
</li>
</ul>
<a name="setEncoding(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEncoding</h4>
<pre>public <a href="../../../org/jdom/output/Format.html" title="class in org.jdom.output">Format</a> setEncoding(java.lang.String encoding)</pre>
<div class="block">Sets the output encoding. The name should be an accepted XML
encoding.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>encoding</code> - the encoding format. Use XML-style names like
"UTF-8" or "ISO-8859-1" or "US-ASCII"</dd>
<dt><span class="strong">Returns:</span></dt><dd>a pointer to this Format for chaining</dd></dl>
</li>
</ul>
<a name="getEncoding()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEncoding</h4>
<pre>public java.lang.String getEncoding()</pre>
<div class="block">Returns the configured output encoding.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the output encoding</dd></dl>
</li>
</ul>
<a name="clone()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clone</h4>
<pre>public java.lang.Object clone()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>clone</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Format.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><b>JDOM<br><font size='-1'>1.SNAPSHOT</font></b></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/jdom/output/EscapeStrategy.html" title="interface in org.jdom.output"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../org/jdom/output/Format.TextMode.html" title="class in org.jdom.output"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/jdom/output/Format.html" target="_top">FRAMES</a></li>
<li><a href="Format.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY: </li>
<li><a href="#nested_class_summary">NESTED</a> | </li>
<li>FIELD | </li>
<li>CONSTR | </li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL: </li>
<li>FIELD | </li>
<li>CONSTR | </li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright ? 2011 Jason Hunter, Brett McLaughlin. All Rights Reserved.</small></p>
</body>
</html>
|