Klasse SwingViewerContext

java.lang.Object
com.inet.viewer.SwingViewerContext
Alle implementierten Schnittstellen:
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);
  }

Seit:
7.1
Siehe auch:

  • Konstruktordetails

    • 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.
      Parameter:
      viewer - SwingReportViewer to which this context belongs.
      Seit:
      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.
      Parameter:
      parent - Parent to which this context belongs.
      Seit:
      15.0

  • Methodendetails

    • showInfo

      public void showInfo()
      Shows the info screen of this viewer.
      Angegeben von:
      showInfo in Schnittstelle ViewerContext
      Seit:
      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.
      Angegeben von:
      showError in Schnittstelle ViewerContext
      Parameter:
      e - The Throwable of the error that actually occurred.
      source - The source where the exception occurred, such as the SwingReportView or SwingPageView.
      Seit:
      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.
      Angegeben von:
      export in Schnittstelle ViewerContext
      Parameter:
      view - ReportView whose report is to be exported
      Gibt zurück:
      the progress
      Seit:
      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.
      Parameter:
      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.
      Gibt zurück:
      the running export progress
      Seit:
      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.
      Parameter:
      parent - Parent to display the dialog in
      data - RenderData to use for retrieving the export data
      Gibt zurück:
      the running export progress
      Seit:
      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.
      Angegeben von:
      print in Schnittstelle ViewerContext
      Parameter:
      view - ReportView whose report is to be printed.
      Gibt zurück:
      the progress
      Seit:
      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.
      Angegeben von:
      showStatusMessage in Schnittstelle ViewerContext
      Parameter:
      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.
      Seit:
      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.
      Angegeben von:
      showUrl in Schnittstelle ViewerContext
      Parameter:
      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)
      Löst aus:
      MalformedURLException - The supplied URL String is invalid.

    • setViewer

      public void setViewer(SwingReportViewer viewer)
      Sets the viewer to which this context belongs.
      Parameter:
      viewer - the viewer to which this context belongs, can be null if the context is not to be bound to a viewer
      Seit:
      9.0

    • getViewer

      public SwingReportViewer getViewer()
      Returns the viewer to which this context belongs.
      Gibt zurück:
      the viewer to which this context belongs, or null if the context is not bound to a viewer
      Seit:
      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).
      Angegeben von:
      showPrompts in Schnittstelle ViewerContext
      Parameter:
      prompts - list of required prompts
      data - RenderData of the report requiring prompts
      Gibt zurück:
      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.
      Angegeben von:
      showHelp in Schnittstelle ViewerContext
      Parameter:
      helpPageKey - key of the page to open
      comp - component to use when opening the window