com.crystaldecisions.report.web.viewer
Class CrystalReportViewerBase

java.lang.Object
  |
  +--com.crystaldecisions.report.web.ServerControl
        |
        +--com.crystaldecisions.report.web.viewer.ReportServerControl
              |
              +--com.crystaldecisions.report.web.viewer.CrystalReportViewerBase

Direct Known Subclasses:

CrystalReportViewer

public abstract class CrystalReportViewerBase

extends ReportServerControl

This class provides listeners for the report viewer, as well as providing methods for getting and setting hyperlink targets.

Field Summary

static int	BACKWARD Reserved for future use.
static int	FORWARD Search direction as forward.
static int	NOACTION Reserved for future use.

Constructor Summary

CrystalReportViewerBase()

Method Summary

void	addAfterRenderContentEventListener(AfterRenderContentEventListener listener) Adds a listener for AfterRenderContentEvents.
void	addAfterRenderEventListener(AfterRenderEventListener listener) Adds a listener for AfterRenderEvents.
void	addAfterRenderObjectEventListener(AfterRenderObjectEventListener listener) Adds a listener for AfterRenderObjectEvents.
void	addAfterRenderViewItemEventListener(IAfterRenderViewItemEventListener listener) Adds a listener for AfterRenderViewItemEvents.
void	addBeforeRenderContentEventListener(BeforeRenderContentEventListener listener) Adds a listener for BeforeRenderContentEvents.
void	addBeforeRenderEventListener(BeforeRenderEventListener listener) Adds a listener for BeforeRenderEvents.
void	addBeforeRenderObjectEventListener(BeforeRenderObjectEventListener listener) Adds a listener for BeforeRenderObjectEvents.
void	addBeforeRenderViewItemEventListener(IBeforeRenderViewItemEventListener listener) Adds a listener for BeforeRenderViewItemEvents.
void	addDrillEventListener(DrillEventListener listener) Adds a listener for DrillEvents.
void	addOnRenderScriptEventListener(OnRenderScriptEventListener listener) Adds a listener for OnRenderScriptEvents.
void	addOnRenderStyleEventListener(OnRenderStyleEventListener listener) Adds a listener for OnRenderStyleEvents.
java.lang.String	getHyperlinkTarget() Returns the hyperlink target for displaying the HTML.
void	removeAfterRenderContentEventListener() Removes the listener for AfterRenderContentEvents.
void	removeAfterRenderEventListener() Removes the listener for AfterRenderEvents.
void	removeAfterRenderObjectEventListener() Removes the listener for AfterRenderObjectEvents.
void	removeAfterRenderViewItemEventListener() Removes the listener for AfterRenderViewItemEvents.
void	removeBeforeRenderContentEventListener() Removes the listener for BeforeRenderContentEvents.
void	removeBeforeRenderEventListener() Removes the listener for BeforeRenderEvents.
void	removeBeforeRenderObjectEventListener() Removes the listener for BeforeRenderObjectEvents.
void	removeBeforeRenderViewItemEventListener() Removes the listener for BeforeRenderViewItemEvents.
void	removeDrillEventListener() Removes the listener for DrillEvents.
void	removeOnRenderScriptEventListener() Removes the listener for OnRenderScriptEvents.
void	removeOnRenderStyleEventListener() Removes the listener for OnRenderStyleEvents.
void	setHyperlinkTarget(java.lang.String target) Sets the hyperlink target for displaying the HTML.

Methods inherited from class com.crystaldecisions.report.web.viewer.ReportServerControl

addReportPartBookmarkNavigationEventListener, addReportSourceChangeEventListener, dispose, getDatabaseLogonInfos, getEnterpriseLogon, getParameterFields, getReportSource, getReportSourceClassFactoryName, getSelectionFormula, getStyleSheetFileName, isEnableLogonPrompt, isEnableParameterPrompt, isReuseParameterValuesOnRefresh, navigateTo, refresh, removeReportPartBookmarkNavigationEventListener, removeReportPartBookmarkNavigationEventListenerr, removeReportSourceChangeEventListener, setDatabaseLogonInfos, setEnableLogonPrompt, setEnableParameterPrompt, setEnterpriseLogon, setParameterFields, setReportSource, setReportSourceClassFactoryName, setReuseParameterValuesOnRefresh, setSelectionFormula, setStyleSheetFileName, setURI, setViewTimeSelectionFormula

Methods inherited from class com.crystaldecisions.report.web.ServerControl

deserializeBase64ToObject, getHeight, getHtmlContent, getLeft, getName, getTop, getURI, getViewState, getWidth, isIgnoreViewStateOnLoad, isOwnForm, isOwnPage, processHttpRequest, setHeight, setIgnoreViewStateOnLoad, setLeft, setName, setOwnForm, setOwnPage, setTop, setViewState, setWidth

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FORWARD

