org.apache.batik.swing.svg

Class SVGUserAgentAdapter

public class SVGUserAgentAdapter extends Object implements SVGUserAgent

This Implements the SVGUserAgent interface to provide a very simple version of client services to the JSVGComponent. This implementation does not require any GUI interaction to work. This implementation is particularly bad about user interaction most of the alert,prompt,etc methods are totally useless. In a GUI environment you probably want to use SVGUserAgentGUIAdapter.
Constructor Summary
SVGUserAgentAdapter()
Method Summary
voidcheckLoadExternalResource(ParsedURL resourceURL, ParsedURL docURL)
This method throws a SecurityException if the resource found at url and referenced from docURL should not be loaded.
voidcheckLoadScript(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.
voiddisplayError(String message)
Displays an error message.
voiddisplayError(Exception ex)
Displays an error resulting from the specified Exception.
voiddisplayMessage(String message)
Displays a message in the User Agent interface.
StringgetAlternateStyleSheet()
Returns this user agent's alternate style-sheet title.
floatgetBolderFontWeight(float f)
Returns a bolder font-weight.
StringgetDefaultFontFamily()
Returns the default font family.
ExternalResourceSecuritygetExternalResourceSecurity(ParsedURL resourceURL, ParsedURL docURL)
Returns the security settings for the given resource url and document url
StringgetLanguages()
Returns the language settings.
floatgetLighterFontWeight(float f)
Returns a lighter font-weight.
StringgetMedia()
Returns this user agent's CSS media.
floatgetMediumFontSize()
Returns the medium font size.
floatgetPixelToMM()
Returns the size of a px CSS unit in millimeters.
floatgetPixelUnitToMillimeter()
Returns the size of a px CSS unit in millimeters.
ScriptSecuritygetScriptSecurity(String scriptType, ParsedURL scriptURL, ParsedURL docURL)
Returns the security settings for the given script type, script url and document url
StringgetUserStyleSheetURI()
Returns the user stylesheet uri.
StringgetXMLParserClassName()
Returns the class name of the XML parser.
voidhandleElement(Element elt, Object data)
booleanisXMLParserValidating()
Returns true if the XML parser must be in validation mode, false otherwise.
voidopenLink(String uri, boolean newc)
Opens a link.
voidshowAlert(String message)
Shows an alert dialog box.
booleanshowConfirm(String message)
Shows a confirm dialog box.
StringshowPrompt(String message)
Shows a prompt dialog box.
StringshowPrompt(String message, String defaultValue)
Shows a prompt dialog box.
booleansupportExtension(String s)
Tells whether the given extension is supported by this user agent.

Constructor Detail

SVGUserAgentAdapter

public SVGUserAgentAdapter()

Method Detail

checkLoadExternalResource

public 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. This is a convenience method to call checkLoadExternalResource on the ExternalResourceSecurity strategy returned by getExternalResourceSecurity.

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.

checkLoadScript

public void checkLoadScript(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. This is a convenience method to call checkLoadScript on the ScriptSecurity strategy returned by getScriptSecurity.

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.

displayError

public void displayError(String message)
Displays an error message.

displayError

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

displayMessage

public void displayMessage(String message)
Displays a message in the User Agent interface. The given message is typically displayed in a status bar.

getAlternateStyleSheet

public String getAlternateStyleSheet()
Returns this user agent's alternate style-sheet title.

getBolderFontWeight

public float getBolderFontWeight(float f)
Returns a bolder font-weight.

getDefaultFontFamily

public String getDefaultFontFamily()
Returns the default font family.

getExternalResourceSecurity

public ExternalResourceSecurity getExternalResourceSecurity(ParsedURL resourceURL, ParsedURL docURL)
Returns the security settings for the given resource url and document url

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.

getLanguages

public String getLanguages()
Returns the language settings.

getLighterFontWeight

public float getLighterFontWeight(float f)
Returns a lighter font-weight.

getMedia

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

getMediumFontSize

public float getMediumFontSize()
Returns the medium font size.

getPixelToMM

public float getPixelToMM()
Returns the size of a px CSS unit in millimeters. This will be removed after next release.

See Also: getPixelUnitToMillimeter

getPixelUnitToMillimeter

public float getPixelUnitToMillimeter()
Returns the size of a px CSS unit in millimeters.

getScriptSecurity

public ScriptSecurity getScriptSecurity(String scriptType, ParsedURL scriptURL, ParsedURL docURL)
Returns the security settings for the given script type, script url and document url

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.

getUserStyleSheetURI

public String getUserStyleSheetURI()
Returns the user stylesheet uri.

Returns: null if no user style sheet was specified.

getXMLParserClassName

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

handleElement

public void handleElement(Element elt, Object data)

isXMLParserValidating

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

openLink

public void openLink(String uri, boolean newc)
Opens a link.

Parameters: uri The document URI. newc Whether the link should be activated in a new component.

showAlert

public void showAlert(String message)
Shows an alert dialog box.

showConfirm

public boolean showConfirm(String message)
Shows a confirm dialog box.

showPrompt

public String showPrompt(String message)
Shows a prompt dialog box.

showPrompt

public String showPrompt(String message, String defaultValue)
Shows a prompt dialog box.

supportExtension

public boolean supportExtension(String s)
Tells whether the given extension is supported by this user agent.
Copyright B) 2008 Apache Software Foundation. All Rights Reserved.