|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.3.0) E17493-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.ide.model.DefaultDisplayable
oracle.ide.model.DefaultElement
oracle.jdeveloper.webapp.libraries.TagLibrary
public abstract class TagLibrary
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 |
---|
public static final boolean RUN_TAGS_IN_EDITOR_BY_DEFAULT
protected java.lang.String prefferedPrefix
protected java.lang.String version
Constructor Detail |
---|
public TagLibrary(java.net.URL taglibURL, java.lang.String uri, java.lang.String libraryName, java.lang.String libraries)
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.protected TagLibrary()
Method Detail |
---|
public boolean getShowInPalette()
getShowInPalette
in interface DisplayableTagLibrary
public boolean getRunInEditor()
getRunInEditor
in interface DisplayableTagLibrary
setRunInEditor( boolean )
public void setRunInEditor(boolean runInEditor)
setRunInEditor
in interface DisplayableTagLibrary
runInEditor
- set true if tags should be run inside the Visual Editor.public void setShowInPalette(boolean showInPalette)
setShowInPalette
in interface DisplayableTagLibrary
showInPalette
-public java.lang.String getPrefix()
getPrefix
in interface DisplayableTagLibrary
setPrefix(String)
public void setIcon(java.lang.String iconURL)
setIcon
in interface DisplayableTagLibrary
iconURL
- url of icon.public java.lang.String getName()
getName
in interface DisplayableTagLibrary
setName(String)
public java.lang.String getURI()
DisplayableTagLibrary
getURI
in interface DisplayableTagLibrary
setURI(String)
public java.lang.String getLibraries()
setLibraries(String)
public void setName(java.lang.String name)
setName
in interface DisplayableTagLibrary
name
- the name to use when the tag is being manipulated within JDeveloper.public java.lang.String getShortLabel()
getShortLabel
in interface Displayable
getShortLabel
in class DefaultDisplayable
Displayable
that can be shown to the user.Displayable.getShortLabel()
public boolean isMutable()
public void setMutable(boolean mutable)
public void setURI(java.lang.String uri)
uri
- the taglibs namespacepublic java.lang.Object[] getLibraryIds(Context context)
public java.lang.String getVersion()
getVersion
in interface DisplayableTagLibrary
setVersion(String)
public java.lang.String getIconURL()
getIconURL
in interface DisplayableTagLibrary
public void setVersion(java.lang.String version)
setVersion
in interface DisplayableTagLibrary
version
- the version of this taglib.public java.net.URL getTaglibURL()
public static void copy(TagLibrary src, TagLibrary dst)
public java.lang.String[] getCustomizedRunInEditorTagNames()
RUN_TAGS_IN_EDITOR_BY_DEFAULT
protected abstract void initFromTaglib()
protected abstract java.lang.String getTaglibURLExt()
public abstract void setAvailableProperties(TagLibrary target)
target
- copying to a different TagLibrary subclass may not be supportedpublic abstract oracle.jdeveloper.webapp.taglib.model.AbstractTaglib getTaglib()
AbstractTaglib
object.AbstractTaglib
object.public void setPrefix(java.lang.String prefix)
setPrefix
in interface DisplayableTagLibrary
prefix
- the prefix to use with this taglib.public void setLibraries(java.lang.String libraries)
libraries
- the semi-column delimited string of library IDs.public void reportMissingData()
public void setTaglibURL(java.net.URL url)
public java.lang.String getTechnologyScope()
setTechnologyScope(String)
public void setTechnologyScope(java.lang.String technologyScope)
technologyScope
- the semi-column delimited string of technology scope IDs.public void setCustomizedRunInEditorTagNames(java.lang.String[] tags)
getCustomizedRunInEditorTagNames()
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.3.0) E17493-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |