LayoutElements (iObjects Java Help)

java.lang.Object
- com.supermap.layout.LayoutElements

public class LayoutElements
extends Object

布局元素集合类。

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`boolean`	`addNew(Geometry geometry)` 向布局元素集合中添加对象。
`boolean`	`delete()` 删除布局元素集合中的当前元素对象，成功则返回 true。
`int`	`delete(int[] ids)` 根据传入的 ID 数组批量删除布局元素集合中的布局元素。
`boolean`	`deleteAll()` 删除布局元素集合中的所有布局元素。
`int`	`getCount()` 返回布局元素集合中对象的个数。
`Geometry`	`getGeometry()` 返回当前布局元素几何对象。
`long`	`getHandle()` 已过时。
`int`	`getID()` 返回当前布局几何对象的 ID。
`String`	`getTagWithID(int id)` 根据指定的布局元素集合的布局元素 ID 返回布局元素标签。
`boolean`	`isBOF()` 判断布局元素集合的对象指针是否位于起始位置，true 表示位于起始位置，false 表示不位于起始位置。
`boolean`	`isEmpty()` 判断布局元素集合中是否有对象，true 表示该布局元素集合中无对象。
`boolean`	`isEOF()` 判断布局元素集合的对象指针是否位于最后位置，true 表示位于最后位置，false 表示不位于最后位置。
`boolean`	`move(int count)` 移动当前布局元素指针，成功返回 true。
`boolean`	`moveFirst()` 用于移动当前布局元素指针到第一条布局元素，成功则返回 true。
`boolean`	`moveLast()` 移动当前布局元素指针到最后一条布局元素，成功则返回 true。
`boolean`	`moveNext()` 移动当前布局元素指针到下一条布局元素，成功则返回 true。
`boolean`	`movePrev()` 移动当前布局元素指针到上一条布局元素，成功则返回 true。
`boolean`	`moveTo(int position)` 用于将当前布局元素指针移动到指定的位置，成功则返回 true。
`boolean`	`refresh()` 刷新布局元素集合。
`boolean`	`seekID(int id)` 在布局元素集合中搜索指定 ID 号的布局元素，并把当前布局元素指针定位于该布局元素。
`boolean`	`seekTag(String tag)` 根据指定的布局元素标签在布局元素集合中搜索指定的布局元素，并将当前指针定位于该布局元素。
`boolean`	`setGeometry(Geometry geometry)` 修改布局元素集合中当前位置的布局元素几何对象，覆盖原来的布局元素几何对象，成功则返回 true。
`boolean`	`setTagWithID(int id, String tag)` 修改布局元素集合中指定ID的布局元素标签，覆盖原来的布局元素标签。

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

- 方法详细资料
  - isBOF
```
public boolean isBOF()
```
    判断布局元素集合的对象指针是否位于起始位置，true 表示位于起始位置，false 表示不位于起始位置。
    
    返回:
    
    位于起始位置返回 true；否则返回 false。
  - isEOF
```
public boolean isEOF()
```
    判断布局元素集合的对象指针是否位于最后位置，true 表示位于最后位置，false 表示不位于最后位置。
    
    返回:
    
    位于最后位置返回 true；否则返回 false。
  - isEmpty
```
public boolean isEmpty()
```
    判断布局元素集合中是否有对象，true 表示该布局元素集合中无对象。
    
    返回:
    
    布局元素集合中无对象返回 true；否则返回 false。
  - getCount
```
public int getCount()
```
    返回布局元素集合中对象的个数。
    
    返回:
    
    返回布局元素集合中对象的个数。
  - addNew
```
public boolean addNew(Geometry geometry)
```
    向布局元素集合中添加对象。
    
    参数:
    
    geometry - 向布局元素中添加的几何对象。
    
    返回:
    
    添加成功返回 true，失败返回 false。
  - delete
```
public int delete(int[] ids)
```
    根据传入的 ID 数组批量删除布局元素集合中的布局元素。
    
    参数:
    
    ids - 指定的 ID 数组。
    
    返回:
    
    返回被成功删除的对象的个数。
  - delete
```
public boolean delete()
```
    删除布局元素集合中的当前元素对象，成功则返回 true。
    
    返回:
    
    删除成功返回 true，失败返回 false。
  - deleteAll