public static final int FORWARD

Search direction as forward.

See Also:

Constant Field Values

BACKWARD

public static final int BACKWARD

Reserved for future use.

See Also:

Constant Field Values

NOACTION

public static final int NOACTION

Reserved for future use.

See Also:

Constant Field Values

Constructor Detail

CrystalReportViewerBase

public CrystalReportViewerBase()

Method Detail

addAfterRenderContentEventListener

public void addAfterRenderContentEventListener(AfterRenderContentEventListener listener)
                                        throws java.util.TooManyListenersException

Adds a listener for AfterRenderContentEvents. The event is fired after rendering the body of the report is complete.

Parameters:

listener - The AfterRenderContentEvent listener.

Throws:

TooManyListenersException - This is thrown if you attempt to add more than one listener on a particular event listener source concurrently.

See Also:

removeAfterRenderContentEventListener()

addAfterRenderEventListener

public void addAfterRenderEventListener(AfterRenderEventListener listener)
                                 throws java.util.TooManyListenersException

Adds a listener for AfterRenderEvents. The event is fired after the rendering process is complete.

Parameters:

listener - The AfterRenderEvent listener.

Throws:

TooManyListenersException - This is thrown if you attempt to add more than one listener on a particular event listener source concurrently.

See Also:

removeAfterRenderEventListener()

addAfterRenderObjectEventListener

public void addAfterRenderObjectEventListener(AfterRenderObjectEventListener listener)
                                       throws java.util.TooManyListenersException

Adds a listener for AfterRenderObjectEvents. The event is fired after rendering the report object.

Parameters:

listener - The AfterRenderObjectEvent listener.

Throws:

TooManyListenersException - This is thrown if you attempt to add more than one listener on a particular event listener source concurrently.

See Also:

removeAfterRenderObjectEventListener()

addAfterRenderViewItemEventListener

public void addAfterRenderViewItemEventListener(IAfterRenderViewItemEventListener listener)
                                         throws java.util.TooManyListenersException

Adds a listener for AfterRenderViewItemEvents. The event is fired after rendering a viewer item (Toolbar, GroupTree, or Page).

Parameters:

listener - The AfterRenderViewItemEvent listener.

Throws:

TooManyListenersException - This is thrown if you attempt to add more than one listener on a particular event listener source concurrently.

See Also:

removeAfterRenderViewItemEventListener()

addBeforeRenderContentEventListener

public void addBeforeRenderContentEventListener(BeforeRenderContentEventListener listener)
                                         throws java.util.TooManyListenersException

Adds a listener for BeforeRenderContentEvents. The event is fired before rendering the body of the report is complete.

Parameters:

listener - The BeforeRenderContentEvent listener.

Throws:

TooManyListenersException - This is thrown if you attempt to add more than one listener on a particular event listener source concurrently.

See Also:

removeBeforeRenderContentEventListener()

addBeforeRenderEventListener

public void addBeforeRenderEventListener(BeforeRenderEventListener listener)
                                  throws java.util.TooManyListenersException

Adds a listener for BeforeRenderEvents. The event is fired before the rendering process begins.

Parameters:

listener - The BeforeRenderEvent listener.

Throws:

TooManyListenersException - This is thrown if you attempt to add more than one listener on a particular event listener source concurrently.

See Also:

removeBeforeRenderEventListener()

addBeforeRenderObjectEventListener

public void addBeforeRenderObjectEventListener(BeforeRenderObjectEventListener listener)
                                        throws java.util.TooManyListenersException

Adds a listener for BeforeRenderObjectEvents. The event is fired before rendering the report object.

Parameters:

listener - The BeforeRenderObjectEvent listener.

Throws:

TooManyListenersException - This is thrown if you attempt to add more than one listener on a particular event listener source concurrently.

See Also:

removeBeforeRenderObjectEventListener()

addBeforeRenderViewItemEventListener

public void addBeforeRenderViewItemEventListener(IBeforeRenderViewItemEventListener listener)
                                          throws java.util.TooManyListenersException

Adds a listener for BeforeRenderViewItemEvents. The event is fired before rendering a viewer item (Toolbar, GroupTree, or Page).

Parameters:

listener - The BeforeRenderViewItemEvent listener.

Throws:

TooManyListenersException - This is thrown if you attempt to add more than one listener on a particular event listener source concurrently.

See Also:

removeBeforeRenderViewItemEventListener()

addDrillEventListener

public void addDrillEventListener(DrillEventListener listener)
                           throws java.util.TooManyListenersException

Adds a listener for DrillEvents. The event is fired on drill down.

Parameters:

listener - The DrillEvent listener.

Throws:

TooManyListenersException - This is thrown if you attempt to add more than one listener on a particular event listener source concurrently.

