PageContentInfo

java.lang.Object
- com.grapecity.documents.excel.PageContentInfo

public class PageContentInfo
extends java.lang.Object

Represent a page content info.

Constructor Summary

Constructors
Constructor and Description

PageContentInfo()
Creates a page content info.

PageContentInfo(RowPageContentInfo rowPage, ColumnPageContentInfo columnPage)

Constructors
Constructor and Description
`PageContentInfo()` Creates a page content info.
`PageContentInfo(RowPageContentInfo rowPage, ColumnPageContentInfo columnPage)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getColumnHeaderVisible()` Returns whether the column header is printed.
`int`	`getFillColumn()` Returns a column index.
`int`	`getFillColumnCount()` Returns a value represents the number of times the fill column will be repeated.
`int`	`getFillRow()` Returns a row index.
`int`	`getFillRowCount()` Returns a value represents the number of times the fill row will be repeated.
`IRange`	`getRange()` Returns the range to be printed.
`boolean`	`getRowHeaderVisible()` Returns whether the row header is printed.
`double`	`getRowHeaderWidth()`
`Size`	`getSize(WorksheetCache worksheetCache)`
`int`	`getTailColumnEnd()` Returns the end index of the columns which are printed at the right of the page.
`int`	`getTailColumnStart()` Returns the start index of the columns which are printed at the right of the page.
`int`	`getTailRowEnd()` Returns the end index of the rows which are printed at the bottom of the page.
`int`	`getTailRowStart()` Returns the start index of the rows which are printed at the bottom of the page.
`int`	`getTitleColumnEnd()` Returns the end index of the columns which are printed at the left of the page.
`int`	`getTitleColumnStart()` Returns the start index of the columns which are printed at the left of the page.
`int`	`getTitleRowEnd()` Returns the end index of the rows which are printed at the top of the page.
`int`	`getTitleRowStart()` Returns the start index of the rows which are printed at the top of the page.
`double`	`getZoomFactor()` Returns a Variant value that represents a percentage by which GcExcel will scale the worksheet for printing.
`void`	`setColumnHeaderVisible(boolean value)` Sets whether the column header is printed.
`void`	`setFillColumn(int value)` Sets a column index.
`void`	`setFillColumnCount(int value)` Sets a value represents the number of times the fill column will be repeated.
`void`	`setFillRow(int value)` Sets a row index.
`void`	`setFillRowCount(int value)` Sets a value represents the number of times the fill row will be repeated.
`void`	`setRange(IRange value)` Sets the range to be printed.
`void`	`setRowHeaderVisible(boolean value)` Sets whether the row header is printed.
`void`	`setRowHeaderWidth(double value)`
`void`	`setTailColumnEnd(int value)` Sets the end index of the columns which are printed at the right of the page.
`void`	`setTailColumnStart(int value)` Sets the start index of the columns which are printed at the right of the page.
`void`	`setTailRowEnd(int value)` Sets the end index of the rows which are printed at the bottom of the page.
`void`	`setTailRowStart(int value)` Sets the start index of the rows which are printed at the bottom of the page.
`void`	`setTitleColumnEnd(int value)` Sets the end index of the columns which are printed at the left of the page.
`void`	`setTitleColumnStart(int value)` Sets the start index of the columns which are printed at the left of the page.
`void`	`setTitleRowEnd(int value)` Sets the end index of the rows which are printed at the top of the page.
`void`	`setTitleRowStart(int value)` Sets the start index of the rows which are printed at the top of the page.
`void`	`setZoomFactor(double value)` Sets a Variant value that represents a percentage by which GcExcel will scale the worksheet for printing.
`void`	`updateFillColumnCount(double pageContentAvailableWidth)` Updates the FillColumnCount.
`void`	`updateFillRowCount(double pageContentAvailableHeight)` Updates the FillRowCount.
`void`	`updateRange(WorksheetCache worksheetCache, IRange printArea, int rowStart, int columnStart, Size availableSize)`
`void`	`updateRange(WorksheetCache worksheetCache, IRange printArea, int rowStart, int columnStart, Size availableSize, boolean ignoreRowPageBreaks)`
`void`	`updateRange(WorksheetCache worksheetCache, IRange printArea, int rowStart, int columnStart, Size availableSize, boolean ignoreRowPageBreaks, boolean ignoreColumnPageBreaks)` Updates the Range of the current ColumnPageContentInfo.
`void`	`updateRange(WorksheetCache worksheetCache, IRange printArea, int rowStart, int columnStart, Size availableSize, boolean ignoreRowPageBreaks, boolean ignoreColumnPageBreaks, boolean extend)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PageContentInfo
```
public PageContentInfo()
```
    Creates a page content info.
  - PageContentInfo
```
public PageContentInfo(RowPageContentInfo rowPage,
                       ColumnPageContentInfo columnPage)
