quadbase.reportdesigner.ReportViewer.swing

Class Viewer

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Panel

java.applet.Applet

javax.swing.JApplet

quadbase.reportdesigner.ReportViewer.swing.CApplet

quadbase.reportdesigner.ReportViewer.swing.Viewer

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer

public class Viewer
extends quadbase.reportdesigner.ReportViewer.swing.CApplet

This class provides the mechanism for viewing a report object (one that implements Interface IReport), in either an application or an applet environment.

The most common use of this Viewer class is getting a Component Object from a IReport Object:

Component c = (new Viewer()).getComponent(report);

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JApplet

javax.swing.JApplet.AccessibleJApplet

Nested classes/interfaces inherited from class java.applet.Applet

java.applet.Applet.AccessibleApplet

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

java.awt.Panel.AccessibleAWTPanel

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

java.awt.Container.AccessibleAWTContainer

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 inherited from class javax.swing.JApplet

accessibleContext, rootPane, rootPaneCheckingEnabled

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

Constructors

Constructor and Description
Viewer()

Method Summary

Modifier and Type	Method and Description
void	destroy() For internal use only
java.awt.Component	getComponent(IReport report) Returns a Component that displays the report.
java.awt.Component	getComponent(IReport report, int scrollBarOption) Returns a Component that displays the report, with the specified scroll bar option
ReportCanvas	getReportCanvas() Gets the ReportCanvas object associated with this viewer
void	init() For internal use only
static void	main(java.lang.String[] argv) internal use only
void	setBackMenuItemVisible(boolean b) Sets the visibility of the Back Menu Item.
void	setCanvasBackgroundColor(java.awt.Color color) Sets the Canvas Background color of the viewed application or applet.
void	setDynamicExport(boolean state, java.lang.String serverName, int serverPort, java.lang.String servletDirectory) Sets the attributes for a dynamic export (when using setExportServlet)
void	setExportServlet(java.lang.String url) Sets the url to the ViewerExportServlet, which is used for exporting to a servlet that streams back content to the client via a browser url
void	setGoToMenuItemVisible(boolean b) Sets the visibility of the Go To Menu Item.
void	setMenuVisible(boolean b) Sets the visibility of the Menu.
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 a MouseMotionListener to be used with the Viewer.
void	setMultiDrillDownVisible(boolean b) Sets the visibility of Multi Drill Down.
void	setOutputMenuItemVisible(java.lang.String[] menuItem, boolean b) Sets the visibility of some particular menu item(s) on the Output Menu.
void	setOutputMenuVisible(boolean b) Sets the visibility of the Output Menu.
void	setPageMenuItemVisible(java.lang.String[] menuItem, boolean b) Sets the visibility of some particular menuitem(s) on the page Menu.
void	setPageMenuVisible(boolean b) Sets the visibility of the Page Menu.
void	setRefreshMenuItemVisible(boolean b) Sets the visibility of the Refresh Menu Item.
void	setReportMain(quadbase.reportdesigner.util.IReportMain reportMain) internal use only.
void	setSectionMenuVisible(boolean b) Sets the visibility of the Section Menu.
void	setSectionoMenuItemVisible(java.lang.String[] menuItem, boolean b) Sets the visibility of some particular menu item(s).
void	setSortMenuVisible(boolean b) Sets the visibility of the Sort Menu.
void	setToolBarMenuVisible(boolean b) sets the display status of toolbar menu item in popup menu
void	setZoomMenuItemVisible(boolean b) Sets the visibility of the Zoom Menu Item.
void	start() For internal use only
void	stop() For internal use only

Methods inherited from class quadbase.reportdesigner.ReportViewer.swing.CApplet

add, add, setBorderLayout

Methods inherited from class javax.swing.JApplet

addImpl, createRootPane, getAccessibleContext, getContentPane, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isRootPaneCheckingEnabled, paramString, remove, repaint, setContentPane, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.applet.Applet

