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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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.java.lang.String
getDefaultFontFamily()
Returns the default font family.ExternalResourceSecurity
getExternalResourceSecurity(ParsedURL resourceURL, ParsedURL docURL)
Returns the security settings for the given resource url and document urljava.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 urlfloat
getSourceResolution()
java.lang.String
getUserStyleSheetURI()
Returns the user stylesheet uri.java.lang.String
getXMLParserClassName()
Returns the class name of the XML parser.void
handleElement(org.w3c.dom.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
setSourceResolution(float sourceResolution)
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
void displayError(java.lang.String message)
Displays an error message.
-
displayError
void displayError(java.lang.Exception ex)
Displays an error resulting from the specified Exception.
-
displayMessage
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
void showAlert(java.lang.String message)
Shows an alert dialog box.
-
showPrompt
java.lang.String showPrompt(java.lang.String message)
Shows a prompt dialog box.
-
showPrompt
java.lang.String showPrompt(java.lang.String message, java.lang.String defaultValue)
Shows a prompt dialog box.
-
showConfirm
boolean showConfirm(java.lang.String message)
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:
getPixelUnitToMillimeter()
-
getDefaultFontFamily
java.lang.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
java.lang.String getLanguages()
Returns the language settings.
-
getUserStyleSheetURI
java.lang.String getUserStyleSheetURI()
Returns the user stylesheet uri.- Returns:
- null if no user style sheet was specified.
-
getXMLParserClassName
java.lang.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
java.lang.String getMedia()
Returns this user agent's CSS media.
-
getAlternateStyleSheet
java.lang.String getAlternateStyleSheet()
Returns this user agent's alternate style-sheet title.
-
openLink
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
boolean supportExtension(java.lang.String s)
Tells whether the given extension is supported by this user agent.
-
handleElement
void handleElement(org.w3c.dom.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
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 nulldocURL
- url for the document into which the script was found.
-
checkLoadScript
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 nulldocURL
- url for the document into which the script was found.- Throws:
java.lang.SecurityException
-
getExternalResourceSecurity
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 nulldocURL
- url for the document into which the resource was found.
-
checkLoadExternalResource
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:
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:
java.lang.SecurityException
-
getSourceResolution
float getSourceResolution()
-
setSourceResolution
void setSourceResolution(float sourceResolution)
-
-