oracle.jdeveloper.jsp.libraries
Class JspLibrary

java.lang.Object
  oracle.ide.model.DefaultDisplayable
      oracle.ide.model.DefaultElement
          oracle.jdeveloper.jsp.libraries.JspLibrary

All Implemented Interfaces:

Displayable, Element

public class JspLibrary

extends DefaultElement

implements Element

Instances of this class represent JSP Tag Libraries avialiable within the JDeveloper.
When JSP Tag Library is used (deployed) in a web project, associated libraries are added to the project and their archives are copied to the WEB-INF/lib folder. In case when there are no associated libraries, archive that contains Tag Library Descriptor (TLD) will be added to the project's class path, and copied to the WEB-INF/lib folder.

Field Summary

static boolean

RUN_TAGS_IN_EDITOR_BY_DEFAULT Default value runInEditor property will take when new library is created.

Constructor Summary

JspLibrary(JspLibrary jsplibrary)
Copy constructor.

JspLibrary(java.lang.String tldURL, java.lang.String uri, java.lang.String libraryName, java.lang.String libraries)
This creates a JspLibrary object that can be registered with JDeveloper.

Method Summary

static void	copy(JspLibrary src, JspLibrary dst) Copy utility method.
boolean	equals(java.lang.Object obj)
java.lang.String	getClassesURL() Deprecated.
java.lang.String[]	getCustomizedRunInEditorTagNames() Returns list of names of tags for which "run in editor" setting is opposite then the default run in editor settings for tag libraries.
java.lang.String	getIconURL()
java.lang.String	getJspLibraries()
java.lang.String	getJspVersion() If JSP version is not explicitly set, it will be deduced from information in TLD file.
java.lang.String	getLibraries()
java.lang.Object[]	getLibraryIds(Context context)
java.lang.String	getName()
java.lang.String	getPrefix() If preferred prefix is not defined short library name frmo TLD file will be used instead.
boolean	getRunInEditor()
java.lang.String	getShortLabel() Label is combination of library name and its version.
boolean	getShowInPalette()
oracle.jdeveloper.xml.j2ee.tld.Taglib	getTaglibModel() TOD: gide this from public API.
java.lang.String	getTechnologyScope()
java.lang.String	getTldURL()
java.lang.String	getURI()
java.lang.String	getVersion() If tag library version is not explicitly set, it will be deduced from information in TLD file.
int	hashCode()
protected boolean	isMutable()
void	setClassesURL(java.lang.String classesURL) Deprecated. Create new Java library and use setLibraries
void	setCustomizedRunInEditorTagNames(java.lang.String[] tags)
void	setIcon(java.lang.String iconURL) Set the url of the icon you wish to use when displaying individual tags within JDeveloper.
void	setJspLibraries(java.lang.String jspLibraries) Set the JSP tag libraries that should be added to the active project whenever any tags belonging to this taglib are used.
void	setJspVersion(java.lang.String jspVersion) Sets mimimal required version of the JSP for this library to work.
void	setLibraries(java.lang.String libraries) Set the libraries that should be added to the active project whenever any tags belonging to this taglib are used.
protected void	setMutable(boolean mutable)
void	setName(java.lang.String name) Set the name of this tag library.
void	setPrefix(java.lang.String prefix) Set the preffered prefix to be used for this taglib.
void	setRunInEditor(boolean runInEditor) Set whether to run all tags when viewed in the Visual Editor.
void	setShowInPalette(boolean showInPalette)
void	setTechnologyScope(java.lang.String technologyScope) Example: "Faces;JSP".
void	setTldURL(java.lang.String url) Set the location of the tag library descriptor.
void	setURI(java.lang.String uri) Set the taglib's namespace.
void	setVersion(java.lang.String version) Set the version of the tag library.
java.lang.String	toString() Returns the Short Label displayed to a user.

Methods inherited from class oracle.ide.model.DefaultElement

getAttributes, getChildren, getData, mayHaveChildren

Methods inherited from class oracle.ide.model.DefaultDisplayable

getIcon, getLongLabel, getToolTipText

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.ide.model.Element

getAttributes, getChildren, getData, mayHaveChildren

Methods inherited from interface oracle.ide.model.Displayable

getIcon, getLongLabel, getToolTipText

Field Detail

RUN_TAGS_IN_EDITOR_BY_DEFAULT

public static final boolean RUN_TAGS_IN_EDITOR_BY_DEFAULT

Default value runInEditor property will take when new library is created.

See Also:

getRunInEditor(), Constant Field Values

Constructor Detail

JspLibrary

public JspLibrary(java.lang.String tldURL,
                  java.lang.String uri,
                  java.lang.String libraryName,
                  java.lang.String libraries)

This creates a JspLibrary object that can be registered with JDeveloper. None of the parameters can be null.

Parameters:

tldURL - - the location of the TLD file. Note that you can use macros to specify relative urls to oracle home. ex. @oracle.home@/jdev/mylibraries/taglib.tld. Macro will be expanded once the library is added to the manager.

uri - - the namespace of this tag library.

libraryName - - the name to be used to identify this taglib.

libraries - - semi-column delimited list of Java library IDs that will be deployed when this tag library is used.

JspLibrary

public JspLibrary(JspLibrary jsplibrary)

Copy constructor. This performs deep copying.

Method Detail

copy

public static void copy(JspLibrary src,
                        JspLibrary dst)

Copy utility method. This performs deep copying.