```
public boolean deleteAll()
```
    删除布局元素集合中的所有布局元素。
    
    返回:
    
    删除成功返回 true，失败返回 false。
  - getGeometry
```
public Geometry getGeometry()
```
    返回当前布局元素几何对象。
    
    返回:
    
    若成功返回布局元素几何对象，否则返回 null。
  - getID
```
public int getID()
```
    返回当前布局几何对象的 ID。
    
    返回:
    
    返回几何对象的 ID 号。
  - move
```
public boolean move(int count)
```
    移动当前布局元素指针，成功返回 true。
    
    参数:
    
    count - 移动的行数。
    
    返回:
    
    移动指针成功返回 true，否则返回 false。
  - moveFirst
```
public boolean moveFirst()
```
    用于移动当前布局元素指针到第一条布局元素，成功则返回 true。
    
    返回:
    
    移动指针成功返回 true，否则返回 false。
  - moveLast
```
public boolean moveLast()
```
    移动当前布局元素指针到最后一条布局元素，成功则返回 true。
    
    返回:
    
    移动指针成功返回 true，否则返回 false。
  - moveNext
```
public boolean moveNext()
```
    移动当前布局元素指针到下一条布局元素，成功则返回 true。
    
    返回:
    
    移动指针成功返回 true，否则返回 false。
  - movePrev
```
public boolean movePrev()
```
    移动当前布局元素指针到上一条布局元素，成功则返回 true。
    
    返回:
    
    移动指针成功返回 true，否则返回 false。
  - moveTo
```
public boolean moveTo(int position)
```
    用于将当前布局元素指针移动到指定的位置，成功则返回 true。
    
    参数:
    
    position - 移动到的位置，即第几条布局元素。
    
    返回:
    
    移动指针成功返回 true，否则返回 false。
  - refresh
```
public boolean refresh()
```
    刷新布局元素集合。
    
    返回:
    
    刷新成功返回 true，否则返回 false。
  - seekID
```
public boolean seekID(int id)
```
    在布局元素集合中搜索指定 ID 号的布局元素，并把当前布局元素指针定位于该布局元素。
    
    参数:
    
    id - 要搜索的 ID 号。
    
    返回:
    
    成功返回 true，否则返回 false。
  - setGeometry
```
public boolean setGeometry(Geometry geometry)
```
    修改布局元素集合中当前位置的布局元素几何对象，覆盖原来的布局元素几何对象，成功则返回 true。
    
    参数:
    
    geometry - 用来覆盖原布局元素几何对象的新布局元素几何对象。
    
    返回:
    
    设置成功返回 true，否则返回 false。
  - getHandle
```
@Deprecated
public long getHandle()
```
    已过时。
  - setTagWithID
```
public boolean setTagWithID(int id,
                            String tag)
```
    修改布局元素集合中指定ID的布局元素标签，覆盖原来的布局元素标签。
    
    参数:
    
    id - 指定的布局元素ID。
    
    tag - 指定的用来覆盖原布局元素标签的新布局元素标签。
    
    返回:
    
    一个布尔值，表示修改是否成功，如果修改成功，返回 true，否则返回 false。
  - getTagWithID
```
public String getTagWithID(int id)
```
    根据指定的布局元素集合的布局元素 ID 返回布局元素标签。
    
    参数:
    
    id - 指定的布局元素 ID。
    
    返回:
    
    若成功则返回指定 ID 对应的布局元素的标签，否则返回 null。
  - seekTag
```
public boolean seekTag(String tag)
```
    根据指定的布局元素标签在布局元素集合中搜索指定的布局元素，并将当前指针定位于该布局元素。
    
    参数:
    
    tag - 指定的布局元素标签。
    
    返回:
    
    一个布尔值，表示搜索是否成功，如果搜索成功，返回 true，否则返回 false。

类 LayoutElements

方法概要

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

方法详细资料

isBOF

isEOF

isEmpty

getCount

addNew

delete

delete

deleteAll

getGeometry

getID

move

moveFirst

moveLast

moveNext

movePrev

moveTo

refresh

seekID

setGeometry

getHandle

setTagWithID

getTagWithID

seekTag