com.supermap.data
类 GeoText

java.lang.Object
  com.supermap.data.Geometry
      com.supermap.data.GeoText

public class GeoText
extends Geometry

文本类，派生于 Geometry 类。该类主要用于对地物要素进行标识和必要的注记说明。文本对象由一个或多个部分组成，每个部分称为文本对象的一个子对象，每个子对象都是一个 TextPart 的实例。同一个文本对象的所有子对象都使用相同的文本风格，即使用该文本对象的文本风格进行显示。

构造方法摘要

GeoText()
构造一个新的 GeoText 对象。

GeoText(GeoText geoText)
根据给定的 GeoText 对象来构造一个与其完全相同的新对象。

GeoText(TextPart part)
根据指定的参数来构造一个 GeoText 的新对象。

GeoText(TextPart part, TextStyle textStyle)
根据指定的参数来构造一个 GeoText 的新对象。

方法摘要

int	addPart(TextPart part) 在文本对象中添加文本子对象。
GeoText	clone() 返回当前 GeoText 对象的一个拷贝。
void	dispose() 释放对象所占用的资源。
TextPart	getPart(int index) 返回此文本对象的指定序号的子对象。
int	getPartCount() 返回文本对象的子对象个数。
GeoStyle	getStyle() 此类不支持该接口。
java.lang.String	getText() 返回文本对象的内容。
TextStyle	getTextStyle() 返回文本对象的文本风格。
int	indexOf(TextPart part) 返回指定的子对象在此文本对象中的序号。
boolean	insertPart(int index, TextPart part) 在此文本对象的指定位置插入一个文本子对象。
boolean	isEmpty() 判定该文本对象是否为空，即其子对象的个数是否为0。
static GeoText	makeAlongLineText(java.lang.String text, GeoLine line) 创建沿线文本。
static GeoText	makeAlongLineText(java.lang.String text, GeoLine line, double angle) 创建沿线文本。
boolean	removePart(int index) 删除此文本对象的指定序号的文本子对象。
boolean	setPart(int index, TextPart part) 修改此文本对象的指定序号的子对象，即用新的文本子对象来替换原来的文本子对象。
void	setStyle(GeoStyle value) 此类不支持该接口。
void	setTextStyle(TextStyle textStyle) 设置文本对象的文本风格。

从类 com.supermap.data.Geometry 继承的方法

addCustomGeometryCreatedListener, fromXML, getBounds, getID, getInnerPoint, getType, getVariantID, hitTest, mirror, offset, removeCustomGeometryCreatedListener, resize, rotate, setEmpty, setID, toXML

从类 java.lang.Object 继承的方法

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造方法详细信息

GeoText

public GeoText()

构造一个新的 GeoText 对象。

GeoText

public GeoText(GeoText geoText)

根据给定的 GeoText 对象来构造一个与其完全相同的新对象。

参数：

geoText - 指定的 GeoText 对象。

GeoText

public GeoText(TextPart part)

根据指定的参数来构造一个 GeoText 的新对象。

参数：

part - TextPart子对象。

另请参见：

TextPart

GeoText

public GeoText(TextPart part,
               TextStyle textStyle)

根据指定的参数来构造一个 GeoText 的新对象。

参数：

part - 指定的文本子对象。

textStyle - 指定的文本风格对象。

方法详细信息

getText

public java.lang.String getText()

返回文本对象的内容。 如果该对象有多个子对象时，其值为子对象字符串之和。

返回：

文本对象的内容。

默认值:

默认值为一个空字符串。

getPartCount

public int getPartCount()

返回文本对象的子对象个数。当文本对象清空后，其子对象的个数为0。

返回：

文本对象的子对象个数。

默认值:

默认值为 0。

getTextStyle

public TextStyle getTextStyle()

返回文本对象的文本风格。文本风格用于指定文本对象显示时的字体、宽度、高度和颜色等。

注意：GeoText.getTextStyle().setRotation() 对文本子对象 TextPart 无效，TextPart 的旋转角度由其自身 getRotation() 和 setRotation() 方法来控制。

返回：

文本对象的文本风格。

另请参见：

TextStyle

示例:

请参见 TextStyle 类的示例。

setTextStyle

public void setTextStyle(TextStyle textStyle)

设置文本对象的文本风格。文本风格用于指定文本对象显示时的字体、宽度、高度和颜色等。

注意：GeoText.getTextStyle().setRotation() 对文本子对象 TextPart 无效，TextPart 的旋转角度由其自身 getRotation() 和 setRotation() 方法来控制。

