com.fr.page

类 ReportPage

java.lang.Object

com.fr.page.ReportPage

所有已实现的接口:

PageAttributeGetter, PaperSettingGetter, ReportPageProvider, FCloneable, java.awt.print.Printable, java.io.Serializable, java.lang.Cloneable

直接已知子类:

ReportPage.XMLReportPage, SheetPage

public class ReportPage
extends java.lang.Object
implements PageAttributeGetter, java.awt.print.Printable, java.io.Serializable, FCloneable, PaperSettingGetter, ReportPageProvider

用于展示及打印的页面 执行完一个多Sheet的Report后, 会生成多个ReportPage

另请参阅:

序列化表格

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	ReportPage.XMLReportPage

字段概要

字段

限定符和类型	字段和说明
protected int	bsCurrentPageNumber
protected int	bsTotalPageNumber
protected java.util.List	clippedPageList
protected int	currentPageNumber
protected ReportSettingsProvider	reportSettings
protected int	resolution
protected ResultReport	source_report
protected int	totalPageNumber
protected int	x
static java.lang.String	XML_TAG
protected int	y

从接口继承的字段 com.fr.page.ReportPageProvider

XML_TAG_4_SHEET

从接口继承的字段 java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

构造器概要

构造器

构造器和说明
ReportPage() 初始化一个ReportPage
ReportPage(ResultReport source_report, int totalPageNumber, int x, int y) 初始化一个ReportPage
ReportPage(ResultReport source_report, int totalPageNumber, int x, int y, ReportSettings reportSettings) 初始化一个ReportPage

方法概要

方法

限定符和类型	方法和说明
void	addClippedPage(ClippedPageProvider page) 添加分页块
java.lang.Object	clone() 浅克隆就行，clone一下，避免一些多线程同步问题
ReportPageProvider	deriveResolution(int resolution) 传递当前页面所使用的分辨率
int	getBsCurrentPageNumber()
int	getBsTotalPageNumber()
int	getContentHeight() 获取页面内容高度
int	getContentWidth() 获取页面内容宽度
int	getCurrentPageNumber() 获取当前页面的页码
ClippedPageProvider	getDefaultPage() 获取默认的页面
int	getFirstPage()
ReportHFProvider	getFooter() 获取这个ReportPage的页脚
ReportHFProvider	getFooter(int reportPageType) 获取指定页的页脚
ReportHFProvider	getHeader() 获取这个ReportPage的页眉
ReportHFProvider	getHeader(int reportPageType) 获取指定页的页眉
UNIT	getMarginBottom() 获取UNIT为单位的margin bottom
UNIT	getMarginLeft() 获取UNIT为单位的margin left
UNIT	getMarginRight() 获取UNIT为单位的margin right
UNIT	getMarginTop() 获取UNIT为单位的margin top
ClippedPageProvider[]	getPages() 获取reportpage中所有分页块
UNIT	getPaperHeight() 获取纸张高度
PaperSettingProvider	getPaperSetting() 获取页面设置
UNIT	getPaperWidth() 获取纸张宽度
ReportPageAttrProvider	getReportPageAttr() 获取报表分页属性
ReportSettingsProvider	getReportSettings() 获取页面设置
int	getTotalPages() 获取总页数
int	getWebPageHeight() 获取浏览器页面高度
int	getWebPageWidth() 获取浏览器页面宽度
int[]	getXY() 返回该ReportPage在其所属的Report生成的ReportPage[][]中的两维坐标定位
int	print(java.awt.Graphics g, java.awt.print.PageFormat pf, int pageIndex) 打印指定的页面
void	setBsCurrentPageNumber(int bsCurrentPageNumber) 设置浏览器端的当前页面的页码
void	setBsTotalPageNumber(int bsTotalPageNumber) 设置浏览器端的总页码
void	setCurrentPageNumber(int currentPageNumber) 设置当前这个ReportPage的页码
void	setTotalPages(int pages) 设置总页数
java.awt.Image	toImage() 将ReportPage转成一个Image对象
java.awt.Image	toImage(boolean isPrint, boolean isShowAsImageInWeb) 将ReportPage转成一个Image对象
JSONObject	toJSONObject(Repository repository) 分页的对象输出为JSON
void	writePageIndex(JSONObject jsonObject) 将页码信息输到JSON中
void	writeScriptForWebPage(java.io.PrintWriter writer) 为浏览器端添加script代码

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

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

字段详细资料

XML_TAG

public static final java.lang.String XML_TAG

另请参阅:

常量字段值

source_report

protected ResultReport source_report

reportSettings

protected ReportSettingsProvider reportSettings

