com.supermap.mapping

类 BookMarks

java.lang.Object

com.supermap.data.InternalHandle

com.supermap.mapping.BookMarks

public class BookMarks
extends com.supermap.data.InternalHandle

地图书签集合类。地图书签用来保存地图浏览时的感兴趣区域。

方法概要

限定符和类型	方法和说明
int	add(BookMark bookMark) 向地图书签集合中添加一个地图书签对象。
void	clear() 清除地图书签集合中的所有书签对象。
BookMark	get(int index) 返回地图书签集合中指定索引的地图书签对象。
BookMark	get(String name) 返回地图书签集合中指定名称的地图书签对象。
String	getAvailableName(String name) 返回地图书签集合中未被占用的地图书签对象的名称。
int	getCount() 返回地图书签集合中的书签数目。
int	indexOf(BookMark bookMark) 返回地图书签集合中指定地图书签对象的索引值。
int	indexOf(String name) 返回地图书签集合中指定地图书签名称的索引值。
boolean	insert(int index, BookMark bookMark) 向地图书签集合中指定索引位置插入一个地图书签对象。
boolean	isAvailableName(String name) 判断地图书签对象的名称是否合法。
boolean	remove(int index) 从地图书签集合中移除指定索引的地图书签对象。
boolean	remove(String name) 地图书签集合中移除指定名称的地图书签对象。
boolean	set(int index, BookMark bookMark) 设置指定索引位置的书签为指定的地图书签对象。

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

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

方法详细资料

getCount

public int getCount()

返回地图书签集合中的书签数目。

返回:

返回地图书签集合中的书签数目。

add

public int add(BookMark bookMark)

向地图书签集合中添加一个地图书签对象。

参数:

bookMark - 指定的要添加的地图书签对象。

返回:

返回添加的地图书签对象在集合中的索引值。

insert

public boolean insert(int index,
                      BookMark bookMark)

向地图书签集合中指定索引位置插入一个地图书签对象。

参数:

index - 指定插入地图书签对象的位置。

bookMark - 指定的地图书签对象。

返回:

插入成功返回true；否则返回false。

get

public BookMark get(int index)

返回地图书签集合中指定索引的地图书签对象。

参数:

index - 指定的地图书签对象的索引值。

返回:

返回地图书签集合中指定索引的地图书签对象。

get

public BookMark get(String name)

返回地图书签集合中指定名称的地图书签对象。

参数:

name - 指定的地图书签对象的名称。

返回:

返回地图书签集合中指定名称的地图书签对象。

set

public boolean set(int index,
                   BookMark bookMark)

设置指定索引位置的书签为指定的地图书签对象。

参数:

index - 指定的索引值。

bookMark - 指定的地图书签对象。

返回:

设置成功返回true；否则返回false。

indexOf

public int indexOf(BookMark bookMark)

返回地图书签集合中指定地图书签对象的索引值。

参数:

bookMark - 指定的地图书签对象。

返回:

返回地图书签集合中指定地图书签对象的索引值。

indexOf

public int indexOf(String name)

返回地图书签集合中指定地图书签名称的索引值。

参数:

name - 地图书签名称

返回:

索引值

remove

public boolean remove(int index)

从地图书签集合中移除指定索引的地图书签对象。

参数:

index - 指定要移除的地图书签对象的索引值。

返回:

移除成功返回true；否则返回false。

remove

public boolean remove(String name)

地图书签集合中移除指定名称的地图书签对象。

参数:

name - 指定要移除的地图书签对象的名称

返回:

移除成功返回true；否则返回false。

clear

public void clear()

清除地图书签集合中的所有书签对象。

isAvailableName

public boolean isAvailableName(String name)

判断地图书签对象的名称是否合法。

参数:

name - 指定的地图书签对象的名称。

返回:

若地图书签对象的名称合法返回true；否则返回false。

getAvailableName

public String getAvailableName(String name)

返回地图书签集合中未被占用的地图书签对象的名称。

参数:

name - 指定的地图书签对象的名称。

返回:

返回地图书签集合中未被占用的地图书签对象的名称。