Package org.apache.batik.bridge
Class UserAgentAdapter
java.lang.Object
org.apache.batik.bridge.UserAgentAdapter
- All Implemented Interfaces:
UserAgent
- Direct Known Subclasses:
SVGAbstractTranscoder.SVGAbstractTranscoderUserAgent
,SVGOnLoadExceptionTest.TestUserAgent
An abstract user agent adaptor implementation. It exists to simply
the creation of UserAgent instances.
- Version:
- $Id: UserAgentAdapter.java 1805408 2017-08-18 12:21:52Z ssteiner $
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected BridgeContext
The BridgeContext to use for error information.protected Set
protected Set
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds the standard SVG feature strings to the set of features supported by this user agent.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
(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
This user agent doesn't display text selections so nothing to clear.void
Display the specified error (forwards call to displayError(String))void
displayError
(String message) Display the specified error message (forwards call to displayMessage).void
displayMessage
(String message) Display the specified message.Returns this user agent's alternate style-sheet title.float
getBolderFontWeight
(float f) Returns a bolder font-weight.org.w3c.dom.svg.SVGDocument
getBrokenLinkDocument
(Element e, String url, String message) This Implementation simply throws a BridgeException.Unsupported operation.Returns the default font family.Unsupported operation.getExternalResourceSecurity
(ParsedURL resourceURL, ParsedURL docURL) Returns the security settings for the given resource url and document urlReturns the Font Family ResolverReturns the user language "en" (english).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 urlstatic float
getStandardBolderFontWeight
(float f) Returns a bolder font-weight.static float
getStandardLighterFontWeight
(float f) Returns a lighter font-weight.Unsupported operation.Returns the user stylesheetReturns the default size of this user agent (400x400).Returns the XML parser to usevoid
handleElement
(Element elt, Object data) Notifies the UserAgent that the input element has been found in the document.boolean
hasFeature
(String s) Tells whether the given feature is supported by this user agent.boolean
Returnsfalse
.void
loadDocument
(String url) This method should load a new document described by the supplied URL.void
openLink
(org.w3c.dom.svg.SVGAElement elt) Unsupported operation.void
Lets the bridge tell the user agent that the following ex tension is supported by the bridge.void
Unsupported operation.void
Sets the BridgeContext to be used for error information.void
setSVGCursor
(Cursor cursor) Unsupported operation.void
setTextSelection
(Mark start, Mark end) This user agent doesn't display text selections.void
Unsupported operation.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.
-
Field Details
-
FEATURES
-
extensions
-
ctx
The BridgeContext to use for error information.
-
-
Constructor Details
-
UserAgentAdapter
public UserAgentAdapter()
-
-
Method Details
-
setBridgeContext
Sets the BridgeContext to be used for error information. -
addStdFeatures
public void addStdFeatures()Adds the standard SVG feature strings to the set of features supported by this user agent. -
getViewportSize
Returns the default size of this user agent (400x400).- Specified by:
getViewportSize
in interfaceUserAgent
-
displayMessage
Display the specified message.- Specified by:
displayMessage
in interfaceUserAgent
-
displayError
Display the specified error message (forwards call to displayMessage). -
displayError
Display the specified error (forwards call to displayError(String))- Specified by:
displayError
in interfaceUserAgent
-
showAlert
Shows an alert dialog box. -
showPrompt
Shows a prompt dialog box.- Specified by:
showPrompt
in interfaceUserAgent
-
showPrompt
Shows a prompt dialog box.- Specified by:
showPrompt
in interfaceUserAgent
-
showConfirm
Shows a confirm dialog box.- Specified by:
showConfirm
in interfaceUserAgent
-
getPixelUnitToMillimeter
public float getPixelUnitToMillimeter()Returns the size of a px CSS unit in millimeters.- Specified by:
getPixelUnitToMillimeter
in interfaceUserAgent
-
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 interfaceUserAgent
- See Also:
-
getDefaultFontFamily
Returns the default font family.- Specified by:
getDefaultFontFamily
in interfaceUserAgent
-
getMediumFontSize
public float getMediumFontSize()Returns the medium font size.- Specified by:
getMediumFontSize
in interfaceUserAgent
-
getLighterFontWeight
public float getLighterFontWeight(float f) Returns a lighter font-weight.- Specified by:
getLighterFontWeight
in interfaceUserAgent
-
getBolderFontWeight
public float getBolderFontWeight(float f) Returns a bolder font-weight.- Specified by:
getBolderFontWeight
in interfaceUserAgent
-
getLanguages
Returns the user language "en" (english).- Specified by:
getLanguages
in interfaceUserAgent
-
getMedia
Returns this user agent's CSS media. -
getAlternateStyleSheet
Returns this user agent's alternate style-sheet title.- Specified by:
getAlternateStyleSheet
in interfaceUserAgent
-
getUserStyleSheetURI
Returns the user stylesheet- Specified by:
getUserStyleSheetURI
in interfaceUserAgent
- Returns:
- null if no user style sheet was specified.
-
getXMLParserClassName
Returns the XML parser to use- Specified by:
getXMLParserClassName
in interfaceUserAgent
-
isXMLParserValidating
public boolean isXMLParserValidating()Returnsfalse
. The XML parser is not in validation mode.- Specified by:
isXMLParserValidating
in interfaceUserAgent
-
getEventDispatcher
Unsupported operation.- Specified by:
getEventDispatcher
in interfaceUserAgent
-
openLink
public void openLink(org.w3c.dom.svg.SVGAElement elt) Unsupported operation. -
setSVGCursor
Unsupported operation.- Specified by:
setSVGCursor
in interfaceUserAgent
- Parameters:
cursor
- the new cursor
-
setTextSelection
This user agent doesn't display text selections.- Specified by:
setTextSelection
in interfaceUserAgent
- Parameters:
start
- The Mark for the start of the selection.end
- The Mark for the end of the selection.
-
deselectAll
public void deselectAll()This user agent doesn't display text selections so nothing to clear.- Specified by:
deselectAll
in interfaceUserAgent
-
runThread
Unsupported operation. -
getTransform
Unsupported operation.- Specified by:
getTransform
in interfaceUserAgent
-
setTransform
Unsupported operation.- Specified by:
setTransform
in interfaceUserAgent
-
getClientAreaLocationOnScreen
Unsupported operation.- Specified by:
getClientAreaLocationOnScreen
in interfaceUserAgent
-
hasFeature
Tells whether the given feature is supported by this user agent.- Specified by:
hasFeature
in interfaceUserAgent
-
supportExtension
Tells whether the given extension is supported by this user agent.- Specified by:
supportExtension
in interfaceUserAgent
-
registerExtension
Lets the bridge tell the user agent that the following ex tension is supported by the bridge.- Specified by:
registerExtension
in interfaceUserAgent
-
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.- Specified by:
handleElement
in interfaceUserAgent
-
getScriptSecurity
Returns the security settings for the given script type, script url and document url- Specified by:
getScriptSecurity
in interfaceUserAgent
- 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
public 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.- Specified by:
checkLoadScript
in interfaceUserAgent
- 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
public ExternalResourceSecurity getExternalResourceSecurity(ParsedURL resourceURL, ParsedURL docURL) Returns the security settings for the given resource url and document url- Specified by:
getExternalResourceSecurity
in interfaceUserAgent
- 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
public void checkLoadExternalResource(ParsedURL resourceURL, ParsedURL docURL) throws 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 interfaceUserAgent
- 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.- Throws:
SecurityException
-
getStandardLighterFontWeight
public static float getStandardLighterFontWeight(float f) Returns a lighter font-weight. -
getStandardBolderFontWeight
public static float getStandardBolderFontWeight(float f) Returns a bolder font-weight. -
getBrokenLinkDocument
This Implementation simply throws a BridgeException.- Specified by:
getBrokenLinkDocument
in interfaceUserAgent
- Parameters:
e
- The <image> element that can't be loaded.url
- The resolved url that can't be loaded.message
- As best as can be determined the reason it can't be loaded (not available, corrupt, unknown format,...).
-
loadDocument
This method should load a new document described by the supplied URL.- Specified by:
loadDocument
in interfaceUserAgent
- Parameters:
url
- The url to be loaded as a string.
-
getFontFamilyResolver
Returns the Font Family Resolver- Specified by:
getFontFamilyResolver
in interfaceUserAgent
-