Class DefaultDocumentListener

  • All Implemented Interfaces:
    DocumentListener

    public class DefaultDocumentListener
    extends java.lang.Object
    implements DocumentListener
    Default, do-nothing implementation of a DocumentListener; implements all methods in DocumentListener but the methods do nothing. Subclass this class and override whichever methods you need to trap.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void documentLoaded()
      Indicates document layout has complete, e.g.
      void documentStarted()
      Indicates document has been requested (e.g.
      void onLayoutException​(java.lang.Throwable t)
      Called when document layout failed with an exception.
      void onRenderException​(java.lang.Throwable t)
      Called when document render failed with an exception.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • DefaultDocumentListener

        public DefaultDocumentListener()
    • Method Detail

      • documentStarted

        public void documentStarted()
        Indicates document has been requested (e.g. a new document is going to be loaded). This will be called before any activity takes place for the document.
        Specified by:
        documentStarted in interface DocumentListener
      • documentLoaded

        public void documentLoaded()
        Indicates document layout has complete, e.g. document is fully "loaded" for display; this is not a callback for the document source (e.g. XML) being loaded. This method will be called on every layout run (including, for example, after panel resizes).
        Specified by:
        documentLoaded in interface DocumentListener
      • onLayoutException

        public void onLayoutException​(java.lang.Throwable t)
        Called when document layout failed with an exception. All Throwable objects thrown (except for ThreadDeath) during layout and not otherwise handled will be provided to this method. If a DocumentListener has been defined an XHTML panel, the listener is entirely responsible for handling the exception. No other action will be taken.
        Specified by:
        onLayoutException in interface DocumentListener
      • onRenderException

        public void onRenderException​(java.lang.Throwable t)
        Called when document render failed with an exception. All Throwable objects thrown (except for ThreadDeath) during render and not otherwise handled will be provided to this method. If a DocumentListener has been defined an XHTML panel, the listener is entirely responsible for handling the exception. No other action will be taken.
        Specified by:
        onRenderException in interface DocumentListener