IlvPrintableDocument (Rogue Wave JViews 9.2 API)

java.lang.Object
- ilog.views.util.print.IlvPrintableDocument

All Implemented Interfaces:

Pageable, Printable

Direct Known Subclasses:

IlvChartPrintableDocument, IlvGanttPrintableDocument, IlvManagerPrintableDocument
```
public class IlvPrintableDocument
extends Object
implements Printable, Pageable
```
An IlvPrintableDocument defines a set of pages to be printed. An IlvPrintableDocument maintains a set of pages, defined by IlvPage objects.
There are two ways to construct an IlvPrintableDocument:
- You can add the pages as IlvPage objects, doing the layout yourself.
- You can use an IlvFlow object and add pieces of text and arbitrary IlvFlowObjects to it. The IlvFlow object does its layout automatically.
To print or preview the content of a IlvPrintableDocument you must use an IlvPrintingController, which is designed for this purpose.
Since:

JViews 5.5

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ORDERED_BY_COLUMNS` A page order that indicates that pages are organized by columns.
`static int`	`ORDERED_BY_ROWS` A page order that indicates that pages are organized by rows.

Fields inherited from interface java.awt.print.Printable
NO_SUCH_PAGE, PAGE_EXISTS

Fields inherited from interface java.awt.print.Pageable
UNKNOWN_NUMBER_OF_PAGES

Constructor Summary

Constructors
Constructor and Description
`IlvPrintableDocument(String name)` Deprecated. Since JViews 8.8, please use a constructor which allows the page format to depend on the printer or - if no printer is available - on the current locale.
`IlvPrintableDocument(String name, int orientation)` Creates an initially empty `IlvPrintableDocument` with the given orientation.
`IlvPrintableDocument(String name, int orientation, Paper paperFormat)` Creates an initially empty `IlvPrintableDocument` with the given page format, given as an orientation and a paper format.
`IlvPrintableDocument(String name, PageFormat pageFormat)` Creates an initially empty `IlvPrintableDocument` with the given page format.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPage(IlvPage page)` Adds a page to the document.
`void`	`addPropertyChangeListener(PropertyChangeListener propertyChangeListener)` Adds a listener to listen to the modification of all properties.
`void`	`addPropertyChangeListener(String propertyName, PropertyChangeListener propertyChangeListener)` Adds a listener to listen to the modification of the specified property.
`protected IlvPage[]`	`createPages()` Creates the pages of this document.
`void`	`enablePrintStyle(boolean enable)` This method allows to display the contents of the document differently for printing than for on-screen display.
`protected void`	`firePropertyChange(String propertyName, Object oldValue, Object newValue)` Fires a `PropertyChangeEvent` event for the specified property.
`String`	`getAuthor()` Returns the name of the author of the document.
`int`	`getColumnCount()` Returns the number of pages in a column in this document.
`Date`	`getDate()` Returns the printing date.
`IlvFlow`	`getFlow()` Returns the flow of text contained in this document.
`IlvFooter`	`getFooter()` Returns the footer that is printed on each page.
`IlvHeader`	`getHeader()` Returns the header that is printed on each page.
`IlvUnit.Rectangle`	`getImageableBounds()` Returns the size of the page.
`String`	`getName()` Returns the name of the document.
`int`	`getNumberOfPages()` Returns the number of pages in the document.
`int`	`getOrientation()` Returns the orientation for all contained pages.
`IlvPage`	`getPage(int index)` Gets the page at the specified index.
`PageFormat`	`getPageFormat()` Returns the page format for all contained pages.
`PageFormat`	`getPageFormat(int pageIndex)` Returns the page format for the indexed page.
`int`	`getPageIndex(IlvPage page)` Gets the index of the specified page.
`int`	`getPageOrder()` Returns the order of pages.
`Paper`	`getPaperFormat()` Returns the paper format (paper size and imageable area) for all contained pages.
`Printable`	`getPrintable(int pageIndex)` Returns the `Printable` object for the indexed page.
`Sides`	`getSides()` Returns the way pages are mapped on the sides of the paper sheets.
`IlvPage`	`getTemplatePage()` Returns the template page of the document.
`void`	`invalidateFlowLayout()` This method invalidates the layout of the `IlvFlow` attached to this document if there is one.
`protected void`	`invalidatePages()` Marks the pages status as invalid.
`boolean`	`isFlowLayoutValid()` Indicates if the layout of the text flow is completed or not.
`protected void`	`maybeInvalidatePages()` This method is called before accessing the pages of the document.
`protected void`	`prepareDocument()` This method is called before printing the document, before showing the Print Preview dialog box or opening the Page Setup dialog box.
`int`	`print(Graphics graphics, PageFormat format, int pageIndex)` This method is called to print the document.
`void`	`removeAll()` Removes all pages.
`void`	`removePage(IlvPage page)` Removes a page from the document.
`void`	`removePropertyChangeListener(PropertyChangeListener propertyChangeListener)` Removes a listener so that it no longer listens to the modification of the properties.
`void`	`removePropertyChangeListener(String propertyName, PropertyChangeListener propertyChangeListener)` Removes a listener so that it no longer listens to the modification of the specified property.
`void`	`setAuthor(String name)` Changes the name of the author of the document.
`void`	`setColumnCount(int nbColumns)` Indicates the number of pages in each column of this document.
`void`	`setDate(Date date)` Sets the printing date.
`void`	`setFooter(IlvFooter footer)` Changes the footer to be printed on each page.
`void`	`setHeader(IlvHeader header)` Changes the header to be printed on each page.
`void`	`setName(String name)` Changes the name of the document.
`void`	`setOrientation(int orientation)` Sets the orientation for all contained pages.
`void`	`setPageFormat(PageFormat pageFormat)` Specifies the page format for all contained pages.
`void`	`setPageOrder(int order)` Changes the order of pages.
`void`	`setPages(IlvPage[] pages)` Changes all the pages of the document.
`void`	`setPaperFormat(Paper paperFormat)` Sets the paper format (paper size and imageable area) for all contained pages.
`void`	`setSides(Sides value)` Sets the way pages are mapped on the sides of the paper sheets.
`void`	`setTemplatePage(IlvPage template)` Specifies the template page for the document.

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

