RMDocument (ReportMill 13 API)

java.lang.Object
- com.reportmill.base.RMListenerList
- - com.reportmill.base.RMObject
  - - com.reportmill.shape.RMShape
    - - com.reportmill.shape.RMDocument

All Implemented Interfaces:: DeepChangeListener, RMPropertyChanger, RMTypes, java.beans.PropertyChangeListener, java.lang.Cloneable, java.util.EventListener

public class RMDocument
extends RMShape

The RMDocument class represents a ReportMill document and is also an RMShape subclass, so it can be a real part of the document/shape hierarchy. RMDocuments are also what ReportMill refers to as templates, and is commonly used like this:

   RMDocument template = new RMDocument(aSource); // Load from path String, File, byte array, etc.
   RMDocument report = template.generateReport(aDataset); // Any Java dataset: EJBs, custom classes, collctns, etc.
   report.writePDF("MyReport.pdf");

On rare occasions, you may also want to create a document dynamically. Here's an example:

   RMDocument doc = new RMDocument(612, 792); // Standard US Letter size (8.5" x 11"), in points
   RMTable table = new RMTable(); // Create new table ...
   doc.getPage(0).addChild(table); // ... and add to first page
   table.setBounds(36, 36, 540, 680); // Position and size table
   table.getRow("Objects Details").getColumn(0).setText("Title: @getTitle@"); // Configure first text

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RMDocument.DocListener` An interface to define objects that want to get document notifications.
`static class`	`RMDocument.PageLayout`
`static class`	`RMDocument.Unit`

Nested classes/interfaces inherited from interface com.reportmill.base.RMTypes
RMTypes.AlignX, RMTypes.AlignY

Field Summary

Fields
Modifier and Type Field and Description

static java.util.Locale _locale
- Fields inherited from class com.reportmill.shape.RMShape
  WRAP_TYPE_BOTH, WRAP_TYPE_NONE

Fields
Modifier and Type	Field and Description
`static java.util.Locale`	`_locale`

Constructor Summary

Constructors
Constructor and Description
`RMDocument()` Creates a plain empty document.
`RMDocument(float aWidth, float aHeight)` Creates a document with the given width and height (in printer points).
`RMDocument(java.lang.Object aSource)` Creates a new document from the given source.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`acceptsChildren()` Editor method indicates that document accepts children (should probably be false).
`void`	`addBinder(javi.ui.Binder aBinder)` Adds a binder to the panel.
`void`	`addChild(RMShape aChild, int anIndex)` Override to do special stuff.
`RMPage`	`addPage()` Adds a new page to this document.
`void`	`addPage(RMPage aPage)` Adds a given page to this document.
`void`	`addPage(RMPage aPage, int anIndex)` Adds a given page to this document at the given index.
`void`	`addPages(RMDocument aDoc)` Add the pages in the given document to this document (at end) and clears the pages list in the given document.
`boolean`	`childrenSuperSelectImmediately()` Editor method indicates that pages super select immediately.
`RMDocument`	`clone()` Copies basic document attributes (shallow copy only - no children or pages).
`RMDocument`	`cloneDeep()` Copies the complete document, including document pages and all their children.
`RMShapeLayout`	`createLayout()` Overrides to create document layout.
`RMPage`	`createPage()` Creates a new page.
`boolean`	`equals(java.lang.Object anObj)` Standard equals implementation.
`java.lang.Object`	`fromXMLShape(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, java.lang.Object anOwner)` XML unarchival.
`void`	`fromXMLShapeChildren(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, java.lang.Object anOwner)` XML unarchival for shape children.
`RMDocument`	`generateReport()` Returns a generated report from this template evaluated against the given object.
`RMDocument`	`generateReport(java.lang.Object theObjects)` Returns a generated report from this template evaluated against the given object.
`RMDocument`	`generateReport(java.lang.Object objects, boolean paginate)` Returns a generated report from this template evaluated against the given object with an option to paginate.
`RMDocument`	`generateReport(java.lang.Object objects, java.lang.Object userInfo)` Returns a generated report from this template evaluated against the given object and userInfo.
`RMDocument`	`generateReport(java.lang.Object theObjects, java.lang.Object theUserInfo, boolean aPaginateFlag)` Returns generated report from this template evaluated against given object/userInfo (with option to paginate).
`RMAnimator`	`getAnimator(int anIndex)` Returns the animator for a specific page.
`RMAnimator`	`getAnimatorLast()` Returns the animator for the last page.
`java.lang.String`	`getAutosizingDefault()` Returns the autosizing default.
`javi.ui.Binder`	`getBinder(int anIndex)` Returns the specific binder at the given index.
`javi.ui.Binder`	`getBinder(java.lang.String aName)` Returns the named binder for this panel.
`int`	`getBinderCount()` Returns the number of binders for this panel.
`java.util.List<javi.ui.Binder>`	`getBinders()` Returns the binders list.
`byte[]`	`getBytes()` Returns the document as an XML byte array.
`byte[]`	`getBytesCSV()` Returns the document as a byte array of a CSV file.
`byte[]`	`getBytesDelimitedAscii(java.lang.String fieldDelimiter, java.lang.String recordDelimiter, boolean quoteFields)` Returns the document as a byte array of a delimited ASCII file (using given field, record separator strings).
`byte[]`	`getBytesExcel()` Returns the document as byte array of an Excel file.
`byte[]`	`getBytesHTML()` Returns the document as a byte array of an HTML file.
`byte[]`	`getBytesJPEG()` Returns the document as byte array of a JPEG file.
`byte[]`	`getBytesPDF()` Returns the document as a byte array of a PDF file.
`byte[]`	`getBytesPNG()` Returns the document as byte array of PNG file.
`byte[]`	`getBytesRTF()` Returns the document as byte array of an Excel file.
`boolean`	`getCompress()` Returns whether the document should compress images in generated file formats like PDF.
`javi.data.Entity`	`getDatasetEntity()` Returns the entity this shape should show in keys browser.
`RMDataSource`	`getDataSource()` Returns the RMDataSource associated with this document.
`javi.data.Schema`	`getDataSourceSchema()` Returns the schema for the RMDataSource associated with this document (convenience).
`static RMDocument`	`getDoc(java.lang.Object aSource)` Creates a new document from aSource using RMArchiver.
`RMDocument.DocListener`	`getDocListener()` Returns the first doc listener from listeners list.
`RMDocument`	`getDocument()` Returns the document itself (over-ridden from RMShape).
`java.lang.String`	`getFilename()` Returns the filename associated with this document, if available.
`RMFont`	`getFont()` Returns the document's default font.
`float`	`getGridSpacing()` Returns the grid spacing for the document's grid.
`boolean`	`getLoops()` Returns whether the last animator loops.
`java.util.Map`	`getMapHTML(java.lang.String anImageRoot)` Returns the document as a Map of an HTML file and image resources.
`float`	`getMarginBottom()` Returns the margin rects bottom value.
`float`	`getMarginLeft()` Returns the margin rects left value.
`RMRect`	`getMarginRect()` Returns the margin rect for this document.
`RMRect`	`getMarginRectDefault()` Returns the default margin rect.
`float`	`getMarginRight()` Returns the margin rects right value.
`float`	`getMarginTop()` Returns the margin rects top value.
`float`	`getMaxTime()` Returns the total time needed to animate this document (total of all page animators).
`java.lang.String`	`getNullString()` Returns the string used to replace any occurrances of null values in a generated report.
`RMPage`	`getPage(int anIndex)` Returns the page at the given index.
`int`	`getPageCount()` Returns the number of pages in this document.
`RMPage`	`getPageLast()` Returns the last page (convenience).
`RMDocument.PageLayout`	`getPageLayout()` Returns the page layout for the document.
`java.util.List<RMPage>`	`getPages()` Returns the list of pages associated with this document.
`RMSize`	`getPageSize()` Returns the size of a document page.
`RMSize`	`getPageSizeDefault()` Returns the default page size.
`java.lang.Boolean`	`getPaginate()` Returns whether the document should paginate generated reports by default.
`float`	`getPointsFromUnits(float aValue)` Converts given value from document units to printer points (1/72 of an inch).
`java.lang.String`	`getPublishUrl()` Returns the URL this document should be uploaded to.
`ReportMill`	`getReportMill()` Returns the reportmill associated with the document (create if needed).
`RMPage`	`getSelectedPage()` Returns the currently selected page of this document.
`int`	`getSelectedPageIndex()` Returns the current page index of this document.
`boolean`	`getShowGrid()` Returns whether the document should show an alignment grid.
`boolean`	`getShowMargin()` Returns whether the document should show a margin rect.
`boolean`	`getSnapGrid()` Returns whether the document should snap to an alignment grid.
`boolean`	`getSnapMargin()` Returns whether the document should snap to a margin rect.
`RMDocumentSource`	`getSource()` Returns the document source.
`java.lang.String`	`getStringCSV()` Returns the document as a string of a CSV file.
`java.lang.String`	`getStringDelimitedText(java.lang.String fieldDelimiter, java.lang.String recordDelimiter, boolean quoteFields)` Returns the document as a string of a delimited text file.
`RMDocument`	`getSubreport(java.lang.String aName)` Returns a subreport document for given name (override to improve).
`RMUndoer`	`getUndoer()` Returns the RMUndoer for this document.
`RMDocument.Unit`	`getUnit()` Returns the units used to express sizes in the current document (POINTS, INCHES, CENTIMETERS).
`float`	`getUnitsFromPoints(float aValue)` Converts given value to document units from printer points (1/72 of an inch).
`float`	`getUnitsMultiplier()` Returns the multiplier used to convert printer points to document units.
`float`	`getVersion()` Returns the version this document was loaded as.
`com.reportmill.archiver.RXElement`	`getWindowXML()` Returns the xml element for the document window.
`boolean`	`isEditing()` Returns whether the document is visible in an editor.
`boolean`	`isShowing()` Returns whether the document is visible in a viewer or editor.
`void`	`paint(java.awt.Graphics2D aGraphics)` Override to set Painting flag.
`void`	`paintShape(java.awt.Graphics2D aGraphics)` Overrides paint shape, because document should never really paint itself.
`byte[]`	`pdfBytes()` Obsolete method for old pdfBytes() method.
`int`	`removeBinder(javi.ui.Binder aBinder)` Removes a binder from the panel.
`javi.ui.Binder`	`removeBinder(int anIndex)` Removes a binder at the given index from the panel.
`RMPage`	`removeChild(int anIndex)` Removes the page at the given index from this document.
`RMPage`	`removePage(int anIndex)` Removes a page from this document.
`int`	`removePage(RMPage aPage)` Removes the given page.
`void`	`repaint()` Make sure document registers for repaint too.
`void`	`repaint(RMShape aShape)` This is a notification call for impending visual shape attribute changes.
`void`	`resolvePageReferences()` Performs page substitutions on any text fields that were identified as containing @Page@ keys.
`void`	`setCompress(boolean aValue)` Sets whether the document should compress images in generated file formats like PDF.
`void`	`setDataSource(RMDataSource aDataSource)` Sets the RMDataSource associated with this document.
`void`	`setFont(RMFont aFont)` Sets the document default font.
`void`	`setGridSpacing(float aValue)` Sets the grid spacing for the document's grid.
`void`	`setMarginRect(RMRect aRect)` Sets the margin rect for this document.
`void`	`setMargins(float left, float right, float top, float bottom)` Sets the margin rect for this document.
`void`	`setNullString(java.lang.String aValue)` Sets the string used to replace any occurrances of null values in a generated report.
`void`	`setPageLayout(RMDocument.PageLayout aValue)` Sets the page layout for the document.
`void`	`setPageLayout(java.lang.String aValue)` Set page layout from string.
`void`	`setPageSize(float aWidth, float aHeight)` Sets the size of the document (and all of its pages).
`void`	`setPaginate(java.lang.Boolean aValue)` Sets whether the document should paginate generated reports by default.
`void`	`setPublishUrl(java.lang.String aValue)` Sets the URL this document should be uploaded to.
`void`	`setReportMill(ReportMill aReportMill)` Creates an RPG clone of document.
`void`	`setSelectedPage(RMPage aPage)` Selects the given page.
`void`	`setSelectedPageIndex(int anIndex)` Selects the currently selected page by index.
`void`	`setShowGrid(boolean aValue)` Sets whether the document should show an alignment grid.
`void`	`setShowMargin(boolean aValue)` Sets whether the document should show a margin rect.
`void`	`setSnapGrid(boolean aValue)` Sets whether the document should snap to an alignment grid.
`void`	`setSnapMargin(boolean aValue)` Sets whether the document should snap to a margin rect.
`void`	`setSource(java.lang.Object aSource)` Sets the document source.
`void`	`setSource(RMDocumentSource aSource)` Sets the document source.
`void`	`setUndoer(RMUndoer anUndoer)` Sets the RMUndoer for this document.
`void`	`setUnit(RMDocument.Unit aValue)` Sets the units used to express sizes in the current document (POINTS, INCHES, CENTIMETERS).
`void`	`setUnit(java.lang.String aString)` Sets the units used to express sizes in the current document with one of the strings: point, inch or cm.
`void`	`setWindowXML(com.reportmill.archiver.RXElement anElement)` Sets the xml element for the document window.
`boolean`	`superSelectable()` Editor method indicates that document is super selectable.
`com.reportmill.archiver.RXElement`	`toXML()` Returns RXElement for document.
`com.reportmill.archiver.RXElement`	`toXMLShape(com.reportmill.archiver.RXArchiver anArchiver, java.lang.Object anOwner)` XML archival.
`void`	`toXMLShapeChildren(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, java.lang.Object anOwner)` XML archival of children.
`void`	`write(java.io.File aFile)` Writes the document to the given File object
`void`	`write(java.lang.String aPath)` Writes the document out to the given path String (it extracts type from path extension).
`java.util.Map`	`writeHTML(java.lang.String aPath)` Writes the document to the given path String as HTML.
`java.util.Map`	`writeHTML(java.lang.String aPath, java.lang.String anImageRoot)` Writes the document to the given path String as HTML (referenced images are written at the given relative path).
`void`	`writePDF(java.lang.String aPath)` Writes the document to the given path String as PDF.

Methods inherited from class com.reportmill.shape.RMShape
acceptsMouse, addAction, addActions, addBinding, addChild, addChild, addChild, addDeepChangeListener, addListener, addMouseListener, animUpdate, bounds, bringShapesToFront, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedSizeFromShape, convertedSizeToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertSizeFromShape, convertSizeToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, createDivideShapeRemainder, createPartClone, deepChange, divideShapeFromEdge, divideShapeFromTop, doLayout, fromXML, fromXMLShapeLayout, get, get, getAction, getAlignmentX, getAlignmentY, getAncestor, getAncestorCount, getAncestorInCommon, getAnimator, getAnimator, getAutosizing, getBestHeight, getBestSize, getBestSize, getBestWidth, getBinding, getBinding, getBindingCount, getBounds, getBoundsInside, getBoundsMarked, getBoundsMarkedDeep, getBoundsOfChildren, getCausesWrap, getCausesWrapType, getChild, getChildAnimator, getChildAnimator, getChildArray, getChildClipShape, getChildContaining, getChildCount, getChildLast, getChildren, getChildrenIntersecting, getChildrenWhoCauseWrap, getChildrenWithClass, getChildrenWithClass, getChildWithClass, getChildWithName, getClipShape, getColor, getDatasetKey, getEffect, getEventAdapter, getFill, getFormat, getFrame, getFrame, getFrameMaxX, getFrameMaxY, getFrameX, getFrameXY, getFrameY, getHeight, getHover, getImageFill, getLayout, getLayout, getLayoutInfo, getLineWidth, getMaskPath, getMaximumSize, getMaximumSizeProperty, getMaxX, getMaxY, getMinimumSize, getMinimumSizeProperty, getName, getOpacity, getOpacityDeep, getOriginal, getOutline, getPageBreak, getPageBreakMax, getPageBreakPage, getPageBreakPageMax, getPageShape, getParent, getParentWithClass, getPart, getPartCount, getPartDeep, getPartDeepCount, getPath, getPathInBounds, getPreferredSize, getPreferredSize, getPreferredSizeProperty, getPropertyNameMapped, getPropertyNames, getRoll, getRootShape, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSizeP, getSkewX, getSkewY, getStroke, getStrokeColor, getStrokeWidth, getTextColor, getTimeline, getTimeline, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getURL, getVisbileBounds, getVisibleBounds, getVisibleBounds, getVisibleBounds, getWidth, getX, getXY, getXYP, getY, height, indexOf, indexOfChild, intersects, isAncestor, isAnimProperty, isDescendant, isEnabled, isHittable, isHittableChild, isLocked, isMaximumSizeSet, isMinimumSizeSet, isRoot, isRSS, isUnderlined, isViewing, isVisible, isVisibleChild, layoutReset, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, notRSS, offsetChildrenXY, offsetXY, page, pageMax, paintShapeAll, paintShapeChildren, paintShapeOver, propertyChange, put, removeAction, removeBinding, removeBinding, removeChild, removeChildren, removeDeepChangeListener, removeFromParent, removeMouseListener, resolvePageReferences, revalidate, sendShapesToBack, setAction, setAlignmentX, setAlignmentY, setAutosizing, setBestHeight, setBestSize, setBestSize, setBounds, setBounds, setCausesWrap, setCausesWrapType, setColor, setEffect, setEnabled, setFill, setFormat, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHeight, setHover, setLayout, setLayoutInfo, setLineWidth, setLocked, setMaximumSize, setMinimumSize, setName, setOpacity, setOutline, setParent, setPreferredSize, setReportMillBindings, setReportMillDeep, setRoll, setScaleX, setScaleXY, setScaleY, setShowing, setSize, setSize, setSizeP, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setStrokeWidth, setTextColor, setTime, setUnderlined, setURL, setVisible, setWidth, setX, setXY, setXY, setXYP, setY, toString, toXML, toXMLShapeLayout, undoerDisable, undoerEnable, undoerSetUndoTitle, validate, width, x, y

Methods inherited from class com.reportmill.base.RMObject
addPropertyChangeListener, removePropertyChangeListener

Methods inherited from class com.reportmill.base.RMListenerList
getListener, getListenerCount, getListenerCount, getListenerList, getListeners, hasListeners, removeListener

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

- Field Detail
  - _locale
```
public static java.util.Locale _locale
```
- Constructor Detail
  - RMDocument
```
public RMDocument()
```
    Creates a plain empty document. It's really only used by the archiver.
  - RMDocument
```
public RMDocument(float aWidth,
          float aHeight)
