|
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.jdeveloper.library.JLibraryList
public final class JLibraryList
Field Summary | |
---|---|
static URLFilter |
JDK_FILTER |
static URLFilter |
LIB_FILTER |
static java.lang.String |
SYSTEM_LIBRARIES |
static java.lang.String |
USER_LIBRARIES |
Fields inherited from interface oracle.jdeveloper.library.LibraryList |
---|
JDK_LIST_PROPERTY, LIB_LIST_PROPERTY, LISTNAME_PROPERTY, TRANSIENT_PROPERTY |
Constructor Summary | |
---|---|
JLibraryList(java.net.URL url) |
Method Summary | |
---|---|
JDK |
addJDK(java.lang.String name, java.net.URL exeURL) Add a JDK using the given name and based upon the given executble. |
JDK |
addJDK(java.lang.String name, java.net.URL exeURL, java.net.URL location) |
JLibrary |
addLibrary(java.lang.String name) Add a JLibrary using the given name. |
JLibrary |
addLibrary(java.lang.String name, java.net.URL location) |
java.lang.Object |
createIDFromName(java.lang.String name, boolean isJDK) Create an ID based upon the given name. |
JDK |
findJDK(java.lang.Object id) Finds the JDK definition that matches the specified name. |
JLibrary |
findLibrary(java.lang.Object id) Finds the JLibrary that matches the specified id. |
javax.swing.Icon |
getDefaultIcon() Get the default Icon used for newly created Library instances. |
javax.swing.Icon |
getIcon() Returns an Icon that can be shown in association with this Displayable . |
java.util.List |
getJdkList() Retrieves a List of JDK definitions contained in this LibraryList. |
java.util.List |
getLibraryList() Retrieves a List of JLibrary definitions contained in this LibraryList. |
java.lang.String |
getListName() Retrieves the name of this LibraryList. |
java.lang.String |
getLongLabel() Returns a long label that can be displayed to the user. |
java.lang.String |
getShortLabel() Returns a short label that can be displayed to the user. |
java.lang.String |
getToolTipText() Returns the tool tip text to show when the mouse pointer pauses over a UI component that represents this Displayable . |
java.net.URL |
getURL() Returns the URL that identifies this Locatable . |
boolean |
isTransient() Whether this list is transient (not-persistent). |
boolean |
remove(Library library) Remove a JDK or JLibrary from the respective list. |
void |
setJdkList(java.util.List jdks) Sets a List of JDK definitions contained in this LibraryList. |
void |
setLibraryList(java.util.List libraries) Sets a List of JLibrary definitions contained in this LibraryList. |
void |
setListName(java.lang.String name) Sets the name of this LibraryList. |
void |
setURL(java.net.URL url) Sets the URL associated with this Locatable . |
java.lang.String |
toString() Returns the Short Label displayed to a user. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String SYSTEM_LIBRARIES
public static final java.lang.String USER_LIBRARIES
public static final URLFilter JDK_FILTER
public static final URLFilter LIB_FILTER
Constructor Detail |
---|
public JLibraryList(java.net.URL url)
Method Detail |
---|
public JDK findJDK(java.lang.Object id)
LibraryList
findJDK
in interface LibraryList
id
- the id of the JDK definitionJDK
representing the JDK definition.public JLibrary findLibrary(java.lang.Object id)
LibraryList
findLibrary
in interface LibraryList
public java.util.List getJdkList()
LibraryList
getJdkList
in interface LibraryList
public java.util.List getLibraryList()
LibraryList
getLibraryList
in interface LibraryList
public java.lang.String getListName()
LibraryList
getListName
in interface LibraryList
public boolean isTransient()
LibraryList
isTransient
in interface LibraryList
public java.lang.String getShortLabel()
Displayable
String
is considered translatable and should therefore be placed in an appropriate resource file. When possible, the returned label should be reasonably short enough to show in the navigator or explorer windows but long enough to clearly identify and distinguish the Displayable
.getShortLabel
in interface Displayable
Displayable
that can be shown to the user.public java.lang.String getLongLabel()
Displayable
String
is considered translatable and should therefore be placed in an appropriate resource file. The long label differs from the short label essentially on length. Usually the long label will only be shown on-demand and in places where horizontal space is more available. Examples are the status bar and tooltips.getLongLabel
in interface Displayable
Displayable
that can be shown to the user.public javax.swing.Icon getIcon()
Displayable
Icon
that can be shown in association with this Displayable
. Typically the icon will be used in a tree control or list control. Therefore the icon must fit naturally within the space normally given to items within those controls. Such icons are usually 16x16 in size or, if there is a one-pixel transparent padding around the edge, 18x18 in size. It is strongly recommended that icons returned by this method be either 16x16 or 18x18 in size. If null
is returned, the control may show a default icon, or it may show no icon, whichever is appropriate.getIcon
in interface Displayable
Icon
to be displayed for the Displayable
.public java.lang.String getToolTipText()
Displayable
Displayable
. In many cases it may be appropriate for this method to return the same value as Displayable.getLongLabel()
.getToolTipText
in interface Displayable
Displayable
.public java.lang.String toString()
Displayable
toString
method in java.lang.Object
.
Implementors of the Displayable
interface should override this as appropriate. The default implementation is the same as getShortLabel
toString
in interface Displayable
toString
in class java.lang.Object
Object.toString()
, Displayable.getShortLabel()
public java.net.URL getURL()
Locatable
URL
that identifies this Locatable
. Parts of the IDE will use the value of this URL
as a hash key for caching UI components for this Locatable
. Therefore, URL
uniqueness is important.getURL
in interface Locatable
URL
identifying this Locatable
.public void setURL(java.net.URL url)
Locatable
URL
associated with this Locatable
. It is important that the URL
only be changed when the Locatable
has just been created or when all caches keyed on the previous URL
can also be updated.setURL
in interface Locatable
url
- The URL
to set.public void setJdkList(java.util.List jdks)
MutableLibraryList
setJdkList
in interface MutableLibraryList
public void setLibraryList(java.util.List libraries)
MutableLibraryList
setLibraryList
in interface MutableLibraryList
public void setListName(java.lang.String name)
MutableLibraryList
setListName
in interface MutableLibraryList
public JDK addJDK(java.lang.String name, java.net.URL exeURL, java.net.URL location)
public JDK addJDK(java.lang.String name, java.net.URL exeURL)
MutableLibraryList
addJDK
in interface MutableLibraryList
name
- the name to use for the JDK, or null to generate a unique name.exeURL
- the location of the JDK executable.public JLibrary addLibrary(java.lang.String name, java.net.URL location)
public JLibrary addLibrary(java.lang.String name)
MutableLibraryList
addLibrary
in interface MutableLibraryList
name
- the name to use for the JLibrary, or null to generate a unique name.public boolean remove(Library library)
MutableLibraryList
remove
in interface MutableLibraryList
library
- the library to remove.public java.lang.Object createIDFromName(java.lang.String name, boolean isJDK)
MutableLibraryList
createIDFromName
in interface MutableLibraryList
name
- seed from which to produce the ID.isJDK
- true if the ID should apply to a JDK.public javax.swing.Icon getDefaultIcon()
MutableLibraryList
getDefaultIcon
in interface MutableLibraryList
|
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 |