Package nl.nikhef.xhtmlrenderer.swing

Interface IDocumentContainer

All Known Subinterfaces:

ITemplateContainer, ITemplatePanel, IXHTMLPanel

All Known Implementing Classes:

RequestWizard, TemplateButtonPanel, TemplatePanel, TemplateWizard, XHTMLPanel

public interface IDocumentContainer

XHTMLPanel methods related to the Document.

Method Summary

Modifier and Type	Method	Description
Document	getDocument()
String	getDocumentTitle()	Returns the title as reported by the NamespaceHandler assigned to the SharedContext in this panel.
URL	getURL()
void	reloadDocument(String URI)	Reloads the document using the same base URL and namespace handler.
void	reloadDocument(Document doc)	Reloads the document using the same base URL and namespace handler.
void	setDocument(File file)	Renders a Document read from an InputStream using a URL as a base URL for relative paths.
void	setDocument(InputStream stream, String url)	Renders a Document read from an InputStream using a URL as a base URL for relative paths.
void	setDocument(InputStream stream, String url, org.xhtmlrenderer.extend.NamespaceHandler nsh)
void	setDocument(String uri)	Loads and renders a Document given a uri.
void	setDocument(String url, org.xhtmlrenderer.extend.NamespaceHandler nsh)
void	setDocument(Document doc)	Renders an XML Document instance.
void	setDocument(Document doc, String url)	Renders a Document using a URL as a base URL for relative paths.
void	setDocumentFromString(String content, String url, org.xhtmlrenderer.extend.NamespaceHandler nsh)

Method Detail

setDocument

void setDocument(String uri)

Loads and renders a Document given a uri. The uri is resolved by the UserAgentCallback

Parameters:

uri -

setDocument

void setDocument(Document doc)

Renders an XML Document instance. Make sure that no relative resources are needed

Parameters:

doc - The document to render.

setDocument

void setDocument(Document doc,
                 String url)

Renders a Document using a URL as a base URL for relative paths.

Parameters:

doc - The new document value

url - The new document value

setDocument

void setDocument(InputStream stream,
                 String url)
          throws Exception

Renders a Document read from an InputStream using a URL as a base URL for relative paths.

Parameters:

stream - The stream to read the Document from.

url - The URL used to resolve relative path references.

Throws:

Exception

setDocument

void setDocument(InputStream stream,
                 String url,
                 org.xhtmlrenderer.extend.NamespaceHandler nsh)

setDocumentFromString

void setDocumentFromString(String content,
                           String url,
                           org.xhtmlrenderer.extend.NamespaceHandler nsh)

setDocument

void setDocument(String url,
                 org.xhtmlrenderer.extend.NamespaceHandler nsh)

reloadDocument

void reloadDocument(String URI)

Reloads the document using the same base URL and namespace handler. Reloading will pick up changes to styles within the document.

Parameters:

URI - A URI for the Document to load, for example, file.toURL().toExternalForm().

reloadDocument

void reloadDocument(Document doc)

Reloads the document using the same base URL and namespace handler. Reloading will pick up changes to styles within the document.

Parameters:

doc - The document to reload.

getURL

URL getURL()

getDocument

Document getDocument()

getDocumentTitle

String getDocumentTitle()

Returns the title as reported by the NamespaceHandler assigned to the SharedContext in this panel. For an HTML document, this will be the contents of /html/head/title.

Returns:

the document title, or "" if the namespace handler cannot find a title, or if there is no current document in the panel.

setDocument

void setDocument(File file)
          throws Exception

Renders a Document read from an InputStream using a URL as a base URL for relative paths.

Parameters:

file - The file to read the Document from. Relative paths will be resolved based on the file's parent directory.

Throws:

Exception