```
    Creates a document with the given width and height (in printer points).
  - RMDocument
```
public RMDocument(java.lang.Object aSource)
```
    Creates a new document from the given source.
- Method Detail
  - getDoc
```
public static RMDocument getDoc(java.lang.Object aSource)
```
    Creates a new document from aSource using RMArchiver.
  - getSource
```
public RMDocumentSource getSource()
```
    Returns the document source.
  - setSource
```
public void setSource(RMDocumentSource aSource)
```
    Sets the document source.
  - setSource
```
public void setSource(java.lang.Object aSource)
```
    Sets the document source.
  - getFilename
```
public java.lang.String getFilename()
```
    Returns the filename associated with this document, if available.
  - getFont
```
public RMFont getFont()
```
    Returns the document's default font.
    
    Overrides:
    
    getFont in class RMShape
  - setFont
```
public void setFont(RMFont aFont)
```
    Sets the document default font.
    
    Overrides:
    
    setFont in class RMShape
  - getVersion
```
public float getVersion()
```
    Returns the version this document was loaded as.
  - getPageCount
```
public int getPageCount()
```
    Returns the number of pages in this document.
  - getPage
```
public RMPage getPage(int anIndex)
```
    Returns the page at the given index.
  - getPageLast
```
public RMPage getPageLast()
```
    Returns the last page (convenience).
  - getPages
```
public java.util.List<RMPage> getPages()
```
    Returns the list of pages associated with this document.
  - addPage
```
public RMPage addPage()
```
    Adds a new page to this document.
  - addPage
```
public void addPage(RMPage aPage)
```
    Adds a given page to this document.
  - addPage
```
public void addPage(RMPage aPage,
           int anIndex)
