org.apache.batik.swing.svg
Interface SVGUserAgent

All Known Implementing Classes:

JSVGViewerFrame.UserAgent

public interface SVGUserAgent

This interface must be implemented to provide client services to a JSVGComponent.

Method Summary

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 ex) Displays an error resulting from the specified Exception.
void	displayError(java.lang.String message) Displays an error message.
void	displayMessage(java.lang.String message) Displays a message in the User Agent interface.
java.lang.String	getAlternateStyleSheet() Returns this user agent's alternate style-sheet title.
float	getBolderFontWeight(float f) Returns a bolder font-weight.
ExternalResourceSecurity	getExternalResourceSecurity(ParsedURL resourceURL, ParsedURL docURL) Returns the security settings for the given resource url and document url
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
java.lang.String	getUserStyleSheetURI() Returns the user stylesheet uri.
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	isXMLParserValidating() Returns true if the XML parser must be in validation mode, false otherwise.
void	openLink(java.lang.String uri, boolean newc) Opens a link in a new component.
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.

Method Detail

displayError

public void displayError(java.lang.String message)

Displays an error message.

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. The given message is typically displayed in a status bar.

showAlert

public void showAlert(java.lang.String message)

Shows an alert dialog box.

showPrompt

public java.lang.String showPrompt(java.lang.String message)

Shows a prompt dialog box.

showPrompt

public java.lang.String showPrompt(java.lang.String message,
                                   java.lang.String defaultValue)

Shows a prompt dialog box.

showConfirm

public boolean showConfirm(java.lang.String message)

Shows a confirm dialog box.

getPixelUnitToMillimeter

public float getPixelUnitToMillimeter()

Returns the size of a px CSS unit in millimeters.

getPixelToMM

public float getPixelToMM()

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

See Also:

getMediumFontSize

public float getMediumFontSize()

Returns the medium font size.

getLighterFontWeight

public float getLighterFontWeight(float f)

Returns a lighter font-weight.

getBolderFontWeight

public float getBolderFontWeight(float f)

Returns a bolder font-weight.

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.

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.

getMedia

public java.lang.String getMedia()

Returns this user agent's CSS media.

getAlternateStyleSheet

public java.lang.String getAlternateStyleSheet()

Returns this user agent's alternate style-sheet title.

openLink

public void openLink(java.lang.String uri,
                     boolean newc)

Opens a link in a new component.

Parameters:

uri - The document URI.

newc - Whether the link should be activated in a new component.

supportExtension

public boolean supportExtension(java.lang.String s)

Tells whether the given extension is supported by this user agent.

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.

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

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.

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 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.

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.

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.