org.apache.batik.bridge
Class UserAgentAdapter

java.lang.Object
  |
  +--org.apache.batik.bridge.UserAgentAdapter

All Implemented Interfaces:

UserAgent

Direct Known Subclasses:

SVGAbstractTranscoder.SVGAbstractTranscoderUserAgent

public class UserAgentAdapter

extends java.lang.Object

implements UserAgent

An abstract user agent adaptor implementation. It exists to simply the creation of UserAgent instances.

Field Summary

protected java.util.Set	extensions
protected java.util.Set	FEATURES

Constructor Summary

UserAgentAdapter()

Method Summary

void	addStdFeatures()
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	displayError(java.lang.Exception e) Display the specified error (forwards call to displayError(String))
void	displayError(java.lang.String message) Display the specified error message (forwards call to displayMessage).
void	displayMessage(java.lang.String message) Display the specified message.
java.lang.String	getAlternateStyleSheet() Returns this user agent's alternate style-sheet title.
float	getBolderFontWeight(float f) Returns a bolder font-weight.
java.awt.Point	getClientAreaLocationOnScreen() Unsupported operation.
EventDispatcher	getEventDispatcher() Unsupported operation.
ExternalResourceSecurity	getExternalResourceSecurity(ParsedURL resourcePURL, ParsedURL docURL) Returns the security settings for the given resource url and document url
java.lang.String	getLanguages() Returns the user language "en" (english).
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 scriptPURL, ParsedURL docPURL) Returns the security settings for the given script type, script url and document url
static float	getStandardBolderFontWeight(float f) Returns a bolder font-weight.
static float	getStandardLighterFontWeight(float f) Returns a lighter font-weight.
java.awt.geom.AffineTransform	getTransform() Unsupported operation.
java.lang.String	getUserStyleSheetURI() Returns the user stylesheet
java.awt.geom.Dimension2D	getViewportSize() Returns the default size of this user agent (400x400).
java.lang.String	getXMLParserClassName() Returns the XML parser to use
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 false.
void	openLink(SVGAElement elt) Unsupported operation.
void	registerExtension(BridgeExtension ext) Lets the bridge tell the user agent that the following ex tension is supported by the bridge.
void	runThread(java.lang.Thread t) Unsupported operation.
void	setSVGCursor(java.awt.Cursor cursor) Unsupported operation.
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

FEATURES

protected java.util.Set FEATURES

extensions

protected java.util.Set extensions

Constructor Detail

UserAgentAdapter

public UserAgentAdapter()

Method Detail

addStdFeatures

public void addStdFeatures()

getViewportSize

public java.awt.geom.Dimension2D getViewportSize()

Returns the default size of this user agent (400x400).

Specified by:

getViewportSize in interface UserAgent

displayMessage

public void displayMessage(java.lang.String message)

Display the specified message.

Specified by:

displayMessage in interface UserAgent

displayError

public void displayError(java.lang.String message)

Display the specified error message (forwards call to displayMessage).

displayError

public void displayError(java.lang.Exception e)

Display the specified error (forwards call to displayError(String))

Specified by:

displayError 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

getPixelToMM

public float getPixelToMM()

Returns the size of a px CSS unit in millimeters. This will be removed after next release.

Specified by:

getPixelToMM in interface UserAgent

See Also:

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 user language "en" (english).

Specified by:

getLanguages 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

getUserStyleSheetURI

public java.lang.String getUserStyleSheetURI()

Returns the user stylesheet

Specified by:

getUserStyleSheetURI in interface UserAgent

Following copied from interface: org.apache.batik.bridge.UserAgent

Returns:

null if no user style sheet was specified.

getXMLParserClassName

public java.lang.String getXMLParserClassName()

Returns the XML parser to use

Specified by:

getXMLParserClassName in interface UserAgent

isXMLParserValidating

public boolean isXMLParserValidating()

Returns false. The XML parser is not in validation mode.

Specified by:

isXMLParserValidating in interface UserAgent

getEventDispatcher

public EventDispatcher getEventDispatcher()

Unsupported operation.

Specified by:

getEventDispatcher in interface UserAgent

openLink

public void openLink(SVGAElement elt)

Unsupported operation.

Specified by:

openLink in interface UserAgent

Following copied from interface: org.apache.batik.bridge.UserAgent

Parameters:

elt - The activated link element.

setSVGCursor

public void setSVGCursor(java.awt.Cursor cursor)

Unsupported operation.

Specified by:

setSVGCursor in interface UserAgent

Following copied from interface: org.apache.batik.bridge.UserAgent

Parameters:

cursor - the new cursor

runThread

public void runThread(java.lang.Thread t)

Unsupported operation.

getTransform

public java.awt.geom.AffineTransform getTransform()

Unsupported operation.

Specified by:

getTransform in interface UserAgent

getClientAreaLocationOnScreen

public java.awt.Point getClientAreaLocationOnScreen()

Unsupported operation.

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 ex tension is supported by the bridge.

Specified by:

registerExtension in interface UserAgent

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.

Specified by:

handleElement in interface UserAgent

getScriptSecurity

public ScriptSecurity getScriptSecurity(java.lang.String scriptType,
                                        ParsedURL scriptPURL,
                                        ParsedURL docPURL)

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.

getExternalResourceSecurity

public ExternalResourceSecurity getExternalResourceSecurity(ParsedURL resourcePURL,
                                                            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 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.

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:

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.

getStandardLighterFontWeight

public static float getStandardLighterFontWeight(float f)

Returns a lighter font-weight.

getStandardBolderFontWeight

public static float getStandardBolderFontWeight(float f)

Returns a bolder font-weight.