com.inet.viewer.SwingViewerContext

All Implemented Interfaces:: ViewerContext

public class SwingViewerContext extends Object implements ViewerContext

The default implementation of ViewerContext for i-net Clear Reports Viewer. This takes all errors and displays them in a small error dialog, and shows a simple info dialog when one is requested.

Note that most often the source given for an error will be a SwingReportView, allowing you to make further adjustments to your settings for that view.

For example, if an UnknownHostException comes for a ReportView, you might want to make an adjustment to the ReportView's RenderData object, making it fall back onto a backup report server instead of the original one:

class MyErrorHandler extends SwingViewerContext {
   public void showError( ViewerException e, Object source ) {
     if (source instanceof ReportView && e.getCause() instanceof UnknownHostException) {
       ((ReportView)source).getReportData().setReportLocation( "http://www.backupserver.com:9000/?report=file:backupreport.rpt" );
       ((ReportView)source).reload();
     }
   }

It is also possible you would like to add specific logging to all errors shown:

class MyErrorHandler extends SwingViewerContext { public void showError( ViewerException e, Object source ) { // ...log the error here... super.showError(e,source); }

Since:

7.1

See Also:

ReportViewer.setViewerContext(ViewerContext)

Constructor Summary

Constructors

Constructor

Description

SwingViewerContext(SwingReportViewer viewer)

Creates a SwingViewerContext with a reference to a SwingReportViewer which is used for example when parent components are needed for dialogs, etc.

SwingViewerContext(Component parent)

Creates a SwingViewerContext with a reference to a parent Component which is used for example when parent components are needed for dialogs, etc.
Method Summary

Modifier and Type

Method

Description

ExportProgress

export(ReportView view)

This method is called when the export action is to be performed.

ExportProgress

export(Component parent, RenderData data)

Opens the export dialog with the given parent as its parent and exports using the provided RenderData object.

ExportProgress

export(Component parent, RenderData data, PropertyChangeListener changeListener)

Opens the export dialog with the given parent as its parent and exports using the provided RenderData object.

SwingReportViewer

getViewer()

Returns the viewer to which this context belongs.

Progress

print(ReportView view)

This method is called when the print action is to be performed.

void

setViewer(SwingReportViewer viewer)

Sets the viewer to which this context belongs.

void

showError(Throwable e, Object source)

This method will be called whenever an error occurs and thereby allows the implementor of this interface to handle the error as seen fit.

void

showHelp(String helpPageKey, Component comp)

Opens a HelpPage with a key in a window that corresponds to the component.

void

showInfo()

Shows the info screen of this viewer.

boolean

showPrompts(PromptData[] prompts, RenderData data)

Handles a prompt request from the server.

void

showStatusMessage(ReportView view, String message, boolean isError)

Handled when a status message is to be displayed.

void

showUrl(String url, Properties props)

Handles opening a URL, e.g. a click on a hyperlink.

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

Constructor Details
- SwingViewerContext
  
  public SwingViewerContext(SwingReportViewer viewer)
  
  Creates a SwingViewerContext with a reference to a SwingReportViewer which is used for example when parent components are needed for dialogs, etc.
  
  Parameters:
  
  viewer - SwingReportViewer to which this context belongs.
  
  Since:
  
  7.1
- SwingViewerContext
  
  public SwingViewerContext(Component parent)
  
  Creates a SwingViewerContext with a reference to a parent Component which is used for example when parent components are needed for dialogs, etc.
  
  Parameters:
  
  parent - Parent to which this context belongs.
  
  Since:
  
  15.0
Method Details
- showInfo
  
  public void showInfo()
  
  Shows the info screen of this viewer.
  
  Specified by:
  
  showInfo in interface ViewerContext
  
  Since:
  
  7.0
- showError
  
  public void showError(Throwable e, Object source)
  
  This method will be called whenever an error occurs and thereby allows the implementor of this interface to handle the error as seen fit.
  
  Specified by:
  
  showError in interface ViewerContext
  
  Parameters:
  
  e - The Throwable of the error that actually occurred.
  
  source - The source where the exception occurred, such as the SwingReportView or SwingPageView.
  
  Since:
  
  7.0
- export
  
  public ExportProgress export(ReportView view)
  
  This method is called when the export action is to be performed. By default, this will show the export dialog and then export the currently visible report view's report with the settings given by the user.
  