```
    Adds a given page to this document at the given index.
  - removePage
```
public RMPage removePage(int anIndex)
```
    Removes a page from this document.
  - removePage
```
public int removePage(RMPage aPage)
```
    Removes the given page.
  - addChild
```
public void addChild(RMShape aChild,
            int anIndex)
```
    Override to do special stuff.
    
    Overrides:
    
    addChild in class RMShape
  - removeChild
```
public RMPage removeChild(int anIndex)
```
    Removes the page at the given index from this document.
    
    Overrides:
    
    removeChild in class RMShape
  - createPage
```
public RMPage createPage()
```
    Creates a new page.
  - addPages
```
public void addPages(RMDocument aDoc)
```
    Add the pages in the given document to this document (at end) and clears the pages list in the given document.
  - getSelectedPage
```
public RMPage getSelectedPage()
```
    Returns the currently selected page of this document.
  - setSelectedPage
```
public void setSelectedPage(RMPage aPage)
```
    Selects the given page.
  - getSelectedPageIndex
```
public int getSelectedPageIndex()
```
    Returns the current page index of this document.
  - setSelectedPageIndex
```
public void setSelectedPageIndex(int anIndex)
```
    Selects the currently selected page by index.
  - getPageLayout
```
public RMDocument.PageLayout getPageLayout()
```
    Returns the page layout for the document.
  - setPageLayout
```
public void setPageLayout(RMDocument.PageLayout aValue)
```
    Sets the page layout for the document.
  - setPageLayout
```
public void setPageLayout(java.lang.String aValue)
```
    Set page layout from string.
  - getUnit
```
public RMDocument.Unit getUnit()
```
    Returns the units used to express sizes in the current document (POINTS, INCHES, CENTIMETERS).
  - setUnit
```
public void setUnit(RMDocument.Unit aValue)
```
    Sets the units used to express sizes in the current document (POINTS, INCHES, CENTIMETERS).
  - setUnit
```
public void setUnit(java.lang.String aString)
```
    Sets the units used to express sizes in the current document with one of the strings: point, inch or cm.
  - getPointsFromUnits
```
public float getPointsFromUnits(float aValue)
```
    Converts given value from document units to printer points (1/72 of an inch).
  - getUnitsFromPoints
```
public float getUnitsFromPoints(float aValue)
```
    Converts given value to document units from printer points (1/72 of an inch).
  - getUnitsMultiplier
```
public float getUnitsMultiplier()
```
    Returns the multiplier used to convert printer points to document units.
  - getShowGrid
```
public boolean getShowGrid()
```
    Returns whether the document should show an alignment grid.
  - setShowGrid
```
public void setShowGrid(boolean aValue)
```
    Sets whether the document should show an alignment grid.
  - getSnapGrid
```
public boolean getSnapGrid()
```
    Returns whether the document should snap to an alignment grid.
  - setSnapGrid
```
public void setSnapGrid(boolean aValue)
```
    Sets whether the document should snap to an alignment grid.
  - getGridSpacing
```
public float getGridSpacing()
```
    Returns the grid spacing for the document's grid.
  - setGridSpacing
```
public void setGridSpacing(float aValue)
```
    Sets the grid spacing for the document's grid.
  - getShowMargin
```
public boolean getShowMargin()
```
    Returns whether the document should show a margin rect.
  - setShowMargin
```
public void setShowMargin(boolean aValue)
```
    Sets whether the document should show a margin rect.
  - getSnapMargin
```
public boolean getSnapMargin()
```
    Returns whether the document should snap to a margin rect.
  - setSnapMargin
```
public void setSnapMargin(boolean aValue)
```
    Sets whether the document should snap to a margin rect.
  - getMarginRect
```
public RMRect getMarginRect()
```
    Returns the margin rect for this document.
  - setMarginRect
```
public void setMarginRect(RMRect aRect)
```
    Sets the margin rect for this document.
  - getMarginRectDefault
```
public RMRect getMarginRectDefault()
```
    Returns the default margin rect.
  - setMargins
```
public void setMargins(float left,
              float right,
              float top,
              float bottom)
