com.crystaldecisions.report.web.viewer
Class CrystalReportViewerBase

java.lang.Object
  extended bycom.crystaldecisions.report.web.ServerControl
      extended bycom.crystaldecisions.report.web.viewer.ReportServerControl
          extended bycom.crystaldecisions.report.web.viewer.CrystalReportViewerBase
Direct Known Subclasses:
CrystalReportPartsViewer, 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.


Constructor Summary
CrystalReportViewerBase()
           
 
Method Summary
 void addAfterRenderContentEventListener(AfterRenderContentEventListener listener)
          This method is currently not supported.
 void addAfterRenderEventListener(AfterRenderEventListener listener)
          This method is currently not supported.
 void addAfterRenderObjectEventListener(AfterRenderObjectEventListener listener)
          This method is currently not supported.
 void addAfterRenderViewItemEventListener(IAfterRenderViewItemEventListener listener)
          This method is currently not supported.
 void addBeforeRenderContentEventListener(BeforeRenderContentEventListener listener)
          This method is currently not supported.
 void addBeforeRenderEventListener(BeforeRenderEventListener listener)
          This method is currently not supported.
 void addBeforeRenderObjectEventListener(BeforeRenderObjectEventListener listener)
          This method is currently not supported.
 void addBeforeRenderViewItemEventListener(IBeforeRenderViewItemEventListener listener)
          This method is currently not supported.
 void addDrillEventListener(DrillEventListener listener)
          Adds a listener for a drill event.
 void addOnRenderScriptEventListener(OnRenderScriptEventListener listener)
          Adds a listener for a OnRenderScriptEvent.
 void addOnRenderStyleEventListener(OnRenderStyleEventListener listener)
          Adds a listener for a OnRenderStyleEvent.
 java.lang.String getHyperlinkTarget()
          Returns the hyperlink target for displaying the HTML.
 void removeAfterRenderContentEventListener()
          This method is currently not supported.
 void removeAfterRenderEventListener()
          This method is currently not supported.
 void removeAfterRenderObjectEventListener()
          This method is currently not supported.
 void removeAfterRenderViewItemEventListener()
          This method is currently not supported.
 void removeBeforeRenderContentEventListener()
          This method is currently not supported.
 void removeBeforeRenderEventListener()
          This method is currently not supported.
 void removeBeforeRenderObjectEventListener()
          This method is currently not supported.
 void removeBeforeRenderViewItemEventListener()
          This method is currently not supported.
 void removeDrillEventListener()
          Removes the listener for a drill down event.
 void removeOnRenderScriptEventListener()
          Removes the listener for a OnRenderScriptEvent object.
 void removeOnRenderStyleEventListener()
          Removes the listener for a OnRenderStyleEvent object.
 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, getRenderingDPI, getReportSource, getReportSourceClassFactoryName, getSelectionFormula, getStyleSheetFileName, getViewTimeSelectionFormula, isEnableLogonPrompt, isEnableParameterPrompt, isReuseParameterValuesOnRefresh, navigateTo, refresh, removeReportPartBookmarkNavigationEventListener, removeReportPartBookmarkNavigationEventListenerr, removeReportSourceChangeEventListener, setDatabaseLogonInfos, setEnableLogonPrompt, setEnableParameterPrompt, setEnterpriseLogon, setParameterFields, setRenderingDPI, setReportSource, setReportSourceClassFactoryName, setReuseParameterValuesOnRefresh, setSelectionFormula, setStyleSheetFileName, setViewTimeSelectionFormula
 
Methods inherited from class com.crystaldecisions.report.web.ServerControl
getHeight, getHtmlContent, getLeft, getName, getProductLocale, getTop, getURI, getViewState, getWidth, isIgnoreViewStateOnLoad, isOwnForm, isOwnPage, processHttpRequest, setHeight, setIgnoreViewStateOnLoad, setLeft, setName, setOwnForm, setOwnPage, setProductLocale, setTop, setURI, setViewState, setWidth
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CrystalReportViewerBase