See Also:

removeDrillEventListener

addOnRenderScriptEventListener

public void addOnRenderScriptEventListener(OnRenderScriptEventListener listener)
                                    throws java.util.TooManyListenersException

Adds a listener for OnRenderScriptEvents. The event is fired before rendering the "SCRIPT" block.

Parameters:

listener - The OnRenderScriptEvent listener.

Throws:

TooManyListenersException - This is thrown if you attempt to add more than one listener on a particular event listener source concurrently.

See Also:

removeOnRenderScriptEventListener()

addOnRenderStyleEventListener

public void addOnRenderStyleEventListener(OnRenderStyleEventListener listener)
                                   throws java.util.TooManyListenersException

Adds a listener for OnRenderStyleEvents. The event is fired before rendering the "STYLE" block.

Parameters:

listener - OnRenderStyleEvents listener.

Throws:

TooManyListenersException - This is thrown if you attempt to add more than one listener on a particular event listener source concurrently.

See Also:

removeOnRenderStyleEventListener()

getHyperlinkTarget

public java.lang.String getHyperlinkTarget()

Returns the hyperlink target for displaying the HTML.

The target _self displays the HTML document in the same frame, the target _parent displays the HTML document in the same frame or window that contains the current frameset, the target _top displays the HTML document in the entire browser window, and the target _blank to displays the HTML document in a new browser window.

Returns:

The hyperlink target as a String. By default the target is _self.

See Also:

setHyperlinkTarget

removeAfterRenderContentEventListener

public void removeAfterRenderContentEventListener()

Removes the listener for AfterRenderContentEvents.

See Also:

addAfterRenderContentEventListener(com.crystaldecisions.report.htmlrender.AfterRenderContentEventListener)

removeAfterRenderEventListener

public void removeAfterRenderEventListener()

Removes the listener for AfterRenderEvents.

See Also:

addAfterRenderEventListener(com.crystaldecisions.report.htmlrender.AfterRenderEventListener)

removeAfterRenderObjectEventListener

public void removeAfterRenderObjectEventListener()

Removes the listener for AfterRenderObjectEvents.

See Also:

addAfterRenderObjectEventListener(com.crystaldecisions.report.htmlrender.AfterRenderObjectEventListener)

removeAfterRenderViewItemEventListener

public void removeAfterRenderViewItemEventListener()

Removes the listener for AfterRenderViewItemEvents.

See Also:

addAfterRenderViewItemEventListener(com.crystaldecisions.report.htmlrender.IAfterRenderViewItemEventListener)

removeBeforeRenderContentEventListener

public void removeBeforeRenderContentEventListener()

Removes the listener for BeforeRenderContentEvents.

See Also:

addBeforeRenderContentEventListener(com.crystaldecisions.report.htmlrender.BeforeRenderContentEventListener)

removeBeforeRenderEventListener

public void removeBeforeRenderEventListener()

Removes the listener for BeforeRenderEvents.

See Also:

addBeforeRenderEventListener(com.crystaldecisions.report.htmlrender.BeforeRenderEventListener)

removeBeforeRenderObjectEventListener

public void removeBeforeRenderObjectEventListener()

Removes the listener for BeforeRenderObjectEvents.

See Also:

addBeforeRenderObjectEventListener(com.crystaldecisions.report.htmlrender.BeforeRenderObjectEventListener)

removeBeforeRenderViewItemEventListener

public void removeBeforeRenderViewItemEventListener()

Removes the listener for BeforeRenderViewItemEvents.

See Also:

addBeforeRenderViewItemEventListener(com.crystaldecisions.report.htmlrender.IBeforeRenderViewItemEventListener)

removeDrillEventListener

public void removeDrillEventListener()

Removes the listener for DrillEvents.

See Also:

addDrillEventListener

removeOnRenderScriptEventListener

public void removeOnRenderScriptEventListener()

Removes the listener for OnRenderScriptEvents.

See Also:

addOnRenderScriptEventListener(com.crystaldecisions.report.htmlrender.OnRenderScriptEventListener)

removeOnRenderStyleEventListener

public void removeOnRenderStyleEventListener()

Removes the listener for OnRenderStyleEvents.

See Also:

addOnRenderStyleEventListener(com.crystaldecisions.report.htmlrender.OnRenderStyleEventListener)

setHyperlinkTarget

public void setHyperlinkTarget(java.lang.String target)

Sets the hyperlink target for displaying the HTML.

Use the target _self to display the HTML document in the same frame, _parent to display HTML document in the same frame or window that contains the current frameset, _top to display HTML document in the entire browser window, and _blank to display HTML document in a new browser window.

Parameters:

target - A String that specifies the target for the hyperlink. By default the target is _self.

See Also:

getHyperlinkTarget