```
    Sets the margin rect for this document.
  - getMarginLeft
```
public float getMarginLeft()
```
    Returns the margin rects left value.
  - getMarginRight
```
public float getMarginRight()
```
    Returns the margin rects right value.
  - getMarginTop
```
public float getMarginTop()
```
    Returns the margin rects top value.
  - getMarginBottom
```
public float getMarginBottom()
```
    Returns the margin rects bottom value.
  - getPageSize
```
public RMSize getPageSize()
```
    Returns the size of a document page.
  - setPageSize
```
public void setPageSize(float aWidth,
               float aHeight)
```
    Sets the size of the document (and all of its pages).
  - getPageSizeDefault
```
public RMSize getPageSizeDefault()
```
    Returns the default page size.
  - getAutosizingDefault
```
public java.lang.String getAutosizingDefault()
```
    Returns the autosizing default.
    
    Overrides:
    
    getAutosizingDefault in class RMShape
  - getDataSource
```
public RMDataSource getDataSource()
```
    Returns the RMDataSource associated with this document.
  - setDataSource
```
public void setDataSource(RMDataSource aDataSource)
```
    Sets the RMDataSource associated with this document.
  - getDataSourceSchema
```
public javi.data.Schema getDataSourceSchema()
```
    Returns the schema for the RMDataSource associated with this document (convenience).
  - getDatasetEntity
```
public javi.data.Entity getDatasetEntity()
```
    Returns the entity this shape should show in keys browser.
    
    Overrides:
    
    getDatasetEntity in class RMShape
  - getBinderCount
```
public int getBinderCount()
```
    Returns the number of binders for this panel.
  - getBinder
```
public javi.ui.Binder getBinder(int anIndex)
```
    Returns the specific binder at the given index.
  - getBinders
```
public java.util.List<javi.ui.Binder> getBinders()
```
    Returns the binders list.
  - getBinder
```
public javi.ui.Binder getBinder(java.lang.String aName)
```
    Returns the named binder for this panel.
  - addBinder
```
public void addBinder(javi.ui.Binder aBinder)
```
    Adds a binder to the panel.
  - removeBinder
```
public javi.ui.Binder removeBinder(int anIndex)
```
    Removes a binder at the given index from the panel.
  - removeBinder
```
public int removeBinder(javi.ui.Binder aBinder)
```
    Removes a binder from the panel.
  - getPublishUrl
```
public java.lang.String getPublishUrl()
```
    Returns the URL this document should be uploaded to.
  - setPublishUrl
```
public void setPublishUrl(java.lang.String aValue)
```
    Sets the URL this document should be uploaded to.
  - getNullString
```
public java.lang.String getNullString()
```
    Returns the string used to replace any occurrances of null values in a generated report.
  - setNullString
```
public void setNullString(java.lang.String aValue)
```
    Sets the string used to replace any occurrances of null values in a generated report.
  - getPaginate
```
public java.lang.Boolean getPaginate()
```
    Returns whether the document should paginate generated reports by default.
  - setPaginate
```
public void setPaginate(java.lang.Boolean aValue)
```
    Sets whether the document should paginate generated reports by default.
  - getCompress
```
public boolean getCompress()
```
    Returns whether the document should compress images in generated file formats like PDF.
  - setCompress
```
public void setCompress(boolean aValue)
```
    Sets whether the document should compress images in generated file formats like PDF.
  - getWindowXML
```
public com.reportmill.archiver.RXElement getWindowXML()
```
    Returns the xml element for the document window.
  - setWindowXML
```
public void setWindowXML(com.reportmill.archiver.RXElement anElement)
```
    Sets the xml element for the document window.
  - getBytes
```
public byte[] getBytes()
```
    Returns the document as an XML byte array.
  - getBytesPDF
```
public byte[] getBytesPDF()
```
    Returns the document as a byte array of a PDF file.
  - getBytesHTML
```
public byte[] getBytesHTML()
```
    Returns the document as a byte array of an HTML file.
  - getBytesCSV
```
public byte[] getBytesCSV()
```
    Returns the document as a byte array of a CSV file.
  - getBytesDelimitedAscii
```
public byte[] getBytesDelimitedAscii(java.lang.String fieldDelimiter,
                            java.lang.String recordDelimiter,
                            boolean quoteFields)