```
- Method Detail
  - getRowHeaderWidth
```
public double getRowHeaderWidth()
```
  - setRowHeaderWidth
```
public void setRowHeaderWidth(double value)
```
  - getRowHeaderVisible
```
public boolean getRowHeaderVisible()
```
    Returns whether the row header is printed.
  - setRowHeaderVisible
```
public void setRowHeaderVisible(boolean value)
```
    Sets whether the row header is printed.
  - getColumnHeaderVisible
```
public final boolean getColumnHeaderVisible()
```
    Returns whether the column header is printed.
  - setColumnHeaderVisible
```
public final void setColumnHeaderVisible(boolean value)
```
    Sets whether the column header is printed.
  - getZoomFactor
```
public final double getZoomFactor()
```
    Returns a Variant value that represents a percentage by which GcExcel will scale the worksheet for printing.
  - setZoomFactor
```
public final void setZoomFactor(double value)
```
    Sets a Variant value that represents a percentage by which GcExcel will scale the worksheet for printing.
  - getRange
```
public final IRange getRange()
```
    Returns the range to be printed.
  - setRange
```
public final void setRange(IRange value)
```
    Sets the range to be printed.
  - getTitleRowStart
```
public final int getTitleRowStart()
```
    Returns the start index of the rows which are printed at the top of the page.
  - setTitleRowStart
```
public final void setTitleRowStart(int value)
```
    Sets the start index of the rows which are printed at the top of the page.
  - getTitleRowEnd
```
public final int getTitleRowEnd()
```
    Returns the end index of the rows which are printed at the top of the page.
  - setTitleRowEnd
```
public final void setTitleRowEnd(int value)
```
    Sets the end index of the rows which are printed at the top of the page.
  - getTailRowStart
```
public final int getTailRowStart()
```
    Returns the start index of the rows which are printed at the bottom of the page.
  - setTailRowStart
```
public final void setTailRowStart(int value)
```
    Sets the start index of the rows which are printed at the bottom of the page.
  - getTailRowEnd
```
public final int getTailRowEnd()
```
    Returns the end index of the rows which are printed at the bottom of the page.
  - setTailRowEnd
```
public final void setTailRowEnd(int value)
```
    Sets the end index of the rows which are printed at the bottom of the page.
  - getTitleColumnStart
```
public final int getTitleColumnStart()
```
    Returns the start index of the columns which are printed at the left of the page.
  - setTitleColumnStart
```
public final void setTitleColumnStart(int value)
```
    Sets the start index of the columns which are printed at the left of the page.
  - getTitleColumnEnd
```
public final int getTitleColumnEnd()
```
    Returns the end index of the columns which are printed at the left of the page.
  - setTitleColumnEnd
```
public final void setTitleColumnEnd(int value)
```
    Sets the end index of the columns which are printed at the left of the page.
  - getTailColumnStart
```
public final int getTailColumnStart()
```
    Returns the start index of the columns which are printed at the right of the page.
  - setTailColumnStart
```
public final void setTailColumnStart(int value)
```
    Sets the start index of the columns which are printed at the right of the page.
  - getTailColumnEnd
```
public final int getTailColumnEnd()
```
    Returns the end index of the columns which are printed at the right of the page.
  - setTailColumnEnd
```
public final void setTailColumnEnd(int value)
```
    Sets the end index of the columns which are printed at the right of the page.
  - getFillRow
```
public final int getFillRow()
```
    Returns a row index. The last page will be filled with this row.
  - setFillRow
```
public final void setFillRow(int value)
```
    Sets a row index. The last page will be filled with this row.
  - getFillRowCount
```
public final int getFillRowCount()
```
    Returns a value represents the number of times the fill row will be repeated.
  - setFillRowCount
```
public final void setFillRowCount(int value)
```
    Sets a value represents the number of times the fill row will be repeated.
  - getFillColumn
```
public final int getFillColumn()
```
    Returns a column index. The last page will be filled with this column.
  - setFillColumn
```
public final void setFillColumn(int value)
```
    Sets a column index. The last page will be filled with this column.
  - getFillColumnCount
```
public final int getFillColumnCount()
```
    Returns a value represents the number of times the fill column will be repeated.
  - setFillColumnCount
```
public final void setFillColumnCount(int value)
```
    Sets a value represents the number of times the fill column will be repeated.
  - updateRange
```
public final void updateRange(WorksheetCache worksheetCache,
                              IRange printArea,
                              int rowStart,
                              int columnStart,
                              Size availableSize,
                              boolean ignoreRowPageBreaks,
                              boolean ignoreColumnPageBreaks)
