com.supermap.ui
类 MapLayoutControl

java.lang.Object
  com.supermap.ui.MapLayoutControl

public class MapLayoutControl
extends java.lang.Object

布局控件类。

布局窗口，用于布局的显示窗口，提供布局中各类元素的可视化编辑与操作的环境。

如下图所示，为一个布局窗口，窗口中显示了一个布局对象。

嵌套类摘要

static class

MapLayoutControl.Cursors 该类为 MapLayoutControl 类的内部类。

构造方法摘要

MapLayoutControl()
默认构造函数，构造一个新的 MapLayoutControl 对象。

方法摘要

void	addActionCursorChangingListener(ActionCursorChangingListener l) 添加一个用于接收更新光标事件（ActionCursorChangingEvent）的监听器。
void	addElementAddedListener(ElementAddedListener l) 添加一个用于接收添加元素对象事件的监听器。
void	addElementDeletedListener(ElementDeletedListener l) 添加一个用于接收元素移除事件的监听器。
void	addElementDeletingListener(ElementDeletingListener l) 添加一个用于接收删除元素对象事件的监听器。
void	addElementModifiedListener(ElementModifiedListener l) 添加一个用于接收元素对象修改结束事件的监听器。
void	addElementModifyingListener(ElementModifyingListener l) 添加一个用于接收元素对象修改事件的监听器。
void	addElementSelectedListener(ElementSelectedListener l) 添加一个用于接收选中元素对象事件（ElementSelectedEvent）的监听器。
void	addLayoutActionChangedListener(ActionChangedListener l) 添加一个用于接收操作状态变化事件（ActionChangedEvent）的监听器。
void	addPointInputedListener(PointInputedListener l) 添加一个用于接收绘制几何对象输入点事件（PointInputedEvent）的监听器。
void	addTrackedListener(TrackedListener l) 添加一个用于接收跟踪绘制结束事件（TrackedEvent）的监听器。
void	addTrackingListener(TrackingListener l) 添加一个用于接收跟踪绘制事件（TrackingEvent）的监听器。
boolean	align(ElementsAlignment alignment) 对选中的对象进行对齐操作，以选中最后一个对象为基准。
boolean	bringForward() 把选定的对象上移一层。
boolean	bringToFront() 把选定的对象移到最上层。
boolean	canCopy() 返回当前布局窗口是否可以进行复制操作。
boolean	canCut() 返回当前布局窗口是否可以进行剪切操作。
boolean	canDelete() 返回当前布局窗口是否可以进行删除操作。
boolean	canPaste() 返回当前布局窗口是否可以进行粘贴操作。
boolean	canRedo() 返回当前布局窗口是否可以进行恢复操作。
boolean	canUndo() 返回当前布局窗口是否可以进行取消当前编辑内容的操作。
boolean	copy() 执行复制操作，返回是否成功完成操作。
boolean	cut() 执行剪切操作，返回是否成功完成操作。
boolean	delete() 执行删除操作，返回值标示是否成功完成操作。
void	dispose() 释放该对象所占用的资源。
int	getActiveGeoMapID() 返回激活的地图几何对象的 ID。
Map	getActiveMap() 返回当前激活的地图对象，在没有激活的状态下，该返回值为 null。
Action	getLayoutAction() 返回布局的操作状态常量对象。
Action	getMapAction() 返回布局中被锁定地图的操作状态。
MapLayout	getMapLayout() 返回布局窗口中显示的布局对象。
TrackMode	getTrackMode() 返回布局控件绘制对象时是在哪里绘制这些对象。
boolean	isGridSnapable() 返回格网是否可捕捉。
boolean	isHorizontalScrollbarVisible() 返回是否显示水平滚动条。
boolean	isVerticalScrollbarVisible() 返回是否显示垂直滚动条。
boolean	makeHorizontalSpacingEqual() 使选中的对象水平间距相等。
boolean	makeSameHeight() 使选中的对象与基准对象等高，以最后一个被选中的对象为基准对象。
boolean	makeSameSize() 使选中的对象与基准对象相同大小，以最后一个被选中的对象为基准对象。
boolean	makeSameWidth() 使选中的对象与基准对象等宽，以最后一个被选中的对象为基准对象。
boolean	makeSpacingEqual() 使选中的对象垂直与水平间距都相等。
boolean	makeVerticalSpacingEqual() 使选中的对象垂直间距相等。
boolean	paste() 执行粘贴操作，返回是否成功完成操作。
boolean	redo() 执行恢复操作，返回是否成功完成操作。
void	removeActionCursorChangingListener(ActionCursorChangingListener l) 移除一个用于接收更新光标事件（ActionCursorChangingEvent）的监听器。
void	removeElementAddedListener(ElementAddedListener l) 移除一个用于接收添加元素对象事件的监听器。
void	removeElementDeletedListener(ElementDeletedListener l) 移除一个用于接收元素移除事件的监听器。
void	removeElementDeletingListener(ElementDeletingListener l) 移除一个用于接收删除元素对象事件的监听器。
void	removeElementModifiedListener(ElementModifiedListener l) 移除一个用于接收元素对象修改结束事件的监听器。
void	removeElementModifyingListener(ElementModifyingListener l) 移除一个用于接收元素对象修改事件的监听器。
void	removeElementSelectedListener(ElementSelectedListener l) 移除一个用于接收选中元素对象事件（ElementSelectedEvent）的监听器。
void	removeLayoutActionChangedListener(ActionChangedListener l) 移除一个用于接收操作状态变化事件（ActionChangedEvent）的监听器。
void	removePointInputedListener(PointInputedListener l) 移除一个用于接收绘制几何对象输入点事件（PointInputedEvent）的监听器。
void	removeTrackedListener(TrackedListener l) 移除一个用于接收跟踪绘制结束事件（TrackedEvent）的监听器。
void	removeTrackingListener(TrackingListener l) 移除一个用于接收跟踪绘制事件（TrackingEvent）的监听器。
boolean	sendBackward() 把选定的对象向下移动一层。
boolean	sendToBack() 把选定的对象移到最低层。
void	setActiveGeoMapID(int value) 设置激活的地图几何对象的 ID。
void	setGridSnapable(boolean value) 设置格网是否可捕捉。
void	setHorizontalScrollbarVisible(boolean value) 设置是否显示水平滚动条。
void	setLayoutAction(Action layoutAction) 设置布局的操作状态常量对象。
void	setMapAction(Action action) 设置布局中被锁定地图的操作状态。
void	setTrackMode(TrackMode trackMode) 设置布局控件绘制对象时是在哪里绘制这些对象。
void	setVerticalScrollbarVisible(boolean value) 设置是否显示垂直滚动条。
boolean	undo() 执行撤销操作，返回是否成功完成操作。

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

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

