340 lines
16 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<div class="header">
<div class="subTitle">
javax.print
</div>
<h2 class="title" title="Class SimpleDoc">Class SimpleDoc</h2>
</div><div class="contentContainer">
<ul class="inheritance">
<li><a href="../../java/lang/Object.html" title="class in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>javax.print.SimpleDoc</li>
</ul> </li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>
All Implemented Interfaces:
</dt>
<dd>
<span><a href="../../javax/print/Doc.html" title="javax.print中的接口">Doc</a></span>
</dd>
</dl>
<hr/> <br/> <pre>public final class <span class="typeNameLabel">SimpleDoc</span>
extends <a href="../../java/lang/Object.html" title="class in java.lang">Object</a>
implements <a href="../../javax/print/Doc.html" title="interface in javax.print">Doc</a></pre>
<div class="block">
<span>该类是可以在许多常见打印请求中使用的接口<code>Doc</code>实现。</span>
<span>它可以处理DocFlavor类中定义为静态变量的所有当前定义的“预定义”文档。</span>
<p> <span>特别地该类实现Doc规范的某些必需语义如下</span> </p>
<ul>
<li> <span>如果请求和适当,构建服务的流。</span> </li>
<li> <span>确保在方法上为每个调用返回相同的对象。</span> </li>
<li> <span>确保多个线程可以访问文档</span> </li>
<li> <span>执行一些验证,数据与文档风格匹配。</span> </li>
</ul>
<span>想要在其他作业中重新使用doc对象或需要MultiDoc的客户端不会想使用此类。</span>
<p> <span>如果打印数据是流,或打印作业以数据流的形式请求数据,则<code>SimpleDoc</code>不会监视数据传输完成或作业终止后是否正确关闭流。</span> <span>客户可能更喜欢使用提供自己的文档实现来添加监听器来监视作业完成并验证诸如流的资源被释放(即关闭)。</span> </p>
</div> </li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- --> </a> <h3>构造方法摘要</h3>
<table border="0" cellpadding="3" cellspacing="0" class="memberSummary" summary="Constructor Summary table, listing constructors, and an explanation">
<caption>
<span>构造方法</span>
<span class="tabEnd"> </span>
</caption>
<tbody>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../javax/print/SimpleDoc.html#SimpleDoc-java.lang.Object-javax.print.DocFlavor-javax.print.attribute.DocAttributeSet-">SimpleDoc</a></span>(<a href="../../java/lang/Object.html" title="class in java.lang">Object</a> printData, <a href="../../javax/print/DocFlavor.html" title="class in javax.print">DocFlavor</a> flavor, <a href="../../javax/print/attribute/DocAttributeSet.html" title="interface in javax.print.attribute">DocAttributeSet</a> attributes)</code>
<div class="block">
构造一个
<code>SimpleDoc</code>具有指定打印数据doc的风味和文档属性集。
</div> </td>
</tr>
</tbody>
</table> </li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- --> </a> <h3>方法摘要</h3>
<table border="0" cellpadding="3" cellspacing="0" class="memberSummary" summary="Method Summary table, listing methods, and an explanation">
<caption>
<span class="activeTableTab" id="t0"><span>所有方法</span><span class="tabEnd"> </span></span>
<span class="tableTab" id="t2"><span><a href="javascript:show(2);">接口方法</a></span><span class="tabEnd"> </span></span>
<span class="tableTab" id="t4"><span><a href="javascript:show(8);">具体的方法</a></span><span class="tabEnd"> </span></span>
</caption>
<tbody>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor" id="i0">
<td class="colFirst"><code><a href="../../javax/print/attribute/DocAttributeSet.html" title="interface in javax.print.attribute">DocAttributeSet</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/print/SimpleDoc.html#getAttributes--">getAttributes</a></span>()</code>
<div class="block">
获取此文档对象的打印属性集。
</div> </td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code><a href="../../javax/print/DocFlavor.html" title="class in javax.print">DocFlavor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/print/SimpleDoc.html#getDocFlavor--">getDocFlavor</a></span>()</code>
<div class="block">
确定此文档对象将提供其打印数据的文档风格。
</div> </td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code><a href="../../java/lang/Object.html" title="class in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/print/SimpleDoc.html#getPrintData--">getPrintData</a></span>()</code>
<div class="block">
以与支持的文档风格相对应的格式获取包含此文档对象的打印数据的打印数据表示对象。
</div> </td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code><a href="../../java/io/Reader.html" title="class in java.io">Reader</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/print/SimpleDoc.html#getReaderForText--">getReaderForText</a></span>()</code>
<div class="block">
获取从该文档中提取字符打印数据的读取器。
</div> </td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code><a href="../../java/io/InputStream.html" title="class in java.io">InputStream</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/print/SimpleDoc.html#getStreamForBytes--">getStreamForBytes</a></span>()</code>
<div class="block">
获取从该文档中提取字节打印数据的输入流。
</div> </td>
</tr>
</tbody>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- --> </a> <h3>Methods inherited from class java.lang.<a href="../../java/lang/Object.html" title="class in java.lang">Object</a></h3> <code><a href="../../java/lang/Object.html#clone--">clone</a>, <a href="../../java/lang/Object.html#equals-java.lang.Object-">equals</a>, <a href="../../java/lang/Object.html#finalize--">finalize</a>, <a href="../../java/lang/Object.html#getClass--">getClass</a>, <a href="../../java/lang/Object.html#hashCode--">hashCode</a>, <a href="../../java/lang/Object.html#notify--">notify</a>, <a href="../../java/lang/Object.html#notifyAll--">notifyAll</a>, <a href="../../java/lang/Object.html#toString--">toString</a>, <a href="../../java/lang/Object.html#wait--">wait</a>, <a href="../../java/lang/Object.html#wait-long-">wait</a>, <a href="../../java/lang/Object.html#wait-long-int-">wait</a></code></li>
</ul> </li>
</ul> </li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- --> </a> <h3>构造方法详细信息</h3> <a name="SimpleDoc-java.lang.Object-javax.print.DocFlavor-javax.print.attribute.DocAttributeSet-">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>SimpleDoc</h4> <pre>public SimpleDoc(<a href="../../java/lang/Object.html" title="class in java.lang">Object</a> printData,
<a href="../../javax/print/DocFlavor.html" title="class in javax.print">DocFlavor</a> flavor,
<a href="../../javax/print/attribute/DocAttributeSet.html" title="interface in javax.print.attribute">DocAttributeSet</a> attributes)</pre>
<div class="block">
构造一个
<code>SimpleDoc</code>具有指定打印数据doc的风味和文档属性集。
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>printData</code> - 打印数据对象
</dd>
<dd>
<code>flavor</code> -
<code>DocFlavor</code>对象
</dd>
<dd>
<code>attributes</code> - a
<code>DocAttributeSet</code> ,可以是
<code>null</code>
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../java/lang/IllegalArgumentException.html" title="class in java.lang">IllegalArgumentException</a></code> - 如果
<code>flavor</code>
<code>printData</code>
<code>null</code> ,或
<code>printData</code>不对应于指定的文档风格 - 例如数据不是指定为DocFlavor中的
<code>DocFlavor</code>
</dd>
</dl> </li>
</ul> </li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- --> </a> <h3>方法详细信息</h3> <a name="getDocFlavor--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getDocFlavor</h4> <pre>public <a href="../../javax/print/DocFlavor.html" title="class in javax.print">DocFlavor</a> getDocFlavor()</pre>
<div class="block">
确定此文档对象将提供其打印数据的文档风格。
</div>
<dl>
<dt>
<span class="overrideSpecifyLabel">Specified by:</span>
</dt>
<dd>
<code><a href="../../javax/print/Doc.html#getDocFlavor--">getDocFlavor</a></code>在界面
<code><a href="../../javax/print/Doc.html" title="interface in javax.print">Doc</a></code>
</dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
Doc味道。
</dd>
</dl> </li>
</ul> <a name="getAttributes--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getAttributes</h4> <pre>public <a href="../../javax/print/attribute/DocAttributeSet.html" title="interface in javax.print.attribute">DocAttributeSet</a> getAttributes()</pre>
<div class="block">
<span>获取此文档对象的打印属性集。</span>
<span>如果返回的属性集包含特定属性<i>X</i>的实例<i></i>打印机必须使用该文档的属性值,覆盖作业属性集中属性<i>X的</i>任何值。</span>
<span>如果返回的属性集不包含特定属性<i>X</i>的实例或者如果返回null则打印机必须查看作业的属性集以获取属性<i>X</i>的值<i></i>如果没有找到,则打印机必须使用实现 -依赖默认值。</span>
<span>返回的属性集是不可修改的。</span>
</div>
<dl>
<dt>
<span class="overrideSpecifyLabel">Specified by:</span>
</dt>
<dd>
<code><a href="../../javax/print/Doc.html#getAttributes--">getAttributes</a></code>在界面
<code><a href="../../javax/print/Doc.html" title="interface in javax.print">Doc</a></code>
</dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
此文档的不可修改的打印属性集或null可从作业的属性集获取所有属性值。
</dd>
</dl> </li>
</ul> <a name="getPrintData--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getPrintData</h4> <pre>public <a href="../../java/lang/Object.html" title="class in java.lang">Object</a> getPrintData()
throws <a href="../../java/io/IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">
<span class="descfrmTypeLabel">说明从界面: <code><a href="../../javax/print/Doc.html#getPrintData--">Doc</a></code>复制</span>
</div>
<div class="block">
<span>以与支持的文档风格相对应的格式获取包含此文档对象的打印数据的打印数据表示对象。</span>
<span><code>getPrintData()</code>方法返回名称由<code><a href="../../javax/print/Doc.html#getDocFlavor--"><code>getDocFlavor()</code></a>.<a href="../../javax/print/DocFlavor.html#getRepresentationClassName--"><code>getRepresentationClassName()</code></a></code>给出的表示类的实例返回值可以从类Object转换为该表示类。</span>
</div>
<dl>
<dt>
<span class="overrideSpecifyLabel">Specified by:</span>
</dt>
<dd>
<code><a href="../../javax/print/Doc.html#getPrintData--">getPrintData</a></code>在界面
<code><a href="../../javax/print/Doc.html" title="interface in javax.print">Doc</a></code>
</dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
打印数据表示对象。
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../java/io/IOException.html" title="class in java.io">IOException</a></code> - 如果表示类是流并在构建流时出现I / O错误则抛出。
</dd>
</dl> </li>
</ul> <a name="getReaderForText--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getReaderForText</h4> <pre>public <a href="../../java/io/Reader.html" title="class in java.io">Reader</a> getReaderForText()
throws <a href="../../java/io/IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">
<span>获取从该文档中提取字符打印数据的读取器。</span>
<span><code>Doc</code>实现需要在支持此方法如果<code>DocFlavor</code>具有以下打印数据表示形式类之一,并返回<code>null</code>否则:</span>
<ul>
<li> <code>char[]</code> </li>
<li> <code>java.lang.String</code> </li>
<li> <code>java.io.Reader</code> </li>
</ul>
<span>文档的打印数据表示对象用于构造并返回一个<code>Reader</code> ,用于从打印数据表示对象读取打印数据作为字符流。</span>
<span>然而,如果打印数据表示对象本身是一个<code>Reader</code>则打印数据表示对象只需返回。</span>
<p></p>
</div>
<dl>
<dt>
<span class="overrideSpecifyLabel">Specified by:</span>
</dt>
<dd>
<code><a href="../../javax/print/Doc.html#getReaderForText--">getReaderForText</a></code>在界面
<code><a href="../../javax/print/Doc.html" title="interface in javax.print">Doc</a></code>
</dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
<span>一个<code>Reader</code>用于读取此文档中的打印数据字符。</span>
<span>如果由于本文档不符合上述条件而无法提供读者,则返回<code>null</code></span>
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../java/io/IOException.html" title="class in java.io">IOException</a></code> - 创建阅读器时是否有I / O错误。
</dd>
</dl> </li>
</ul> <a name="getStreamForBytes--">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>getStreamForBytes</h4> <pre>public <a href="../../java/io/InputStream.html" title="class in java.io">InputStream</a> getStreamForBytes()
throws <a href="../../java/io/IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">
<span>获取从该文档中提取字节打印数据的输入流。</span>
<span>如果<code>DocFlavor</code>具有以下打印数据表示类之一,则需要<code>Doc</code>实现来支持此方法;</span>
<span>否则该方法返回<code>null</code> </span>
<ul>
<li> <code>byte[]</code> </li>
<li> <code>java.io.InputStream</code> </li>
</ul>
<span>获取文档的打印数据表示对象。</span>
<span>然后,创建并返回用于从打印数据表示对象读取打印数据作为字节流的输入流。</span>
<span>然而,如果打印数据表示对象本身是输入流,则简单地返回打印数据表示对象。</span>
<p></p>
</div>
<dl>
<dt>
<span class="overrideSpecifyLabel">Specified by:</span>
</dt>
<dd>
<code><a href="../../javax/print/Doc.html#getStreamForBytes--">getStreamForBytes</a></code>在界面
<code><a href="../../javax/print/Doc.html" title="interface in javax.print">Doc</a></code>
</dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
<span>一个<code>InputStream</code>用于读取此文档中的打印数据字节。</span>
<span>如果由于此文档不符合上述条件而无法提供输入流,则返回<code>null</code></span>
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../java/io/IOException.html" title="class in java.io">IOException</a></code> - 创建输入流时是否有I / O错误。
</dd>
</dl> </li>
</ul> </li>
</ul> </li>
</ul>
</div>
</div>