EspressReport 6.6

quadbase.reportdesigner.PageViewer
Class ReportCanvas

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Canvas
          extended by quadbase.reportdesigner.PageViewer.CCanvas
              extended by quadbase.reportdesigner.PageViewer.ReportCanvas
All Implemented Interfaces:
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.PageViewer.CCanvas
implements java.lang.Runnable, java.awt.event.MouseListener, java.awt.event.MouseMotionListener

ReportCanvas is the Canvas object that is contained within the PageViewer component. Use Viewer.getReportCanvas(...) to get an instance of a ReportCanvas.

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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 boolean backMenuItemVisible
           
 boolean goToMenuItemVisible
           
 java.util.Vector<java.lang.String> invisibleOutputMenuItem
           
 java.util.Vector<java.lang.String> invisiblePageMenuItem
           
 java.util.Vector<java.lang.String> invisibleSectionMenuItem
           
 boolean menuVisible
           
 boolean multiDrillDownVisible
           
 boolean outputMenuVisible
           
 boolean pageMenuVisible
           
 boolean refreshMenuItemVisible
           
 boolean sectionMenuVisible
           
 boolean sortMenuVisible
           
 boolean toolbarMenuVisible
           
 boolean zoomMenuItemVisible
           
 
Fields inherited from class java.awt.Component
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
ReportCanvas(quadbase.reportdesigner.PageViewer.ReportInfo iFile)
          internal use only
 
Method Summary
 void do_Reload()
          internal use only
protected  void finalize()
          Remove all the mouseListener before exit
 int getBackwardLinkClickCount()
          gets how many times the user needs to trigger the backwardLinkModifier MouseEvent to go backward.
 int getBackwardLinkModifier()
          gets what java.awt.event.MouseEvent triggers the Canvas to go backward (if available: after a forward link was triggered and the user wants to go back to the previous page|link).
 java.awt.Color getDataHintBgColor()
          gets the data hint background color
 java.awt.Font getDataHintFont()
          gets the data hint font
 java.awt.Color getDataHintFontColor()
          gets the data hint font color
 java.awt.Dimension getDataHintOffset()
          gets the offset of the data hint
 java.lang.String getExportServlet()
           
 int getForwardLinkClickCount()
          gets how many times the user needs to trigger the forwardLinkModifier MouseEvent to go forward.
 int getForwardLinkModifier()
          gets what java.awt.event.MouseEvent triggers a link (drill down link, etc.) to go forward.
 java.lang.String[] getInvisibleMenuItemList()
          gets a list of menu items in the right-click pop up menu that are invisible
 java.awt.Dimension getMinimumSize()
          Returns the minimum size
 java.awt.Dimension getPreferredSize()
          Returns the preferred size
 quadbase.reportdesigner.PageViewer.Report getReport()
          internal use only
 java.awt.Component getReportComponent()
          Returns the Component object for adding additional components to the Canvas
 quadbase.reportdesigner.PageViewer.ReportInfo getReportInfo()
          internal use only
 ReportToolBar getReportToolBar()
          returns report toolbar object