```
    Returns the document as a byte array of a delimited ASCII file (using given field, record separator strings).
  - getBytesExcel
```
public byte[] getBytesExcel()
```
    Returns the document as byte array of an Excel file.
  - getBytesRTF
```
public byte[] getBytesRTF()
```
    Returns the document as byte array of an Excel file.
  - getBytesJPEG
```
public byte[] getBytesJPEG()
```
    Returns the document as byte array of a JPEG file.
  - getBytesPNG
```
public byte[] getBytesPNG()
```
    Returns the document as byte array of PNG file.
  - getMapHTML
```
public java.util.Map getMapHTML(java.lang.String anImageRoot)
```
    Returns the document as a Map of an HTML file and image resources.
  - getStringCSV
```
public java.lang.String getStringCSV()
```
    Returns the document as a string of a CSV file.
  - getStringDelimitedText
```
public java.lang.String getStringDelimitedText(java.lang.String fieldDelimiter,
                                      java.lang.String recordDelimiter,
                                      boolean quoteFields)
```
    Returns the document as a string of a delimited text file.
  - write
```
public void write(java.lang.String aPath)
```
    Writes the document out to the given path String (it extracts type from path extension).
  - write
```
public void write(java.io.File aFile)
```
    Writes the document to the given File object
  - writePDF
```
public void writePDF(java.lang.String aPath)
```
    Writes the document to the given path String as PDF.
  - writeHTML
```
public java.util.Map writeHTML(java.lang.String aPath)
```
    Writes the document to the given path String as HTML.
  - writeHTML
```
public java.util.Map writeHTML(java.lang.String aPath,
                      java.lang.String anImageRoot)
