Package org.apache.batik.swing.svg
Interface SVGUserAgent
- All Known Implementing Classes:
JSVGViewerFrame.UserAgent
,SVGUserAgentAdapter
,SVGUserAgentGUIAdapter
public interface SVGUserAgent
This interface must be implemented to provide client services to
a JSVGComponent.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
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
(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
Displays an error resulting from the specified Exception.void
displayError
(String message) Displays an error message.void
displayMessage
(String message) Displays a message in the User Agent interface.Returns this user agent's alternate style-sheet title.float
getBolderFontWeight
(float f) Returns a bolder font-weight.Returns the default font family.getExternalResourceSecurity
(ParsedURL resourceURL, ParsedURL docURL) Returns the security settings for the given resource url and document urlReturns the language settings.float
getLighterFontWeight
(float f) Returns a lighter font-weight.getMedia()
Returns this user agent's CSS media.float
Returns the medium font size.float
Returns the size of a px CSS unit in millimeters.float
Returns the size of a px CSS unit in millimeters.getScriptSecurity
(String scriptType, ParsedURL scriptURL, ParsedURL docURL) Returns the security settings for the given script type, script url and document urlReturns the user stylesheet uri.Returns the class name of the XML parser.void
handleElement
(Element elt, Object data) Notifies the UserAgent that the input element has been found in the document.boolean
Returns true if the XML parser must be in validation mode, false otherwise.void
Opens a link in a new component.void
Shows an alert dialog box.boolean
showConfirm
(String message) Shows a confirm dialog box.showPrompt
(String message) Shows a prompt dialog box.showPrompt
(String message, String defaultValue) Shows a prompt dialog box.boolean
Tells whether the given extension is supported by this user agent.
-
Method Details
-
displayError
Displays an error message. -
displayError
Displays an error resulting from the specified Exception. -
displayMessage
Displays a message in the User Agent interface. The given message is typically displayed in a status bar. -
showAlert
Shows an alert dialog box. -
showPrompt
Shows a prompt dialog box. -
showPrompt
Shows a prompt dialog box. -
showConfirm
Shows a confirm dialog box. -
getPixelUnitToMillimeter
float getPixelUnitToMillimeter()Returns the size of a px CSS unit in millimeters. -
getPixelToMM
float getPixelToMM()Returns the size of a px CSS unit in millimeters. This will be removed after next release.- See Also:
-
getDefaultFontFamily
String getDefaultFontFamily()Returns the default font family. -
getMediumFontSize
float getMediumFontSize()Returns the medium font size. -
getLighterFontWeight
float getLighterFontWeight(float f) Returns a lighter font-weight. -
getBolderFontWeight
float getBolderFontWeight(float f) Returns a bolder font-weight. -
getLanguages
String getLanguages()Returns the language settings. -
getUserStyleSheetURI
String getUserStyleSheetURI()Returns the user stylesheet uri.- Returns:
- null if no user style sheet was specified.
-
getXMLParserClassName
String getXMLParserClassName()Returns the class name of the XML parser. -
isXMLParserValidating
boolean isXMLParserValidating()Returns true if the XML parser must be in validation mode, false otherwise. -
getMedia
String getMedia()Returns this user agent's CSS media. -
getAlternateStyleSheet
String getAlternateStyleSheet()Returns this user agent's alternate style-sheet title. -
openLink
Opens a link in a new component.- Parameters:
uri
- The document URI.newc
- Whether the link should be activated in a new component.
-
supportExtension
Tells whether the given extension is supported by this user agent. -
handleElement
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
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 nulldocURL
- url for the document into which the script was found.
-
checkLoadScript
void checkLoadScript(String scriptType, ParsedURL scriptURL, ParsedURL docURL) throws 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 nulldocURL
- url for the document into which the script was found.- Throws:
SecurityException
-
getExternalResourceSecurity
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 nulldocURL
- url for the document into which the resource was found.
-
checkLoadExternalResource
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 script, as defined in the resource's xlink:href attribute. If that attribute was empty, then this parameter should be nulldocURL
- url for the document into which the resource was found.- Throws:
SecurityException
-