Package org.apache.batik.swing.svg
Class JSVGComponent.BridgeUserAgent
- java.lang.Object
-
- org.apache.batik.swing.svg.JSVGComponent.BridgeUserAgent
-
- All Implemented Interfaces:
UserAgent
- Direct Known Subclasses:
JSVGCanvas.CanvasUserAgent
- Enclosing class:
- JSVGComponent
protected class JSVGComponent.BridgeUserAgent extends java.lang.Object implements UserAgent
To hide the user-agent methods.
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Mapextensions
-
Constructor Summary
Constructors Modifier Constructor Description protectedBridgeUserAgent()Creates a new user agent.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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()Informs the user agent that the text selection should be cleared.voiddisplayError(java.lang.Exception ex)Displays an error resulting from the specified Exception.voiddisplayError(java.lang.String message)Displays an error message in the User Agent interface.voiddisplayMessage(java.lang.String message)Displays a message in the User Agent interface.protected voidfireLinkActivatedEvent(org.w3c.dom.svg.SVGAElement elt, java.lang.String href)Fires a LinkActivatedEvent.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 provides a true SVG Document that it annotates with some information about why the real document can't be loaded (unfortunately right now tool tips are broken for content referenced by images so you can't actually see the info).java.awt.PointgetClientAreaLocationOnScreen()Returns the location on the screen of the client area in the UserAgent.java.lang.StringgetDefaultFontFamily()Returns the default font family.EventDispatchergetEventDispatcher()Returns theEventDispatcherused by theUserAgentto dispatch events on GVT.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 language settings.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 urljava.awt.geom.AffineTransformgetTransform()Returns theAffineTransformcurrently applied to the drawing by the UserAgent.java.lang.StringgetUserStyleSheetURI()Returns the user stylesheet uri.java.awt.geom.Dimension2DgetViewportSize()Returns the default size of the viewport of this user agent (0, 0).java.lang.StringgetXMLParserClassName()Returns the class name of the XML parser.voidhandleElement(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()Returns true if the XML parser must be in validation mode, false otherwise depending on the SVGUserAgent.voidloadDocument(java.lang.String url)This method should load a new document described by the supplied URL.voidopenLink(org.w3c.dom.svg.SVGAElement elt)Opens a link.voidregisterExtension(BridgeExtension ext)Lets the bridge tell the user agent that the following extension is supported by the bridge.voidsetSVGCursor(java.awt.Cursor cursor)Informs the user agent to change the cursor.voidsetTextSelection(Mark start, Mark end)Informs the user agent that the text selection has changed.voidsetTransform(java.awt.geom.AffineTransform at)Sets theAffineTransformto be applied to the drawing by the UserAgent.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.
-
-
-
Method Detail
-
getViewportSize
public java.awt.geom.Dimension2D getViewportSize()
Returns the default size of the viewport of this user agent (0, 0).- Specified by:
getViewportSizein interfaceUserAgent
-
getEventDispatcher
public EventDispatcher getEventDispatcher()
Returns theEventDispatcherused by theUserAgentto dispatch events on GVT.- Specified by:
getEventDispatcherin interfaceUserAgent
-
displayError
public void displayError(java.lang.String message)
Displays an error message in the User Agent interface.
-
displayError
public void displayError(java.lang.Exception ex)
Displays an error resulting from the specified Exception.- Specified by:
displayErrorin interfaceUserAgent
-
displayMessage
public void displayMessage(java.lang.String message)
Displays a message in the User Agent interface.- Specified by:
displayMessagein 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 language settings.- Specified by:
getLanguagesin interfaceUserAgent
-
getUserStyleSheetURI
public java.lang.String getUserStyleSheetURI()
Returns the user stylesheet uri.- Specified by:
getUserStyleSheetURIin interfaceUserAgent- Returns:
- null if no user style sheet was specified.
-
openLink
public void openLink(org.w3c.dom.svg.SVGAElement elt)
Opens a link.
-
fireLinkActivatedEvent
protected void fireLinkActivatedEvent(org.w3c.dom.svg.SVGAElement elt, java.lang.String href)Fires a LinkActivatedEvent.
-
setSVGCursor
public void setSVGCursor(java.awt.Cursor cursor)
Informs the user agent to change the cursor.- Specified by:
setSVGCursorin interfaceUserAgent- Parameters:
cursor- the new cursor
-
setTextSelection
public void setTextSelection(Mark start, Mark end)
Informs the user agent that the text selection has changed.- 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()
Informs the user agent that the text selection should be cleared.- Specified by:
deselectAllin interfaceUserAgent
-
getXMLParserClassName
public java.lang.String getXMLParserClassName()
Returns the class name of the XML parser.- Specified by:
getXMLParserClassNamein interfaceUserAgent
-
isXMLParserValidating
public boolean isXMLParserValidating()
Returns true if the XML parser must be in validation mode, false otherwise depending on the SVGUserAgent.- Specified by:
isXMLParserValidatingin interfaceUserAgent
-
getTransform
public java.awt.geom.AffineTransform getTransform()
Returns theAffineTransformcurrently applied to the drawing by the UserAgent.- Specified by:
getTransformin interfaceUserAgent
-
setTransform
public void setTransform(java.awt.geom.AffineTransform at)
Sets theAffineTransformto be applied to the drawing by the UserAgent.- Specified by:
setTransformin 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
-
getClientAreaLocationOnScreen
public java.awt.Point getClientAreaLocationOnScreen()
Returns the location on the screen of the client area in the UserAgent.- 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 extension 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 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 script 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
-
getBrokenLinkDocument
public org.w3c.dom.svg.SVGDocument getBrokenLinkDocument(org.w3c.dom.Element e, java.lang.String url, java.lang.String message)This implementation provides a true SVG Document that it annotates with some information about why the real document can't be loaded (unfortunately right now tool tips are broken for content referenced by images so you can't actually see the info).- 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()
Description copied from interface:UserAgentReturns the Font Family Resolver- Specified by:
getFontFamilyResolverin interfaceUserAgent
-
-