public CrystalReportViewerBase()
Method Detail

addAfterRenderContentEventListener

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

This method is currently not supported.

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

This method is currently not supported.

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

This method is currently not supported.

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

This method is currently not supported.

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

This method is currently not supported.

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

This method is currently not supported.

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

This method is currently not supported.

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

This method is currently not supported.

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 a drill event. The event is fired on drill down.

Parameters:
listener - The DrillEventListener.
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 a OnRenderScriptEvent. The event is fired before rendering the "SCRIPT" block.

Parameters:
listener - A OnRenderScriptEventListener.
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 a OnRenderStyleEvent. The event is fired before rendering the "STYLE" block.

Parameters:
listener - A OnRenderStyleEventListener.
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()

This method is currently not supported.

Removes the listener for a AfterRenderContentEvent object.

See Also:
addAfterRenderContentEventListener(com.crystaldecisions.report.htmlrender.AfterRenderContentEventListener)

removeAfterRenderEventListener

public void removeAfterRenderEventListener()

This method is currently not supported.

Removes the listener for a AfterRenderEvent object.

See Also:
addAfterRenderEventListener(com.crystaldecisions.report.htmlrender.AfterRenderEventListener)

removeAfterRenderObjectEventListener

public void removeAfterRenderObjectEventListener()

This method is currently not supported.

Removes the listener for a AfterRenderObjectEvent object.

See Also:
addAfterRenderObjectEventListener(com.crystaldecisions.report.htmlrender.AfterRenderObjectEventListener)

removeAfterRenderViewItemEventListener

public void removeAfterRenderViewItemEventListener()

This method is currently not supported.

Removes the listener for a AfterRenderViewItemEvent object.

See Also:
addAfterRenderViewItemEventListener(com.crystaldecisions.report.htmlrender.IAfterRenderViewItemEventListener)

removeBeforeRenderContentEventListener

public void removeBeforeRenderContentEventListener()

This method is currently not supported.

Removes the listener for a BeforeRenderContentEvent object.

See Also:
addBeforeRenderContentEventListener(com.crystaldecisions.report.htmlrender.BeforeRenderContentEventListener)

removeBeforeRenderEventListener

public void removeBeforeRenderEventListener()

This method is currently not supported.

Removes the listener for a BeforeRenderEvent object.

See Also:
addBeforeRenderEventListener(com.crystaldecisions.report.htmlrender.BeforeRenderEventListener)

removeBeforeRenderObjectEventListener

public void removeBeforeRenderObjectEventListener()

This method is currently not supported.

Removes the listener for a BeforeRenderObjectEvent object.

See Also:
addBeforeRenderObjectEventListener(com.crystaldecisions.report.htmlrender.BeforeRenderObjectEventListener)

removeBeforeRenderViewItemEventListener

public void removeBeforeRenderViewItemEventListener()

This method is currently not supported.

Removes the listener for a BeforeRenderViewItemEvent object.

See Also:
addBeforeRenderViewItemEventListener(com.crystaldecisions.report.htmlrender.IBeforeRenderViewItemEventListener)

removeDrillEventListener

public void removeDrillEventListener()

Removes the listener for a drill down event.

See Also:
addDrillEventListener

removeOnRenderScriptEventListener

public void removeOnRenderScriptEventListener()

Removes the listener for a OnRenderScriptEvent object.

See Also:
addOnRenderScriptEventListener(com.crystaldecisions.report.htmlrender.OnRenderScriptEventListener)

removeOnRenderStyleEventListener

public void removeOnRenderStyleEventListener()

Removes the listener for a OnRenderStyleEvent object.

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.

Note: This property only applies to hyperlinks in the report content. Hyperlinks that define viewer actions (such as group tree hyperlinks, toolbar button hyperlinks, or the Business Objects logo hyperlink) are not effected by this property.

Parameters:
target - A String that specifies the target for the hyperlink. By default the target is _self.
See Also:
getHyperlinkTarget