- Field Detail
  - ORDERED_BY_COLUMNS
```
public static final int ORDERED_BY_COLUMNS
```
    A page order that indicates that pages are organized by columns. This order is useful only when the pages are representing a document split in rows and columns. In this page order the pages are organized so that all the pages of a column appear before the next column.
    
    See Also:
    
    setPageOrder(int), ORDERED_BY_ROWS, Constant Field Values
  - ORDERED_BY_ROWS
```
public static final int ORDERED_BY_ROWS
```
    A page order that indicates that pages are organized by rows. This order is useful only when the pages are representing a document split in rows and columns. In this page order the pages are organized so that all the pages of a row appear before the next row.
    
    See Also:
    
    setPageOrder(int), ORDERED_BY_COLUMNS, Constant Field Values
- Constructor Detail
  - IlvPrintableDocument
```
public IlvPrintableDocument(String name,
                            PageFormat pageFormat)
```
    Creates an initially empty IlvPrintableDocument with the given page format.
    
    Parameters:
    
    name - The name of the document.
    
    pageFormat - The default page format for all pages. Because a fixed page format is not apppropriate for all printers and all locales, it is recommended that this argument be constructed from IlvPrintingController.getDefaultPageFormat() or IlvPrintingController.getDefaultPaperFormat().
  - IlvPrintableDocument
