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
public class UserAgentAdapter extends java.lang.Object implements UserAgent
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
Fields Modifier and Type Field Description protected BridgeContextctxThe BridgeContext to use for error information.protected java.util.Setextensionsprotected java.util.SetFEATURES
-
Constructor Summary
Constructors Constructor Description UserAgentAdapter()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddStdFeatures()Adds the standard SVG feature strings to the set of features supported by this user agent.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(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.voiddeselectAll()This user agent doesn't display text selections so nothing to clear.voiddisplayError(java.lang.Exception e)Display the specified error (forwards call to displayError(String))voiddisplayError(java.lang.String message)Display the specified error message (forwards call to displayMessage).voiddisplayMessage(java.lang.String message)Display the specified message.java.lang.StringgetAlternateStyleSheet()Returns this user agent's alternate style-sheet title.floatgetBolderFontWeight(float f)Returns a bolder font-weight.org.w3c.dom.svg.SVGDocumentgetBrokenLinkDocument(org.w3c.dom.Element e, java.lang.String url, java.lang.String message)This Implementation simply throws a BridgeException.java.awt.PointgetClientAreaLocationOnScreen()Unsupported operation.java.lang.StringgetDefaultFontFamily()Returns the default font family.EventDispatchergetEventDispatcher()Unsupported operation.ExternalResourceSecuritygetExternalResourceSecurity(ParsedURL resourceURL, ParsedURL docURL)Returns the security settings for the given resource url and document urlFontFamilyResolvergetFontFamilyResolver()Returns the Font Family Resolverjava.lang.StringgetLanguages()Returns the user language "en" (english).floatgetLighterFontWeight(float f)Returns a lighter font-weight.java.lang.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(java.lang.String scriptType, ParsedURL scriptURL, ParsedURL docURL)Returns the security settings for the given script type, script url and document urlstatic floatgetStandardBolderFontWeight(float f)Returns a bolder font-weight.static floatgetStandardLighterFontWeight(float f)Returns a lighter font-weight.java.awt.geom.AffineTransformgetTransform()Unsupported operation.java.lang.StringgetUserStyleSheetURI()Returns the user stylesheetjava.awt.geom.Dimension2DgetViewportSize()Returns the default size of this user agent (400x400).java.lang.StringgetXMLParserClassName()Returns the XML parser to usevoidhandleElement(org.w3c.dom.Element elt, java.lang.Object data)Notifies the UserAgent that the input element has been found in the document.booleanhasFeature(java.lang.String s)Tells whether the given feature is supported by this user agent.booleanisXMLParserValidating()Returnsfalse.voidloadDocument(java.lang.String url)This method should load a new document described by the supplied URL.voidopenLink(org.w3c.dom.svg.SVGAElement elt)Unsupported operation.voidregisterExtension(BridgeExtension ext)Lets the bridge tell the user agent that the following ex tension is supported by the bridge.voidrunThread(java.lang.Thread t)Unsupported operation.voidsetBridgeContext(BridgeContext ctx)Sets the BridgeContext to be used for error information.voidsetSVGCursor(java.awt.Cursor cursor)Unsupported operation.voidsetTextSelection(Mark start, Mark end)This user agent doesn't display text selections.voidsetTransform(java.awt.geom.AffineTransform at)Unsupported operation.voidshowAlert(java.lang.String message)Shows an alert dialog box.booleanshowConfirm(java.lang.String message)Shows a confirm dialog box.java.lang.StringshowPrompt(java.lang.String message)Shows a prompt dialog box.java.lang.StringshowPrompt(java.lang.String message, java.lang.String defaultValue)Shows a prompt dialog box.booleansupportExtension(java.lang.String s)Tells whether the given extension is supported by this user agent.
-
-
-
Field Detail
-
FEATURES
protected java.util.Set FEATURES
-
extensions
protected java.util.Set extensions
-
ctx
protected BridgeContext ctx
The BridgeContext to use for error information.
-
-
Method Detail
-
setBridgeContext
public void setBridgeContext(BridgeContext ctx)
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
public java.awt.geom.Dimension2D getViewportSize()
Returns the default size of this user agent (400x400).- Specified by:
getViewportSizein interfaceUserAgent
-
displayMessage
public void displayMessage(java.lang.String message)
Display the specified message.- Specified by:
displayMessagein interfaceUserAgent
-
displayError
public void displayError(java.lang.String message)
Display the specified error message (forwards call to displayMessage).
-
displayError
public void displayError(java.lang.Exception e)
Display the specified error (forwards call to displayError(String))- Specified by:
displayErrorin interfaceUserAgent
-
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.- Specified by:
showPromptin interfaceUserAgent
-
showPrompt
public java.lang.String showPrompt(java.lang.String message, java.lang.String defaultValue)Shows a prompt dialog box.- Specified by:
showPromptin interfaceUserAgent
-
showConfirm
public boolean showConfirm(java.lang.String message)
Shows a confirm dialog box.- Specified by:
showConfirmin interfaceUserAgent
-
getPixelUnitToMillimeter
public float getPixelUnitToMillimeter()
Returns the size of a px CSS unit in millimeters.- Specified by:
getPixelUnitToMillimeterin interfaceUserAgent
-
getPixelToMM
public float getPixelToMM()
Returns the size of a px CSS unit in millimeters. This will be removed after next release.- Specified by:
getPixelToMMin interfaceUserAgent- See Also:
getPixelUnitToMillimeter()
-
getDefaultFontFamily
public java.lang.String getDefaultFontFamily()
Returns the default font family.- Specified by:
getDefaultFontFamilyin interfaceUserAgent
-
getMediumFontSize
public float getMediumFontSize()
Returns the medium font size.- Specified by:
getMediumFontSizein interfaceUserAgent
-
getLighterFontWeight
public float getLighterFontWeight(float f)
Returns a lighter font-weight.- Specified by:
getLighterFontWeightin interfaceUserAgent
-
getBolderFontWeight
public float getBolderFontWeight(float f)
Returns a bolder font-weight.- Specified by:
getBolderFontWeightin interfaceUserAgent
-
getLanguages
public java.lang.String getLanguages()
Returns the user language "en" (english).- Specified by:
getLanguagesin interfaceUserAgent
-
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.- Specified by:
getAlternateStyleSheetin interfaceUserAgent
-
getUserStyleSheetURI
public java.lang.String getUserStyleSheetURI()
Returns the user stylesheet- Specified by:
getUserStyleSheetURIin interfaceUserAgent- Returns:
- null if no user style sheet was specified.
-
getXMLParserClassName
public java.lang.String getXMLParserClassName()
Returns the XML parser to use- Specified by:
getXMLParserClassNamein interfaceUserAgent
-
isXMLParserValidating
public boolean isXMLParserValidating()
Returnsfalse. The XML parser is not in validation mode.- Specified by:
isXMLParserValidatingin interfaceUserAgent
-
getEventDispatcher
public EventDispatcher getEventDispatcher()
Unsupported operation.- Specified by:
getEventDispatcherin interfaceUserAgent
-
openLink
public void openLink(org.w3c.dom.svg.SVGAElement elt)
Unsupported operation.
-
setSVGCursor
public void setSVGCursor(java.awt.Cursor cursor)
Unsupported operation.- Specified by:
setSVGCursorin interfaceUserAgent- Parameters:
cursor- the new cursor
-
setTextSelection
public void setTextSelection(Mark start, Mark end)
This user agent doesn't display text selections.- Specified by:
setTextSelectionin 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:
deselectAllin interfaceUserAgent
-
runThread
public void runThread(java.lang.Thread t)
Unsupported operation.
-
getTransform
public java.awt.geom.AffineTransform getTransform()
Unsupported operation.- Specified by:
getTransformin interfaceUserAgent
-
setTransform
public void setTransform(java.awt.geom.AffineTransform at)
Unsupported operation.- Specified by:
setTransformin interfaceUserAgent
-
getClientAreaLocationOnScreen
public java.awt.Point getClientAreaLocationOnScreen()
Unsupported operation.- Specified by:
getClientAreaLocationOnScreenin interfaceUserAgent
-
hasFeature
public boolean hasFeature(java.lang.String s)
Tells whether the given feature is supported by this user agent.- Specified by:
hasFeaturein interfaceUserAgent
-
supportExtension
public boolean supportExtension(java.lang.String s)
Tells whether the given extension is supported by this user agent.- Specified by:
supportExtensionin interfaceUserAgent
-
registerExtension
public void registerExtension(BridgeExtension ext)
Lets the bridge tell the user agent that the following ex tension is supported by the bridge.- Specified by:
registerExtensionin interfaceUserAgent
-
handleElement
public 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.- Specified by:
handleElementin interfaceUserAgent
-
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- Specified by:
getScriptSecurityin 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(java.lang.String scriptType, ParsedURL scriptURL, ParsedURL docURL) throws java.lang.SecurityExceptionThis 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:
checkLoadScriptin 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:
java.lang.SecurityException
-
getExternalResourceSecurity
public ExternalResourceSecurity getExternalResourceSecurity(ParsedURL resourceURL, ParsedURL docURL)
Returns the security settings for the given resource url and document url- Specified by:
getExternalResourceSecurityin 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 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.- Specified by:
checkLoadExternalResourcein 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:
java.lang.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
public org.w3c.dom.svg.SVGDocument getBrokenLinkDocument(org.w3c.dom.Element e, java.lang.String url, java.lang.String message)This Implementation simply throws a BridgeException.- Specified by:
getBrokenLinkDocumentin 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
public void loadDocument(java.lang.String url)
This method should load a new document described by the supplied URL.- Specified by:
loadDocumentin interfaceUserAgent- Parameters:
url- The url to be loaded as a string.
-
getFontFamilyResolver
public FontFamilyResolver getFontFamilyResolver()
Returns the Font Family Resolver- Specified by:
getFontFamilyResolverin interfaceUserAgent
-
-