```
    Writes the document to the given path String as HTML (referenced images are written at the given relative path).
  - getMaxTime
```
public float getMaxTime()
```
    Returns the total time needed to animate this document (total of all page animators).
  - getDocument
```
public RMDocument getDocument()
```
    Returns the document itself (over-ridden from RMShape).
    
    Overrides:
    
    getDocument in class RMShape
  - getAnimator
```
public RMAnimator getAnimator(int anIndex)
```
    Returns the animator for a specific page.
  - getAnimatorLast
```
public RMAnimator getAnimatorLast()
```
    Returns the animator for the last page.
  - getLoops
```
public boolean getLoops()
```
    Returns whether the last animator loops.
  - getUndoer
```
public RMUndoer getUndoer()
```
    Returns the RMUndoer for this document.
    
    Overrides:
    
    getUndoer in class RMShape
  - setUndoer
```
public void setUndoer(RMUndoer anUndoer)
```
    Sets the RMUndoer for this document.
  - getDocListener
```
public RMDocument.DocListener getDocListener()
```
    Returns the first doc listener from listeners list.
  - getSubreport
```
public RMDocument getSubreport(java.lang.String aName)
```
    Returns a subreport document for given name (override to improve).
  - isShowing
```
public boolean isShowing()
```
    Returns whether the document is visible in a viewer or editor.
    
    Overrides:
    
    isShowing in class RMShape
  - isEditing
```
public boolean isEditing()
```
    Returns whether the document is visible in an editor.
    
    Overrides:
    
    isEditing in class RMShape
  - repaint
```
public void repaint()
```
    Make sure document registers for repaint too.
    
    Overrides:
    
    repaint in class RMShape
  - repaint
```
public void repaint(RMShape aShape)
```
    This is a notification call for impending visual shape attribute changes.
    
    Overrides:
    
    repaint in class RMShape
  - paint
```
public void paint(java.awt.Graphics2D aGraphics)
```
    Override to set Painting flag.
    
    Overrides:
    
    paint in class RMShape
  - paintShape
```
public void paintShape(java.awt.Graphics2D aGraphics)
```
    Overrides paint shape, because document should never really paint itself.
    
    Overrides:
    
    paintShape in class RMShape
  - generateReport
```
public RMDocument generateReport()
```
    Returns a generated report from this template evaluated against the given object.
  - generateReport
```
public RMDocument generateReport(java.lang.Object theObjects)
```
    Returns a generated report from this template evaluated against the given object.
  - generateReport
```
public RMDocument generateReport(java.lang.Object objects,
                        java.lang.Object userInfo)