```
public IlvPrintableDocument(String name,
                            int orientation,
                            Paper paperFormat)
```
    Creates an initially empty IlvPrintableDocument with the given page format, given as an orientation and a paper format.
    
    Parameters:
    
    name - The name of the document.
    
    orientation - One of PageFormat.PORTRAIT, PageFormat.LANDSCAPE, PageFormat.REVERSE_LANDSCAPE.
    
    paperFormat - A paper format object, or null if the paper format shall be provided by the IlvPrintingController, depending on the default printer or - if no printer is available - depending on the current locale. Because a fixed page format is not apppropriate for all printers and all locales, it is recommended that this argument be null or constructed from IlvPrintingController.getDefaultPaperFormat().
    
    Since:
    
    JViews 8.8
  - IlvPrintableDocument
```
public IlvPrintableDocument(String name,
                            int orientation)
```
    Creates an initially empty IlvPrintableDocument with the given orientation. The paper format shall be provided by the IlvPrintingController, depending on the default printer or - if no printer is available - depending on the current locale.
    
    Parameters:
    
    name - The name of the document.
    
    orientation - One of PageFormat.PORTRAIT, PageFormat.LANDSCAPE, PageFormat.REVERSE_LANDSCAPE.
    
    Since:
    
    JViews 8.8
  - IlvPrintableDocument
```
@Deprecated
public IlvPrintableDocument(String name)
```
    Deprecated. Since JViews 8.8, please use a constructor which allows the page format to depend on the printer or - if no printer is available - on the current locale.
    
    Creates an initially empty IlvPrintableDocument object with portrait orientation and a page format that is a US Letter sized page with one-inch margins.
    
    Parameters:
    
    name - The name of the document.
- Method Detail
  - getName
```
public String getName()
```
    Returns the name of the document. The method may return null if no name was set.
    
    See Also:
    
    setName(java.lang.String)
  - setName
```
public void setName(String name)
```
    Changes the name of the document. The method fires a PropertyChangeEvent for the 'name' property.
    
    See Also:
    
    getName()
  - getDate
```
public Date getDate()
```
    Returns the printing date.
    
    See Also:
    
    setDate(java.util.Date)
  - setDate
```
public void setDate(Date date)
```
    Sets the printing date. The method fires a 'PropertyChangeEvent' for the 'date' property.
    
    See Also:
    
    getDate()
  - getAuthor
```
public String getAuthor()
```
    Returns the name of the author of the document. The method may return null if no author was set.
    
    See Also:
    
    setAuthor(java.lang.String)
  - setAuthor
```
public void setAuthor(String name)
```
    Changes the name of the author of the document. The method fires a PropertyChangeEvent for the 'author' property.
    
    See Also:
    
    getAuthor()
  - getSides
```
public Sides getSides()
```
    Returns the way pages are mapped on the sides of the paper sheets. This method may return null when it is unspecified and up to the printer to arrange the pages.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    setSides(javax.print.attribute.standard.Sides)
  - setSides
```
public void setSides(Sides value)
```
    Sets the way pages are mapped on the sides of the paper sheets. A value of null means that it is unspecified and up to the printer to arrange the pages.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    getSides()
  - getTemplatePage
```
public IlvPage getTemplatePage()
```
    Returns the template page of the document.
    
    Returns:
    
    The template page.
    
    See Also:
    
    setTemplatePage(ilog.views.util.print.IlvPage)
  - setTemplatePage
```
public void setTemplatePage(IlvPage template)
```
    Specifies the template page for the document. Before printing each contained page, the content of the template page is first printed. The template page is designed to put common print objects for all contained pages. The method fires a PropertyChangeEvent for the 'templatePage' property.
    
    Parameters:
    
    template - The template page.
    
    See Also:
    
    getTemplatePage()
  - getHeader
```
public IlvHeader getHeader()
```
    Returns the header that is printed on each page.
    
    See Also:
    
    setHeader(ilog.views.util.print.IlvHeader), getFooter()
  - setHeader
```
public void setHeader(IlvHeader header)
```
    Changes the header to be printed on each page. The method fires a PropertyChangeEvent for the 'header' property.
    
    See Also:
    
    getHeader(), setFooter(ilog.views.util.print.IlvFooter)
  - getFooter