  Specified by:
  
  export in interface ViewerContext
  
  Parameters:
  
  view - ReportView whose report is to be exported
  
  Returns:
  
  the progress
  
  Since:
  
  7.0
- export
  
  public ExportProgress export(Component parent, RenderData data, PropertyChangeListener changeListener)
  
  Opens the export dialog with the given parent as its parent and exports using the provided RenderData object. This method can be called without first initializing a ReportViewer if so desired. Note that this method is never called by the viewer itself, rather it is meant for you to call yourself if you want to export without initializing a viewer.
  
  Parameters:
  
  parent - Parent to display the dialog in
  
  data - RenderData to use for retrieving the export data
  
  changeListener - PropertyChangeListener that will be notified whenever a bean changes a "bound" property.
  
  Returns:
  
  the running export progress
  
  Since:
  
  7.6
- export
  
  public ExportProgress export(Component parent, RenderData data)
  
  Opens the export dialog with the given parent as its parent and exports using the provided RenderData object. This method can be called without first initializing a ReportViewer if so desired. Note that this method is never called by the viewer itself, rather it is meant for you to call yourself if you want to export without initializing a viewer.
  
  Parameters:
  
  parent - Parent to display the dialog in
  
  data - RenderData to use for retrieving the export data
  
  Returns:
  
  the running export progress
  
  Since:
  
  7.6
- print
  
  public Progress print(ReportView view)
  
  This method is called when the print action is to be performed. By default, this will show a print dialog and then print the given report view's report.
  
  Specified by:
  
  print in interface ViewerContext
  
  Parameters:
  
  view - ReportView whose report is to be printed.
  
  Returns:
  
  the progress
  
  Since:
  
  7.0
- showStatusMessage
  
  public void showStatusMessage(ReportView view, String message, boolean isError)
  
  Handled when a status message is to be displayed. Normally the implementor will display this message in the status bar.
  
  Specified by:
  
  showStatusMessage in interface ViewerContext
  
  Parameters:
  
  view - the ReportView which is to display the status message, must not be null
  
  message - the message to be displayed
  
  isError - true if the message is an error message, false otherwise.
  
  Since:
  
  8.1
- showUrl
  
  public void showUrl(String url, Properties props) throws MalformedURLException
  
  Handles opening a URL, e.g. a click on a hyperlink. Actually opening the link should run asynchronously, so it won't block the control flow.
  
  Specified by:
  
  showUrl in interface ViewerContext
  
  Parameters:
  
  url - String of the hyperlink URL which is to be shown. The length need to be > 0.
  
  props - Extra optional Properties for the URL connection (can be null for no extra properties)
  
  Throws:
  
  MalformedURLException - The supplied URL String is invalid.
- setViewer
  
  public void setViewer(SwingReportViewer viewer)
  
  Sets the viewer to which this context belongs.
  
  Parameters:
  
  viewer - the viewer to which this context belongs, can be null if the context is not to be bound to a viewer
  
  Since:
  
  9.0
- getViewer
  
  public SwingReportViewer getViewer()
  
  Returns the viewer to which this context belongs.
  
  Returns:
  
  the viewer to which this context belongs, or null if the context is not bound to a viewer
  
  Since:
  
  9.0
- showPrompts
  
  public boolean showPrompts(PromptData[] prompts, RenderData data)
  
  Handles a prompt request from the server. The chosen value of the prompts in the array must be set in the PromptData objects using PromptData.setChosenValues(Object).
  
  Specified by:
  
  showPrompts in interface ViewerContext
  
  Parameters:
  
  prompts - list of required prompts
  
  data - RenderData of the report requiring prompts
  
  Returns:
  
  true if prompts were successfully set, false if the prompt dialog was canceled
- showHelp
  
  public void showHelp(String helpPageKey, Component comp)
  
  Opens a HelpPage with a key in a window that corresponds to the component.
  
  Specified by:
  
  showHelp in interface ViewerContext
  
  Parameters:
  
  helpPageKey - key of the page to open
  
  comp - component to use when opening the window

Class SwingViewerContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

SwingViewerContext

SwingViewerContext

Method Details

showInfo

showError

export

export

export

print

showStatusMessage

showUrl

setViewer

getViewer

showPrompts

showHelp