DelegatingUserAgent (xhtmlrenderer 3.0.0-M1 API)

java.lang.Object
- org.docx4j.org.xhtmlrenderer.swing.DelegatingUserAgent

所有已实现的接口:

DocumentListener, UserAgentCallback
```
public class DelegatingUserAgent
extends Object
implements UserAgentCallback, DocumentListener
```
NaiveUserAgent is a simple implementation of UserAgentCallback which places no restrictions on what XML, CSS or images are loaded, and reports visited links without any filtering. The most straightforward process available in the JDK is used to load the resources in question--either using java.io or java.net classes.

The NaiveUserAgent has a small cache for images, the size of which (number of images) can be passed as a constructor argument. There is no automatic cleaning of the cache; call shrinkImageCache() to remove the least-accessed elements--for example, you might do this when a new document is about to be loaded. The NaiveUserAgent is also a DocumentListener; if registered with a source of document events (like the panel hierarchy), it will respond to the DocumentListener.documentStarted() call and attempt to shrink its cache.

This class is meant as a starting point--it will work out of the box, but you should really implement your own, tuned to your application's needs.

作者:

Torbjorn Gannholm

构造器概要

构造器
构造器和说明

DelegatingUserAgent()
Creates a new instance of NaiveUserAgent with a max image cache of 16 images.

