Margin

Class Margin

java.lang.Object

com.grapecity.documents.excel.Margin

---

public class Margin extends Object

表示相对于单元格的水印边距，以像素为单位。

使用此类可定义通过 ILabelOptions.setMargin(Margin) 应用于区域中水印的上、右、下、左边距。可以创建四边值相同的边距，也可以分别指定每一边。

 worksheet.getRange("A1").setValue("Draft");
 Margin margin = new Margin(4, 8, 4, 8);
 worksheet.getRange("A1").getLabelOptions().setMargin(margin);
 

• Constructor Summary

  Constructors

  Constructor

  Description

  Margin(int all)

  创建一个 Margin 实例，将相同的边距值应用于四个边。

  Margin(int top, int right, int bottom, int left)

  创建一个 Margin 实例，并为每一边使用单独的值。

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  int

  getBottom()

  获取底部边距。

  int

  getLeft()

  获取左侧边距。

  int

  getRight()

  获取右侧边距。

  int

  getTop()

  获取顶部边距。

  String

  toString()

  获取此边距的字符串表示形式。

  Methods inherited from class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

• Constructor Details

  • Margin

    public Margin(int all)

    创建一个 Margin 实例，将相同的边距值应用于四个边。

    当上、右、下、左边距应相同时，使用此构造函数可定义相对于单元格的水印边距（以像素为单位）。创建的边距可通过 ILabelOptions.setMargin(Margin) 应用。

    
     worksheet.getRange("A1").setValue("Draft");
     Margin margin = new Margin(4);
     worksheet.getRange("A1").getLabelOptions().setMargin(margin);
     

    Parameters:

    all - 要为所有边距设置的值，以像素为单位。

  • Margin

    public Margin(int top, int right, int bottom, int left)

    创建一个 Margin 实例，并为每一边使用单独的值。

    使用此构造函数可在将边距分配给标签选项之前，分别定义上、右、下、左水印边距。

    
     Margin margin = new Margin(10, 20, 10, 20);
     worksheet.getRange("A1").getLabelOptions().setMargin(margin);
     

    Parameters:

    top - 顶部边距值。

    right - 右侧边距值。

    bottom - 底部边距值。

    left - 左侧边距值。

• Method Details

  • getLeft

    public int getLeft()

    获取左侧边距。

    返回值是相对于单元格的左侧水印边距（以像素为单位）。

    
     Margin margin = new Margin(1, 2, 3, 4);
     int left = margin.getLeft();
     

    Returns:

    左侧边距值（以像素为单位）。

  • getRight

    public int getRight()

    获取右侧边距。

    返回值指定相对于单元格的右侧水印边距（以像素为单位）。

    
     Margin margin = new Margin(1, 2, 3, 4);
     int right = margin.getRight();
     

    Returns:

    右侧边距值（以像素为单位）。

  • getTop

    public int getTop()

    获取顶部边距。

    返回相对于单元格的顶部边距值，以像素为单位。

    
     Margin margin = new Margin(1, 2, 3, 4);
     int top = margin.getTop();
     

    Returns:

    顶部边距值，以相对于单元格的像素为单位。

  • getBottom

    public int getBottom()

    获取底部边距。

    返回的值是相对于单元格的底部水印边距，以像素为单位。

    
     Margin margin = new Margin(1, 2, 3, 4);
     int bottom = margin.getBottom();
     

    Returns:

    底部边距值，以像素为单位。

  • toString

    public String toString()

    获取此边距的字符串表示形式。

    返回的字符串按上、右、下、左的顺序包含边距值，并以空格分隔。可以将返回值传递给 StringToMargin(String)，以创建具有相同边距值的 Margin 实例。

    Overrides:

    toString in class Object

    Returns:

    表示此边距的字符串，顺序为上-右-下-左。