当前页面: 在线文档首页 > JavaTM 2 Platform Standard Edition 5.0 API 规范中文版

Segment (Java 2 Platform SE 5.0) - JavaTM 2 Platform Standard Edition 5.0 API 规范中文版

概述  软件包   类  使用  树  已过时  索引  帮助		JavaTM 2 Platform Standard Ed. 5.0
上一个类   下一个类	框架    无框架
摘要： 嵌套 | 字段 | 构造方法 | 方法	详细信息： 字段 | 构造方法 | 方法

---

javax.swing.text
类 Segment

java.lang.Object
  javax.swing.text.Segment

所有已实现的接口：

Cloneable, CharacterIterator

---

public class Segment
extends Object
implements Cloneable, CharacterIterator

表示文本片段的字符数组的 segment。尽管能够直接访问数组，也应将其视为不可变的。此实现提供了对文本片段的快速访问，而且不存在来回复制字符的开销。它实际上是一个未受保护的 String。

Segment 实现 java.text.CharacterIterator 接口以支持对国际化支持的使用，而不用将文本复制到某个字符串。

---

字段摘要
char[]	array           这是包含了所需文本的数组。
int	count           这是构成所需文本的数组元素的数目。
int	offset           这是所需文件开始处的数组偏移量。

 

从接口 java.text.CharacterIterator 继承的字段
DONE

 

构造方法摘要
Segment()           创建新 segment。
Segment(char[] array, int offset, int count)           创建一个引用现有数组的新 segment。

 

方法摘要
Object	clone()           创建一个浅表副本。
char	current()           获取当前位置（由 getIndex() 返回）的字符。
char	first()           将位置设置为 getBeginIndex()，并返回该位置的字符。
int	getBeginIndex()           返回文本的起始索引。
int	getEndIndex()           返回文本的结束索引。
int	getIndex()           返回当前索引。
boolean	isPartialReturn()           指示部分返回有效的标记。
char	last()           将位置设置为 getEndIndex()-1（如果文本为空，则设置为 getEndIndex()），并返回该位置的字符。
char	next()           将迭代器的索引加一，并返回新索引处的字符。
char	previous()           将迭代器的索引减一，并返回新索引处的字符。
char	setIndex(int position)           将位置设置为文本中的指定位置，并返回该字符。
void	setPartialReturn(boolean p)           指示部分返回有效的标记。
String	toString()           将 segment 转换为 String。

 

从类 java.lang.Object 继承的方法
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

字段详细信息

array

public char[] array

这是包含了所需文本的数组。永远不应修改此数组；它是用来提高效率的。

---

offset

public int offset

这是所需文件开始处的数组偏移量。

---

count

public int count

这是构成所需文本的数组元素的数目。

构造方法详细信息

Segment

public Segment()

创建新 segment。

---

Segment

public Segment(char[] array,
               int offset,
               int count)

创建一个引用现有数组的新 segment。

参数：

array - 要引用的数组

offset - 数组中的偏移量

count - 字符数

方法详细信息

setPartialReturn

public void setPartialReturn(boolean p)

指示部分返回有效的标记。如果标志为 true，接口方法 Document.getText(position,length,Segment) 的实现应该在不进行复制的情况下尽可能多地返回文本。标志的默认状态为 false，这将导致 Document.getText(position,length,Segment) 提供其总是具有的返回行为（要么复制，要么不复制文本，具体取决于请求）。

参数：

p - 部分返回是否有效。

从以下版本开始：

1.4

---

isPartialReturn

public boolean isPartialReturn()

指示部分返回有效的标记。

返回：

部分返回是否有效。

从以下版本开始：

1.4

---

toString

public String toString()

将 segment 转换为 String。

覆盖：

类 Object 中的 toString

返回：

字符串

---

first

public char first()

将位置设置为 getBeginIndex()，并返回该位置的字符。

指定者：

接口 CharacterIterator 中的 first

返回：

文本中的第一个字符，如果文本为空，则返回 DONE

另请参见：

getBeginIndex()

---

last

public char last()

将位置设置为 getEndIndex()-1（如果文本为空，则设置为 getEndIndex()），并返回该位置的字符。

指定者：

接口 CharacterIterator 中的 last

返回：

文本中的最后一个字符，如果文本为空，则返回 DONE

另请参见：

getEndIndex()

---

current

public char current()

获取当前位置（由 getIndex() 返回）的字符。

指定者：

接口 CharacterIterator 中的 current

返回：

当前位置的字符；如果当前位置已超出文本末尾，则返回 DONE。

另请参见：

getIndex()

---

next

public char next()

将迭代器的索引加一，并返回新索引处的字符。如果得到的索引大于或等于 getEndIndex()，则将当前索引重置为 getEndIndex()，并返回值 DONE。

指定者：

接口 CharacterIterator 中的 next

返回：

新位置的字符；如果该新位置已超出文本范围的末尾，则返回 DONE。

---

previous

public char previous()

将迭代器的索引减一，并返回新索引处的字符。如果当前索引为 getBeginIndex()，则新索引仍为 getBeginIndex()，并返回值 DONE。

指定者：

接口 CharacterIterator 中的 previous

返回：

新位置的字符；如果当前位置等于 getBeginIndex()，则返回 DONE。

---

setIndex

public char setIndex(int position)

将位置设置为文本中的指定位置，并返回该字符。

指定者：

接口 CharacterIterator 中的 setIndex

参数：

position - 文本中的位置。从 getBeginIndex() 到 getEndIndex() 的有效值范围。如果提供了无效值，则抛出 IllegalArgumentException。

返回：

指定位置的字符；如果指定位置等于 getEndIndex()，则返回 DONE

---

getBeginIndex

public int getBeginIndex()

返回文本的起始索引。

指定者：

接口 CharacterIterator 中的 getBeginIndex

返回：

文本开始处的索引。

---

getEndIndex

public int getEndIndex()

返回文本的结束索引。此索引是文本末尾后面第一个字符的索引。

指定者：

接口 CharacterIterator 中的 getEndIndex

返回：

文本中最后一个字符后面的索引

---

getIndex

public int getIndex()

返回当前索引。

指定者：

接口 CharacterIterator 中的 getIndex

返回：

当前索引。

---

clone

public Object clone()

创建一个浅表副本。

指定者：

接口 CharacterIterator 中的 clone

覆盖：

类 Object 中的 clone

返回：

副本

另请参见：

Cloneable

---

概述  软件包   类  使用  树  已过时  索引  帮助		JavaTM 2 Platform Standard Ed. 5.0
上一个类   下一个类	框架    无框架
摘要： 嵌套 | 字段 | 构造方法 | 方法	详细信息： 字段 | 构造方法 | 方法

---

提交错误或意见
有关更多的 API 参考资料和开发人员文档，请参阅 Java 2 SDK SE 开发人员文档。该文档包含更详细的、面向开发人员的描述，以及总体概述、术语定义、使用技巧和工作代码示例。

版权所有 2004 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策。