Paper (iObjects Java Help)

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

```
public class Paper
extends Object
```
纸面类。
下图为一个布局窗口，窗口中显示了一个布局对象。黑色双箭头指示的就是布局的纸面对象。

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`Color`	`getBackgroundColor()` 返回纸面的背景颜色。
`GridSetting`	`getGrid()` 返回格网设置对象。
`double`	`getHeight()` 返回纸面的高度。
`PaperMargin`	`getMargin()` 返回页边对象。
`Color`	`getMarginDashColor()` 返回纸面的网格虚线颜色。
`Color`	`getMarginSolidColor()` 返回纸面的网格实线颜色。
`PaperOrientation`	`getOrientation()` 返回纸面的方向。
`Color`	`getPaperShadowColor()` 返回纸面的阴影颜色。
`PaperSize`	`getSize()` 返回纸面的尺寸类型。
`double`	`getWidth()` 返回纸面的宽度。
`boolean`	`isVisible()` 返回纸张是否可见。
`void`	`setBackgroundColor(Color color)` 设置纸面的背景颜色。
`void`	`setGrid(GridSetting setting)` 设置格网设置对象。
`void`	`setHeight(double value)` 设置纸面的高度。
`void`	`setMargin(PaperMargin paperMargin)` 设置页边对象。
`void`	`setMarginDashColor(Color color)` 设置纸面的网格虚线颜色。
`void`	`setMarginSolidColor(Color color)` 设置纸面的网格实线颜色。
`void`	`setOrientation(PaperOrientation paperOrientation)` 设置纸面的方向。
`void`	`setPaperShadowColor(Color color)` 设置纸面的阴影颜色
`void`	`setSize(PaperSize paperSize)` 设置纸面的尺寸类型。
`void`	`setVisible(boolean value)` 设置纸张是否可见。
`void`	`setWidth(double value)` 设置纸面的宽度。

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

- 方法详细资料
  - getBackgroundColor
```
public Color getBackgroundColor()
```
    返回纸面的背景颜色。
    
    返回:
    
    纸面的背景颜色。
  - setBackgroundColor
```
public void setBackgroundColor(Color color)
```
    设置纸面的背景颜色。
    
    参数:
    
    color - 纸面的背景颜色。
  - getOrientation
```
public PaperOrientation getOrientation()
```
    返回纸面的方向。
    
    返回:
    
    纸面的方向。
  - setOrientation
```
public void setOrientation(PaperOrientation paperOrientation)
```
    设置纸面的方向。
    
    参数:
    
    paperOrientation - 纸面的方向。
  - getWidth
```
public double getWidth()
```
    返回纸面的宽度。单位为逻辑单位，即0.1毫米。
    如下图所示，为布局窗口中显示的布局对象，布局中存在一个纸面对象，图中绿色的小圆点表示纸面的原点位置，即纸面尺寸量算的起始点，纸面的原点始终位于布局中（0，0）坐标点的位置。纸面大小为B5型号纸张的大小（182*257mm），即纸面的宽度为182mm，高度为257mm。默认情况下，布局中纸面的大小为A4型号纸张的大小（210*297mm）。
    
    返回:
    
    纸面的宽度。
  - setWidth
```
public void setWidth(double value)
```
    设置纸面的宽度。单位为逻辑单位，即0.1毫米。
    
    参数:
    
    value - 纸面的宽度。
  - getHeight
```
public double getHeight()
```
    返回纸面的高度。高度的单位为0.1毫米。
    
    返回:
    
    纸面的高度。
  - setHeight
```
public void setHeight(double value)
```
    设置纸面的高度。高度的单位为0.1毫米。
    
    参数:
    
    value - 纸面的高度。
  - getSize
```
public PaperSize getSize()
```
    返回纸面的尺寸类型。
    
    返回:
    
    纸面的尺寸类型。
  - setSize
```
public void setSize(PaperSize paperSize)
```
    设置纸面的尺寸类型。
    
    参数:
    
    paperSize - 纸面的尺寸类型。
  - getMargin
```
public PaperMargin getMargin()
```
    返回页边对象。
    
    返回:
    
    页边对象。
  - setMargin
```
public void setMargin(PaperMargin paperMargin)
```
    设置页边对象。
    
    参数:
    
    paperMargin - 页边对象。
    
    抛出:
    
    IllegalStateException - 对象已被释放
  - getGrid
```
public GridSetting getGrid()
```
    返回格网设置对象。
    所谓的纸面中的格网，就是如下图所示的田字格的背景，下图为一个布局窗口，窗口中显示了一个布局对象，布局上的田字格状的格子即为纸面的格网，格网可以辅助布局中各个元素位置的排列以及元素大小的确定等。
    
    该方法在当前版本只支持 GridSetting 类中 isVisible()，isSnapable()，setHorizontalSpacing()，setVerticalSpacing() 方法的设置，其他设置无效，即显示上无效。
    
    返回:
    
    格网设置对象。
    
    抛出:
    
    IllegalStateException - 对象已被释放
  - setGrid
```
public void setGrid(GridSetting setting)
```
    设置格网设置对象。
    
    参数:
    
    setting - 格网设置对象。
    
    抛出:
    
    IllegalStateException - 对象已被释放
  - isVisible
```
public boolean isVisible()
```
    返回纸张是否可见。
    
    返回:
    
    一个布尔值，纸张可见返回 true；纸张不可见返回 false。
    
    抛出:
    
    IllegalStateException - 对象已被释放
  - setVisible
```
public void setVisible(boolean value)
```
    设置纸张是否可见。
    
    参数:
    
    value - 纸张是否可见。
  - getMarginDashColor
```
public Color getMarginDashColor()
```
    返回纸面的网格虚线颜色。
    
    返回:
    
    返回纸面的网格虚线颜色
  - setMarginDashColor
```
public void setMarginDashColor(Color color)
```
    设置纸面的网格虚线颜色。
    
    参数:
    
    color - 纸面的网格虚线颜色。
  - getMarginSolidColor
```
public Color getMarginSolidColor()
```
    返回纸面的网格实线颜色。
    
    返回:
    
    返回纸面的网格实线颜色
  - setMarginSolidColor
```
public void setMarginSolidColor(Color color)
```
    设置纸面的网格实线颜色。
    
    参数:
    
    color - 纸面的网格实线颜色。
  - getPaperShadowColor
```
public Color getPaperShadowColor()
```
    返回纸面的阴影颜色。
    
    返回:
    
    返回纸面的阴影颜色
  - setPaperShadowColor
```
public void setPaperShadowColor(Color color)
```
    设置纸面的阴影颜色
    
    参数:
    
    color - 纸面的阴影颜色

类 Paper

方法概要

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

方法详细资料

getBackgroundColor

setBackgroundColor

getOrientation

setOrientation

getWidth

setWidth

getHeight

setHeight

getSize

setSize

getMargin

setMargin

getGrid

setGrid

isVisible

setVisible

getMarginDashColor

setMarginDashColor

getMarginSolidColor

setMarginSolidColor

getPaperShadowColor

setPaperShadowColor