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

com.supermap.data
类 GeoLegend

java.lang.Object
  继承者 com.supermap.data.Geometry
      继承者 com.supermap.data.GeoLegend

public class GeoLegend
extends Geometry

该类继承自 Geometry 抽象类。需要关联地图名和工作空间进行使用，当设置标题，图例项是否可见等内容时，需要调用 load() 方法，设置才起作用。 可以使用 getInnerGeometry() 方法来控制图例项的显示内容和位置。

构造方法摘要
GeoLegend(GeoLegend geoLegend)
          根据给定的 GeoLegend 对象构造一个与其完全相同的新对象。
GeoLegend(java.lang.String mapName, Workspace workspace)
          根据指定的参数来构造一个 GeoLegend 的新对象。
GeoLegend(java.lang.String mapName, Workspace workspace, java.lang.String title)
          根据指定的参数来构造一个 GeoLegend 的新对象。
 
方法摘要
 GeoLegend clone()
          返回当前 GeoLegend 对象的一个拷贝。
 void dispose()
          释放该对象所占用的资源。
 boolean fromXML(java.lang.String xml)
          此类不支持该接口。
 GeoStyle getBackGroundStyle()
          返回背景的风格。
 double getBottomMargin()
          返回边框向下扩充的距离。
 Point2D getCenter()
          返回二维矩形几何对象的中心点。
 int getColumnCount()
          返回图例项的列数。
 double getHeight()
          返回地图图例对象的高度。
 GeoCompound getInnerGeometry()
          返回图例包含的复合几何对象（GeoCompound）。
 java.lang.String[] getItemNames()
          返回图例项的名称的数组。
 java.lang.String[] getItems()
          已过时。 已过时。使用getItemNames()替代。 返回图例项的名称的数组。
 TextStyle getItemTextStyle()
          返回图例项说明的文本风格。
 double getLeftMargin()
          返回边框向左扩充的距离。
 java.lang.String getMapName()
          返回地图几何对象所关联的地图名称，此对象所属的工作空间中须含有此地图名称，否则地图无法正常显示。
 double getRightMargin()
          返回边框向右扩充的距离。
 GeoStyle getStyle()
          此类不支持该接口。
 int getSubItemStyle()
          返回图例子项风格。
 TextStyle getSubItemTextStyle()
          返回图例子项(如专题图)说明的文本风格。
 java.lang.String getTitle()
          返回图例标题。
 TextStyle getTitleStyle()
          返回图例标题风格。
 double getTopMargin()
          返回边框向上扩充的距离。
 double getWidth()
          返回地图图例对象的宽度。
 Workspace getWorkspace()
          返回关联的工作空间，默认是返回到该图例对象所属的工作空间对象。
 boolean isEmpty()
          此类不支持该接口。
 boolean isItemVisible(java.lang.String itemName)
          返回图例项是否可见。
 void load(boolean isAddToScreenLayer)
          加载设置的内容。
 Geometry mirror(Point2D startPoint, Point2D endPoint)
          此类不支持该接口。
 void setBackGroundStyle(GeoStyle geoStyle)
          设置背景的风格
 void setBottomMargin(double value)
          设置边框向下扩充的距离。
 void setCenter(Point2D point2D)
          设置二维矩形几何对象的中心点。
 void setColumnCount(int value)
          设置图例项的列数。
 void setEmpty()
          此类不支持该接口。
 void setHeight(double value)
          设置地图图例对象的高度。
 void setItemTextStyle(TextStyle textStyle)
          设置图例项说明的文本风格。
 void setItemVisible(java.lang.String itemName, boolean value)
          设置图例项是否可见。
 void setLeftMargin(double value)
          设置边框向左扩充的距离。
 void setMapName(java.lang.String string)
          设置地图几何对象所关联的地图名称，此对象所属的工作空间中须含有此地图名称，否则地图无法正常显示。
 void setRightMargin(double value)
          设置边框向右扩充的距离。
 void setStyle(GeoStyle value)
          此类不支持该接口。
 void setSubItemStyle(int nGeoStyle)
          设置图例子项风格。
 void setSubItemTextStyle(TextStyle textStyle)
          设置图例子项(如专题图)说明的文本风格。
 void setTitle(java.lang.String string)
          设置图例标题。
 void setTitleStyle(TextStyle textStyle)
          设置图例标题风格。
 void setTopMargin(double value)
          设置边框向上扩充的距离。
 void setWidth(double value)
          设置地图图例对象的宽度。
 java.lang.String toXML()
          此类不支持该接口。
 