构造方法详细信息

MapLayoutControl

public MapLayoutControl()

默认构造函数，构造一个新的 MapLayoutControl 对象。

方法详细信息

getMapLayout

public MapLayout getMapLayout()

返回布局窗口中显示的布局对象。

返回：

布局窗口中显示的布局对象。

getActiveMap

public Map getActiveMap()

返回当前激活的地图对象，在没有激活的状态下，该返回值为 null。

返回：

当前激活的地图对象，在没有激活的状态下，该返回值为 null。

isGridSnapable

public boolean isGridSnapable()

返回格网是否可捕捉。

返回：

一个布尔值，格网可捕捉返回 true，否则返回 false。

默认值:

默认值为 false。

setGridSnapable

public void setGridSnapable(boolean value)

设置格网是否可捕捉。

该方法的设置与 is/setSnapable() 方法的功能相同，方便对编辑功能的设置，具体设置请参见 GridSetting。

参数：

value - 格网是否可捕捉。

align

public boolean align(ElementsAlignment alignment)

对选中的对象进行对齐操作，以选中最后一个对象为基准。

参数：

alignment - 元素的对齐方式。

返回：

一个布尔值，成功返回 true，否则返回 false。

makeSameWidth

public boolean makeSameWidth()

使选中的对象与基准对象等宽，以最后一个被选中的对象为基准对象。

返回：

一个布尔值，成功则返回 true，否则返回 false。

makeSameHeight

public boolean makeSameHeight()

使选中的对象与基准对象等高，以最后一个被选中的对象为基准对象。

返回：

一个布尔值，成功则返回 true，否则返回 false。

makeSameSize

public boolean makeSameSize()

使选中的对象与基准对象相同大小，以最后一个被选中的对象为基准对象。

返回：

一个布尔值，成功则返回 true，否则返回 false。

makeVerticalSpacingEqual

public boolean makeVerticalSpacingEqual()