```
public IlvFooter getFooter()
```
    Returns the footer that is printed on each page.
    
    See Also:
    
    setFooter(ilog.views.util.print.IlvFooter), getHeader()
  - setFooter
```
public void setFooter(IlvFooter footer)
```
    Changes the footer to be printed on each page. The method fires a PropertyChangeEvent for the 'footer' property.
    
    See Also:
    
    getFooter(), setHeader(ilog.views.util.print.IlvHeader)
  - getOrientation
```
public int getOrientation()
```
    Returns the orientation for all contained pages.
    
    Returns:
    
    One of PageFormat.PORTRAIT, PageFormat.LANDSCAPE, PageFormat.REVERSE_LANDSCAPE.
    
    Since:
    
    JViews 8.8
  - setOrientation
```
public void setOrientation(int orientation)
```
    Sets the orientation for all contained pages.
    
    Parameters:
    
    orientation - One of PageFormat.PORTRAIT, PageFormat.LANDSCAPE, PageFormat.REVERSE_LANDSCAPE.
    
    Since:
    
    JViews 8.8
  - getPaperFormat
```
public Paper getPaperFormat()
```
    Returns the paper format (paper size and imageable area) for all contained pages. Returns null if it has not been set through a constructor and not yet been set by the IlvPrintingController.
    
    Returns:
    
    A fresh copy of the paper format, or null if it has not yet been set.
    
    Since:
    
    JViews 8.8
  - setPaperFormat
```
public void setPaperFormat(Paper paperFormat)
```
    Sets the paper format (paper size and imageable area) for all contained pages.
    
    Parameters:
    
    paperFormat - A paper format object, or null if the paper format shall be provided by the IlvPrintingController, depending on the default printer or - if no printer is available - depending on the current locale.
    
    Since:
    
    JViews 8.8
  - getPageFormat
```
public PageFormat getPageFormat()
```
    Returns the page format for all contained pages.
    This is initially the default page format or null. Once the IlvPrintingController has set it, it is the real page format.
    This value is a combination of getOrientation() and getPaperFormat().
    
    Returns:
    
    The page format for all contained pages, or null if the paper format has not yet been set.
    
    See Also:
    
    setPageFormat(java.awt.print.PageFormat)
  - setPageFormat
```
public void setPageFormat(PageFormat pageFormat)
```
    Specifies the page format for all contained pages. It is a combination of the orientation and the paper format.
    
    Parameters:
    
    pageFormat - The page format for all contained pages.
    
    See Also:
    
    getPageFormat(), setOrientation(int), setPaperFormat(Paper)
  - getImageableBounds
```
public IlvUnit.Rectangle getImageableBounds()
```
    Returns the size of the page. This method takes into account the header and footer that might be attached to this document.
  - addPage
```
public void addPage(IlvPage page)
```
    Adds a page to the document. The method fires a PropertyChangeEvent for the 'pageCount' property.
    
    Parameters:
    
    page - The page to be added.
  - removePage
```
public void removePage(IlvPage page)
```
    Removes a page from the document. The method fires a PropertyChangeEvent for the 'pageCount' property.
    
    Parameters:
    
    page - The page to be removed.
  - removeAll
```
public void removeAll()
```
    Removes all pages. The method fires a PropertyChangeEvent for the 'pageCount' property.
  - setPages
```
public void setPages(IlvPage[] pages)
```
    Changes all the pages of the document. The method fires a PropertyChangeEvent for the 'pageCount' property.
    
    Parameters:
    
    pages - The new pages.
  - getFlow
```
public IlvFlow getFlow()
```
    Returns the flow of text contained in this document. A new flow (IlvFlow) is created if the document does not already have a flow.
    
    See Also:
    
    isFlowLayoutValid(), invalidateFlowLayout()
  - isFlowLayoutValid
