public abstract class LibraryAdapter extends HashStructureAdapter implements LibraryWithMacroSupport
_hash
LIBRARY_ID_PROPERTY, LIBRARY_NAME_PROPERTY
CLASSPATH_PROPERTY, DOCPATH_PROPERTY, ISLOCKED_PROPERTY, SOURCEPATH_PROPERTY
Constructor and Description |
---|
LibraryAdapter(HashStructure hash) |
Modifier and Type | Method and Description |
---|---|
boolean |
equivalent(Library library)
Determine whether the given Library is equivalent to this one with respect
to the values of its public properties other than name.
|
URLPath |
getClassPath() |
URLPath |
getClassPath(boolean expandMacros) |
URLPath |
getClassPath(Context context,
boolean expandMacros)
Context is ignored unless expandMacros is true; when expanding macros,
certain built-in IDE macros require a context in order to evaluate
correctly.
|
URLPath |
getDefaultClassPath()
Deprecated.
use getClassPath()
|
URLPath |
getDefaultDocPath()
Deprecated.
use getDocPath()
|
URLPath |
getDefaultSourcePath()
Deprecated.
use getSourcePath()
|
URLPath |
getDocPath() |
URLPath |
getDocPath(boolean expandMacros) |
URLPath |
getDocPath(Context context,
boolean expandMacros) |
javax.swing.Icon |
getIcon()
Returns an
Icon that can be shown in association with this
Displayable . |
java.lang.Object |
getID() |
java.lang.String |
getLongLabel()
Returns a long label that can be displayed to the user.
|
java.lang.String |
getName() |
java.lang.String |
getShortLabel()
Returns a short label that can be displayed to the user.
|
URLPath |
getSourcePath() |
URLPath |
getSourcePath(boolean expandMacros) |
URLPath |
getSourcePath(Context context,
boolean expandMacros) |
java.lang.String |
getToolTipText()
Returns the tool tip text to show when the mouse pointer pauses
over a UI component that represents this
Displayable . |
void |
initFromLibrary(Library library)
Initialize all public properties, other than name, from the Library
provided.
|
boolean |
isLocked() |
void |
setClassPath(URLPath path) |
void |
setDefaultClassPath(URLPath path)
Deprecated.
use setClassPath(URLPath)
|
void |
setDefaultDocPath(URLPath path)
Deprecated.
use setDocPath(URLPath)
|
void |
setDefaultSourcePath(URLPath path)
Deprecated.
use setSourcePath(URLPath)
|
void |
setDocPath(URLPath path) |
void |
setID(java.lang.Object id) |
void |
setLocked(boolean isLocked) |
void |
setName(java.lang.String name) |
void |
setSourcePath(URLPath path) |
java.lang.String |
toString()
Returns the Short Label displayed to a user.
|
addStructureChangeListener, containsKey, copyTo, copyToImpl, equals, equalsImpl, findOrCreate, forcedCopyTo, getHashStructure, removeStructureChangeListener, useObjectEquals
public LibraryAdapter(HashStructure hash)
public URLPath getClassPath()
getClassPath
in interface JPaths
public URLPath getClassPath(boolean expandMacros)
getClassPath
in interface LibraryWithMacroSupport
public URLPath getClassPath(Context context, boolean expandMacros)
LibraryWithMacroSupport
getClassPath
in interface LibraryWithMacroSupport
public void setClassPath(URLPath path)
setClassPath
in interface JPaths
public URLPath getSourcePath()
getSourcePath
in interface JPaths
public URLPath getSourcePath(boolean expandMacros)
getSourcePath
in interface LibraryWithMacroSupport
public URLPath getSourcePath(Context context, boolean expandMacros)
getSourcePath
in interface LibraryWithMacroSupport
public void setSourcePath(URLPath path)
setSourcePath
in interface JPaths
public URLPath getDocPath()
getDocPath
in interface JPaths
public URLPath getDocPath(boolean expandMacros)
getDocPath
in interface LibraryWithMacroSupport
public URLPath getDocPath(Context context, boolean expandMacros)
getDocPath
in interface LibraryWithMacroSupport
public void setDocPath(URLPath path)
setDocPath
in interface JPaths
public boolean equivalent(Library library)
Library
equivalent
in interface Library
library
- the Library against which to test for equivalence.public void initFromLibrary(Library library)
Library
initFromLibrary
in interface Library
library
- the Library from which to fetch property values.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.lang.String getName()
public java.lang.Object getID()
public void setID(java.lang.Object id)
@Deprecated public URLPath getDefaultClassPath()
getDefaultClassPath
in interface Library
@Deprecated public void setDefaultClassPath(URLPath path)
setDefaultClassPath
in interface Library
@Deprecated public URLPath getDefaultSourcePath()
getDefaultSourcePath
in interface Library
@Deprecated public void setDefaultSourcePath(URLPath path)
setDefaultSourcePath
in interface Library
@Deprecated public URLPath getDefaultDocPath()
getDefaultDocPath
in interface Library
@Deprecated public void setDefaultDocPath(URLPath path)
setDefaultDocPath
in interface Library