参数：

textStyle - 文本对象的文本风格。

另请参见：

TextStyle

isEmpty

public boolean isEmpty()

判定该文本对象是否为空，即其子对象的个数是否为0。判断精度为零值判断精度。关于零值判断精度的详细信息请参见 Environment 类。

覆盖：

类 Geometry 中的 isEmpty

返回：

如果该文本对象为空，则返回 true；否则返回 false。

另请参见：

Geometry.offset(double, double)

addPart

public int addPart(TextPart part)

在文本对象中添加文本子对象。

参数：

part - 一个 TextPart 类的文本子对象。

返回：

当添加成功则返回子对象序号，失败时返回-1。

示例:

请参见 TextStyle 的示例。

getPart

public TextPart getPart(int index)

返回此文本对象的指定序号的子对象。

参数：

index - 子对象序号。

返回：

指定序号的子对象。

抛出：

java.lang.IndexOutOfBoundsException - 如果 index 小于零或 index 大于等于该文本对象的子对象个数。

insertPart

public boolean insertPart(int index,
                          TextPart part)

在此文本对象的指定位置插入一个文本子对象。

参数：

index - 插入子对象的位置，即子对象的序号值。其中序号值大于0且小于子对象的总数。

part - 要插入的文本子对象。

返回：

如果插入成功返回 true，否则返回 false。

抛出：

java.lang.IndexOutOfBoundsException - 如果 index 小于零或 index 大于该文本对象的子对象个数。

另请参见：

addPart(TextPart), removePart(int)

removePart

public boolean removePart(int index)

删除此文本对象的指定序号的文本子对象。

参数：

index - 文本子对象序号。

返回：

如果删除成功返回 true，否则返回 false。

抛出：

java.lang.IndexOutOfBoundsException - 如果 index 小于零或 index 大于等于该文本对象的子对象个数。

setPart

public boolean setPart(int index,
                       TextPart part)

修改此文本对象的指定序号的子对象，即用新的文本子对象来替换原来的文本子对象。

参数：

index - 文本子对象序号。

part - 文本子对象。

返回：

如果设置成功返回 true，否则返回 false。

抛出：

java.lang.IndexOutOfBoundsException - 如果 index 小于零或 index 大于等于该文本对象的子对象个数。

makeAlongLineText

public static GeoText makeAlongLineText(java.lang.String text,
                                        GeoLine line)

创建沿线文本。将指定的文本沿指定的线对象，从线对象的起始点开始沿线均匀放置。文本中每个字的旋转角度与其所在的线对象上的位置有关。如果线对象有多个子对象，先将线的子对象按照序号首尾相接生成一个新的线对象。再沿新的线对象均匀放置文本。

参数：

text - 一个 String 对象代表将沿线放置的文本。

line - 线对象。

返回：

沿线文本。

makeAlongLineText

public static GeoText makeAlongLineText(java.lang.String text,
                                        GeoLine line,
                                        double angle)

创建沿线文本。将指定的文本沿指定的线对象，从线对象的起始点开始沿线均匀放置。文本中每个字的旋转角度均为指定角度。如果线对象有多个子对象，先将线的子对象按照序号首尾相接生成一个新的线对象。再沿新的线对象均匀放置文本。

参数：

text - 一个 String 对象代表将沿线放置的文本。

line - 线对象。

angle - 文本子对象的旋转角度，单位为度。

返回：

沿线文本。

clone

public GeoText clone()

返回当前 GeoText 对象的一个拷贝。

覆盖：

类 java.lang.Object 中的 clone

返回：

通过克隆操作得到的 GeoText 对象。

dispose

public void dispose()

释放对象所占用的资源。当调用该方法之后，此对象不再可用。

覆盖：

类 Geometry 中的 dispose

indexOf

public int indexOf(TextPart part)

返回指定的子对象在此文本对象中的序号。

参数：

part - 指定的文本子对象。

返回：

指定的子对象在此文本对象中的序号。若该子对象不存在，则返回-1。

getStyle

public GeoStyle getStyle()

此类不支持该接口。

覆盖：

类 Geometry 中的 getStyle

返回：

几何对象的风格。

setStyle

public void setStyle(GeoStyle value)

此类不支持该接口。

覆盖：

类 Geometry 中的 setStyle

参数：

value - 用来设置几何对象风格的 GeoStyle 对象。

另请参见：

Geometry.offset(double, double)