构造器
构造器和说明
`DelegatingUserAgent()` Creates a new instance of NaiveUserAgent with a max image cache of 16 images.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`clearImageCache()` Empties the image cache entirely.
`void`	`documentLoaded()` Indicates document layout has complete, e.g. document is fully "loaded" for display; this is not a callback for the document source (e.g.
`void`	`documentStarted()` Indicates document has been requested (e.g. a new document is going to be loaded).
`String`	`getBaseURL()` Returns the current baseUrl for this class.
`byte[]`	`getBinaryResource(String uri)` Retrieves a binary resource located at a given URI and returns its contents as a byte array or `null` if the resource could not be loaded.
`CSSResource`	`getCSSResource(String uri)` Retrieves the CSS located at the given URI.
`ImageResource`	`getImageResource(String uri)` Retrieves the image located at the given URI.
`XMLResource`	`getXMLResource(String uri)` Retrieves the XML located at the given URI.
`boolean`	`isVisited(String uri)` Returns true if the given URI was visited, meaning it was requested at some point since initialization.
`void`	`onLayoutException(Throwable t)` Called when document layout failed with an exception.
`void`	`onRenderException(Throwable t)` Called when document render failed with an exception.
`protected InputStream`	`resolveAndOpenStream(String uri)` Gets a Reader for the resource identified
`String`	`resolveURI(String uri)` Resolves the URI; if absolute, leaves as is, if relative, returns an absolute URI based on the baseUrl for the agent.
`void`	`setBaseURL(String uri)` URL relative to which URIs are resolved.
`void`	`setImageResourceLoader(ImageResourceLoader loader)`
`void`	`setRepaintListener(RepaintListener listener)`
`void`	`shrinkImageCache()` If the image cache has more items than the limit specified for this class, the least-recently used will be dropped from cache until it reaches the desired size.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - DelegatingUserAgent
```
public DelegatingUserAgent()
```
    Creates a new instance of NaiveUserAgent with a max image cache of 16 images.
- 方法详细资料
  - setImageResourceLoader
```
public void setImageResourceLoader(ImageResourceLoader loader)
```
  - shrinkImageCache
```
public void shrinkImageCache()
```
    If the image cache has more items than the limit specified for this class, the least-recently used will be dropped from cache until it reaches the desired size.
  - clearImageCache
```
public void clearImageCache()
```
    Empties the image cache entirely.
  - resolveAndOpenStream
```
protected InputStream resolveAndOpenStream(String uri)
```
    Gets a Reader for the resource identified
    
    参数:
    
    uri - PARAM
    
    返回:
    
    The stylesheet value
  - getCSSResource
```
public CSSResource getCSSResource(String uri)
```
    Retrieves the CSS located at the given URI. It's assumed the URI does point to a CSS file--the URI will be accessed (using java.io or java.net), opened, read and then passed into the CSS parser. The result is packed up into an CSSResource for later consumption.
    
    指定者:
    
    getCSSResource 在接口中 UserAgentCallback
    
    参数:
    
    uri - Location of the CSS source.
    
    返回:
    
    A CSSResource containing the parsed CSS.
  - getImageResource
```
public ImageResource getImageResource(String uri)
```
    Retrieves the image located at the given URI. It's assumed the URI does point to an image--the URI will be accessed (using java.io or java.net), opened, read and then passed into the JDK image-parsing routines. The result is packed up into an ImageResource for later consumption.
    
    指定者:
    
    getImageResource 在接口中 UserAgentCallback
    
    参数:
    
    uri - Location of the image source.
    
    返回:
    
    An ImageResource containing the image.
  - getXMLResource
```
public XMLResource getXMLResource(String uri)
```
    Retrieves the XML located at the given URI. It's assumed the URI does point to a XML--the URI will be accessed (using java.io or java.net), opened, read and then passed into the XML parser (XMLReader) configured for Flying Saucer. The result is packed up into an XMLResource for later consumption.
    
    指定者:
    
    getXMLResource 在接口中 UserAgentCallback
    
    参数:
    
    uri - Location of the XML source.
    
    返回:
    
    An XMLResource containing the image.
  - getBinaryResource
```
public byte[] getBinaryResource(String uri)
```
    从接口复制的说明: UserAgentCallback
    
    Retrieves a binary resource located at a given URI and returns its contents as a byte array or null if the resource could not be loaded.
    
    指定者:
    
    getBinaryResource 在接口中 UserAgentCallback
  - isVisited
```
public boolean isVisited(String uri)
```
    Returns true if the given URI was visited, meaning it was requested at some point since initialization.
    
    指定者:
    
    isVisited 在接口中 UserAgentCallback
    
    参数:
    
    uri - A URI which might have been visited.
    
    返回:
    
    Always false; visits are not tracked in the NaiveUserAgent.
  - setBaseURL
```
public void setBaseURL(String uri)
```
    URL relative to which URIs are resolved.
    
    指定者:
    
    setBaseURL 在接口中 UserAgentCallback
    
    参数:
    
    uri - A URI which anchors other, possibly relative URIs.
  - resolveURI
```
public String resolveURI(String uri)
```
    Resolves the URI; if absolute, leaves as is, if relative, returns an absolute URI based on the baseUrl for the agent.
    
    指定者:
    
    resolveURI 在接口中 UserAgentCallback
    
    参数:
    
    uri - A URI, possibly relative.
    
    返回:
    
    A URI as String, resolved, or null if there was an exception (for example if the URI is malformed).
  - getBaseURL
```
public String getBaseURL()
```
    Returns the current baseUrl for this class.
    
    指定者:
    
    getBaseURL 在接口中 UserAgentCallback
    
    返回:
    
    the base uri, possibly in the implementations private uri-space
  - documentStarted
```
public void documentStarted()
```
    从接口复制的说明: DocumentListener
    
    Indicates document has been requested (e.g. a new document is going to be loaded). This will be called before any activity takes place for the document.
    
    指定者:
    
    documentStarted 在接口中 DocumentListener
  - documentLoaded
```
public void documentLoaded()
```
    从接口复制的说明: DocumentListener
    
    Indicates document layout has complete, e.g. document is fully "loaded" for display; this is not a callback for the document source (e.g. XML) being loaded. This method will be called on every layout run (including, for example, after panel resizes).
    
    指定者:
    
    documentLoaded 在接口中 DocumentListener
  - onLayoutException
```
public void onLayoutException(Throwable t)
```
    从接口复制的说明: DocumentListener
    
    Called when document layout failed with an exception. All Throwable objects thrown (except for ThreadDeath) during layout and not otherwise handled will be provided to this method. If a DocumentListener has been defined an XHTML panel, the listener is entirely responsible for handling the exception. No other action will be taken.
    
    指定者:
    
    onLayoutException 在接口中 DocumentListener
  - onRenderException
```
public void onRenderException(Throwable t)
```
    从接口复制的说明: DocumentListener
    
    Called when document render failed with an exception. All Throwable objects thrown (except for ThreadDeath) during render and not otherwise handled will be provided to this method. If a DocumentListener has been defined an XHTML panel, the listener is entirely responsible for handling the exception. No other action will be taken.
    
    指定者:
    
    onRenderException 在接口中 DocumentListener
  - setRepaintListener
```
public void setRepaintListener(RepaintListener listener)
```

类 DelegatingUserAgent

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

DelegatingUserAgent

方法详细资料

setImageResourceLoader

shrinkImageCache

clearImageCache

resolveAndOpenStream

getCSSResource

getImageResource

getXMLResource

getBinaryResource

isVisited

setBaseURL

resolveURI

getBaseURL

documentStarted

documentLoaded

onLayoutException

onRenderException

setRepaintListener