setShowInPalette

public void setShowInPalette(boolean showInPalette)

Parameters:

showInPalette -

getShowInPalette

public boolean getShowInPalette()

Returns:

setRunInEditor

public void setRunInEditor(boolean runInEditor)

Set whether to run all tags when viewed in the Visual Editor.

Parameters:

runInEditor - set true if tags should be run inside the Visual Editor.

getRunInEditor

public boolean getRunInEditor()

See Also:

setRunInEditor( boolean )

getCustomizedRunInEditorTagNames

public java.lang.String[] getCustomizedRunInEditorTagNames()

Returns list of names of tags for which "run in editor" setting is opposite then the default run in editor settings for tag libraries.

See Also:

RUN_TAGS_IN_EDITOR_BY_DEFAULT

setCustomizedRunInEditorTagNames

public void setCustomizedRunInEditorTagNames(java.lang.String[] tags)

See Also:

getCustomizedRunInEditorTagNames()

setName

public void setName(java.lang.String name)

Set the name of this tag library. If preferred prefix is not defined this value will be used instead. Can not be null or an empty String.

Parameters:

name - the name to use when the tag is being manipulated within JDeveloper.

getName

public java.lang.String getName()

See Also:

setName(String)

setURI

public void setURI(java.lang.String uri)

Set the taglib's namespace. Can not be null or an empty String.

Parameters:

uri - the taglibs namespace

getURI

public java.lang.String getURI()

See Also:

setURI(String)

setTldURL

public void setTldURL(java.lang.String url)

Set the location of the tag library descriptor. Can not be null or an empty String.

Parameters:

url - - the url location of the TLD defining this library.

getTldURL

public java.lang.String getTldURL()

See Also:

setTldURL(String)

setLibraries

public void setLibraries(java.lang.String libraries)

Set the libraries that should be added to the active project whenever any tags belonging to this taglib are used. This is semi-column delimited string of library IDs. Example: "JSF;JSTL;D:/myLibs/foo.library".

Parameters:

libraries - the semi-column delimited string of library IDs.

getLibraries

public java.lang.String getLibraries()

See Also:

setLibraries(String)

getLibraryIds

public java.lang.Object[] getLibraryIds(Context context)

setJspLibraries

public void setJspLibraries(java.lang.String jspLibraries)

Set the JSP tag libraries that should be added to the active project whenever any tags belonging to this taglib are used. This is semi-column delimited string of JSP library names. Example: "JSTL Core;Struts HTML". Libraries can also be versioned by adding its version number after the name seperated by comma. Example: "JSTL Core,1.0;Struts HTML".

getJspLibraries

public java.lang.String getJspLibraries()

See Also:

setJspLibraries(String)

getTechnologyScope

public java.lang.String getTechnologyScope()

See Also:

setTechnologyScope(String)

setTechnologyScope

public void setTechnologyScope(java.lang.String technologyScope)

Example: "Faces;JSP".

Parameters:

technologyScope - the semi-column delimited string of technology scope IDs.

setPrefix

public void setPrefix(java.lang.String prefix)

Set the preffered prefix to be used for this taglib.

Parameters:

prefix - the prefix to use with this taglib.

getPrefix

public java.lang.String getPrefix()

If preferred prefix is not defined short library name frmo TLD file will be used instead. If short library name is not available prefix will be constructed from the library name.

See Also:

setPrefix( String )

setVersion

public void setVersion(java.lang.String version)

Set the version of the tag library.

Parameters:

version - the version of this taglib.

getVersion

public java.lang.String getVersion()

If tag library version is not explicitly set, it will be deduced from information in TLD file.

See Also:

setVersion( String )

setJspVersion

public void setJspVersion(java.lang.String jspVersion)

Sets mimimal required version of the JSP for this library to work.

Parameters:

jspVersion - One of "1.1", "1.2", "2.0" ...

getJspVersion

public java.lang.String getJspVersion()

If JSP version is not explicitly set, it will be deduced from information in TLD file.

See Also:

setJspVersion(String)

setClassesURL

public void setClassesURL(java.lang.String classesURL)

Deprecated. Create new Java library and use setLibraries

See Also:

setLibraries(java.lang.String)

getClassesURL

public java.lang.String getClassesURL()

Deprecated.

getTaglibModel

public oracle.jdeveloper.xml.j2ee.tld.Taglib getTaglibModel()

TOD: gide this from public API.

isMutable

protected boolean isMutable()

Returns:

true is element is editable via UI

setMutable

protected void setMutable(boolean mutable)

setIcon

public void setIcon(java.lang.String iconURL)

Set the url of the icon you wish to use when displaying individual tags within JDeveloper.

Parameters:

iconURL - url of icon.

getIconURL

public java.lang.String getIconURL()

getShortLabel

public java.lang.String getShortLabel()

Label is combination of library name and its version.

Specified by:

getShortLabel in interface Displayable

Overrides:

getShortLabel in class DefaultDisplayable

See Also:

Displayable.getShortLabel()

equals

public boolean equals(java.lang.Object obj)

hashCode

public int hashCode()

toString

public java.lang.String toString()

Description copied from interface: Displayable

Returns the Short Label displayed to a user. This overrides the toString method in java.lang.Object.

Implementors of the Displayable interface should override this as appropriate. The default implementation is the same as getShortLabel

Specified by:

toString in interface Displayable

Overrides:

toString in class DefaultDisplayable

See Also:

Displayable.toString()