```
    Returns a generated report from this template evaluated against the given object and userInfo.
  - generateReport
```
public RMDocument generateReport(java.lang.Object objects,
                        boolean paginate)
```
    Returns a generated report from this template evaluated against the given object with an option to paginate.
  - generateReport
```
public RMDocument generateReport(java.lang.Object theObjects,
                        java.lang.Object theUserInfo,
                        boolean aPaginateFlag)
```
    Returns generated report from this template evaluated against given object/userInfo (with option to paginate).
  - getReportMill
```
public ReportMill getReportMill()
```
    Returns the reportmill associated with the document (create if needed).
    
    Overrides:
    
    getReportMill in class RMShape
  - setReportMill
```
public void setReportMill(ReportMill aReportMill)
```
    Creates an RPG clone of document.
    
    Overrides:
    
    setReportMill in class RMShape
  - resolvePageReferences
```
public void resolvePageReferences()
```
    Performs page substitutions on any text fields that were identified as containing @Page@ keys.
  - createLayout
```
public RMShapeLayout createLayout()
```
    Overrides to create document layout.
  - toXML
```
public com.reportmill.archiver.RXElement toXML()
```
    Returns RXElement for document.
  - equals
```
public boolean equals(java.lang.Object anObj)
```
    Standard equals implementation.
    
    Overrides:
    
    equals in class RMShape
  - clone
```
public RMDocument clone()
```
    Copies basic document attributes (shallow copy only - no children or pages).
    
    Overrides:
    
    clone in class RMShape
  - cloneDeep
```
public RMDocument cloneDeep()
```
    Copies the complete document, including document pages and all their children.
    
    Overrides:
    
    cloneDeep in class RMShape
  - toXMLShape
```
public com.reportmill.archiver.RXElement toXMLShape(com.reportmill.archiver.RXArchiver anArchiver,
                                           java.lang.Object anOwner)