从类 com.supermap.data.Geometry 继承的方法
addCustomGeometryCreatedListener, getBounds, getID, getInnerPoint, getType, getVariantID, hitTest, offset, removeCustomGeometryCreatedListener, resize, rotate, setID
 
从类 java.lang.Object 继承的方法
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

构造方法详细信息

GeoLegend

public GeoLegend(GeoLegend geoLegend)
根据给定的 GeoLegend 对象构造一个与其完全相同的新对象。

参数：
geoLegend - 给定的 GeoLegend 对象

GeoLegend

public GeoLegend(java.lang.String mapName,
                 Workspace workspace)
根据指定的参数来构造一个 GeoLegend 的新对象。

参数：
mapName - 关联地图的名称。
workspace - 关联的工作空间。

GeoLegend

public GeoLegend(java.lang.String mapName,
                 Workspace workspace,
                 java.lang.String title)
根据指定的参数来构造一个 GeoLegend 的新对象。

参数：
mapName - 关联地图的名称。
workspace - 关联的工作空间。
title - 图例的标题。
方法详细信息

getMapName

public java.lang.String getMapName()
返回地图几何对象所关联的地图名称，此对象所属的工作空间中须含有此地图名称，否则地图无法正常显示。

返回：
地图几何对象所关联的地图名称，此对象所属的工作空间中须含有此地图名称，否则地图无法正常显示。

setMapName

public void setMapName(java.lang.String string)
设置地图几何对象所关联的地图名称，此对象所属的工作空间中须含有此地图名称，否则地图无法正常显示。

参数：
string - 地图几何对象所关联的地图名称

getTitle

public java.lang.String getTitle()
返回图例标题。

返回：
图例标题。

setTitle

public void setTitle(java.lang.String string)
设置图例标题。

参数：
string - 图例标题

getTitleStyle

public TextStyle getTitleStyle()
返回图例标题风格。

返回：
图例标题风格。

setTitleStyle

public void setTitleStyle(TextStyle textStyle)
设置图例标题风格。

参数：
textStyle - 图例标题风格

getItemTextStyle

public TextStyle getItemTextStyle()
返回图例项说明的文本风格。

返回：
图例项说明的文本风格。

setItemTextStyle

public void setItemTextStyle(TextStyle textStyle)
设置图例项说明的文本风格。

参数：
textStyle - 图例项说明的文本风格。

getSubItemTextStyle

public TextStyle getSubItemTextStyle()
返回图例子项(如专题图)说明的文本风格。

返回：
图例子项(如专题图)说明的文本风格。

setSubItemTextStyle

public void setSubItemTextStyle(TextStyle textStyle)
设置图例子项(如专题图)说明的文本风格。

参数：
textStyle - 图例子项(如专题图)说明的文本风格。

getBackGroundStyle

public GeoStyle getBackGroundStyle()
返回背景的风格。

返回：
背景的风格。

setBackGroundStyle

public void setBackGroundStyle(GeoStyle geoStyle)
设置背景的风格

参数：
geoStyle - 背景的风格

getLeftMargin

public double getLeftMargin()
返回边框向左扩充的距离。

返回：
边框向左扩充的距离。

setLeftMargin

public void setLeftMargin(double value)
设置边框向左扩充的距离。

参数：
value - 边框向左扩充的距离。

getRightMargin

public double getRightMargin()
返回边框向右扩充的距离。

返回：
边框向右扩充的距离。

setRightMargin

public void setRightMargin(double value)
设置边框向右扩充的距离。

参数：
value - 边框向右扩充的距离。

getTopMargin

public double getTopMargin()
返回边框向上扩充的距离。

返回：
边框向上扩充的距离。

setTopMargin

public void setTopMargin(double value)
设置边框向上扩充的距离。

参数：
value - 边框向上扩充的距离。

getBottomMargin

public double getBottomMargin()
返回边框向下扩充的距离。

返回：
边框向下扩充的距离。

setBottomMargin

public void setBottomMargin(double value)
设置边框向下扩充的距离。

参数：
value - 边框向下扩充的距离。

getColumnCount

public int getColumnCount()
返回图例项的列数。

返回：
图例项的列数。

setColumnCount

public void setColumnCount(int value)
设置图例项的列数。

参数：
value - 图例项的列数。

getItemNames

public java.lang.String[] getItemNames()
返回图例项的名称的数组。

返回：
图例项的名称的数组。

getItems