currentPageNumber

protected int currentPageNumber

totalPageNumber

protected int totalPageNumber

bsCurrentPageNumber

protected int bsCurrentPageNumber

bsTotalPageNumber

protected int bsTotalPageNumber

x

protected int x

y

protected int y

resolution

protected int resolution

clippedPageList

protected java.util.List clippedPageList

构造器详细资料

ReportPage

public ReportPage()

初始化一个ReportPage

ReportPage

public ReportPage(ResultReport source_report,
          int totalPageNumber,
          int x,
          int y,
          ReportSettings reportSettings)

初始化一个ReportPage

参数:

source_report - 该ReportPage所属的report

totalPageNumber - 总页数

x - 该ReportPage在生成其的Report生成的所有的ReportPage中的位置(x, y)

y - 该ReportPage在生成其的Report生成的所有的ReportPage中的位置(x, y)

reportSettings - 页面设置

ReportPage

public ReportPage(ResultReport source_report,
          int totalPageNumber,
          int x,
          int y)

初始化一个ReportPage

参数:

source_report - 该ReportPage所属的report

totalPageNumber - 总页数

x - 该ReportPage在生成其的Report生成的所有的ReportPage中的位置(x, y)

y - 该ReportPage在生成其的Report生成的所有的ReportPage中的位置(x, y)

方法详细资料

toJSONObject

public JSONObject toJSONObject(Repository repository)
                        throws java.lang.Exception

从接口复制的说明: ReportPageProvider

分页的对象输出为JSON

指定者:

toJSONObject 在接口中 ReportPageProvider

参数:

repository - session相关的上下文对象

返回:

JSON对象

抛出:

java.lang.Exception

getPages

public ClippedPageProvider[] getPages()

获取reportpage中所有分页块

指定者:

getPages 在接口中 ReportPageProvider

addClippedPage

public void addClippedPage(ClippedPageProvider page)

添加分页块

指定者:

addClippedPage 在接口中 ReportPageProvider

参数:

page - 被添加的分页块

getXY

public int[] getXY()

返回该ReportPage在其所属的Report生成的ReportPage[][]中的两维坐标定位

指定者:

getXY 在接口中 ReportPageProvider

getReportPageAttr

public ReportPageAttrProvider getReportPageAttr()

获取报表分页属性

指定者:

getReportPageAttr 在接口中 ReportPageProvider

getPaperSetting

public PaperSettingProvider getPaperSetting()

获取页面设置

指定者:

getPaperSetting 在接口中 PaperSettingGetter

指定者:

getPaperSetting 在接口中 ReportPageProvider

getPaperWidth

public UNIT getPaperWidth()

获取纸张宽度

指定者:

getPaperWidth 在接口中 ReportPageProvider

getWebPageWidth

public int getWebPageWidth()

获取浏览器页面宽度

指定者:

getWebPageWidth 在接口中 ReportPageProvider

getPaperHeight

public UNIT getPaperHeight()

获取纸张高度

指定者:

getPaperHeight 在接口中 ReportPageProvider

getWebPageHeight

public int getWebPageHeight()

获取浏览器页面高度

指定者:

getWebPageHeight 在接口中 ReportPageProvider

getMarginTop

public UNIT getMarginTop()

获取UNIT为单位的margin top

指定者:

getMarginTop 在接口中 ReportPageProvider

getMarginLeft

public UNIT getMarginLeft()

获取UNIT为单位的margin left

指定者:

getMarginLeft 在接口中 ReportPageProvider

getMarginBottom

public UNIT getMarginBottom()

获取UNIT为单位的margin bottom

指定者:

getMarginBottom 在接口中 ReportPageProvider

getMarginRight

public UNIT getMarginRight()

获取UNIT为单位的margin right

指定者:

getMarginRight 在接口中 ReportPageProvider

getReportSettings

public ReportSettingsProvider getReportSettings()

获取页面设置

指定者:

getReportSettings 在接口中 PageAttributeGetter

指定者:

getReportSettings 在接口中 ReportPageProvider

返回:

返回页面属性

getHeader

public ReportHFProvider getHeader()

获取这个ReportPage的页眉

指定者:

getHeader 在接口中 ReportPageProvider

getFooter

public ReportHFProvider getFooter()

获取这个ReportPage的页脚

指定者:

getFooter 在接口中 ReportPageProvider

getFooter

public ReportHFProvider getFooter(int reportPageType)

从接口复制的说明: ReportPageProvider

获取指定页的页脚

指定者:

getFooter 在接口中 ReportPageProvider

另请参阅:

