uTools-Manuals/docs/java/javax/swing/text/StyledDocument.html

439 lines
21 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.swing.text
</div>
<h2 class="title" title="Interface StyledDocument">Interface StyledDocument</h2>
</div><div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>
All Superinterfaces:
</dt>
<dd>
<span><a href="../../../javax/swing/text/Document.html" title="javax.swing.text中的接口">Document</a></span>
</dd>
</dl>
<dl>
<dt>
所有已知实现类:
</dt>
<dd>
<span><a href="../../../javax/swing/text/DefaultStyledDocument.html" title="javax.swing.text中的类">DefaultStyledDocument</a> <a href="../../../javax/swing/text/html/HTMLDocument.html" title="javax.swing.text.html中的类">HTMLDocument</a></span>
</dd>
</dl>
<hr/> <br/> <pre>public interface <span class="typeNameLabel">StyledDocument</span>
extends <a href="../../../javax/swing/text/Document.html" title="interface in javax.swing.text">Document</a></pre>
<div class="block">
通用样式文档的界面。
</div> </li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- --> </a> <h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.javax.swing.text.Document">
<!-- --> </a> <h3>Fields inherited from interface javax.swing.text.<a href="../../../javax/swing/text/Document.html" title="interface in javax.swing.text">Document</a></h3> <code><a href="../../../javax/swing/text/Document.html#StreamDescriptionProperty">StreamDescriptionProperty</a>, <a href="../../../javax/swing/text/Document.html#TitleProperty">TitleProperty</a></code></li>
</ul> </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="t3"><span><a href="javascript:show(4);">抽象方法</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/swing/text/Style.html" title="interface in javax.swing.text">Style</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/swing/text/StyledDocument.html#addStyle-java.lang.String-javax.swing.text.Style-">addStyle</a></span>(<a href="../../../java/lang/String.html" title="class in java.lang">String</a> nm, <a href="../../../javax/swing/text/Style.html" title="interface in javax.swing.text">Style</a> parent)</code>
<div class="block">
在逻辑样式层次结构中添加新样式。
</div> </td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code><a href="../../../java/awt/Color.html" title="class in java.awt">Color</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/swing/text/StyledDocument.html#getBackground-javax.swing.text.AttributeSet-">getBackground</a></span>(<a href="../../../javax/swing/text/AttributeSet.html" title="interface in javax.swing.text">AttributeSet</a> attr)</code>
<div class="block">
获取一组属性并将其转换为背景颜色规范。
</div> </td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code><a href="../../../javax/swing/text/Element.html" title="interface in javax.swing.text">Element</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/swing/text/StyledDocument.html#getCharacterElement-int-">getCharacterElement</a></span>(int pos)</code>
<div class="block">
获取表示文档中给定偏移量的字符的元素。
</div> </td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code><a href="../../../java/awt/Font.html" title="class in java.awt">Font</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/swing/text/StyledDocument.html#getFont-javax.swing.text.AttributeSet-">getFont</a></span>(<a href="../../../javax/swing/text/AttributeSet.html" title="interface in javax.swing.text">AttributeSet</a> attr)</code>
<div class="block">
获取一组属性并将其转换为字体规范。
</div> </td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code><a href="../../../java/awt/Color.html" title="class in java.awt">Color</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/swing/text/StyledDocument.html#getForeground-javax.swing.text.AttributeSet-">getForeground</a></span>(<a href="../../../javax/swing/text/AttributeSet.html" title="interface in javax.swing.text">AttributeSet</a> attr)</code>
<div class="block">
获取一组属性,并将其转换为前景颜色规范。
</div> </td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code><a href="../../../javax/swing/text/Style.html" title="interface in javax.swing.text">Style</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/swing/text/StyledDocument.html#getLogicalStyle-int-">getLogicalStyle</a></span>(int p)</code>
<div class="block">
获取段落中给定位置的逻辑风格。
</div> </td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code><a href="../../../javax/swing/text/Element.html" title="interface in javax.swing.text">Element</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/swing/text/StyledDocument.html#getParagraphElement-int-">getParagraphElement</a></span>(int pos)</code>
<div class="block">
获取表示在文档中包含给定偏移量的段落的元素。
</div> </td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code><a href="../../../javax/swing/text/Style.html" title="interface in javax.swing.text">Style</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/swing/text/StyledDocument.html#getStyle-java.lang.String-">getStyle</a></span>(<a href="../../../java/lang/String.html" title="class in java.lang">String</a> nm)</code>
<div class="block">
获取先前添加的命名样式。
</div> </td>
</tr>
<tr class="altColor" id="i8">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/swing/text/StyledDocument.html#removeStyle-java.lang.String-">removeStyle</a></span>(<a href="../../../java/lang/String.html" title="class in java.lang">String</a> nm)</code>
<div class="block">
删除之前添加到文档的命名样式。
</div> </td>
</tr>
<tr class="rowColor" id="i9">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/swing/text/StyledDocument.html#setCharacterAttributes-int-int-javax.swing.text.AttributeSet-boolean-">setCharacterAttributes</a></span>(int offset, int length, <a href="../../../javax/swing/text/AttributeSet.html" title="interface in javax.swing.text">AttributeSet</a> s, boolean replace)</code>
<div class="block">
更改用于文档中现有内容的给定范围的内容元素属性。
</div> </td>
</tr>
<tr class="altColor" id="i10">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/swing/text/StyledDocument.html#setLogicalStyle-int-javax.swing.text.Style-">setLogicalStyle</a></span>(int pos, <a href="../../../javax/swing/text/Style.html" title="interface in javax.swing.text">Style</a> s)</code>
<div class="block">
设置用于给定位置的段落的逻辑样式。
</div> </td>
</tr>
<tr class="rowColor" id="i11">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/swing/text/StyledDocument.html#setParagraphAttributes-int-int-javax.swing.text.AttributeSet-boolean-">setParagraphAttributes</a></span>(int offset, int length, <a href="../../../javax/swing/text/AttributeSet.html" title="interface in javax.swing.text">AttributeSet</a> s, boolean replace)</code>
<div class="block">
设置段落属性。
</div> </td>
</tr>
</tbody>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.javax.swing.text.Document">
<!-- --> </a> <h3>Methods inherited from interface javax.swing.text.<a href="../../../javax/swing/text/Document.html" title="interface in javax.swing.text">Document</a></h3> <code><a href="../../../javax/swing/text/Document.html#addDocumentListener-javax.swing.event.DocumentListener-">addDocumentListener</a>, <a href="../../../javax/swing/text/Document.html#addUndoableEditListener-javax.swing.event.UndoableEditListener-">addUndoableEditListener</a>, <a href="../../../javax/swing/text/Document.html#createPosition-int-">createPosition</a>, <a href="../../../javax/swing/text/Document.html#getDefaultRootElement--">getDefaultRootElement</a>, <a href="../../../javax/swing/text/Document.html#getEndPosition--">getEndPosition</a>, <a href="../../../javax/swing/text/Document.html#getLength--">getLength</a>, <a href="../../../javax/swing/text/Document.html#getProperty-java.lang.Object-">getProperty</a>, <a href="../../../javax/swing/text/Document.html#getRootElements--">getRootElements</a>, <a href="../../../javax/swing/text/Document.html#getStartPosition--">getStartPosition</a>, <a href="../../../javax/swing/text/Document.html#getText-int-int-">getText</a>, <a href="../../../javax/swing/text/Document.html#getText-int-int-javax.swing.text.Segment-">getText</a>, <a href="../../../javax/swing/text/Document.html#insertString-int-java.lang.String-javax.swing.text.AttributeSet-">insertString</a>, <a href="../../../javax/swing/text/Document.html#putProperty-java.lang.Object-java.lang.Object-">putProperty</a>, <a href="../../../javax/swing/text/Document.html#remove-int-int-">remove</a>, <a href="../../../javax/swing/text/Document.html#removeDocumentListener-javax.swing.event.DocumentListener-">removeDocumentListener</a>, <a href="../../../javax/swing/text/Document.html#removeUndoableEditListener-javax.swing.event.UndoableEditListener-">removeUndoableEditListener</a>, <a href="../../../javax/swing/text/Document.html#render-java.lang.Runnable-">render</a></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>方法详细信息</h3> <a name="addStyle-java.lang.String-javax.swing.text.Style-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>addStyle</h4> <pre><a href="../../../javax/swing/text/Style.html" title="interface in javax.swing.text">Style</a> addStyle(<a href="../../../java/lang/String.html" title="class in java.lang">String</a> nm,
<a href="../../../javax/swing/text/Style.html" title="interface in javax.swing.text">Style</a> parent)</pre>
<div class="block">
<span>在逻辑样式层次结构中添加新样式。</span>
<span>样式属性从下到上解析,因此在孩子中指定的属性将覆盖父项中指定的属性。</span>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<span><code>nm</code> - 样式的名称(在命名样式的集合中必须是唯一的)。</span>
<span>如果风格未命名名称可能为null但是调用者负责管理返回的引用因为未命名的样式无法通过名称获取。</span>
<span>一个未命名的样式可能对于诸如字符属性覆盖(例如在样式运行中找到)的事情是有用的。</span>
</dd>
<dd>
<span><code>parent</code> - 父风格。</span>
<span>如果未指定的属性不需要以某种其他风格解析则此值可能为null。</span>
</dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
样式
</dd>
</dl> </li>
</ul> <a name="removeStyle-java.lang.String-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>removeStyle</h4> <pre>void removeStyle(<a href="../../../java/lang/String.html" title="class in java.lang">String</a> nm)</pre>
<div class="block">
删除之前添加到文档的命名样式。
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>nm</code> - 要删除的样式的名称
</dd>
</dl> </li>
</ul> <a name="getStyle-java.lang.String-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getStyle</h4> <pre><a href="../../../javax/swing/text/Style.html" title="interface in javax.swing.text">Style</a> getStyle(<a href="../../../java/lang/String.html" title="class in java.lang">String</a> nm)</pre>
<div class="block">
获取先前添加的命名样式。
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>nm</code> - 风格的名称
</dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
样式
</dd>
</dl> </li>
</ul> <a name="setCharacterAttributes-int-int-javax.swing.text.AttributeSet-boolean-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>setCharacterAttributes</h4> <pre>void setCharacterAttributes(int offset,
int length,
<a href="../../../javax/swing/text/AttributeSet.html" title="interface in javax.swing.text">AttributeSet</a> s,
boolean replace)</pre>
<div class="block">
<span>更改用于文档中现有内容的给定范围的内容元素属性。</span>
<span>给定的属性参数中定义的所有属性将应用于给定的范围。</span>
<span>此方法可用于通过给出没有定义属性的Attributes参数并将replace替换为true来完全删除给定范围的所有内容级属性。</span>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>offset</code> - 更改的开始&gt; = 0
</dd>
<dd>
<code>length</code> - 变更的长度&gt; = 0
</dd>
<dd>
<span><code>s</code> - 要更改的非空属性。</span>
<span>定义的任何属性将被应用于给定范围的文本。</span>
</dd>
<dd>
<span><code>replace</code> - 指示在设置的新属性之前是否应该清除先前的属性。</span>
<span>如果为真,则操作将完全替换以前的属性。</span>
<span>如果为false则新属性将与先前的属性合并。</span>
</dd>
</dl> </li>
</ul> <a name="setParagraphAttributes-int-int-javax.swing.text.AttributeSet-boolean-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>setParagraphAttributes</h4> <pre>void setParagraphAttributes(int offset,
int length,
<a href="../../../javax/swing/text/AttributeSet.html" title="interface in javax.swing.text">AttributeSet</a> s,
boolean replace)</pre>
<div class="block">
设置段落属性。
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>offset</code> - 更改的开始&gt; = 0
</dd>
<dd>
<code>length</code> - 更改的长度&gt; = 0
</dd>
<dd>
<span><code>s</code> - 要更改的非空属性。</span>
<span>定义的任何属性将被应用于给定范围的文本。</span>
</dd>
<dd>
<span><code>replace</code> - 指示在设置新属性之前是否应清除先前的属性。</span>
<span>如果为真,则操作将完全替换以前的属性。</span>
<span>如果为false则新属性将与先前的属性合并。</span>
</dd>
</dl> </li>
</ul> <a name="setLogicalStyle-int-javax.swing.text.Style-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>setLogicalStyle</h4> <pre>void setLogicalStyle(int pos,
<a href="../../../javax/swing/text/Style.html" title="interface in javax.swing.text">Style</a> s)</pre>
<div class="block">
<span>设置用于给定位置的段落的逻辑样式。</span>
<span>如果没有为字符和段落属性明确设置属性,则它们将通过分配给段落的逻辑风格进行解析,而后者又可以通过某些层次结构完全独立于文档中的元素层次结构来解析属性。</span>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>pos</code> - 起始位置&gt; = 0
</dd>
<dd>
<code>s</code> - 要设置的样式
</dd>
</dl> </li>
</ul> <a name="getLogicalStyle-int-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getLogicalStyle</h4> <pre><a href="../../../javax/swing/text/Style.html" title="interface in javax.swing.text">Style</a> getLogicalStyle(int p)</pre>
<div class="block">
获取段落中给定位置的逻辑风格。
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>p</code> - 位置&gt; = 0
</dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
样式
</dd>
</dl> </li>
</ul> <a name="getParagraphElement-int-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getParagraphElement</h4> <pre><a href="../../../javax/swing/text/Element.html" title="interface in javax.swing.text">Element</a> getParagraphElement(int pos)</pre>
<div class="block">
获取表示在文档中包含给定偏移量的段落的元素。
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>pos</code> - offset&gt; = 0
</dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
元素
</dd>
</dl> </li>
</ul> <a name="getCharacterElement-int-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getCharacterElement</h4> <pre><a href="../../../javax/swing/text/Element.html" title="interface in javax.swing.text">Element</a> getCharacterElement(int pos)</pre>
<div class="block">
获取表示文档中给定偏移量的字符的元素。
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>pos</code> - offset&gt; = 0
</dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
元素
</dd>
</dl> </li>
</ul> <a name="getForeground-javax.swing.text.AttributeSet-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getForeground</h4> <pre><a href="../../../java/awt/Color.html" title="class in java.awt">Color</a> getForeground(<a href="../../../javax/swing/text/AttributeSet.html" title="interface in javax.swing.text">AttributeSet</a> attr)</pre>
<div class="block">
<span>获取一组属性,并将其转换为前景颜色规范。</span>
<span>这可能用于指定更亮,更多色相等的东西。</span>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>attr</code> - 属性集
</dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
颜色
</dd>
</dl> </li>
</ul> <a name="getBackground-javax.swing.text.AttributeSet-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getBackground</h4> <pre><a href="../../../java/awt/Color.html" title="class in java.awt">Color</a> getBackground(<a href="../../../javax/swing/text/AttributeSet.html" title="interface in javax.swing.text">AttributeSet</a> attr)</pre>
<div class="block">
<span>获取一组属性并将其转换为背景颜色规范。</span>
<span>这可能用于指定更亮,更多色相等的东西。</span>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>attr</code> - 属性集
</dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
颜色
</dd>
</dl> </li>
</ul> <a name="getFont-javax.swing.text.AttributeSet-">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>getFont</h4> <pre><a href="../../../java/awt/Font.html" title="class in java.awt">Font</a> getFont(<a href="../../../javax/swing/text/AttributeSet.html" title="interface in javax.swing.text">AttributeSet</a> attr)</pre>
<div class="block">
<span>获取一组属性并将其转换为字体规范。</span>
<span>这可以用来将家庭,风格,大小等的东西转换成系统上当前正在使用的文字。</span>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>attr</code> - 属性集
</dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
the font
</dd>
</dl> </li>
</ul> </li>
</ul> </li>
</ul>
</div>
</div>