Class JSVGCanvas.CanvasUserAgent

java.lang.Object
org.apache.batik.swing.svg.JSVGComponent.BridgeUserAgent
org.apache.batik.swing.JSVGCanvas.CanvasUserAgent
All Implemented Interfaces:
UserAgent, XMLConstants
Enclosing class:
JSVGCanvas

protected class JSVGCanvas.CanvasUserAgent extends JSVGComponent.BridgeUserAgent implements XMLConstants
The CanvasUserAgent only adds tooltips to the behavior of the default BridgeUserAgent. A tooltip will be displayed wheneven the mouse lingers over an element which has a <title> or a <desc> child element.
  • Constructor Details

    • CanvasUserAgent

      protected CanvasUserAgent()
  • Method Details

    • handleElement

      public void handleElement(Element elt, Object data)
      The handleElement method builds a tool tip from the content of a <title> element, a <desc> element or both.
      Because these elements can appear in any order, here is the algorithm used to build the tool tip:
      • If a <title> is passed to handleElement the method checks if there is a >desc> peer. If there is one, nothing is done (because the desc will do it). If there in none, the tool tip is set to the value of the <title> element content.
      • If a <desc> is passed to handleElement the method checks if there is a <title> peer. If there is one, the content of that peer is pre-pended to the content of the <desc> element.
      Specified by:
      handleElement in interface UserAgent
      Overrides:
      handleElement in class JSVGComponent.BridgeUserAgent
    • toFormattedHTML

      public String toFormattedHTML(String str)
      Converts line breaks to HTML breaks and encodes special entities. Poor way of replacing '<', '>' and '&' in content.
    • replace

      protected void replace(StringBuffer sb, char c, String r)
    • getPeerWithTag

      public Element getPeerWithTag(Element parent, String nameSpaceURI, String localName)
      Checks if there is a peer element of a given type. This returns the first occurence of the given type or null if none is found.
    • hasPeerWithTag

      public boolean hasPeerWithTag(Element elt, String nameSpaceURI, String localName)
      Returns a boolean defining whether or not there is a peer of elt with the given qualified tag.
    • setToolTip

      public void setToolTip(Element elt, String toolTip)
      Sets the tool tip on the input element.
    • removeToolTip

      public void removeToolTip(Element elt)
    • displayError

      public void displayError(String message)
      Displays an error message in the User Agent interface.
      Overrides:
      displayError in class JSVGComponent.BridgeUserAgent
    • displayError

      public void displayError(Exception ex)
      Displays an error resulting from the specified Exception.
      Specified by:
      displayError in interface UserAgent
      Overrides:
      displayError in class JSVGComponent.BridgeUserAgent