```
    Updates the Range of the current ColumnPageContentInfo.
    
    Parameters:
    
    printArea - The print area.
    
    rowStart - The start row index which is used to calculate the RowEnd.
    
    columnStart - The start column index which is used to calculate the ColumnEnd.
    
    pageContentAvailableSize - The page content size.
    
    ignorePageBreaks - Ignore the page breaks.
  - updateRange
```
public final void updateRange(WorksheetCache worksheetCache,
                              IRange printArea,
                              int rowStart,
                              int columnStart,
                              Size availableSize,
                              boolean ignoreRowPageBreaks)
```
  - updateRange
```
public final void updateRange(WorksheetCache worksheetCache,
                              IRange printArea,
                              int rowStart,
                              int columnStart,
                              Size availableSize)
```
  - updateRange
```
public final void updateRange(WorksheetCache worksheetCache,
                              IRange printArea,
                              int rowStart,
                              int columnStart,
                              Size availableSize,
                              boolean ignoreRowPageBreaks,
                              boolean ignoreColumnPageBreaks,
                              boolean extend)
```
  - updateFillRowCount
```
public final void updateFillRowCount(double pageContentAvailableHeight)
```
    Updates the FillRowCount.
    
    Parameters:
    
    pageContentAvailableHeight - The page content height.
  - updateFillColumnCount
```
public final void updateFillColumnCount(double pageContentAvailableWidth)
```
    Updates the FillColumnCount.
    
    Parameters:
    
    pageContentAvailableWidth - The page content width.
  - getSize
```
public final Size getSize(WorksheetCache worksheetCache)
```

Class PageContentInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PageContentInfo

PageContentInfo

Method Detail

getRowHeaderWidth

setRowHeaderWidth

getRowHeaderVisible

setRowHeaderVisible

getColumnHeaderVisible

setColumnHeaderVisible

getZoomFactor

setZoomFactor

getRange

setRange

getTitleRowStart

setTitleRowStart

getTitleRowEnd

setTitleRowEnd

getTailRowStart

setTailRowStart

getTailRowEnd

setTailRowEnd

getTitleColumnStart

setTitleColumnStart

getTitleColumnEnd

setTitleColumnEnd

getTailColumnStart

setTailColumnStart

getTailColumnEnd

setTailColumnEnd

getFillRow

setFillRow

getFillRowCount

setFillRowCount

getFillColumn

setFillColumn

getFillColumnCount

setFillColumnCount

updateRange

updateRange

updateRange

updateRange

updateFillRowCount

updateFillColumnCount

getSize