com.fr.page

接口 ReportPageProvider

所有超级接口:

java.awt.print.Printable

所有已知实现类:

ReportPage, ReportPage.XMLReportPage, SheetPage

public interface ReportPageProvider
extends java.awt.print.Printable

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	XML_TAG
static java.lang.String	XML_TAG_4_SHEET

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

NO_SUCH_PAGE, PAGE_EXISTS

方法概要

方法

限定符和类型	方法和说明
void	addClippedPage(ClippedPageProvider page) 添加分页块
java.lang.Object	clone() 浅克隆就行，clone一下，避免一些多线程同步问题
ReportPageProvider	deriveResolution(int resolution) 传递当前页面所使用的分辨率
int	getBsCurrentPageNumber()
int	getBsTotalPageNumber()
int	getContentHeight() 获取页面内容高度
int	getContentWidth() 获取页面内容宽度
int	getCurrentPageNumber() 获取当前页面的页码
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代码

字段详细资料

XML_TAG

static final java.lang.String XML_TAG

另请参阅:

常量字段值

XML_TAG_4_SHEET

static final java.lang.String XML_TAG_4_SHEET

另请参阅:

常量字段值

方法详细资料

getPages

ClippedPageProvider[] getPages()

获取reportpage中所有分页块

addClippedPage

void addClippedPage(ClippedPageProvider page)

添加分页块

参数:

page - 被添加的分页块

getXY

int[] getXY()

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

getReportPageAttr

ReportPageAttrProvider getReportPageAttr()

获取报表分页属性

getPaperSetting

PaperSettingProvider getPaperSetting()

获取页面设置

getPaperWidth

UNIT getPaperWidth()

获取纸张宽度

getWebPageWidth

int getWebPageWidth()

获取浏览器页面宽度

getPaperHeight

UNIT getPaperHeight()

获取纸张高度

getWebPageHeight

int getWebPageHeight()

获取浏览器页面高度

getMarginTop

UNIT getMarginTop()

获取UNIT为单位的margin top

getMarginLeft

UNIT getMarginLeft()

获取UNIT为单位的margin left

getMarginBottom

UNIT getMarginBottom()

获取UNIT为单位的margin bottom

getMarginRight

UNIT getMarginRight()

获取UNIT为单位的margin right

getReportSettings

ReportSettingsProvider getReportSettings()

获取页面设置

getHeader

ReportHFProvider getHeader()

获取这个ReportPage的页眉

getFooter

ReportHFProvider getFooter()

获取这个ReportPage的页脚

getFooter

ReportHFProvider getFooter(int reportPageType)

获取指定页的页脚

另请参阅:

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

getHeader

ReportHFProvider getHeader(int reportPageType)

获取指定页的页眉

另请参阅:

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

getContentWidth

int getContentWidth()

获取页面内容宽度

getContentHeight

int getContentHeight()

获取页面内容高度

setCurrentPageNumber

void setCurrentPageNumber(int currentPageNumber)

设置当前这个ReportPage的页码

getCurrentPageNumber

int getCurrentPageNumber()

获取当前页面的页码

getTotalPages

int getTotalPages()

获取总页数

getFirstPage

int getFirstPage()

setTotalPages

void setTotalPages(int pages)

设置总页数

参数:

pages - 总页数

setBsCurrentPageNumber

void setBsCurrentPageNumber(int bsCurrentPageNumber)

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

参数:

bsCurrentPageNumber - 当前页码

getBsCurrentPageNumber

int getBsCurrentPageNumber()

getBsTotalPageNumber

int getBsTotalPageNumber()

setBsTotalPageNumber

void setBsTotalPageNumber(int bsTotalPageNumber)

设置浏览器端的总页码

参数:

bsTotalPageNumber - 总页码

writeScriptForWebPage

void writeScriptForWebPage(java.io.PrintWriter writer)

为浏览器端添加script代码

writePageIndex

void writePageIndex(JSONObject jsonObject)
                    throws JSONException

将页码信息输到JSON中

参数:

jsonObject - JSON对象

抛出:

JSONException

toImage

java.awt.Image toImage()

将ReportPage转成一个Image对象

toImage

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

将ReportPage转成一个Image对象

参数:

isPrint - 是否是打印事件

print

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

打印指定的页面

指定者:

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

参数:

g - 画图上下文

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

pageIndex - 需要打印的页码

抛出:

java.awt.print.PrinterException

clone

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

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

抛出:

java.lang.CloneNotSupportedException

deriveResolution

ReportPageProvider deriveResolution(int resolution)

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

参数:

resolution - 分辨率

toJSONObject

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

分页的对象输出为JSON

参数:

repository - session相关的上下文对象

返回:

JSON对象

抛出:

java.lang.Exception