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
To hide the user-agent methods.
-
Field Summary
Fields -
Constructor Summary
Constructors -
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
Informs the user agent that the text selection should be cleared.void
Displays an error resulting from the specified Exception.void
displayError
(String message) Displays an error message in the User Agent interface.void
displayMessage
(String message) Displays a message in the User Agent interface.protected void
fireLinkActivatedEvent
(org.w3c.dom.svg.SVGAElement elt, String href) Fires a LinkActivatedEvent.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 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).Returns the location on the screen of the client area in the UserAgent.Returns the default font family.Returns theEventDispatcher
used by theUserAgent
to dispatch events on GVT.getExternalResourceSecurity
(ParsedURL resourceURL, ParsedURL docURL) Returns the security settings for the given resource url and document urlReturns the Font Family ResolverReturns 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 urlfloat
Returns theAffineTransform
currently applied to the drawing by the UserAgent.Returns the user stylesheet uri.Returns the default size of the viewport of this user agent (0, 0).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
hasFeature
(String s) Tells whether the given feature is supported by this user agent.boolean
Returns true if the XML parser must be in validation mode, false otherwise depending on the SVGUserAgent.void
loadDocument
(String url) This method should load a new document described by the supplied URL.void
openLink
(org.w3c.dom.svg.SVGAElement elt) Opens a link.void
Lets the bridge tell the user agent that the following extension is supported by the bridge.void
setSourceResolution
(float sourceResolution) void
setSVGCursor
(Cursor cursor) Informs the user agent to change the cursor.void
setTextSelection
(Mark start, Mark end) Informs the user agent that the text selection has changed.void
Sets theAffineTransform
to be applied to the drawing by the UserAgent.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
-
extensions
-
-
Constructor Details
-
BridgeUserAgent
protected BridgeUserAgent()Creates a new user agent.
-
-
Method Details
-
getViewportSize
Returns the default size of the viewport of this user agent (0, 0).- Specified by:
getViewportSize
in interfaceUserAgent
-
getEventDispatcher
Returns theEventDispatcher
used by theUserAgent
to dispatch events on GVT.- Specified by:
getEventDispatcher
in interfaceUserAgent
-
displayError
Displays an error message in the User Agent interface. -
displayError
Displays an error resulting from the specified Exception.- Specified by:
displayError
in interfaceUserAgent
-
displayMessage
Displays a message in the User Agent interface.- Specified by:
displayMessage
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 language settings.- Specified by:
getLanguages
in interfaceUserAgent
-
getUserStyleSheetURI
Returns the user stylesheet uri.- Specified by:
getUserStyleSheetURI
in interfaceUserAgent
- Returns:
- null if no user style sheet was specified.
-
openLink
public void openLink(org.w3c.dom.svg.SVGAElement elt) Opens a link. -
fireLinkActivatedEvent
Fires a LinkActivatedEvent. -
setSVGCursor
Informs the user agent to change the cursor.- Specified by:
setSVGCursor
in interfaceUserAgent
- Parameters:
cursor
- the new cursor
-
setTextSelection
Informs the user agent that the text selection has changed.- 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()Informs the user agent that the text selection should be cleared.- Specified by:
deselectAll
in interfaceUserAgent
-
getXMLParserClassName
Returns the class name of the XML parser.- Specified by:
getXMLParserClassName
in interfaceUserAgent
-
isXMLParserValidating
public boolean isXMLParserValidating()Returns true if the XML parser must be in validation mode, false otherwise depending on the SVGUserAgent.- Specified by:
isXMLParserValidating
in interfaceUserAgent
-
getTransform
Returns theAffineTransform
currently applied to the drawing by the UserAgent.- Specified by:
getTransform
in interfaceUserAgent
-
setTransform
Sets theAffineTransform
to be applied to the drawing by the UserAgent.- Specified by:
setTransform
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
-
getClientAreaLocationOnScreen
Returns the location on the screen of the client area in the UserAgent.- 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 extension 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 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 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
-
getBrokenLinkDocument
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:
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
Description copied from interface:UserAgent
Returns the Font Family Resolver- Specified by:
getFontFamilyResolver
in interfaceUserAgent
-
getSourceResolution
public float getSourceResolution()- Specified by:
getSourceResolution
in interfaceUserAgent
-
setSourceResolution
public void setSourceResolution(float sourceResolution) - Specified by:
setSourceResolution
in interfaceUserAgent
-