org.apache.batik.bridge
Interface UserAgent

All Known Implementing Classes:
ImageTranscoder.ImageTranscoderUserAgent, JSVGComponent.BridgeUserAgent, PrintTranscoder.PrintTranscoderUserAgent, UserAgentAdapter

public interface UserAgent

An interface that provides access to the User Agent informations needed by the bridge.


Method Summary
 void displayError(java.lang.Exception ex)
          Displays an error resulting from the specified Exception.
 void displayMessage(java.lang.String message)
          Displays a message in the User Agent interface.
 java.awt.Point getClientAreaLocationOnScreen()
          Returns the location on the screen of the client area in the UserAgent.
 EventDispatcher getEventDispatcher()
          Returns the event dispatcher to use.
 java.lang.String getLanguages()
          Returns the language settings.
 java.lang.String getMedia()
          Returns this user agent's CSS media.
 float getPixelToMM()
          Returns the pixel to mm factor.
 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.
 java.lang.String getXMLParserClassName()
          Returns the class name of the XML parser.
 void handleElement(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.
 void openLink(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 setSVGCursor(java.awt.Cursor cursor)
          Informs the user agent to change the cursor.
 boolean supportExtension(java.lang.String s)
          Tells whether the given extension is supported by this user agent.
 

Method Detail

getEventDispatcher

public EventDispatcher getEventDispatcher()
Returns the event dispatcher to use.

getViewportSize

public java.awt.geom.Dimension2D getViewportSize()
Returns the default size of the viewport.

displayError

public void displayError(java.lang.Exception ex)
Displays an error resulting from the specified Exception.

displayMessage

public void displayMessage(java.lang.String message)
Displays a message in the User Agent interface.

getPixelToMM

public float getPixelToMM()
Returns the pixel to mm factor.

getLanguages

public java.lang.String getLanguages()
Returns the language settings.

getUserStyleSheetURI

public java.lang.String getUserStyleSheetURI()
Returns the user stylesheet uri.
Returns:
null if no user style sheet was specified.

openLink

public void openLink(SVGAElement elt)
Opens a link.
Parameters:
elt - The activated link element.

setSVGCursor

public void setSVGCursor(java.awt.Cursor cursor)
Informs the user agent to change the cursor.
Parameters:
cursor - the new cursor

getXMLParserClassName

public java.lang.String getXMLParserClassName()
Returns the class name of the XML parser.

isXMLParserValidating

public boolean isXMLParserValidating()
Returns true if the XML parser must be in validation mode, false otherwise.

getTransform

public java.awt.geom.AffineTransform getTransform()
Returns the AffineTransform currently applied to the drawing by the UserAgent.

getMedia

public java.lang.String getMedia()
Returns this user agent's CSS media.

getClientAreaLocationOnScreen

public java.awt.Point getClientAreaLocationOnScreen()
Returns the location on the screen of the client area in the UserAgent.

hasFeature

public boolean hasFeature(java.lang.String s)
Tells whether the given feature is supported by this user agent.

supportExtension

public boolean supportExtension(java.lang.String s)
Tells whether the given extension is supported by this user agent.

registerExtension

public void registerExtension(BridgeExtension ext)
Lets the bridge tell the user agent that the following extension is supported by the bridge.

handleElement

public void handleElement(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.


Copyright © 2001 Apache Software Foundation. All Rights Reserved.