使选中的对象垂直间距相等。

返回：

一个布尔值，成功则返回 true，否则返回 false。

makeHorizontalSpacingEqual

public boolean makeHorizontalSpacingEqual()

使选中的对象水平间距相等。

返回：

一个布尔值，成功则返回 true，否则返回 false。

makeSpacingEqual

public boolean makeSpacingEqual()

使选中的对象垂直与水平间距都相等。

返回：

一个布尔值，成功则返回 true，否则返回 false。

bringForward

public boolean bringForward()

把选定的对象上移一层。

返回：

一个布尔值，成功则返回 true，否则返回 false。

sendBackward

public boolean sendBackward()

把选定的对象向下移动一层。

返回：

一个布尔值，成功则返回 true，否则返回 false。

bringToFront

public boolean bringToFront()

把选定的对象移到最上层。

返回：

一个布尔值，成功则返回 true，否则返回 false。

sendToBack

public boolean sendToBack()

把选定的对象移到最低层。

返回：

一个布尔值，成功则返回 true，否则返回 false。

getActiveGeoMapID

public int getActiveGeoMapID()

返回激活的地图几何对象的 ID。

返回：

激活的地图几何对象的 ID。

setActiveGeoMapID

public void setActiveGeoMapID(int value)

设置激活的地图几何对象的 ID。

参数：

value - 激活的地图对象 ID。

getLayoutAction

public Action getLayoutAction()

返回布局的操作状态常量对象。

返回：

布局的操作状态常量对象。

默认值:

默认值为 Action.SELECT2。

setLayoutAction

public void setLayoutAction(Action layoutAction)

设置布局的操作状态常量对象。

参数：

layoutAction - 布局的操作状态常量对象。

getMapAction

public Action getMapAction()

返回布局中被锁定地图的操作状态。

返回：

布局中被锁定地图的操作状态。

默认值:

默认值为 Action.PAN2。

setMapAction

public void setMapAction(Action action)

设置布局中被锁定地图的操作状态。

参数：

action - 布局中被锁定地图的操作状态。

getTrackMode

public TrackMode getTrackMode()

返回布局控件绘制对象时是在哪里绘制这些对象。

返回：

布局控件绘制对象时是在哪里绘制这些对象。

默认值:

默认值为 ATrackMode.EDITEDIT。

setTrackMode

public void setTrackMode(TrackMode trackMode)

设置布局控件绘制对象时是在哪里绘制这些对象。

参数：

trackMode - 布局控件绘制对象时是在哪里绘制这些对象。

isHorizontalScrollbarVisible

public boolean isHorizontalScrollbarVisible()

返回是否显示水平滚动条。如下图所示，为一个布局窗口，窗口中显示了一个布局对象。图中箭头所指的就是布局窗口的水平和垂直滚动条。

返回：

一个布尔值，显示水平滚动条返回 true；否则返回 false。

默认值:

默认值为 true。

setHorizontalScrollbarVisible

public void setHorizontalScrollbarVisible(boolean value)

设置是否显示水平滚动条。如下图所示，为一个布局窗口，窗口中显示了一个布局对象。图中箭头所指的就是布局窗口的水平和垂直滚动条。

参数：

value - 一个布尔值指定是否显示水平滚动条。

isVerticalScrollbarVisible

public boolean isVerticalScrollbarVisible()

返回是否显示垂直滚动条。 如下图所示，为一个布局窗口，窗口中显示了一个布局对象。图中箭头所指的就是布局窗口的水平和垂直滚动条。

返回：

一个布尔值，显示垂直滚动条返回 true；否则返回 false。

默认值:

默认值为 true。

setVerticalScrollbarVisible

public void setVerticalScrollbarVisible(boolean value)

设置是否显示垂直滚动条。 如下图所示，为一个布局窗口，窗口中显示了一个布局对象。图中箭头所指的就是布局窗口的水平和垂直滚动条。

参数：

value - 一个布尔值指定是否显示垂直滚动条。

canRedo

public boolean canRedo()

返回当前布局窗口是否可以进行恢复操作。

返回：

一个布尔值，可以进行恢复操作返回 true；否则返回 false。

默认值:

默认值为 false。

canUndo

public boolean canUndo()

返回当前布局窗口是否可以进行取消当前编辑内容的操作。

返回：

一个布尔值，可以进行取消当前编辑内容的操作返回 true，否则返回 false。