```
    XML archival.
    
    Overrides:
    
    toXMLShape in class RMShape
  - toXMLShapeChildren
```
public void toXMLShapeChildren(com.reportmill.archiver.RXArchiver anArchiver,
                      com.reportmill.archiver.RXElement anElement,
                      java.lang.Object anOwner)
```
    XML archival of children.
    
    Overrides:
    
    toXMLShapeChildren in class RMShape
  - fromXMLShape
```
public java.lang.Object fromXMLShape(com.reportmill.archiver.RXArchiver anArchiver,
                            com.reportmill.archiver.RXElement anElement,
                            java.lang.Object anOwner)
```
    XML unarchival.
    
    Overrides:
    
    fromXMLShape in class RMShape
  - fromXMLShapeChildren
```
public void fromXMLShapeChildren(com.reportmill.archiver.RXArchiver anArchiver,
                        com.reportmill.archiver.RXElement anElement,
                        java.lang.Object anOwner)
```
    XML unarchival for shape children.
    
    Overrides:
    
    fromXMLShapeChildren in class RMShape
  - superSelectable
```
public boolean superSelectable()
```
    Editor method indicates that document is super selectable.
    
    Overrides:
    
    superSelectable in class RMShape
  - childrenSuperSelectImmediately
```
public boolean childrenSuperSelectImmediately()
```
    Editor method indicates that pages super select immediately.
    
    Overrides:
    
    childrenSuperSelectImmediately in class RMShape
  - acceptsChildren
```
public boolean acceptsChildren()
```
    Editor method indicates that document accepts children (should probably be false).
    
    Overrides:
    
    acceptsChildren in class RMShape
  - pdfBytes
```
public byte[] pdfBytes()
```
    Obsolete method for old pdfBytes() method.

Class RMDocument

Nested Class Summary

Nested classes/interfaces inherited from interface com.reportmill.base.RMTypes

Field Summary

Fields inherited from class com.reportmill.shape.RMShape

Constructor Summary

Method Summary

Methods inherited from class com.reportmill.shape.RMShape

Methods inherited from class com.reportmill.base.RMObject

Methods inherited from class com.reportmill.base.RMListenerList

Methods inherited from class java.lang.Object

Field Detail

_locale

Constructor Detail

RMDocument

RMDocument

RMDocument

Method Detail

getDoc

getSource

setSource

setSource

getFilename

getFont

setFont

getVersion

getPageCount

getPage

getPageLast

getPages

addPage

addPage

addPage

removePage

removePage

addChild

removeChild

createPage

addPages

getSelectedPage

setSelectedPage

getSelectedPageIndex

setSelectedPageIndex

getPageLayout

setPageLayout

setPageLayout

getUnit

setUnit

setUnit

getPointsFromUnits

getUnitsFromPoints

getUnitsMultiplier

getShowGrid

setShowGrid

getSnapGrid

setSnapGrid

getGridSpacing

setGridSpacing

getShowMargin

setShowMargin

getSnapMargin

setSnapMargin

getMarginRect

setMarginRect

getMarginRectDefault

setMargins

getMarginLeft

getMarginRight

getMarginTop

getMarginBottom

getPageSize

setPageSize

getPageSizeDefault

getAutosizingDefault

getDataSource

setDataSource

getDataSourceSchema

getDatasetEntity

getBinderCount

getBinder