public interface UIViewPrinter
Modifier and Type | Field and Description |
---|---|
static int |
ABOVE_FOOTER
Position for line.
|
static int |
ADJUST_FOR_HEADERS_AND_FOOTERS
Margin adjustment:
When headers or footers do not fit in the specified margin,
the margins are enlarged so that the headers or footers fit.
|
static int |
ALL_LOGICAL_PAGES
Range type: Print all the logical pages in the view.
|
static int |
BELOW_HEADER
Position for line.
|
static int |
BOTTOM_FORMATTED_TEXT_AREA
ID for dataView bottom FormattedTextArea.
|
static int |
CROSSTAB_PRINTER |
static int |
CURRENT_LOGICAL_PAGE
Range type: Print only the current logical page of the view.
|
static int |
FOOTER_CENTER
The center footer.
|
static int |
FOOTER_LEFT
The left footer.
|
static int |
FOOTER_RIGHT
The right footer.
|
static int |
FOOTNOTE
ID for dataView footnote.
|
static int |
GRAPH_PRINTER |
static int |
GRIDVIEW_COLUMN_HEADER
ID for GridView column header.
|
static int |
GRIDVIEW_ROW_HEADER
ID for GridView row header.
|
static int |
HEADER_CENTER
The center header.
|
static int |
HEADER_LEFT
The left header.
|
static int |
HEADER_RIGHT
The right header.
|
static int |
HEADERS_AND_FOOTERS_ALL
All headers and footers.
|
static int |
HEADERS_AND_FOOTERS_NONE
No headers or footers.
|
static int |
IGNORE_HEADERS_AND_FOOTERS
Margin adjustment:
When headers or footers do not fit in the specified margin, they are printed
over the view in the printable area.
|
static int |
OCCLUDE_HEADERS_AND_FOOTERS
Margin adjustment:
When headers or footers do not fit in the specified margin,
the margins are unchanged.
|
static int |
ORIGINAL_SIZE
Print scale type: Print the view at its current size.
|
static int |
PAGE_HEADER
ID for page header.
|
static int |
SCALE_TO_FIT_FULL_PAGE
Print scale type: Print the graph so that it fills the entire
physical page.
|
static int |
SCALE_TO_FIT_PAGE
Print scale type: Print the graph so that it fills the physical page,
keeping its on-screen proportions.
|
static int |
SCALE_TO_FIT_PAGES
Print scale type: Scale the view to fit on the specified numbers of
pages.
|
static int |
SCALE_TO_ZOOM_FACTOR
Print scale type: Scale the view according to the
PrintZoomFactor property of this ViewPrinter . |
static int |
SELECTED_LOGICAL_PAGES
Range type: Print selected logical pages in the view.
|
static int |
SUBTITLE
ID for dataView subtitle.
|
static int |
TABLE_PRINTER |
static int |
TEXT_COMPONENTS_ALL
Font scale property: Print the graph so that it scales the original
font sizes of all text components according to on-screen proportions.
|
static int |
TEXT_COMPONENTS_NONE
Font scale property: Print the graph so that it preserves the original
font sizes of all text components.
|
static int |
TITLE
ID for dataView title.
|
static int |
TOP_FORMATTED_TEXT_AREA
ID for dataView top FormattedTextArea.
|
static int |
UNIT_CM |
static int |
UNIT_INCHES |
static int |
UNIT_PIXELS |
static int |
WORKSHEET_WITH_CROSSTAB_AND_GRAPH_PRINTER |
static int |
WORKSHEET_WITH_CROSSTAB_PRINTER |
static int |
WORKSHEET_WITH_GRAPH_PRINTER |
static int |
WORKSHEET_WITH_TABLE_AND_GRAPH_PRINTER |
static int |
WORKSHEET_WITH_TABLE_PRINTER |
Modifier and Type | Method and Description |
---|---|
void |
endPrint()
Sets the view back to its original state.
|
int |
getBottomMargin()
Retrieves the height of the bottom margin of printed physical pages.
|
java.awt.Cursor |
getDefaultCursor() |
int |
getFitToNumPagesTall()
Retrieves the number of physical pages on which a printed view is
required to fit vertically.
|
int |
getFitToNumPagesWide()
Retrieves the number of physical pages on which a printed view is
required to fit horizontally.
|
int |
getFooterMargin()
Retrieves the height of the footer margin.
|
int |
getGraphPrintScaleType()
Retrieves information about how the
DataView is scaled
for printing. |
int |
getGridViewPrintScaleType()
Retrieves information about how the
DataView is scaled
for printing. |
HeaderAndFooterPainter |
getHeaderAndFooterPainter(int headerOrFooterID)
Retrieves a header or footer painter.
|
int |
getHeaderMargin()
Retrieves the height of the header margin.
|
int |
getLeftMargin()
Retrieves the left margin of printed physical pages.
|
int |
getLineWidth(int position)
Retrieves the width of the line printed at the given position.
|
java.util.Locale |
getLocale()
Retrives the locale of the View to be printed by this UIViewPrinter
|
java.awt.print.PageFormat |
getPageFormat()
Retrieves the
PageFormat object that specifies the paper
size for this ViewPrinter . |
int |
getPrintZoomFactor()
Retrieves the zoom factor for printing.
|
int |
getRangeType()
Retrieves information about how much of the view will be printed.
|
int |
getRightMargin()
Retrieves the width of the right margin of printed physical pages.
|
int |
getScaleFontSize()
Retrieves the text components to resize when a graph is
scaled to a different size for printing.
|
java.util.Vector |
getSelectedHPos()
Retrieves the hierarchical addresses of the logical pages to print, when
RangeType is set to SELECTED_LOGICAL_PAGES . |
int |
getSequentialPageNumber() |
TokenSubstitution |
getTokenSubstitution()
Retrieves the handler for token substitution in this
ViewPrinter . |
int |
getTopMargin()
Retrieves the height of the top margin of printed physical pages.
|
int |
getUnits()
Retrieves the unit value: UNIT_PIXEL, UNIT_INCHES, UNIT_CM.
|
java.awt.Dimension |
getViewDimension() |
int |
getViewPrinterType()
Retrieves the type of ViewPrinter.
|
java.awt.Cursor |
getWaitCursor() |
boolean |
goToFirstPage(java.awt.Graphics g) |
boolean |
goToLastPage(java.awt.Graphics g) |
boolean |
hasNextPage()
Indicates whether the view has a physical page after the
current physical page.
|
boolean |
hasPrevPage()
Indicates whether the view has a physical page before the
current physical page.
|
boolean |
isDataviewFootnoteVisible()
Indicates if DataviewFootnote is visble in the View to be printed.
|
boolean |
isDataviewSubtitleVisible()
Indicates if DataviewSubtitle is visble in the View to be printed.
|
boolean |
isDataviewTitleVisible()
Indicates if DataviewTitle is visble in the View to be printed.
|
boolean |
isFirstPhysicalPage() |
boolean |
isGridlinesVisible()
Indicates whether gridlines appear in a printed
GridView . |
boolean |
isLastPhysicalPage() |
boolean |
isPrintByColumns()
Indicates whether physical pages are printed by rows (left-to-right
then top-to-bottom) or by columns(top-to-bottom then left-to-right).
|
boolean |
isRepeatComponent(int component)
Indicates whether the component is displayed on every physical page,
when a table or crosstab is printed on multiple physical pages.
|
boolean |
prepareFirstPage(java.awt.Graphics g)
Prepares the first physical page in the view for printing and
makes it the current page to print.
|
boolean |
prepareNextPage(java.awt.Graphics g)
Prepares the next physical page for printing and makes it the current
page to print.
|
boolean |
preparePrevPage(java.awt.Graphics g)
Prepares the previous physical page for printing and makes it the
current page to print.
|
boolean |
renderFirstPage(java.awt.Graphics g) |
boolean |
renderLastPage(java.awt.Graphics g) |
boolean |
renderPage(java.awt.Graphics g) |
void |
setBottomMargin(int mrgn)
Specifies the height of the bottom margin of printed physical pages.
|
void |
setFitToNumPagesTall(int num)
Specifies the number of physical pages on which to fit a printed view
vertically.
|
void |
setFitToNumPagesWide(int num)
Specifies the number of physical pages on which to fit a printed view
horizontally.
|
void |
setFooterMargin(int mrgn)
Specifies the height of the footer margin.
|
void |
setGraphPrintScaleType(int type)
Specifies how to scale the
DataView for printing. |
void |
setGridlinesVisible(boolean visible)
Specifies whether gridlines appear in a printed
GridView . |
void |
setGridViewPrintScaleType(int type)
Specifies how to scale the
DataView for printing. |
void |
setHeaderMargin(int mrgn)
Specifies the height of the header margin.
|
void |
setLeftMargin(int mrgn)
Specifies the width of left margin of printed physical pages.
|
void |
setLineWidth(int position,
int width)
Specifies the width of the line to be printed at the given position.
|
void |
setPageFormat(java.awt.print.PageFormat pf)
Specifies the
PageFormat object that specifies paper
size for this ViewPrinter . |
void |
setPrintByColumns(boolean byColumns)
Specifies whether physical pages are printed by columns (left-to-right
then top-to-bottom) or by rows(top-to-bottom then left-to-right).
|
void |
setPrintZoomFactor(int zoom)
Specifies the zoom factor for printing.
|
void |
setRangeType(int type)
Specifies whether to print the current logical page or all logical pages.
|
void |
setRepeatComponent(int component,
boolean repeat)
Specifies whether to repeat the component on every physical page, when a table or
crosstab is printed on multiple physical pages.
|
void |
setRightMargin(int mrgn)
Specifies the width of the right margin of printed physical pages.
|
void |
setScaleFontSize(int mask)
Specifies text components to resize when a graph is
scaled to a different size for printing.
|
void |
setSelectedHPos(java.util.Vector printHPos)
Specifies logical pages to print, when the
RangeType is
SELECTED_LOGICAL_PAGES . |
void |
setSequentialPageNumber(int pageNum) |
void |
setTokenSubstitution(TokenSubstitution token)
Specifies a handler for token substitution in this
ViewPrinter . |
void |
setTopMargin(int mrgn)
Specifies the height of the top margin of printed physical pages.
|
void |
setUnits(int iUnit)
Specifies which unit value to use: UNIT_PIXEL, UNIT_INCHES, UNIT_CM..
|
boolean |
startPrint(boolean bPreviewMode)
Puts the view in a state for printing.
|
static final int CROSSTAB_PRINTER
static final int TABLE_PRINTER
static final int GRAPH_PRINTER
static final int WORKSHEET_WITH_TABLE_PRINTER
static final int WORKSHEET_WITH_CROSSTAB_PRINTER
static final int WORKSHEET_WITH_GRAPH_PRINTER
static final int WORKSHEET_WITH_CROSSTAB_AND_GRAPH_PRINTER
static final int WORKSHEET_WITH_TABLE_AND_GRAPH_PRINTER
static final int CURRENT_LOGICAL_PAGE
static final int ALL_LOGICAL_PAGES
static final int SELECTED_LOGICAL_PAGES
setSelectedHPos
method.static final int ORIGINAL_SIZE
PrintScaleType
to this value, the view is
printed at its current size, as determined by its
ZoomFactor
property.static final int SCALE_TO_ZOOM_FACTOR
PrintZoomFactor
property of this ViewPrinter
.
When you set PrintScaleType
to this value, you must also
call setPrintZoomFactor
to specify the scale for printing.
If you use the printPage
method to print, and you
use this scale type, then set the margins to 0 before you call
the startPrint
method.
#setPrintScaleType
,
setPrintZoomFactor(int)
,
Constant Field Valuesstatic final int SCALE_TO_FIT_PAGES
PrintScaleType
to this value, you must also
call setFitToNumPagesTall
and
setFitToNumPagesWide
to specify the number of pages on
which you want the view to fit.
This value does not work in a GraphPrinter
.
If you use it, the graph will be printed at its original size.
If you use the printPage
method to print, and you
use this scale type, then set the margins to 0 before you call
the startPrint
method.
#setPrintScaleType
,
setFitToNumPagesTall(int)
,
setFitToNumPagesWide(int)
,
Constant Field Valuesstatic final int SCALE_TO_FIT_FULL_PAGE
If you use the printPage
method to print, and you
use this scale type, then set the margins to 0 before you call
the startPrint
method.
static final int SCALE_TO_FIT_PAGE
If you use the printPage
method to print, and you
use this scale type, then set the margins to 0 before you call
the startPrint
method.
static final int TEXT_COMPONENTS_ALL
static final int TEXT_COMPONENTS_NONE
static final int BELOW_HEADER
static final int ABOVE_FOOTER
static final int GRIDVIEW_COLUMN_HEADER
static final int GRIDVIEW_ROW_HEADER
static final int PAGE_HEADER
static final int TITLE
static final int SUBTITLE
static final int FOOTNOTE
static final int TOP_FORMATTED_TEXT_AREA
static final int BOTTOM_FORMATTED_TEXT_AREA
static final int HEADER_LEFT
static final int HEADER_CENTER
static final int HEADER_RIGHT
static final int FOOTER_LEFT
static final int FOOTER_CENTER
static final int FOOTER_RIGHT
static final int HEADERS_AND_FOOTERS_ALL
#setHeadersAndFootersUsingCallback
,
Constant Field Valuesstatic final int HEADERS_AND_FOOTERS_NONE
#setHeadersAndFootersUsingCallback
,
Constant Field Valuesstatic final int IGNORE_HEADERS_AND_FOOTERS
static final int ADJUST_FOR_HEADERS_AND_FOOTERS
static final int OCCLUDE_HEADERS_AND_FOOTERS
static final int UNIT_PIXELS
static final int UNIT_INCHES
static final int UNIT_CM
int getViewPrinterType()
CROSSTAB_PRINTER
,
TABLE_PRINTER
,
GRAPH_PRINTER
,
#WORKSHEET_PRINTER
void setLeftMargin(int mrgn)
This method has no effect when you use the printPage
method to print.
mrgn
- The width of the left margin, pixels.int getLeftMargin()
void setRightMargin(int mrgn)
This method has no effect when you use the printPage
method to print.
mrgn
- The width of the right margin, in pixels.int getRightMargin()
void setTopMargin(int mrgn)
This method has no effect when you use the printPage
method to print.
mrgn
- The height of the top margin, in pixels.int getTopMargin()
void setBottomMargin(int mrgn)
This method has no effect when you use the printPage
method to print.
mrgn
- The height of the bottom margin, in pixels.int getBottomMargin()
void setHeaderMargin(int mrgn)
This method has no effect when you use the printPage
method to print.
mrgn
- The height of the header margin, in pixels.int getHeaderMargin()
void setFooterMargin(int mrgn)
This method has no effect when you use the printPage
method to print.
mrgn
- The height of the footer margin, in pixels.int getFooterMargin()
void setPrintZoomFactor(int zoom)
DataView
is
enlarged or reduced for printing.
The value of the PrintZoomFactor
property takes effect only
when the PrintScaleType
property is set to
SCALE_TO_ZOOM_FACTOR
.
By default, the view is printed at full size (100 percent).
zoom
- The percentage at which to print the view. This methods logs
an error if the value is less than 10.#setPrintScaleType
int getPrintZoomFactor()
DataView
is
enlarged or reduced for printing.
The value of the PrintZoomFactor
property takes effect only
when the PrintScaleType
property is set to
SCALE_TO_ZOOM_FACTOR
.
By default, the view is printed at full size (100 percent).
#setPrintScaleType
void setGraphPrintScaleType(int type)
DataView
for printing.
By default, the view is printed at its original size.type
- A constant that indicates how to scale the
DataView
for printing. Constants are listed
in the See Also section.ORIGINAL_SIZE
,
ViewPrinter.SCALE_TO_FIT_PAGE
,
ViewPrinter.SCALE_TO_FIT_FULL_PAGE
int getGraphPrintScaleType()
DataView
is scaled
for printing.DataView
is scaled
for printing. Constants are listed in the See Also section.ORIGINAL_SIZE
,
ViewPrinter.SCALE_TO_FIT_PAGE
,
ViewPrinter.SCALE_TO_FIT_FULL_PAGE
void setGridViewPrintScaleType(int type)
DataView
for printing.
By default, the view is printed at its original size.type
- A constant that indicates how to scale the
DataView
for printing. Constants are listed
in the See Also section.ORIGINAL_SIZE
,
SCALE_TO_FIT_PAGES
,
SCALE_TO_ZOOM_FACTOR
int getGridViewPrintScaleType()
DataView
is scaled
for printing.DataView
is scaled
for printing. Constants are listed in the See Also section.ORIGINAL_SIZE
,
SCALE_TO_FIT_PAGES
,
SCALE_TO_ZOOM_FACTOR
void setFitToNumPagesTall(int num)
GraphPrinter
.
For example, suppose that you have a crosstab that has four columns and
40 rows.
Suppose that this crosstab would normally print on two sheets of paper,
the first 30 rows on page 1 and the remainder on page 2.
You could set FitToNumPagesTall
to 1 in order to reduce the
printed size of the crosstab so that all 40 rows are printed on one
sheet of paper.
The view is scaled to fit the number of pages that you specify only
when the PrintScaleType
property is set to
SCALE_TO_FIT_PAGES
.
num
- The number of pages on which the view should fit vertically.#setPrintScaleType
int getFitToNumPagesTall()
PrintScaleType
property is set to
SCALE_TO_FIT_PAGES
.#setPrintScaleType
void setFitToNumPagesWide(int num)
GraphPrinter
.
For example, suppose you have a crosstab that has 20 columns and 10 rows.
Suppose that this crosstab would normally print on two sheets of paper,
the first 12 columns on page 1 and the remainder on page 2.
You could set FitToNumPagesWide
to 1 in order to reduce
the printed size of the crosstab so that all 20 columns are printed on
one sheet of paper.
The view is scaled to fit the number of pages that you specify only
when the PrintScaleType
property is set to
SCALE_TO_FIT_PAGES
.
num
- The number of pages on which the view should fit horizontally.#setPrintScaleType
int getFitToNumPagesWide()
PrintScaleType
property is set to
SCALE_TO_FIT_PAGES
.#setPrintScaleType
void setGridlinesVisible(boolean visible)
GridView
.
This method does nothing in a GraphPrinter
.visible
- true
to make gridlines appear in a printed
GridView
.
false
to hide gridlines.boolean isGridlinesVisible()
GridView
.true
if gridlines appear in the GridView
when it is printed,
false
if they do not appear.void setSelectedHPos(java.util.Vector printHPos)
RangeType
is
SELECTED_LOGICAL_PAGES
.
Each logical page to print is specified as an HPos
.printHPos
- A Vector
that contains an HPos
for each logical page that you want to print.SELECTED_LOGICAL_PAGES
,
setRangeType(int)
,
DataAccess.getMemberHPos(int, int, int)
java.util.Vector getSelectedHPos()
RangeType
is set to SELECTED_LOGICAL_PAGES
.Vector
that contains an HPos
for
each logical page to print.SELECTED_LOGICAL_PAGES
,
setRangeType(int)
,
DataAccess.getMemberHPos(int, int, int)
void setRangeType(int type)
This method works only when you use the print
method
or the renderPage
method to print.
To set the page to print when you use the printPage
method
to print, call setLogicalPage
.
type
- A constant that identifies how much of the view to print.ALL_LOGICAL_PAGES
,
CURRENT_LOGICAL_PAGE
,
SELECTED_LOGICAL_PAGES
,
#setLogicalPage
int getRangeType()
ALL_LOGICAL_PAGES
,
CURRENT_LOGICAL_PAGE
,
SELECTED_LOGICAL_PAGES
HeaderAndFooterPainter getHeaderAndFooterPainter(int headerOrFooterID)
headerOrFooterID
- A constant that specifies which header or
footer painter you want.HEADER_LEFT
,
HEADER_CENTER
,
HEADER_RIGHT
,
FOOTER_LEFT
,
FOOTER_CENTER
,
FOOTER_RIGHT
void setPrintByColumns(boolean byColumns)
For example, suppose that you have a table that has 30 rows and 20 columns,
and that 15 rows and 10 columns can fit on a printed sheet of paper.
When PrintByColumns
is true
(the default),
then the pages are printed as follows:
When PrintByColumns
is false
, then the pages
are printed as follows:
This method does nothing in a GraphPrinter
.
byRows
- true
if physical pages are printed by columns,
false
if physical pages are printed by rows.boolean isPrintByColumns()
GraphPrinter
.true
if physical pages are printed by columns,
false
if physical pages are printed by rows.boolean startPrint(boolean bPreviewMode)
Use this method, with the renderPage
method,
when you preview a table or crosstab.
Passing true
in the bPreviewMode
parameter
allows this ViewPrinter
to cache information to improve
performance.
Calls to the print
method
belong between calls to startPrint
and
endPrint
.
bPreviewMode
- true
if you are previewing the print job,
false
if you are actually sending
the print job to a printer.true
if the print job starts successfully,
false
if the data in the view is not available
to this ViewPrinter
.endPrint()
,
#print
,
renderPage(java.awt.Graphics)
,
GraphPrinter.printPage(Graphics)
,
oracle.dss.crosstab.CrosstabPrinter#printPage
,
oracle.dss.crosstab.CrosstabPrinter#printPage(Graphics, DataSubsetRecord)
,
oracle.dss.table.TablePrinter#printPage(Graphics)
,
oracle.dss.table.TablePrinter#printPage(Graphics, DataSubsetRecord)
void endPrint()
startPrint
method displays, and restores the active
display of the view.
Calls to the print
method
belong between calls to startPrint
and
endPrint
.
startPrint(boolean)
,
#print
,
renderPage(java.awt.Graphics)
,
oracle.dss.crosstab.CrosstabPrinter#printPag
,
GraphPrinter.printPage(Graphics)e
,
oracle.dss.crosstab.CrosstabPrinter#printPage(Graphics, DataSubsetRecord)
,
oracle.dss.table.TablePrinter#printPage(Graphics)
,
oracle.dss.table.TablePrinter#printPage(Graphics, DataSubsetRecord)
void setRepeatComponent(int component, boolean repeat)
component
- A constant that represents the components.
Valid constants are listed in the See Also section.repeat
- true
to repeat component,
false
to prevent repeating.ViewPrinter.GRIDVIEW_COLUMN_HEADER
,
ViewPrinter.GRIDVIEW_ROW_HEADER
,
ViewPrinter.PAGE_HEADER
,
ViewPrinter.TITLE
,
ViewPrinter.SUBTITLE
,
ViewPrinter.FOOTNOTE
,
ViewPrinter#FTA1
,
ViewPrinter#FTA2
boolean isRepeatComponent(int component)
false
in a
GraphPrinter
.
component
- A constant that represents the components.
Valid constants are listed in the See Also section.true
if the component appears on each page,
false
if they do not.ViewPrinter.GRIDVIEW_COLUMN_HEADER
,
ViewPrinter.GRIDVIEW_ROW_HEADER
,
ViewPrinter.PAGE_HEADER
,
ViewPrinter.TITLE
,
ViewPrinter.SUBTITLE
,
ViewPrinter.FOOTNOTE
,
ViewPrinter#FTA1
,
ViewPrinter#FTA2
boolean renderPage(java.awt.Graphics g)
boolean prepareFirstPage(java.awt.Graphics g)
renderPage
to print.
Call this method before you call any of the other methods for changing
pages.
Call this method, even if you only print one physical page.
This method performs initialization for printing.g
- The Graphics
object to which to print the page.true
if the call is successful,
false
if the first physical page has no data.renderPage(java.awt.Graphics)
,
hasNextPage()
,
prepareNextPage(java.awt.Graphics)
boolean prepareNextPage(java.awt.Graphics g)
renderPage
to print.
Unless you are certain that there is a next page, you should call
hasNextPage
before you call this method.
Also, before calling this method, call prepareFirstPage
.g
- The Graphics
object to which to print the page.true
if the call is successful,
false
if the next physical page has no data.renderPage(java.awt.Graphics)
,
prepareFirstPage(java.awt.Graphics)
,
hasNextPage()
void setScaleFontSize(int mask)
mask
- A constant that represents the set of components to
scale with the graph.
The constants are listed in the See Also section.GraphConstants.TEXT_COMPONENTS_ALL
,
GraphConstants.TEXT_COMPONENTS_NONE
int getScaleFontSize()
GraphConstants.TEXT_COMPONENTS_ALL
,
GraphConstants.TEXT_COMPONENTS_NONE
boolean preparePrevPage(java.awt.Graphics g)
renderPage
to print.
Unless you are certain that there is a previous page, you should call
hasPrevPage
before you call this method.
Also, before calling this method, call prepareFirstPage
.g
- The Graphics
object to which to print the page.true
if the call is successful,
false
if the previous physical page has no data.renderPage(java.awt.Graphics)
,
prepareFirstPage(java.awt.Graphics)
,
hasPrevPage()
boolean hasNextPage()
renderPage
to print.
Call this method before you call prepareNextPage
.true
if the view has another physical page after
the current page,
false
if the current physical page is the last
physical page.renderPage(java.awt.Graphics)
,
prepareNextPage(java.awt.Graphics)
boolean hasPrevPage()
renderPage
to print.
Call this method before you call preparePrevPage
.true
if the view has another physical page before
the current page,
false
if the current physical page is the first
physical page.renderPage(java.awt.Graphics)
,
preparePrevPage(java.awt.Graphics)
void setTokenSubstitution(TokenSubstitution token)
ViewPrinter
.
Token substitution handlers make it possible for users to insert
tokens (such as a token for the current dimension member) in the
headers and footers of this ViewPrinter
.
This method sets the TokenSubstitution
on this
ViewPrinter
and on all
six of headers and footers that this ViewPrinter
maintains.
By default, the TokenSubstitution
on this
ViewPrinter
and on each header and footer is null
.
You can also set a TokenSubstitution
on each individual
header and footer separately.token
- The token substitution handler for this ViewPrinter
.void setPageFormat(java.awt.print.PageFormat pf)
PageFormat
object that specifies paper
size for this ViewPrinter
.
The PageSetupDialog
calls this method to
set the PageFormat
object that it modifies, to set the
paper size on the print job.pf
- The PageFormat
object that specifies the paper size.java.awt.print.PageFormat getPageFormat()
PageFormat
object that specifies the paper
size for this ViewPrinter
.
The PageSetupDialog
calls this method to retrieve
the PageFormat
in its initialization.
If you use the PageSetupDialog
but not the
PrintDialog
, then you should
call this method to set the PageFormat
on the
PageSetupDialog
.PageFormat
object that specifies the paper size
for this ViewPrinter
.TokenSubstitution getTokenSubstitution()
ViewPrinter
.
Token substitution handlers make it possible for users to insert
tokens (such as a token for the current dimension member) in the headers
and footers of this ViewPrinter
.
You can also set a TokenSubstitution
on
each individual
header and footer separately.
This method gets the TokenSubstitution
that is set on this
ViewPrinter
, which
may be overridden in one or more headers or footers.
By default, the TokenSubstitution
on this
ViewPrinter
and on each header
and footer is null
.ViewPrinter
.java.util.Locale getLocale()
Locale
of the Viewboolean isDataviewTitleVisible()
true
if visible
false
otherwiseboolean isDataviewSubtitleVisible()
true
if visible
false
otherwiseboolean isDataviewFootnoteVisible()
true
if visible
false
otherwisevoid setLineWidth(int position, int width)
position
- position of the line
Valid constants are listed in the See Also section.width
- the width of the lineViewPrinter.ABOVE_FOOTER
,
ViewPrinter.BELOW_HEADER
int getLineWidth(int position)
position
- position of the line
Valid constants are listed in the See Also section.ViewPrinter.ABOVE_FOOTER
,
ViewPrinter.BELOW_HEADER
void setUnits(int iUnit)
iUnit
- The unit value to set: UNIT_PIXEL, UNIT_INCHES, UNIT_CM..int getUnits()
java.awt.Dimension getViewDimension()
boolean renderFirstPage(java.awt.Graphics g)
boolean renderLastPage(java.awt.Graphics g)
boolean goToFirstPage(java.awt.Graphics g)
boolean goToLastPage(java.awt.Graphics g)
void setSequentialPageNumber(int pageNum)
int getSequentialPageNumber()
boolean isFirstPhysicalPage()
boolean isLastPhysicalPage()
java.awt.Cursor getWaitCursor()
java.awt.Cursor getDefaultCursor()