默认值:

默认值为 false。

canCut

public boolean canCut()

返回当前布局窗口是否可以进行剪切操作。

返回：

一个布尔值，可以进行剪切操作返回 true；否则返回 false。

默认值:

默认值为 false。

canCopy

public boolean canCopy()

返回当前布局窗口是否可以进行复制操作。

返回：

一个布尔值，可以进行复制操作返回 true；否则返回 false。

默认值:

默认值为 false。

canPaste

public boolean canPaste()

返回当前布局窗口是否可以进行粘贴操作。

返回：

一个布尔值，可以进行粘贴操作返回 true；否则返回 false。

默认值:

默认值为 false。

redo

public boolean redo()

执行恢复操作，返回是否成功完成操作。

返回：

一个布尔值，成功返回 true，否则返回 false。

undo

public boolean undo()

执行撤销操作，返回是否成功完成操作。

返回：

一个布尔值，成功返回 true，否则返回 false。

copy

public boolean copy()

执行复制操作，返回是否成功完成操作。

返回：

一个布尔值，成功返回 true，否则返回 false。

cut

public boolean cut()

执行剪切操作，返回是否成功完成操作。

返回：

一个布尔值，成功返回 true，否则返回 false。

paste

public boolean paste()

执行粘贴操作，返回是否成功完成操作。

返回：

一个布尔值，成功返回 true，否则返回 false。

canDelete

public boolean canDelete()

返回当前布局窗口是否可以进行删除操作。

返回：

当前布局窗口是否可以进行删除操作。

delete

public boolean delete()

执行删除操作，返回值标示是否成功完成操作。

返回：

成功返回true，否则返回false。

addLayoutActionChangedListener

public void addLayoutActionChangedListener(ActionChangedListener l)

添加一个用于接收操作状态变化事件（ActionChangedEvent）的监听器。

参数：

l - 一个用于接收操作状态变化事件的监听器。

removeLayoutActionChangedListener

public void removeLayoutActionChangedListener(ActionChangedListener l)

移除一个用于接收操作状态变化事件（ActionChangedEvent）的监听器。

参数：

l - 一个用于接收操作状态变化事件的监听器。

addElementSelectedListener

public void addElementSelectedListener(ElementSelectedListener l)

添加一个用于接收选中元素对象事件（ElementSelectedEvent）的监听器。

参数：

l - 一个用于接收选中元素对象事件的监听器。

removeElementSelectedListener

public void removeElementSelectedListener(ElementSelectedListener l)

移除一个用于接收选中元素对象事件（ElementSelectedEvent）的监听器。

参数：

l - 一个用于接收选中元素对象事件的监听器。

addElementDeletingListener

public void addElementDeletingListener(ElementDeletingListener l)

添加一个用于接收删除元素对象事件的监听器。

参数：

l - 一个用于接收删除元素对象事件的监听器。

另请参见：

ElementEvent

removeElementDeletingListener

public void removeElementDeletingListener(ElementDeletingListener l)

移除一个用于接收删除元素对象事件的监听器。

参数：

l - 一个用于接收删除元素对象事件的监听器。

另请参见：

ElementEvent

addElementAddedListener

public void addElementAddedListener(ElementAddedListener l)

添加一个用于接收添加元素对象事件的监听器。

参数：

l - 一个用于接收添加元素对象事件的监听器。

另请参见：

ElementEvent

removeElementAddedListener

public void removeElementAddedListener(ElementAddedListener l)

移除一个用于接收添加元素对象事件的监听器。

参数：

l - 一个用于接收添加元素对象事件的监听器。

另请参见：

ElementEvent

addElementModifyingListener

public void addElementModifyingListener(ElementModifyingListener l)

添加一个用于接收元素对象修改事件的监听器。

参数：

l - 一个用于接收元素对象修改事件的监听器。

另请参见：

ElementEvent

removeElementModifyingListener

public void removeElementModifyingListener(ElementModifyingListener l)

移除一个用于接收元素对象修改事件的监听器。

参数：

l - 一个用于接收元素对象修改事件的监听器。

另请参见：

ElementEvent

addElementModifiedListener

public void addElementModifiedListener(ElementModifiedListener l)

添加一个用于接收元素对象修改结束事件的监听器。

参数：

l - 一个用于接收元素对象修改结束事件的监听器。

另请参见：

ElementEvent