protected  java.awt.Container getToolbarContainer()
          internal use only
 int getTotalPages()
          returns total number to pages
 int getTotalSections()
          returns 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()
          sets whether export is 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 isPopupMenuEnabled()
          whether the right-click pop up menu is enabled
 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 isPrintKeyEnabled()
          whether the print key is enabled
 boolean isRefreshEnabled()
          whether the refresh is enabled
 boolean isReportToolBarVisible()
          sets the display status of report toolbar
 boolean isShowDataHint()
          whether to show data hint
 void mouseClicked(java.awt.event.MouseEvent e)
          mouse clicked event
 void mouseDragged(java.awt.event.MouseEvent e)
          method invoked when mouse is dragged
 void mouseEntered(java.awt.event.MouseEvent e)
          mouse entered event
 void mouseExited(java.awt.event.MouseEvent e)
          mouse exited event
 void mouseMoved(java.awt.event.MouseEvent e)
          mouse moved event
 void mousePressed(java.awt.event.MouseEvent e)
          MOUSELISTENER EVENT
 void mouseReleased(java.awt.event.MouseEvent e)
          method invoked when mouse is release
 void paint(java.awt.Graphics g)
          For internal use only
 void print()
          prints the report
 void resetOffScreenImage()
          reset the offScreenImage to null, the repaint process will redraw the whole canvas.
 void run()
          internal use only.
 void setBackwardLinkClickCount(int c)
          sets how many times the user needs to trigger the backwardLinkModifier MouseEvent to go backward.
 void setBackwardLinkModifier(int m)
          sets what java.awt.event.MouseEvent triggers the Canvas to go backward (if available: after a forward link was triggered and the user wants to go back to the previous page|link).
 void setBrowseDirectories(BrowseDirectories dir)
           
 void setCanvasBackgroundColor(java.awt.Color color)
          Sets the Canvas's background color
 void setDataHintBgColor(java.awt.Color c)
          sets the data hint background color
 void setDataHintFont(java.awt.Font f)
          sets the data hint font
 void setDataHintFontColor(java.awt.Color c)
          sets the data hint font color
 void setDataHintOffset(java.awt.Dimension dimension)
          sets the offset of the data hint
 void setDynamicExport(boolean state, java.lang.String serverName, int serverPort, java.lang.String servletDirectory)
           
 void setExportEnabled(boolean b)
          whether export is enabled
 void setExportServlet(java.lang.String url)
           
 void setForwardLinkClickCount(int c)
          sets how many times the user needs to trigger the forwardLinkModifier MouseEvent to go forward.
 void setForwardLinkModifier(int m)
          sets what java.awt.event.MouseEvent triggers a link (drill down link, etc.) to go forward.
 void setInvisibleMenuItemList(java.lang.String[] list)
          sets a list of menu items in the right-click pop up menu that are invisible
 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)
          sets the mouse motion listener
 void setOrder(boolean isAsc, java.lang.String sortColumn)
          sorts the SORTCOLUMN either ASC (isAsc) or DESC (!isAsc).
 void setOutputMenuItemVisible(java.lang.String[] menuItem, boolean b)
          sets whether the "Output" menu item is visible.
 void setPage(int page)
          sets the current page number
 void setPageMenuItemVisible(java.lang.String[] menuItem, boolean b)
          sets whether the "Page" menu item is visible.
 void setParent(java.awt.Frame frame)
          sets the parent frame.
 void setPopupMenuEnabled(boolean b)
          sets whether the right-click pop up menu is enabled
 void setPrintKeyEnabled(boolean p)
          sets whether the print key is enabled
 void setRefreshEnabled(boolean r)
          sets whether the refresh is enabled
 void setReportToolBarVisible(boolean b)
          returns the display status of report toolbar
 void setSection(int section)
          sets the current section number
 void setSectionMenuItemVisible(java.lang.String[] menuItem, boolean b)
          sets whether the "Section" menu item is visible.
 void setShowDataHint(boolean b)
          sets whether to show data hint
 void setSize(java.awt.Dimension d)
          Sets the size using the specified dimension
 void setSize(double w, double h)
           
 void setSize(int w, int h)
          Sets the size using the specified width and height
 void setZoomFactor(int in)
          returns the zoom factor percentage
 void update(java.awt.Graphics g)
          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, 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, 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

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

multiDrillDownVisible

public boolean multiDrillDownVisible

toolbarMenuVisible

public boolean toolbarMenuVisible

zoomMenuItemVisible

public boolean zoomMenuItemVisible

invisibleSectionMenuItem

public java.util.Vector<java.lang.String> invisibleSectionMenuItem

invisiblePageMenuItem

public java.util.Vector<java.lang.String> invisiblePageMenuItem

invisibleOutputMenuItem

public java.util.Vector<java.lang.String> invisibleOutputMenuItem
Constructor Detail

ReportCanvas

public ReportCanvas(quadbase.reportdesigner.PageViewer.ReportInfo iFile)
internal use only

Method Detail

getReportToolBar

public ReportToolBar getReportToolBar()
returns report toolbar object


setReportToolBarVisible

public void setReportToolBarVisible(boolean b)
returns the display status of report toolbar


isReportToolBarVisible

public boolean isReportToolBarVisible()
sets the display status of report toolbar


getToolbarContainer

protected java.awt.Container getToolbarContainer()
internal use only


setParent

public void setParent(java.awt.Frame frame)
sets the parent frame.


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)
sets the mouse motion listener


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.PageViewer.Report getReport()
internal use only


getReportInfo

public quadbase.reportdesigner.PageViewer.ReportInfo getReportInfo()
internal use only


getReportComponent

public java.awt.Component getReportComponent()
Returns the Component object for adding additional components to the Canvas


isPopupMenuEnabled

public boolean isPopupMenuEnabled()
whether the right-click pop up menu is enabled


setPopupMenuEnabled

public void setPopupMenuEnabled(boolean b)
sets whether the right-click pop up menu is enabled


getInvisibleMenuItemList

public java.lang.String[] getInvisibleMenuItemList()
gets a list of menu items in the right-click pop up menu that are invisible


setInvisibleMenuItemList

public void setInvisibleMenuItemList(java.lang.String[] list)
sets a list of menu items in the right-click pop up menu that are invisible


setShowDataHint

public void setShowDataHint(boolean b)
sets whether to show data hint


isShowDataHint

public boolean isShowDataHint()
whether to show data hint


getDataHintOffset

public java.awt.Dimension getDataHintOffset()
gets the offset of the data hint


setDataHintOffset

public void setDataHintOffset(java.awt.Dimension dimension)
sets the offset of the data hint


getDataHintBgColor

