Skip navigation links

oracle.jdeveloper.webapp.libraries
Class TagLibrary

java.lang.Object
oracle.ide.model.DefaultDisplayable
oracle.ide.model.DefaultElement
oracle.jdeveloper.webapp.libraries.TagLibrary

All Implemented Interfaces:

Displayable, Element, DisplayableTagLibrary

Direct Known Subclasses:

JspLibrary

public abstract class TagLibrary

extends DefaultElement

implements Element, DisplayableTagLibrary

Refactored from JspLibrary. A common super class for JspLibrary and FaceletLibrary

Field Summary

protected java.lang.String	prefferedPrefix
static boolean	RUN_TAGS_IN_EDITOR_BY_DEFAULT
protected java.lang.String	version

Constructor Summary

protected	TagLibrary() Exists just to satisfy compiler requirements for subclass constructors.
	TagLibrary(java.net.URL taglibURL, java.lang.String uri, java.lang.String libraryName, java.lang.String libraries) This creates an TagLibrary object that can be registered with JDeveloper.

Method Summary

static void	copy(TagLibrary src, TagLibrary dst) Copy utility method.
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	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 Taglib file will be used instead.
boolean	getRunInEditor() Property for IDE ingegration
java.lang.String	getShortLabel() Label is combination of library name and its version.
boolean	getShowInPalette() Property for IDE ingegration
abstract oracle.jdeveloper.webapp.taglib.model.AbstractTaglib	getTaglib() Get the AbstractTaglib object.
java.net.URL	getTaglibURL()
protected abstract java.lang.String	getTaglibURLExt() Return default extension file for the taglib
java.lang.String	getTechnologyScope()
java.lang.String	getURI() Taglib URI or namespace getter.
java.lang.String	getVersion() If tag library version is not explicitly set, it will be deduced from information in Taglib file.
protected abstract void	initFromTaglib() Init the tag library fields.
boolean	isMutable()
void	reportMissingData()
abstract void	setAvailableProperties(TagLibrary target) This should be avialable only to "friendly" classes.
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	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.
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) Property for IDE ingegration
void	setTaglibURL(java.net.URL url)
void	setTechnologyScope(java.lang.String technologyScope) Example: "Faces;JSP".
void	setURI(java.lang.String uri) Set the taglib's namespace.
void	setVersion(java.lang.String version) Set the version of the tag library.

Methods inherited from class oracle.ide.model.DefaultElement

getAttributes, getChildren, getData, mayHaveChildren

Methods inherited from class oracle.ide.model.DefaultDisplayable

getIcon, getLongLabel, getToolTipText, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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, toString

Field Detail

RUN_TAGS_IN_EDITOR_BY_DEFAULT

public static final boolean RUN_TAGS_IN_EDITOR_BY_DEFAULT

See Also:

Constant Field Values

prefferedPrefix

protected java.lang.String prefferedPrefix

version

protected java.lang.String version

Constructor Detail

TagLibrary

public TagLibrary(java.net.URL taglibURL,
                  java.lang.String uri,
                  java.lang.String libraryName,
                  java.lang.String libraries)

This creates an TagLibrary object that can be registered with JDeveloper. None of the parameters can be null.

Parameters:

taglibURL - - the location of the tag library. It can be taglib file location, or the folder for implicit .tag libraries.

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.

TagLibrary

protected TagLibrary()

Exists just to satisfy compiler requirements for subclass constructors.

Method Detail

getShowInPalette

public boolean getShowInPalette()

Property for IDE ingegration

Specified by:

getShowInPalette in interface DisplayableTagLibrary

Returns:

getRunInEditor

public boolean getRunInEditor()

Property for IDE ingegration

Specified by:

getRunInEditor in interface DisplayableTagLibrary

See Also:

setRunInEditor( boolean )

setRunInEditor

public void setRunInEditor(boolean runInEditor)

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

Specified by:

setRunInEditor in interface DisplayableTagLibrary

Parameters:

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

setShowInPalette

public void setShowInPalette(boolean showInPalette)

Property for IDE ingegration

Specified by:

setShowInPalette in interface DisplayableTagLibrary

Parameters:

showInPalette -

getPrefix

public java.lang.String getPrefix()

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

Specified by:

getPrefix in interface DisplayableTagLibrary

See Also:

setPrefix(String)

setIcon

public void setIcon(java.lang.String iconURL)

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

Specified by:

setIcon in interface DisplayableTagLibrary

Parameters:

iconURL - url of icon.

getName

public java.lang.String getName()

Specified by:

getName in interface DisplayableTagLibrary

See Also:

setName(String)

getURI

public java.lang.String getURI()

Description copied from interface: DisplayableTagLibrary

Taglib URI or namespace getter.

Specified by:

getURI in interface DisplayableTagLibrary

See Also:

setURI(String)

getLibraries

public java.lang.String getLibraries()

See Also:

setLibraries(String)

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.

Specified by:

setName in interface DisplayableTagLibrary

Parameters:

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

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

Returns:

a short descriptive label of the Displayable that can be shown to the user.

See Also:

Displayable.getShortLabel()

isMutable

public boolean isMutable()

Returns:

true is element is editable via UI

setMutable

public void setMutable(boolean mutable)

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

getLibraryIds

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

getVersion

public java.lang.String getVersion()

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

Specified by:

getVersion in interface DisplayableTagLibrary

See Also:

setVersion(String)

getIconURL

public java.lang.String getIconURL()

Specified by:

getIconURL in interface DisplayableTagLibrary

setVersion

public void setVersion(java.lang.String version)

Set the version of the tag library.

Specified by:

setVersion in interface DisplayableTagLibrary

Parameters:

version - the version of this taglib.

getTaglibURL

public java.net.URL getTaglibURL()

copy

public static void copy(TagLibrary src,
                        TagLibrary dst)

Copy utility method. This performs deep copying.

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

initFromTaglib

protected abstract void initFromTaglib()

Init the tag library fields.

getTaglibURLExt

protected abstract java.lang.String getTaglibURLExt()

Return default extension file for the taglib

Returns:

setAvailableProperties

public abstract void setAvailableProperties(TagLibrary target)

This should be avialable only to "friendly" classes. Copies to target only non-required properties that are explicitly set. Avoids loading data from Taglib file.

Parameters:

target - copying to a different TagLibrary subclass may not be supported

getTaglib

public abstract oracle.jdeveloper.webapp.taglib.model.AbstractTaglib getTaglib()

Get the AbstractTaglib object.

Returns:

AbstractTaglib The AbstractTaglib object.

setPrefix

public void setPrefix(java.lang.String prefix)

Set the preffered prefix to be used for this taglib.

Specified by:

setPrefix in interface DisplayableTagLibrary

Parameters:

prefix - the prefix to use with this taglib.

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.

reportMissingData

public void reportMissingData()

setTaglibURL

public void setTaglibURL(java.net.URL url)

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.

setCustomizedRunInEditorTagNames

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

See Also:

getCustomizedRunInEditorTagNames()

Skip navigation links