getAppletContext, getAppletInfo, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getImage, getLocale, getParameter, getParameterInfo, isActive, isValidateRoot, newAudioClip, play, play, resize, resize, setStub, showStatus

Methods inherited from class java.awt.Panel

addNotify

Methods inherited from class java.awt.Container

add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Viewer

public Viewer()

Method Detail

getComponent

public java.awt.Component getComponent(IReport report)

Returns a Component that displays the report.

getComponent

public java.awt.Component getComponent(IReport report,
                                       int scrollBarOption)

Returns a Component that displays the report, with the specified scroll bar option

getReportCanvas

public ReportCanvas getReportCanvas()

Gets the ReportCanvas object associated with this viewer

init

public void init()

For internal use only

Overrides:

init in class java.applet.Applet

start

public void start()

For internal use only

Overrides:

start in class java.applet.Applet

destroy

public void destroy()

For internal use only

Overrides:

destroy in class java.applet.Applet

stop

public void stop()

For internal use only

Overrides:

stop in class java.applet.Applet

main

public static void main(java.lang.String[] argv)

internal use only

setReportMain

public void setReportMain(quadbase.reportdesigner.util.IReportMain reportMain)

internal use only. Sets the main report used.

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 a MouseMotionListener to be used with the Viewer.

setCanvasBackgroundColor

public void setCanvasBackgroundColor(java.awt.Color color)

Sets the Canvas Background color of the viewed application or applet.

setMenuVisible

public void setMenuVisible(boolean b)

Sets the visibility of the Menu.

setSectionMenuVisible

public void setSectionMenuVisible(boolean b)

Sets the visibility of the Section Menu.

setSectionoMenuItemVisible

public void setSectionoMenuItemVisible(java.lang.String[] menuItem,
                                       boolean b)

Sets the visibility of some particular menu item(s).

setPageMenuVisible

public void setPageMenuVisible(boolean b)

Sets the visibility of the Page Menu.

setPageMenuItemVisible

public void setPageMenuItemVisible(java.lang.String[] menuItem,
                                   boolean b)

Sets the visibility of some particular menuitem(s) on the page Menu.

setOutputMenuVisible

public void setOutputMenuVisible(boolean b)

Sets the visibility of the Output Menu.

setOutputMenuItemVisible

public void setOutputMenuItemVisible(java.lang.String[] menuItem,
                                     boolean b)

Sets the visibility of some particular menu item(s) on the Output Menu.

setBackMenuItemVisible

public void setBackMenuItemVisible(boolean b)

Sets the visibility of the Back Menu Item.

setRefreshMenuItemVisible

public void setRefreshMenuItemVisible(boolean b)

Sets the visibility of the Refresh Menu Item.

setGoToMenuItemVisible

public void setGoToMenuItemVisible(boolean b)

Sets the visibility of the Go To Menu Item.

setZoomMenuItemVisible

public void setZoomMenuItemVisible(boolean b)

Sets the visibility of the Zoom Menu Item.

setSortMenuVisible

public void setSortMenuVisible(boolean b)

Sets the visibility of the Sort Menu.

setMultiDrillDownVisible

public void setMultiDrillDownVisible(boolean b)

Sets the visibility of Multi Drill Down.

setToolBarMenuVisible

public void setToolBarMenuVisible(boolean b)

sets the display status of toolbar menu item in popup menu

setDynamicExport

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

Sets the attributes for a dynamic export (when using setExportServlet)

Parameters:

state - whether to use dynamic export

serverName - the name of the server with the dynamic export servlets

serverPort - the port number of the server with the dynamic export servlets

servletDirectory - the servlet context to the server with the dynamic export servlets

setExportServlet

public void setExportServlet(java.lang.String url)

Sets the url to the ViewerExportServlet, which is used for exporting to a servlet that streams back content to the client via a browser url

Parameters:

url - the url to the servlet, for example: "http://localhost:8080/servlet/ViewerExportServlet"