public java.awt.Color getDataHintBgColor()
gets the data hint background color


setDataHintBgColor

public void setDataHintBgColor(java.awt.Color c)
sets the data hint background color


getDataHintFontColor

public java.awt.Color getDataHintFontColor()
gets the data hint font color


setDataHintFontColor

public void setDataHintFontColor(java.awt.Color c)
sets the data hint font color


getDataHintFont

public java.awt.Font getDataHintFont()
gets the data hint font


setDataHintFont

public void setDataHintFont(java.awt.Font f)
sets the data hint font


getForwardLinkModifier

public int getForwardLinkModifier()
gets what java.awt.event.MouseEvent triggers a link (drill down link, etc.) to go forward.


setForwardLinkModifier

public void setForwardLinkModifier(int m)
sets what java.awt.event.MouseEvent triggers a link (drill down link, etc.) to go forward.


getForwardLinkClickCount

public int getForwardLinkClickCount()
gets how many times the user needs to trigger the forwardLinkModifier MouseEvent to go forward.


setForwardLinkClickCount

public void setForwardLinkClickCount(int c)
sets how many times the user needs to trigger the forwardLinkModifier MouseEvent to go forward.


getBackwardLinkModifier

public int getBackwardLinkModifier()
gets what java.awt.event.MouseEvent triggers the Canvas to go backward (if available: after a forward link was triggered and the user wants to go back to the previous page|link).


setBackwardLinkModifier

public void setBackwardLinkModifier(int m)
sets what java.awt.event.MouseEvent triggers the Canvas to go backward (if available: after a forward link was triggered and the user wants to go back to the previous page|link).


getBackwardLinkClickCount

public int getBackwardLinkClickCount()
gets how many times the user needs to trigger the backwardLinkModifier MouseEvent to go backward.


setBackwardLinkClickCount

public void setBackwardLinkClickCount(int c)
sets how many times the user needs to trigger the backwardLinkModifier MouseEvent to go backward.


isPrintKeyEnabled

public boolean isPrintKeyEnabled()
whether the print key is enabled


setPrintKeyEnabled

public void setPrintKeyEnabled(boolean p)
sets whether the print key is enabled


isRefreshEnabled

public boolean isRefreshEnabled()
whether the refresh is enabled


setRefreshEnabled

public void setRefreshEnabled(boolean r)
sets whether the refresh is enabled


setExportEnabled

public void setExportEnabled(boolean b)
whether export is enabled


isExportEnabled

public boolean isExportEnabled()
sets whether export is enabled


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(double w,
                    double h)

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

run

public void run()
internal use only. does nothing

Specified by:
run in interface java.lang.Runnable

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

getZoomFactor

public int getZoomFactor()
sets the zoom factor percentage


setZoomFactor

public void setZoomFactor(int in)
returns the zoom factor percentage


setPage

public void setPage(int page)
sets the current page number


setSection

public void setSection(int section)
sets the current section number


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


setOrder

public void setOrder(boolean isAsc,
                     java.lang.String sortColumn)
sorts the SORTCOLUMN either ASC (isAsc) or DESC (!isAsc).


do_Reload

public void do_Reload()
internal use only


mousePressed

public void mousePressed(java.awt.event.MouseEvent e)
MOUSELISTENER EVENT

Specified by:
mousePressed in interface java.awt.event.MouseListener

mouseDragged

public void mouseDragged(java.awt.event.MouseEvent e)
method invoked when mouse is dragged

Specified by:
mouseDragged in interface java.awt.event.MouseMotionListener

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)
method invoked when mouse is release

Specified by:
mouseReleased in interface java.awt.event.MouseListener

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent e)
mouse clicked event

Specified by:
mouseClicked in interface java.awt.event.MouseListener

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent e)
mouse entered event

Specified by:
mouseEntered in interface java.awt.event.MouseListener

mouseExited

public void mouseExited(java.awt.event.MouseEvent e)
mouse exited event

Specified by:
mouseExited in interface java.awt.event.MouseListener

mouseMoved

public void mouseMoved(java.awt.event.MouseEvent e)
mouse moved event

Specified by:
mouseMoved in interface java.awt.event.MouseMotionListener

print

public void print()
prints the report


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


getTotalPages

public int getTotalPages()
returns total number to pages


getTotalSections

public int getTotalSections()
returns total number of sections


resetOffScreenImage

public void resetOffScreenImage()
reset the offScreenImage to null, the repaint process will redraw the whole canvas.


setBrowseDirectories

public void setBrowseDirectories(BrowseDirectories dir)

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.


setExportServlet

public void setExportServlet(java.lang.String url)

getExportServlet

public java.lang.String getExportServlet()

setDynamicExport

public void setDynamicExport(boolean state,
                             java.lang.String serverName,
                             int serverPort,
                             java.lang.String servletDirectory)

EspressReport 6.6