oracle.jdeveloper.webapp.utils

Class WebDocumentUtil

java.lang.Object

oracle.jdeveloper.webapp.utils.CommonWebDocumentUtil

oracle.jdeveloper.webapp.utils.HtmlWebDocumentUtil

oracle.jdeveloper.webapp.utils.WebDocumentUtil

public final class WebDocumentUtil
extends oracle.jdeveloper.webapp.utils.HtmlWebDocumentUtil

Constructor Summary

Constructors

Constructor and Description
WebDocumentUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addTagLibrary(JspLibrary jspTagLibrary, oracle.bali.xml.gui.jdev.JDevXmlContext xmlContext)
static void	addTagLibrary(JspLibrary jspTagLibrary, Project project, oracle.bali.xml.model.AbstractModel model) Configures JSP page and the project it belongs to to use given JSP tag library.
static void	addTagLibrary(java.lang.String jspLibraryURI, oracle.bali.xml.gui.jdev.JDevXmlContext xmlContext)
static void	addTagLibrary(java.lang.String jspLibraryURI, Project project, oracle.bali.xml.model.AbstractModel model)
static oracle.bali.xml.gui.jdev.JDevXmlContext	createJspXmlContext(Context context, java.lang.String jspContent, boolean xmlSyntax) Creates an in memory JDevXmlContext for the JSP page/document.
static java.lang.String	findJspNamespace(oracle.bali.xml.model.AbstractModel model, java.lang.String fallbackNamespace) Finds namespace of JSP core syntax elements in the given model.
static java.util.Iterator	findTagLibDirectives(oracle.bali.xml.model.AbstractModel model) Finds all taglib directive nodes in the document.
static java.lang.String	getDefaultJspNamespace(oracle.bali.xml.model.XmlContext context) Returns a default JSP core syntax namespace to be used in the given context.
static java.util.List	getJSFActionMethodBindings(oracle.bali.xml.model.AbstractModel model) Returns a List of Strings for all of the JSF elements in the model whose action attributes are method bindings.
static java.lang.String	getJspNamespace(oracle.bali.xml.model.AbstractModel model) Finds JSP namesapce used in the document of the given model, or if none is used returns default JSP namesapce in its context.
static java.util.Set<java.lang.String>	getTagLibsDeclared(oracle.bali.xml.model.AbstractModel model) Finds and returns all the declared tag libraries in JSP Document/ JSP Page

Methods inherited from class oracle.jdeveloper.webapp.utils.HtmlWebDocumentUtil

findHtmlNamespace, getDefaultHtmlNamespace, getHtmlNamespace

Methods inherited from class oracle.jdeveloper.webapp.utils.CommonWebDocumentUtil

findNodes, importFragment, importNode, importNodes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebDocumentUtil

public WebDocumentUtil()

Method Detail

findTagLibDirectives

public static java.util.Iterator findTagLibDirectives(oracle.bali.xml.model.AbstractModel model)

Finds all taglib directive nodes in the document. Caller should acquire a read lock on the model before accessing this method, and release the lock only after the returned iterator is not used any more.

Parameters:

model -

Returns:

list of DOM Nodes

getDefaultJspNamespace

public static java.lang.String getDefaultJspNamespace(oracle.bali.xml.model.XmlContext context)

Returns a default JSP core syntax namespace to be used in the given context. This value should be used as JSP core syntax namespace in the given context if no other JSP core syntax namespace has already been used.

findJspNamespace

public static java.lang.String findJspNamespace(oracle.bali.xml.model.AbstractModel model,
                                java.lang.String fallbackNamespace)

Finds namespace of JSP core syntax elements in the given model. If model does not have any JSP core syntax elements, it returns fallback namespace.

Parameters:

model - to be searched for JSP core syntax elements

fallbackNamespace - namespace to be returned of model does not contain any JSP core syntax elements.

Returns:

namespace of JSP core syntax elements found in document

See Also:

getDefaultJspNamespace(XmlContext)

getJspNamespace

public static java.lang.String getJspNamespace(oracle.bali.xml.model.AbstractModel model)

Finds JSP namesapce used in the document of the given model, or if none is used returns default JSP namesapce in its context.

Parameters:

model -

Returns:

addTagLibrary

public static void addTagLibrary(java.lang.String jspLibraryURI,
                 oracle.bali.xml.gui.jdev.JDevXmlContext xmlContext)
                          throws oracle.bali.xml.model.XmlCommitException

Throws:

oracle.bali.xml.model.XmlCommitException

See Also:

#addTagLibrary( JspLibrary, JProject, AbstractModel )

addTagLibrary

public static void addTagLibrary(java.lang.String jspLibraryURI,
                 Project project,
                 oracle.bali.xml.model.AbstractModel model)
                          throws oracle.bali.xml.model.XmlCommitException

Throws:

oracle.bali.xml.model.XmlCommitException

See Also:

#addTagLibrary( JspLibrary, JProject, AbstractModel )

addTagLibrary

public static void addTagLibrary(JspLibrary jspTagLibrary,
                 oracle.bali.xml.gui.jdev.JDevXmlContext xmlContext)
                          throws oracle.bali.xml.model.XmlCommitException

Throws:

oracle.bali.xml.model.XmlCommitException

See Also:

#addTagLibrary( JspLibrary, JProject, AbstractModel )

addTagLibrary

public static void addTagLibrary(JspLibrary jspTagLibrary,
                 Project project,
                 oracle.bali.xml.model.AbstractModel model)
                          throws oracle.bali.xml.model.XmlCommitException

Configures JSP page and the project it belongs to to use given JSP tag library. This will add tag library directive to the JSP page (or xmlns attribute to JSP document), and configure project to use given JSP tag library. If there are any configuration taks associated with the tag library they will be run too.

Parameters:

jspTagLibrary - JSP tag library.

project - Web application JSP page belongs to.

model - XML model of the one of the JSP file type documents.

Throws:

oracle.bali.xml.model.XmlCommitException

getJSFActionMethodBindings

public static java.util.List getJSFActionMethodBindings(oracle.bali.xml.model.AbstractModel model)

Returns a List of Strings for all of the JSF elements in the model whose action attributes are method bindings.

createJspXmlContext

public static oracle.bali.xml.gui.jdev.JDevXmlContext createJspXmlContext(Context context,
                                                          java.lang.String jspContent,
                                                          boolean xmlSyntax)

Creates an in memory JDevXmlContext for the JSP page/document. Clients may call JDevXmlContext.getIdeDocument().close() to quickly release the JDevXmlContext object.

Parameters:

context - IDE context has to have project.

jspContent - Content of the JSP page or document.

xmlSyntax - True if the given jsp content is in the XML format.

Returns:

getTagLibsDeclared

public static java.util.Set<java.lang.String> getTagLibsDeclared(oracle.bali.xml.model.AbstractModel model)

Finds and returns all the declared tag libraries in JSP Document/ JSP Page

Parameters:

model - to be searched

Returns:

an unmodifiable Set of declared tag libraries in the model.