Class JSVGComponent.BridgeUserAgent

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.util.Map extensions  
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected BridgeUserAgent()
      Creates a new user agent.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void checkLoadExternalResource​(ParsedURL resourceURL, ParsedURL docURL)
      This method throws a SecurityException if the resource found at url and referenced from docURL should not be loaded.
      void checkLoadScript​(java.lang.String scriptType, ParsedURL scriptURL, ParsedURL docURL)
      This method throws a SecurityException if the script of given type, found at url and referenced from docURL should not be loaded.
      void deselectAll()
      Informs the user agent that the text selection should be cleared.
      void displayError​(java.lang.Exception ex)
      Displays an error resulting from the specified Exception.
      void displayError​(java.lang.String message)
      Displays an error message in the User Agent interface.
      void displayMessage​(java.lang.String message)
      Displays a message in the User Agent interface.
      protected void fireLinkActivatedEvent​(org.w3c.dom.svg.SVGAElement elt, java.lang.String href)
      Fires a LinkActivatedEvent.
      java.lang.String getAlternateStyleSheet()
      Returns this user agent's alternate style-sheet title.
      float getBolderFontWeight​(float f)
      Returns a bolder font-weight.
      org.w3c.dom.svg.SVGDocument getBrokenLinkDocument​(org.w3c.dom.Element e, java.lang.String url, java.lang.String message)
      This implementation provides a true SVG Document that it annotates with some information about why the real document can't be loaded (unfortunately right now tool tips are broken for content referenced by images so you can't actually see the info).
      java.awt.Point getClientAreaLocationOnScreen()
      Returns the location on the screen of the client area in the UserAgent.
      java.lang.String getDefaultFontFamily()
      Returns the default font family.
      EventDispatcher getEventDispatcher()
      Returns the EventDispatcher used by the UserAgent to dispatch events on GVT.
      ExternalResourceSecurity getExternalResourceSecurity​(ParsedURL resourceURL, ParsedURL docURL)
      Returns the security settings for the given resource url and document url
      FontFamilyResolver getFontFamilyResolver()
      Returns the Font Family Resolver
      java.lang.String getLanguages()
      Returns the language settings.
      float getLighterFontWeight​(float f)
      Returns a lighter font-weight.
      java.lang.String getMedia()
      Returns this user agent's CSS media.
      float getMediumFontSize()
      Returns the medium font size.
      float getPixelToMM()
      Returns the size of a px CSS unit in millimeters.
      float getPixelUnitToMillimeter()
      Returns the size of a px CSS unit in millimeters.
      ScriptSecurity getScriptSecurity​(java.lang.String scriptType, ParsedURL scriptURL, ParsedURL docURL)
      Returns the security settings for the given script type, script url and document url
      float getSourceResolution()  
      java.awt.geom.AffineTransform getTransform()
      Returns the AffineTransform currently applied to the drawing by the UserAgent.
      java.lang.String getUserStyleSheetURI()
      Returns the user stylesheet uri.
      java.awt.geom.Dimension2D getViewportSize()
      Returns the default size of the viewport of this user agent (0, 0).
      java.lang.String getXMLParserClassName()
      Returns the class name of the XML parser.
      void handleElement​(org.w3c.dom.Element elt, java.lang.Object data)
      Notifies the UserAgent that the input element has been found in the document.
      boolean hasFeature​(java.lang.String s)
      Tells whether the given feature is supported by this user agent.
      boolean isXMLParserValidating()
      Returns true if the XML parser must be in validation mode, false otherwise depending on the SVGUserAgent.
      void loadDocument​(java.lang.String url)
      This method should load a new document described by the supplied URL.
      void openLink​(org.w3c.dom.svg.SVGAElement elt)
      Opens a link.
      void registerExtension​(BridgeExtension ext)
      Lets the bridge tell the user agent that the following extension is supported by the bridge.
      void setSourceResolution​(float sourceResolution)  
      void setSVGCursor​(java.awt.Cursor cursor)
      Informs the user agent to change the cursor.
      void setTextSelection​(Mark start, Mark end)
      Informs the user agent that the text selection has changed.
      void setTransform​(java.awt.geom.AffineTransform at)
      Sets the AffineTransform to be applied to the drawing by the UserAgent.
      void showAlert​(java.lang.String message)
      Shows an alert dialog box.
      boolean showConfirm​(java.lang.String message)
      Shows a confirm dialog box.
      java.lang.String showPrompt​(java.lang.String message)
      Shows a prompt dialog box.
      java.lang.String showPrompt​(java.lang.String message, java.lang.String defaultValue)
      Shows a prompt dialog box.
      boolean supportExtension​(java.lang.String s)
      Tells whether the given extension is supported by this user agent.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • extensions

        protected java.util.Map extensions
    • Constructor Detail

      • BridgeUserAgent

        protected BridgeUserAgent()
        Creates a new user agent.
    • Method Detail

      • getViewportSize

        public java.awt.geom.Dimension2D getViewportSize()
        Returns the default size of the viewport of this user agent (0, 0).
        Specified by:
        getViewportSize in interface UserAgent
      • displayError

        public void displayError​(java.lang.String message)
        Displays an error message in the User Agent interface.
      • displayError

        public void displayError​(java.lang.Exception ex)
        Displays an error resulting from the specified Exception.
        Specified by:
        displayError in interface UserAgent
      • displayMessage

        public void displayMessage​(java.lang.String message)
        Displays a message in the User Agent interface.
        Specified by:
        displayMessage in interface UserAgent
      • showAlert

        public void showAlert​(java.lang.String message)
        Shows an alert dialog box.
        Specified by:
        showAlert in interface UserAgent
      • showPrompt

        public java.lang.String showPrompt​(java.lang.String message)
        Shows a prompt dialog box.
        Specified by:
        showPrompt in interface UserAgent
      • showPrompt

        public java.lang.String showPrompt​(java.lang.String message,
                                           java.lang.String defaultValue)
        Shows a prompt dialog box.
        Specified by:
        showPrompt in interface UserAgent
      • showConfirm

        public boolean showConfirm​(java.lang.String message)
        Shows a confirm dialog box.
        Specified by:
        showConfirm in interface UserAgent
      • getPixelUnitToMillimeter

        public float getPixelUnitToMillimeter()
        Returns the size of a px CSS unit in millimeters.
        Specified by:
        getPixelUnitToMillimeter in interface UserAgent
      • getDefaultFontFamily

        public java.lang.String getDefaultFontFamily()
        Returns the default font family.
        Specified by:
        getDefaultFontFamily in interface UserAgent
      • getMediumFontSize

        public float getMediumFontSize()
        Returns the medium font size.
        Specified by:
        getMediumFontSize in interface UserAgent
      • getLighterFontWeight

        public float getLighterFontWeight​(float f)
        Returns a lighter font-weight.
        Specified by:
        getLighterFontWeight in interface UserAgent
      • getBolderFontWeight

        public float getBolderFontWeight​(float f)
        Returns a bolder font-weight.
        Specified by:
        getBolderFontWeight in interface UserAgent
      • getLanguages

        public java.lang.String getLanguages()
        Returns the language settings.
        Specified by:
        getLanguages in interface UserAgent
      • getUserStyleSheetURI

        public java.lang.String getUserStyleSheetURI()
        Returns the user stylesheet uri.
        Specified by:
        getUserStyleSheetURI in interface UserAgent
        Returns:
        null if no user style sheet was specified.
      • openLink

        public void openLink​(org.w3c.dom.svg.SVGAElement elt)
        Opens a link.
        Specified by:
        openLink in interface UserAgent
        Parameters:
        elt - The activated link element.
      • fireLinkActivatedEvent

        protected void fireLinkActivatedEvent​(org.w3c.dom.svg.SVGAElement elt,
                                              java.lang.String href)
        Fires a LinkActivatedEvent.
      • setSVGCursor

        public void setSVGCursor​(java.awt.Cursor cursor)
        Informs the user agent to change the cursor.
        Specified by:
        setSVGCursor in interface UserAgent
        Parameters:
        cursor - the new cursor
      • setTextSelection

        public void setTextSelection​(Mark start,
                                     Mark end)
        Informs the user agent that the text selection has changed.
        Specified by:
        setTextSelection in interface UserAgent
        Parameters:
        start - The Mark for the start of the selection.
        end - The Mark for the end of the selection.
      • deselectAll

        public void deselectAll()
        Informs the user agent that the text selection should be cleared.
        Specified by:
        deselectAll in interface UserAgent
      • getXMLParserClassName

        public java.lang.String getXMLParserClassName()
        Returns the class name of the XML parser.
        Specified by:
        getXMLParserClassName in interface UserAgent
      • isXMLParserValidating

        public boolean isXMLParserValidating()
        Returns true if the XML parser must be in validation mode, false otherwise depending on the SVGUserAgent.
        Specified by:
        isXMLParserValidating in interface UserAgent
      • getTransform

        public java.awt.geom.AffineTransform getTransform()
        Returns the AffineTransform currently applied to the drawing by the UserAgent.
        Specified by:
        getTransform in interface UserAgent
      • setTransform

        public void setTransform​(java.awt.geom.AffineTransform at)
        Sets the AffineTransform to be applied to the drawing by the UserAgent.
        Specified by:
        setTransform in interface UserAgent
      • getMedia

        public java.lang.String getMedia()
        Returns this user agent's CSS media.
        Specified by:
        getMedia in interface UserAgent
      • getAlternateStyleSheet

        public java.lang.String getAlternateStyleSheet()
        Returns this user agent's alternate style-sheet title.
        Specified by:
        getAlternateStyleSheet in interface UserAgent
      • getClientAreaLocationOnScreen

        public java.awt.Point getClientAreaLocationOnScreen()
        Returns the location on the screen of the client area in the UserAgent.
        Specified by:
        getClientAreaLocationOnScreen in interface UserAgent
      • hasFeature

        public boolean hasFeature​(java.lang.String s)
        Tells whether the given feature is supported by this user agent.
        Specified by:
        hasFeature in interface UserAgent
      • supportExtension

        public boolean supportExtension​(java.lang.String s)
        Tells whether the given extension is supported by this user agent.
        Specified by:
        supportExtension in interface UserAgent
      • registerExtension

        public void registerExtension​(BridgeExtension ext)
        Lets the bridge tell the user agent that the following extension is supported by the bridge.
        Specified by:
        registerExtension in interface UserAgent
      • handleElement

        public void handleElement​(org.w3c.dom.Element elt,
                                  java.lang.Object data)
        Notifies the UserAgent that the input element has been found in the document. This is sometimes called, for example, to handle <a> or <title> elements in a UserAgent-dependant way.
        Specified by:
        handleElement in interface UserAgent
      • getScriptSecurity

        public ScriptSecurity getScriptSecurity​(java.lang.String scriptType,
                                                ParsedURL scriptURL,
                                                ParsedURL docURL)
        Returns the security settings for the given script type, script url and document url
        Specified by:
        getScriptSecurity in interface UserAgent
        Parameters:
        scriptType - type of script, as found in the type attribute of the <script> element.
        scriptURL - url for the script, as defined in the script's xlink:href attribute. If that attribute was empty, then this parameter should be null
        docURL - url for the document into which the script was found.
      • checkLoadScript

        public void checkLoadScript​(java.lang.String scriptType,
                                    ParsedURL scriptURL,
                                    ParsedURL docURL)
                             throws java.lang.SecurityException
        This method throws a SecurityException if the script of given type, found at url and referenced from docURL should not be loaded. This is a convenience method to call checkLoadScript on the ScriptSecurity strategy returned by getScriptSecurity.
        Specified by:
        checkLoadScript in interface UserAgent
        Parameters:
        scriptType - type of script, as found in the type attribute of the <script> element.
        scriptURL - url for the script, as defined in the script's xlink:href attribute. If that attribute was empty, then this parameter should be null
        docURL - url for the document into which the script was found.
        Throws:
        java.lang.SecurityException
      • getExternalResourceSecurity

        public ExternalResourceSecurity getExternalResourceSecurity​(ParsedURL resourceURL,
                                                                    ParsedURL docURL)
        Returns the security settings for the given resource url and document url
        Specified by:
        getExternalResourceSecurity in interface UserAgent
        Parameters:
        resourceURL - url for the script, as defined in the resource's xlink:href attribute. If that attribute was empty, then this parameter should be null
        docURL - url for the document into which the script was found.
      • checkLoadExternalResource

        public void checkLoadExternalResource​(ParsedURL resourceURL,
                                              ParsedURL docURL)
                                       throws java.lang.SecurityException
        This method throws a SecurityException if the resource found at url and referenced from docURL should not be loaded. This is a convenience method to call checkLoadExternalResource on the ExternalResourceSecurity strategy returned by getExternalResourceSecurity.
        Specified by:
        checkLoadExternalResource in interface UserAgent
        Parameters:
        resourceURL - url for the resource, as defined in the resource's xlink:href attribute. If that attribute was empty, then this parameter should be null
        docURL - url for the document into which the resource was found.
        Throws:
        java.lang.SecurityException
      • getBrokenLinkDocument

        public org.w3c.dom.svg.SVGDocument getBrokenLinkDocument​(org.w3c.dom.Element e,
                                                                 java.lang.String url,
                                                                 java.lang.String message)
        This implementation provides a true SVG Document that it annotates with some information about why the real document can't be loaded (unfortunately right now tool tips are broken for content referenced by images so you can't actually see the info).
        Specified by:
        getBrokenLinkDocument in interface UserAgent
        Parameters:
        e - The <image> element that can't be loaded.
        url - The resolved url that can't be loaded.
        message - As best as can be determined the reason it can't be loaded (not available, corrupt, unknown format,...).
      • loadDocument

        public void loadDocument​(java.lang.String url)
        This method should load a new document described by the supplied URL.
        Specified by:
        loadDocument in interface UserAgent
        Parameters:
        url - The url to be loaded as a string.
      • setSourceResolution

        public void setSourceResolution​(float sourceResolution)
        Specified by:
        setSourceResolution in interface UserAgent