```
public boolean isFlowLayoutValid()
```
    Indicates if the layout of the text flow is completed or not. The method will return true if the document does not have a flow of text.
    
    See Also:
    
    IlvFlow, getFlow(), invalidateFlowLayout()
  - invalidateFlowLayout
```
public void invalidateFlowLayout()
```
    This method invalidates the layout of the IlvFlow attached to this document if there is one.
    
    See Also:
    
    getFlow(), isFlowLayoutValid()
  - getColumnCount
```
public int getColumnCount()
```
    Returns the number of pages in a column in this document. This parameter is only useful when the pages are representing a document split in rows and columns. This helps the Print Preview dialog box display the pages as rows and columns.
    
    Returns:
    
    The number of columns, or -1 if this document does not represent pages organized in rows and columns. The default value is -1.
    
    See Also:
    
    setColumnCount(int), setPageOrder(int)
  - setColumnCount
```
public void setColumnCount(int nbColumns)
```
    Indicates the number of pages in each column of this document. Setting this parameter is only useful when the pages are representing a document split in rows and columns. This helps the Print Preview dialog box display the pages as rows and columns. You may set the value to -1 to indicate that the pages do not represent a document split in rows and columns.
    
    See Also:
    
    getColumnCount(), setPageOrder(int)
  - getPageOrder
```
public int getPageOrder()
```
    Returns the order of pages. The order may be one of ORDERED_BY_COLUMNS or ORDERED_BY_ROWS. This parameter is only useful when the pages are representing a document split in rows and columns.
    
    See Also:
    
    setPageOrder(int)
  - setPageOrder
```
public void setPageOrder(int order)
```
    Changes the order of pages. The order may be one of ORDERED_BY_COLUMNS or ORDERED_BY_ROWS. This parameter is only useful when the pages are representing a document split in rows and columns. Note that calling this method does not change the order of the page, but only indicates in which order the pages have been added. It is the responsibility of the programmer to add the pages in the correct order. The method fires a PropertyChangeEvent for the 'pageOrder' property.
    
    See Also:
    
    getPageOrder()
  - prepareDocument
```
protected void prepareDocument()
```
    This method is called before printing the document, before showing the Print Preview dialog box or opening the Page Setup dialog box. It allows you to validate and prepare the document before doing real printing operations. The default implementation is empty.
  - maybeInvalidatePages
```
protected void maybeInvalidatePages()
```
    This method is called before accessing the pages of the document. It gives an opportunity to subclasses to mark the pages status as invalid, by calling invalidatePages(), if some parameters have changed that influence the page layout.
    The default implementation does nothing.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    invalidatePages()
  - invalidatePages
```
protected void invalidatePages()
```
    Marks the pages status as invalid. Invalid pages will be recreated when needed.
    This method should be called either when you change a parameter that influences the page layout, or inside an override of maybeInvalidatePages() when such a parameter change is detected.
    
    See Also:
    
    createPages()
  - createPages
```
protected IlvPage[] createPages()
```
    Creates the pages of this document. Note that this factory method must not modify the structure of the document but rather return an array of the pages to add to this document. The default implementation returns null.
  - getPage
```
public IlvPage getPage(int index)
```
    Gets the page at the specified index.
    
    Parameters:
    
    index - The index of the page.
  - getPageIndex
```
public int getPageIndex(IlvPage page)
```
    Gets the index of the specified page.
    
    Parameters:
    
    page - The page.
  - getNumberOfPages
```
public int getNumberOfPages()
```
    Returns the number of pages in the document.
    
    Specified by:
    
    getNumberOfPages in interface Pageable
    
    Returns:
    
    The number of pages.
  - getPageFormat
```
public PageFormat getPageFormat(int pageIndex)
```
    Returns the page format for the indexed page. This is a method of the Pageable interface.
    
    Specified by:
    
    getPageFormat in interface Pageable
    
    Parameters:
    
    pageIndex - The index of the page.
    
    Returns:
    
    The page format for the indexed page.
  - getPrintable
