ReportCanvas (EspressReport 7.1 Java API

java.lang.Object
- java.awt.Component
- - java.awt.Canvas
  - - quadbase.reportdesigner.ReportViewer.CCanvas
    - - quadbase.reportdesigner.ReportViewer.ReportCanvas

All Implemented Interfaces:

java.awt.event.KeyListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.lang.Runnable, java.util.EventListener, javax.accessibility.Accessible
```
public class ReportCanvas
extends quadbase.reportdesigner.ReportViewer.CCanvas
implements java.lang.Runnable, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.KeyListener
```
ReportCanvas is the Canvas object that is contained within the ReportViewer component.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.awt.Canvas
  java.awt.Canvas.AccessibleAWTCanvas
- Nested classes/interfaces inherited from class java.awt.Component
  java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`backMenuItemVisible`
`boolean`	`goToMenuItemVisible`
`java.util.Vector`	`invisibleOutputMenuItem`
`java.util.Vector`	`invisiblePageMenuItem`
`java.util.Vector`	`invisibleSectionMenuItem`
`java.util.Vector`	`linkHistory`
`boolean`	`menuVisible`
`boolean`	`multiDrillDownVisible`
`boolean`	`outputMenuVisible`
`static int`	`PAGELAYOUT_OFFSET` Gap between the edge of the canvas and the actual page
`boolean`	`pageMenuVisible`
`boolean`	`refreshMenuItemVisible`
`boolean`	`sectionMenuVisible`
`boolean`	`sortMenuVisible`
`boolean`	`toolbarMenuVisible`
`boolean`	`zoomMenuItemVisible`

Fields inherited from class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Constructor and Description
`ReportCanvas(quadbase.reportdesigner.report.Report report)` Create a new ReportCanvas using specified Report object report
`ReportCanvas(quadbase.reportdesigner.report.Report report, int scrollBarOption)` Create a new ReportCanvas using specified Report object report and scroll bar option

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`do_Reload()` For Internal Use only
`void`	`doneReload()` For Internal Use only
`protected void`	`finalize()` Remove all the mouseListener before exit
`java.awt.Dimension`	`getMinimumSize()` Returns the minimum size
`int`	`getPage()` Returns the page number
`java.awt.Dimension`	`getPreferredSize()` Returns the preferred size
`QbReport`	`getQbReport()`
`quadbase.reportdesigner.report.Report`	`getReport()` internal use only
`java.awt.Component`	`getReportComponent()` Returns the Component object for adding additional components to the Canvas
`ReportToolBar`	`getReportToolBar()` returns report toolbar object
`int`	`getSection()` Returns the section
`protected java.awt.Container`	`getToolbarContainer()` internal use only
`int`	`getTotalPages()` Returns the total number of pages
`int`	`getTotalSections()` Returns the total number of sections
`int`	`getZoomFactor()` sets the zoom factor percentage
`void`	`goToNextAvailPage()` go to the next available page.
`void`	`goToPreviousAvailPage()` go to the previous available page.
`boolean`	`isExportEnabled()` whether report exports is enabled
`boolean`	`isExportToMultiPages()` sets whether exporting report to multiple pages is enabled
`boolean`	`isGotoEnabled()` Checks to see if the goto button shoule be enabled
`boolean`	`isNextAvailPageEnabled()` whether the next page button is enabled
`boolean`	`isNextPageEnabled()` Checks to see if next page exists
`boolean`	`isNextSectionEnabled()` Checks to see if next section exists
`boolean`	`isPrevAvailPageEnabled()` whether the previous page button is enabled
`boolean`	`isPrevPageEnabled()` Checks to see if previous page exists
`boolean`	`isPrevSectionEnabled()` Checks to see if previous section exists
`boolean`	`isRefreshEnabled()` whether report refresh is enabled
`boolean`	`isReportToolBarVisible()` gets the display status of report toolbar
`void`	`keyPressed(java.awt.event.KeyEvent e)` Key Pressed event
`void`	`keyReleased(java.awt.event.KeyEvent e)` Key Released event
`void`	`keyTyped(java.awt.event.KeyEvent e)` Key typed event
`void`	`mouseClicked(java.awt.event.MouseEvent e)` Mouse Click event
`void`	`mouseDragged(java.awt.event.MouseEvent e)` Mouse Drag event
`void`	`mouseEntered(java.awt.event.MouseEvent e)` Mouse Enter event
`void`	`mouseExited(java.awt.event.MouseEvent e)` Mouse Exit event
`void`	`mouseMoved(java.awt.event.MouseEvent e)` Mouse Move event
`void`	`mousePressed(java.awt.event.MouseEvent e)` Mouse Press event
`void`	`mouseReleased(java.awt.event.MouseEvent e)` Mouse Release event
`void`	`paint(java.awt.Graphics g)` For internal use only
`void`	`print()` Print
`void`	`resetPages()` Reset page number and section number to 1
`void`	`run()` For Internal Use only
`void`	`setBrowseDirectories(BrowseDirectories dir)`
`void`	`setCanvasBackgroundColor(java.awt.Color color)` Sets the Canvas's background color
`void`	`setDrillDownParameterValues()` internal use only
`void`	`setExportEnabled(boolean b)` sets whether report exports is enabled
`void`	`setExportToMultiPages(boolean state)` whether exporting report to multiple pages is enabled
`void`	`setExportToSingleWPagination(boolean state)` sets whether exporting report to a paginated single page is enabled
`void`	`setFromDesigner(boolean state, boolean isMetric)` internal use only
`void`	`setMouseListener(java.awt.event.MouseListener listener)` Allow the user to implement their own mouse listeners and trap all mouse events
`void`	`setMouseMotionListener(java.awt.event.MouseMotionListener listener)` Allow the user to implement their own mouse listeners and trap all mouse motion events
`void`	`setOutputMenuItemVisible(java.lang.String[] menuItem, boolean b)` sets whether the "Output" menu item is visible.
`void`	`setPage(int p)` Sets the page
`void`	`setPageMenuItemVisible(java.lang.String[] menuItem, boolean b)` sets whether the "Page" menu item is visible.
`void`	`setRefreshEnabled(boolean b)` sets whether report refresh is enabled
`void`	`setRepaint(IReport report)` Redraws the IReport object report
`void`	`setReport(quadbase.reportdesigner.report.Report report)`
`void`	`setReport(quadbase.reportdesigner.report.Report report, quadbase.reportdesigner.report.Report parentReport)` Sets the Report object report
`void`	`setReportToolBarVisible(boolean b)` sets the display status of report toolbar
`void`	`setSection(int s)` Sets the Section
`void`	`setSectionMenuItemVisible(java.lang.String[] menuItem, boolean b)` sets whether the "Section" menu item is visible.
`void`	`setSize(java.awt.Dimension d)` Sets the size using the specified dimension
`void`	`setSize(int w, int h)` Sets the size using the specified width and height
`void`	`setZoomFactor(int in)` returns the zoom factor percentage
`int`	`translate(int x)` internal use only
`void`	`update(java.awt.Graphics g)` For internal use only
`void`	`zoom(double factor)` for internal use only

Methods inherited from class java.awt.Canvas
addNotify, createBufferStrategy, createBufferStrategy, getAccessibleContext, getBufferStrategy

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, validate

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

- Field Detail
  - linkHistory
```
public java.util.Vector linkHistory
```
  - PAGELAYOUT_OFFSET
```
public static final int PAGELAYOUT_OFFSET
```
    Gap between the edge of the canvas and the actual page
    
    See Also:
    
    Constant Field Values
  - menuVisible
```
public boolean menuVisible
```
  - sectionMenuVisible
```
public boolean sectionMenuVisible
```
  - pageMenuVisible
```
public boolean pageMenuVisible
```
  - outputMenuVisible
```
public boolean outputMenuVisible
```
  - backMenuItemVisible
```
public boolean backMenuItemVisible
```
  - refreshMenuItemVisible
```
public boolean refreshMenuItemVisible
```
  - goToMenuItemVisible
```
public boolean goToMenuItemVisible
```
  - sortMenuVisible
```
public boolean sortMenuVisible
```
  - zoomMenuItemVisible
```
public boolean zoomMenuItemVisible
```
  - multiDrillDownVisible
```
public boolean multiDrillDownVisible
```
  - toolbarMenuVisible
```
public boolean toolbarMenuVisible
```
  - invisibleSectionMenuItem
```
public java.util.Vector invisibleSectionMenuItem
```
  - invisiblePageMenuItem
```
public java.util.Vector invisiblePageMenuItem
```
  - invisibleOutputMenuItem
```
public java.util.Vector invisibleOutputMenuItem
```
- Constructor Detail
  - ReportCanvas
```
public ReportCanvas(quadbase.reportdesigner.report.Report report)
```
    Create a new ReportCanvas using specified Report object report
  - ReportCanvas
```
public ReportCanvas(quadbase.reportdesigner.report.Report report,
                    int scrollBarOption)
```
    Create a new ReportCanvas using specified Report object report and scroll bar option
- Method Detail
  - getReportToolBar
```
public ReportToolBar getReportToolBar()
```
    returns report toolbar object
  - setReportToolBarVisible
```
public void setReportToolBarVisible(boolean b)
```
    sets the display status of report toolbar
  - isReportToolBarVisible
```
public boolean isReportToolBarVisible()
```
    gets the display status of report toolbar
  - getToolbarContainer
```
protected java.awt.Container getToolbarContainer()
```
    internal use only
  - setExportEnabled
```
public void setExportEnabled(boolean b)
```
    sets whether report exports is enabled
  - isExportEnabled
```
public boolean isExportEnabled()
```
    whether report exports is enabled
  - setRefreshEnabled
```
public void setRefreshEnabled(boolean b)
```
    sets whether report refresh is enabled
  - isRefreshEnabled
```
public boolean isRefreshEnabled()
```
    whether report refresh is enabled
  - isExportToMultiPages
```
public boolean isExportToMultiPages()
```
    sets whether exporting report to multiple pages is enabled
  - setExportToMultiPages
```
public void setExportToMultiPages(boolean state)
```
    whether exporting report to multiple pages is enabled
  - setExportToSingleWPagination
```
public void setExportToSingleWPagination(boolean state)
```
    sets whether exporting report to a paginated single page is enabled
  - finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
    Remove all the mouseListener before exit
    
    Overrides:
    
    finalize in class java.lang.Object
    
    Throws:
    
    java.lang.Throwable
  - getReport
```
public quadbase.reportdesigner.report.Report getReport()
```
    internal use only
  - getQbReport
```
public QbReport getQbReport()
```
    Returns:
    
    the current QbReport. If this is a drill down report, returns the QbReport of the current drill down level.
  - getReportComponent
```
public java.awt.Component getReportComponent()
```
    Returns the Component object for adding additional components to the Canvas
  - setReport
```
public void setReport(quadbase.reportdesigner.report.Report report)
               throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - setReport
```
public void setReport(quadbase.reportdesigner.report.Report report,
                      quadbase.reportdesigner.report.Report parentReport)
               throws java.lang.Exception
```
    Sets the Report object report
    
    Throws:
    
    java.lang.Exception
  - setSize
```
public void setSize(java.awt.Dimension d)
```
    Sets the size using the specified dimension
    
    Overrides:
    
    setSize in class java.awt.Component
  - setSize
```
public void setSize(int w,
                    int h)
```
    Sets the size using the specified width and height
    
    Overrides:
    
    setSize in class java.awt.Component
  - getPreferredSize
```
public java.awt.Dimension getPreferredSize()
```
    Returns the preferred size
    
    Overrides:
    
    getPreferredSize in class java.awt.Component
  - getMinimumSize
```
public java.awt.Dimension getMinimumSize()
```
    Returns the minimum size
    
    Overrides:
    
    getMinimumSize in class java.awt.Component
  - setRepaint
```
public void setRepaint(IReport report)
```
    Redraws the IReport object report
  - paint
```
public void paint(java.awt.Graphics g)
```
    For internal use only
    
    Overrides:
    
    paint in class java.awt.Canvas
  - update
```
public void update(java.awt.Graphics g)
```
    For internal use only
    
    Overrides:
    
    update in class java.awt.Canvas
  - run
```
public void run()
```
    For Internal Use only
    
    Specified by:
    
    run in interface java.lang.Runnable
  - mouseClicked
```
public void mouseClicked(java.awt.event.MouseEvent e)
```
    Mouse Click event
    
    Specified by:
    
    mouseClicked in interface java.awt.event.MouseListener
  - mouseEntered
```
public void mouseEntered(java.awt.event.MouseEvent e)
```
    Mouse Enter event
    
    Specified by:
    
    mouseEntered in interface java.awt.event.MouseListener
  - mouseExited
```
public void mouseExited(java.awt.event.MouseEvent e)
```
    Mouse Exit event
    
    Specified by:
    
    mouseExited in interface java.awt.event.MouseListener
  - mousePressed
```
public void mousePressed(java.awt.event.MouseEvent e)
```
    Mouse Press event
    
    Specified by:
    
    mousePressed in interface java.awt.event.MouseListener
  - mouseReleased
```
public void mouseReleased(java.awt.event.MouseEvent e)
```
    Mouse Release event
    
    Specified by:
    
    mouseReleased in interface java.awt.event.MouseListener
  - mouseDragged
```
public void mouseDragged(java.awt.event.MouseEvent e)
```
    Mouse Drag event
    
    Specified by:
    
    mouseDragged in interface java.awt.event.MouseMotionListener
  - mouseMoved
```
public void mouseMoved(java.awt.event.MouseEvent e)
```
    Mouse Move event
    
    Specified by:
    
    mouseMoved in interface java.awt.event.MouseMotionListener
  - keyTyped
```
public void keyTyped(java.awt.event.KeyEvent e)
```
    Key typed event
    
    Specified by:
    
    keyTyped in interface java.awt.event.KeyListener
  - keyReleased
```
public void keyReleased(java.awt.event.KeyEvent e)
```
    Key Released event
    
    Specified by:
    
    keyReleased in interface java.awt.event.KeyListener
  - keyPressed
```
public void keyPressed(java.awt.event.KeyEvent e)
```
    Key Pressed event
    
    Specified by:
    
    keyPressed in interface java.awt.event.KeyListener
  - getPage
```
public int getPage()
```
    Returns the page number
  - getSection
```
public int getSection()
```
    Returns the section
  - setPage
```
public void setPage(int p)
```
    Sets the page
  - setSection
```
public void setSection(int s)
```
    Sets the Section
  - getTotalPages
```
public int getTotalPages()
```
    Returns the total number of pages
  - getTotalSections
```
public int getTotalSections()
```
    Returns the total number of sections
  - isNextPageEnabled
```
public boolean isNextPageEnabled()
```
    Checks to see if next page exists
  - isPrevPageEnabled
```
public boolean isPrevPageEnabled()
```
    Checks to see if previous page exists
  - isNextSectionEnabled
```
public boolean isNextSectionEnabled()
```
    Checks to see if next section exists
  - isPrevSectionEnabled
```
public boolean isPrevSectionEnabled()
```
    Checks to see if previous section exists
  - goToPreviousAvailPage
```
public void goToPreviousAvailPage()
```
    go to the previous available page.
  - goToNextAvailPage
```
public void goToNextAvailPage()
```
    go to the next available page.
  - isPrevAvailPageEnabled
```
public boolean isPrevAvailPageEnabled()
```
    whether the previous page button is enabled
  - isNextAvailPageEnabled
```
public boolean isNextAvailPageEnabled()
```
    whether the next page button is enabled
  - isGotoEnabled
```
public boolean isGotoEnabled()
```
    Checks to see if the goto button shoule be enabled
  - resetPages
```
public void resetPages()
                throws java.lang.Exception
```
    Reset page number and section number to 1
    
    Throws:
    
    java.lang.Exception
  - print
```
public void print()
```
    Print
  - do_Reload
```
public void do_Reload()
```
    For Internal Use only
  - doneReload
```
public void doneReload()
```
    For Internal Use only
  - setMouseListener
```
public void setMouseListener(java.awt.event.MouseListener listener)
```
    Allow the user to implement their own mouse listeners and trap all mouse events
  - setMouseMotionListener
```
public void setMouseMotionListener(java.awt.event.MouseMotionListener listener)
```
    Allow the user to implement their own mouse listeners and trap all mouse motion events
  - getZoomFactor
```
public int getZoomFactor()
```
    sets the zoom factor percentage
  - setZoomFactor
```
public void setZoomFactor(int in)
```
    returns the zoom factor percentage
  - zoom
```
public void zoom(double factor)
```
    for internal use only
  - setFromDesigner
```
public void setFromDesigner(boolean state,
                            boolean isMetric)
```
    internal use only
  - translate
```
public int translate(int x)
```
    internal use only
  - setCanvasBackgroundColor
```
public void setCanvasBackgroundColor(java.awt.Color color)
```
    Sets the Canvas's background color
  - setPageMenuItemVisible
```
public void setPageMenuItemVisible(java.lang.String[] menuItem,
                                   boolean b)
```
    sets whether the "Page" menu item is visible.
  - setOutputMenuItemVisible
```
public void setOutputMenuItemVisible(java.lang.String[] menuItem,
                                     boolean b)
```
    sets whether the "Output" menu item is visible.
  - setSectionMenuItemVisible
```
public void setSectionMenuItemVisible(java.lang.String[] menuItem,
                                      boolean b)
```
    sets whether the "Section" menu item is visible.
  - setDrillDownParameterValues
```
public void setDrillDownParameterValues()
                                 throws java.lang.Exception
```
    internal use only
    
    Throws:
    
    java.lang.Exception
  - setBrowseDirectories
```
public void setBrowseDirectories(BrowseDirectories dir)
```

Class ReportCanvas

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Canvas

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class java.awt.Canvas

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

linkHistory

PAGELAYOUT_OFFSET

menuVisible

sectionMenuVisible

pageMenuVisible

outputMenuVisible

backMenuItemVisible

refreshMenuItemVisible

goToMenuItemVisible

sortMenuVisible

zoomMenuItemVisible

multiDrillDownVisible

toolbarMenuVisible

invisibleSectionMenuItem

invisiblePageMenuItem

invisibleOutputMenuItem

Constructor Detail

ReportCanvas

ReportCanvas

Method Detail

getReportToolBar

setReportToolBarVisible

isReportToolBarVisible

getToolbarContainer

setExportEnabled

isExportEnabled

setRefreshEnabled

isRefreshEnabled

isExportToMultiPages

setExportToMultiPages

setExportToSingleWPagination

finalize

getReport

getQbReport

getReportComponent

setReport

setReport

setSize

setSize

getPreferredSize

getMinimumSize

setRepaint

paint

update

run

mouseClicked

mouseEntered

mouseExited

mousePressed

mouseReleased

mouseDragged

mouseMoved

keyTyped

keyReleased

keyPressed

getPage

getSection

setPage

setSection

getTotalPages

getTotalSections

isNextPageEnabled

isPrevPageEnabled

isNextSectionEnabled

isPrevSectionEnabled

goToPreviousAvailPage

goToNextAvailPage