removeElementModifiedListener

public void removeElementModifiedListener(ElementModifiedListener l)

移除一个用于接收元素对象修改结束事件的监听器。

参数：

l - 一个用于接收元素对象修改结束事件的监听器。

另请参见：

ElementEvent

addTrackingListener

public void addTrackingListener(TrackingListener l)

添加一个用于接收跟踪绘制事件（TrackingEvent）的监听器。

在布局窗口中绘制几何对象（即在内存中跟踪绘制）的时候触发该实时跟踪事件（TrackingEvent）。

跟踪绘制即在内存中而不是在跟踪图层中绘制几何对象的过程。

参数：

l - 一个用于接收跟踪绘制事件的监听器。

removeTrackingListener

public void removeTrackingListener(TrackingListener l)

移除一个用于接收跟踪绘制事件（TrackingEvent）的监听器。

在布局窗口中绘制几何对象（即在内存中跟踪绘制）的时候触发该跟踪绘制事件（TrackingEvent）。

跟踪绘制即在内存中而不是在跟踪图层中绘制几何对象的过程。

参数：

l - 一个用于接收跟踪绘制事件的监听器。

addTrackedListener

public void addTrackedListener(TrackedListener l)

添加一个用于接收跟踪绘制结束事件（TrackedEvent）的监听器。

在布局窗口中绘制几何对象结束（即在内存中跟踪绘制结束）的时候触发该跟踪绘制结束事件（TrackedEvent）。

跟踪绘制结束即表示跟踪绘制完毕的状态。当进行布局编辑时，跟踪绘制的几何对象在绘制完毕后保存到相应的数据集中，当进行布局裁剪时，跟踪绘制的几何对象并不保存到数据集中，而是仅仅保存在内存中。

参数：

l - 一个用于接收跟踪绘制结束事件的监听器。

removeTrackedListener

public void removeTrackedListener(TrackedListener l)

移除一个用于接收跟踪绘制结束事件（TrackedEvent）的监听器。

在布局窗口中绘制几何对象结束（即在内存中跟踪绘制结束）的时候触发该跟踪绘制结束事件（TrackedEvent）。

跟踪绘制结束即表示跟踪绘制完毕的状态。当进行布局编辑时，跟踪绘制的几何对象在绘制完毕后保存到相应的数据集中，当进行布局裁剪时，跟踪绘制的几何对象并不保存到数据集中，而是仅仅保存在内存中。

参数：

l - 一个用于接收跟踪绘制结束事件的监听器。

addPointInputedListener

public void addPointInputedListener(PointInputedListener l)

添加一个用于接收绘制几何对象输入点事件（PointInputedEvent）的监听器。

在布局上输入点以后触发该事件。

在布局上绘制空间对象的时候，如果需要对每次输入的点进行坐标调整，可在此事件中处理。

参数：

l - 一个用于接收绘制几何对象输入点事件的监听器。

removePointInputedListener

public void removePointInputedListener(PointInputedListener l)

移除一个用于接收绘制几何对象输入点事件（PointInputedEvent）的监听器。

在布局上输入点以后触发该事件。

在布局上绘制空间对象的时候，如果需要对每次输入的点进行坐标调整，可在此事件中处理。

参数：

l - 一个用于接收绘制几何对象输入点事件的监听器。

addActionCursorChangingListener

public void addActionCursorChangingListener(ActionCursorChangingListener l)

添加一个用于接收更新光标事件（ActionCursorChangingEvent）的监听器。

需要更新光标时触发该事件。

参数：

l - 一个用于接收更新光标事件的监听器。

removeActionCursorChangingListener

public void removeActionCursorChangingListener(ActionCursorChangingListener l)

移除一个用于接收更新光标事件（ActionCursorChangingEvent）的监听器。

需要更新光标时触发该事件。

参数：

l - 一个用于接收更新光标事件的监听器。

addElementDeletedListener

public void addElementDeletedListener(ElementDeletedListener l)

添加一个用于接收元素移除事件的监听器。

参数：

l - 一个用于接收元素移除事件的监听器。

另请参见：

ElementEvent

removeElementDeletedListener

public void removeElementDeletedListener(ElementDeletedListener l)

移除一个用于接收元素移除事件的监听器。

参数：

l - 一个用于接收元素移除事件的监听器。

另请参见：

ElementEvent

dispose

public void dispose()

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