```
public Printable getPrintable(int pageIndex)
```
    Returns the Printable object for the indexed page. This is a method of the Pageable interface.
    
    Specified by:
    
    getPrintable in interface Pageable
    
    Parameters:
    
    pageIndex - The index of the page.
    
    Returns:
    
    The Printable object for the indexed page.
  - print
```
public int print(Graphics graphics,
                 PageFormat format,
                 int pageIndex)
          throws PrinterException
```
    This method is called to print the document. It implements the java.awt.print.Printable.print method.
    
    Specified by:
    
    print in interface Printable
    
    Parameters:
    
    graphics - The output device to which the document should be printed.
    
    format - The page format used to print the indexed page.
    
    pageIndex - The index of the page being printed.
    
    Throws:
    
    PrinterException
  - enablePrintStyle
```
public void enablePrintStyle(boolean enable)
```
    This method allows to display the contents of the document differently for printing than for on-screen display. It is called with enable = true when this document should be configured for printing, or with enable = false when it can be configured for screen display again.
    The default implementation does nothing. Subclasses can override it when the desired look or style for printing is different than for normal display.
    
    Parameters:
    
    enable - true for printing style, false for display style
    
    Since:
    
    JViews 8.8
  - firePropertyChange
```
protected void firePropertyChange(String propertyName,
                                  Object oldValue,
                                  Object newValue)
```
    Fires a PropertyChangeEvent event for the specified property.
    
    Parameters:
    
    propertyName - The name of the property.
    
    oldValue - The old value of the property.
    
    newValue - The new value of the property.
  - addPropertyChangeListener
```
public void addPropertyChangeListener(String propertyName,
                                      PropertyChangeListener propertyChangeListener)
```
    Adds a listener to listen to the modification of the specified property.
    
    Parameters:
    
    propertyName - The name of the property.
    
    propertyChangeListener - The listener.
  - addPropertyChangeListener
```
public void addPropertyChangeListener(PropertyChangeListener propertyChangeListener)
```
    Adds a listener to listen to the modification of all properties.
    
    Parameters:
    
    propertyChangeListener - The listener.
  - removePropertyChangeListener
```
public void removePropertyChangeListener(String propertyName,
                                         PropertyChangeListener propertyChangeListener)
```
    Removes a listener so that it no longer listens to the modification of the specified property.
    
    Parameters:
    
    propertyName - The name of the property.
    
    propertyChangeListener - The listener.
  - removePropertyChangeListener
```
public void removePropertyChangeListener(PropertyChangeListener propertyChangeListener)
```
    Removes a listener so that it no longer listens to the modification of the properties.
    
    Parameters:
    
    propertyChangeListener - The listener.

Class IlvPrintableDocument

Field Summary

Fields inherited from interface java.awt.print.Printable

Fields inherited from interface java.awt.print.Pageable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ORDERED_BY_COLUMNS

ORDERED_BY_ROWS

Constructor Detail

IlvPrintableDocument

IlvPrintableDocument

IlvPrintableDocument

IlvPrintableDocument

Method Detail

getName

setName

getDate

setDate

getAuthor

setAuthor

getSides

setSides

getTemplatePage

setTemplatePage

getHeader

setHeader

getFooter

setFooter

getOrientation

setOrientation

getPaperFormat

setPaperFormat

getPageFormat

setPageFormat

getImageableBounds

addPage

removePage

removeAll

setPages

getFlow

isFlowLayoutValid

invalidateFlowLayout

getColumnCount

setColumnCount

getPageOrder

setPageOrder

prepareDocument

maybeInvalidatePages

invalidatePages

createPages

getPage

getPageIndex

getNumberOfPages

getPageFormat

getPrintable

print

enablePrintStyle

firePropertyChange

addPropertyChangeListener

addPropertyChangeListener

removePropertyChangeListener

removePropertyChangeListener