ReportConstants.REPORTPAGE_DEFAULT, ReportConstants.REPORTPAGE_ODD, ReportConstants.REPORTPAGE_EVEN, ReportConstants.REPORTPAGE_FIRST, ReportConstants.REPORTPAGE_LAST

getHeader

public ReportHFProvider getHeader(int reportPageType)

从接口复制的说明: ReportPageProvider

获取指定页的页眉

指定者:

getHeader 在接口中 ReportPageProvider

另请参阅:

ReportConstants.REPORTPAGE_DEFAULT, ReportConstants.REPORTPAGE_ODD, ReportConstants.REPORTPAGE_EVEN, ReportConstants.REPORTPAGE_FIRST, ReportConstants.REPORTPAGE_LAST

getContentWidth

public int getContentWidth()

获取页面内容宽度

指定者:

getContentWidth 在接口中 ReportPageProvider

getContentHeight

public int getContentHeight()

获取页面内容高度

指定者:

getContentHeight 在接口中 ReportPageProvider

setCurrentPageNumber

public void setCurrentPageNumber(int currentPageNumber)

设置当前这个ReportPage的页码

指定者:

setCurrentPageNumber 在接口中 ReportPageProvider

getCurrentPageNumber

public int getCurrentPageNumber()

获取当前页面的页码

指定者:

getCurrentPageNumber 在接口中 ReportPageProvider

getTotalPages

public int getTotalPages()

获取总页数

指定者:

getTotalPages 在接口中 ReportPageProvider

getFirstPage

public int getFirstPage()

指定者:

getFirstPage 在接口中 ReportPageProvider

setTotalPages

public void setTotalPages(int pages)

设置总页数

指定者:

setTotalPages 在接口中 ReportPageProvider

参数:

pages - 总页数

setBsCurrentPageNumber

public void setBsCurrentPageNumber(int bsCurrentPageNumber)

设置浏览器端的当前页面的页码

指定者:

setBsCurrentPageNumber 在接口中 ReportPageProvider

参数:

bsCurrentPageNumber - 当前页码

getBsCurrentPageNumber

public int getBsCurrentPageNumber()

指定者:

getBsCurrentPageNumber 在接口中 ReportPageProvider

setBsTotalPageNumber

public void setBsTotalPageNumber(int bsTotalPageNumber)

设置浏览器端的总页码

指定者:

setBsTotalPageNumber 在接口中 ReportPageProvider

参数:

bsTotalPageNumber - 总页码

getBsTotalPageNumber

public int getBsTotalPageNumber()

指定者:

getBsTotalPageNumber 在接口中 ReportPageProvider

writeScriptForWebPage

public void writeScriptForWebPage(java.io.PrintWriter writer)

为浏览器端添加script代码

指定者:

writeScriptForWebPage 在接口中 ReportPageProvider

writePageIndex

public void writePageIndex(JSONObject jsonObject)
                    throws JSONException

从接口复制的说明: ReportPageProvider

将页码信息输到JSON中

指定者:

writePageIndex 在接口中 ReportPageProvider

参数:

jsonObject - JSON对象

抛出:

JSONException

toImage

public java.awt.Image toImage()

将ReportPage转成一个Image对象

指定者:

toImage 在接口中 ReportPageProvider

toImage

public java.awt.Image toImage(boolean isPrint,
                     boolean isShowAsImageInWeb)

将ReportPage转成一个Image对象

指定者:

toImage 在接口中 ReportPageProvider

参数:

isPrint - 是否是打印事件

print

public int print(java.awt.Graphics g,
        java.awt.print.PageFormat pf,
        int pageIndex)
          throws java.awt.print.PrinterException

打印指定的页面

指定者:

print 在接口中 ReportPageProvider

指定者:

print 在接口中 java.awt.print.Printable

参数:

g - 画图上下文

pf - 页面的PageFormat, 包含横纵向页面设置等信息

pageIndex - 需要打印的页码

抛出:

java.awt.print.PrinterException

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

浅克隆就行，clone一下，避免一些多线程同步问题

指定者:

clone 在接口中 ReportPageProvider

指定者:

clone 在接口中 FCloneable

覆盖:

clone 在类中 java.lang.Object

返回:

克隆后的对象

抛出:

java.lang.CloneNotSupportedException - 如果克隆失败则抛出此异常

deriveResolution

public ReportPageProvider deriveResolution(int resolution)

传递当前页面所使用的分辨率

指定者:

deriveResolution 在接口中 ReportPageProvider

参数:

resolution - 分辨率

getDefaultPage

public ClippedPageProvider getDefaultPage()

获取默认的页面