@Deprecated
public java.lang.String[] getItems()
已过时。 已过时。使用getItemNames()替代。 返回图例项的名称的数组。

返回：
图例项的名称的数组。

getWorkspace

public Workspace getWorkspace()
返回关联的工作空间，默认是返回到该图例对象所属的工作空间对象。

返回：
返回关联的工作空间。
默认值:
默认是返回到该图例对象所属的工作空间对象。

getInnerGeometry

public GeoCompound getInnerGeometry()
返回图例包含的复合几何对象（GeoCompound）。

返回：
图例包含的复合几何对象（GeoCompound）。

getCenter

public Point2D getCenter()
返回二维矩形几何对象的中心点。

返回：
二维矩形几何对象的中心点。

setCenter

public void setCenter(Point2D point2D)
设置二维矩形几何对象的中心点。

参数：
point2D - 二维矩形几何对象的中心点。

getWidth

public double getWidth()
返回地图图例对象的宽度。

返回：
地图图例对象的宽度。

setWidth

public void setWidth(double value)
设置地图图例对象的宽度。

参数：
value - 地图图例对象的宽度。

getHeight

public double getHeight()
返回地图图例对象的高度。

返回：
地图图例对象的高度。

setHeight

public void setHeight(double value)
设置地图图例对象的高度。

参数：
value - 地图图例对象的高度。

isItemVisible

public boolean isItemVisible(java.lang.String itemName)
返回图例项是否可见。

参数：
itemName - 指定的图例项名称。
返回：
true表示图例项可见，否则不可见。

setItemVisible

public void setItemVisible(java.lang.String itemName,
                           boolean value)
设置图例项是否可见。

参数：
itemName - 指定的图例项名称。
value - 图例项是否可见。

load

public void load(boolean isAddToScreenLayer)
加载设置的内容。

参数：
isAddToScreenLayer - 是否添加到屏幕图层。加载到屏幕图层的图例，将不随布局和地图的缩放而变化，这样在进行布局浏览时，可以获得较好的显示效果；但在进行布局打印时，不建议用户将图例加载到屏幕图层，直接加载到布局即可。

dispose

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

覆盖：
类 Geometry 中的 dispose

clone

public GeoLegend clone()
返回当前 GeoLegend 对象的一个拷贝。

覆盖：
类 java.lang.Object 中的 clone
返回：
通过克隆操作得到的 GeoLegend 对象。

getSubItemStyle

public int getSubItemStyle()
返回图例子项风格。

返回：
图例子项风格。

setSubItemStyle

public void setSubItemStyle(int nGeoStyle)
设置图例子项风格。该方法不支持设置固定文本大小。

参数：
nGeoStyle - 图例子项风格。

fromXML

public boolean fromXML(java.lang.String xml)
此类不支持该接口。

覆盖：
类 Geometry 中的 fromXML
参数：
xml - XML 格式的字符串。
返回：
如果构造成功返回 true，否则返回 false。
另请参见：
Geometry.offset(double, double)

toXML

public java.lang.String toXML()
此类不支持该接口。

覆盖：
类 Geometry 中的 toXML
返回：
表示几何对象的 XML 字符串。
另请参见：
Geometry.offset(double, double)

setEmpty

public void setEmpty()
此类不支持该接口。

覆盖：
类 Geometry 中的 setEmpty

isEmpty

public boolean isEmpty()
此类不支持该接口。

覆盖：
类 Geometry 中的 isEmpty
返回：
一个布尔值指定几何对象是否为空。
另请参见：
Geometry.offset(double, double)

getStyle

public GeoStyle getStyle()
此类不支持该接口。

覆盖：
类 Geometry 中的 getStyle
返回：
几何对象的风格。

setStyle

public void setStyle(GeoStyle value)
此类不支持该接口。

覆盖：
类 Geometry 中的 setStyle
参数：
value - 用来设置几何对象风格的 GeoStyle 对象。
另请参见：
Geometry.offset(double, double)

mirror

public Geometry mirror(Point2D startPoint,
                       Point2D endPoint)
此类不支持该接口。

覆盖：
类 Geometry 中的 mirror
参数：
startPoint - 线段的起点。
endPoint - 线段的终点。
返回：
该几何对象关于指定对称的几何对象。
另请参见：
Geometry.offset(double,double)
概述  软件包   类  树  已过时  索引  帮助 
 上一个类   下一个类 框架    无框架    
摘要： 嵌套 | 字段 | 构造方法 | 方法 详细信息： 字段 | 构造方法 | 方法