|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.7.2) E13403-10 |
|||||||||
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.jsp.libraries.JspLibrary
public class JspLibrary
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) Deprecated. |
|
JspLibrary(java.net.URL taglibURL, 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[] |
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 |
getMaxJspVersion() If last JSP version is not explicitly set, it will return null. |
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() |
java.net.URL |
getTaglibURL() |
java.lang.String |
getTechnologyScope() |
java.lang.String |
getTldURL() Deprecated. use getTaglibURL() |
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 |
setAvailableProperties(JspLibrary 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 |
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. |
void |
setMaxJspVersion(java.lang.String jspVersion) Sets last version of the JSP that this library will work in. |
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 |
setTaglibURL(java.net.URL url) |
void |
setTechnologyScope(java.lang.String technologyScope) Example: "Faces;JSP". |
void |
setTldURL(java.lang.String url) Deprecated. use setTaglibURL(URL) |
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() This implementation delegates to DefaultDisplayable.getShortLabel() . |
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 |
---|
public static final boolean RUN_TAGS_IN_EDITOR_BY_DEFAULT
getRunInEditor()
, Constant Field ValuesConstructor Detail |
---|
public JspLibrary(java.lang.String tldURL, java.lang.String uri, java.lang.String libraryName, java.lang.String libraries)
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.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.public JspLibrary(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 TLD 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.public JspLibrary(JspLibrary jsplibrary)
Method Detail |
---|
public static void copy(JspLibrary src, JspLibrary dst)
public void setAvailableProperties(JspLibrary target)
target
-public void setShowInPalette(boolean showInPalette)
showInPalette
-public boolean getShowInPalette()
public void setRunInEditor(boolean runInEditor)
runInEditor
- set true if tags should be run inside the Visual Editor.public boolean getRunInEditor()
setRunInEditor( boolean )
public java.lang.String[] getCustomizedRunInEditorTagNames()
RUN_TAGS_IN_EDITOR_BY_DEFAULT
public void setCustomizedRunInEditorTagNames(java.lang.String[] tags)
getCustomizedRunInEditorTagNames()
public void setName(java.lang.String name)
name
- the name to use when the tag is being manipulated within JDeveloper.public java.lang.String getName()
setName(String)
public void setURI(java.lang.String uri)
uri
- the taglibs namespacepublic java.lang.String getURI()
setURI(String)
public void setTldURL(java.lang.String url)
setTaglibURL(URL)
url
- - the url location of the TLD defining this library.public java.lang.String getTldURL()
getTaglibURL()
setTldURL(String)
public void setTaglibURL(java.net.URL url)
public java.net.URL getTaglibURL()
public void setLibraries(java.lang.String libraries)
libraries
- the semi-column delimited string of library IDs.public java.lang.String getLibraries()
setLibraries(String)
public java.lang.Object[] getLibraryIds(Context context)
public void setJspLibraries(java.lang.String jspLibraries)
jspLibraries
- the semi-column delimited string of JSP tag library names.public java.lang.String getJspLibraries()
setJspLibraries(String)
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 setPrefix(java.lang.String prefix)
prefix
- the prefix to use with this taglib.public java.lang.String getPrefix()
setPrefix( String )
public void setVersion(java.lang.String version)
version
- the version of this taglib.public java.lang.String getVersion()
setVersion( String )
public void setJspVersion(java.lang.String jspVersion)
jspVersion
- One of "1.1", "1.2", "2.0" ...public java.lang.String getJspVersion()
setJspVersion(String)
public void setMaxJspVersion(java.lang.String jspVersion)
jspVersion
- One of "1.1", "1.2", "2.0" ...public java.lang.String getMaxJspVersion()
setMaxJspVersion(String)
protected boolean isMutable()
protected void setMutable(boolean mutable)
public void setIcon(java.lang.String iconURL)
iconURL
- url of icon.public java.lang.String getIconURL()
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 equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
DefaultDisplayable
DefaultDisplayable.getShortLabel()
.toString
in interface Displayable
toString
in class DefaultDisplayable
Displayable.toString()
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.7.2) E13403-10 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |