|
Extension SDK 10.1.2 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.ide.IdeSubject
oracle.jdeveloper.library.DefaultLibraryList
The DefaultLibraryList class provides a basic implementation of the LibraryList interface. DefaultLibraryList does not provide a mechanism for persisting itself; however, it can be included within the datamodel of another object and be persisted within that object's model. DefaultLibraryList instances are marked as being transient; subclasses must override this if the list is to be displayed to the user when creating new libraries
Field Summary |
Fields inherited from interface oracle.ide.addin.Subject |
OBJECT_MODIFIED |
Constructor Summary | |
DefaultLibraryList() |
|
DefaultLibraryList(DefaultLibraryList orig) |
Method Summary | |
boolean |
add(Element child) Appends a child Element to the end of the Folder . |
boolean |
canAdd(Element element) Other classes can call this method to determine whether the given Element can be added to the Folder . |
boolean |
canRemove(Element element) Other classes can call this method to determine whether the specified Element can be removed from this Folder . |
boolean |
containsChild(Element child) Returns true if the folder contains the specified child Element ; returns false otherwise. |
abstract java.lang.Object |
copyTo(java.lang.Object target) Copies the internal state of this object to the specified copy . |
protected void |
copyToImpl(DefaultLibraryList copy) |
boolean |
equals(java.lang.Object obj) |
protected boolean |
equalsImpl(DefaultLibraryList otherList) |
JDK |
findJDK(java.lang.String jdkName) Finds the J2SE definition that matches the specified name. |
JDK |
findJDK(VersionNumber verNum) Finds the J2SE definition that matches the specified version number. |
JLibrary |
findLibrary(java.lang.String libName) Finds the library that matches the specified name. |
java.lang.String |
findUniqueJDKName() Determines a unique name that can be used for a new J2SE definition. |
java.lang.String |
findUniqueLibraryName() Determines a unique name that can be used for a new library. |
Attributes |
getAttributes() This method returns an Attributes object that encodes the attributes of the Element . |
java.util.Iterator |
getChildren() This method is part of the Element interface to provide a convenient way of getting an Iterator over any contained child Element s without having to test the object's type with the instanceof operator or having to downcast to a more specific type. |
java.lang.Object |
getData() Returns the data element associated with this Data . |
javax.swing.Icon |
getIcon() Returns an Icon that can be shown in association with this Displayable . |
java.util.List |
getJdkList() Retrieves the list of J2SE definitions contained in this LibraryList. |
java.util.List |
getLibraryList() Retrieves the list of Libraries contained in this LibraryList. |
abstract 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 . |
boolean |
isChildJDK(JDK jdk) Determines whether the specified J2SE definition is a child of this LibraryList. |
boolean |
isChildLibrary(JLibrary lib) Determines whether the specified Library is a child of this LibraryList. |
boolean |
isDirty() True if the data in the object has been modified. |
boolean |
isTransient() Whether this list is transient (not-persistent). |
void |
markDirty(boolean dirty) Marks the data with the specified dirty state. |
boolean |
mayHaveChildren() This method is part of the Element interface to provide a convenient way of determining whether an object may have children without having to test the object's type with the instanceof operator or having to downcast to a more specific type. |
boolean |
remove(Element child) Removes the specified child Element . |
void |
removeAll() Removes all children from the folder. |
void |
setJdkList(java.util.List jdkList) |
void |
setLibraryList(java.util.List libList) |
void |
setOwner(Dirtyable owner) This method should be called to set the document in which a SubDirtyable implementation will be persisted. |
int |
size() Returns the current number of children in the folder. |
Methods inherited from class oracle.ide.IdeSubject |
attach, copy, detach, getObservers, notifyObservers, setObservers |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface oracle.ide.model.Displayable |
toString |
Methods inherited from interface oracle.ide.addin.Subject |
attach, detach, notifyObservers |
Constructor Detail |
public DefaultLibraryList()
public DefaultLibraryList(DefaultLibraryList orig)
Method Detail |
public abstract java.lang.Object copyTo(java.lang.Object target)
Copyable
this
object to the specified copy
. If copy
is null
, then this method should create a new instance of this
class and proceed to copy the internal state to the newly created object. Generally, only the persistent state of the object should be copied, but whether or not it is appropriate to copy transient properties is at the discretion of the individual implementor.
Regardless of whether the copy occurs to an existing object or to a newly created object, the return value is object to which this
object's state was copied.
There is a standard implementation pattern for the copyTo
method that helps avoid problems that arise when a Copyable
object is subclassed. The pattern is:
public Object copyTo( Object target )
{
final <this_class> copy =
target != null ? (<this_class>) target : new <this_class>();
copyToImpl( copy );
return copy;
} protected final void copyToImpl( <this_class> copy ) { super.copyToImpl( copy ); // if necessary // put code here for copying the properties of <this_class> }
The parameter passed into the copyToImpl
method is the same type of this
class. The responsibility of copyToImpl
is to copy the state of this
class through direct access of the fields. The copyToImpl
method should not use getters and setters since these may be overridden, causing the state of this
class to be incompletely copied.copyTo
in interface Copyable
target
- The target object to which the state of this
object should be copied. If target
is null
, then the copyTo
method will return a new instance of this
class.this
object was copied. If the target
was non-null
, then the return value is the same as the target
object that was passed in; otherwise, the return value is a new instance of this
class.protected void copyToImpl(DefaultLibraryList copy)
public boolean equals(java.lang.Object obj)
protected boolean equalsImpl(DefaultLibraryList otherList)
public JDK findJDK(java.lang.String jdkName)
LibraryList
findJDK
in interface LibraryList
jdkName
- the name of the J2SE definitionJDK
representing the J2SE definition.public JDK findJDK(VersionNumber verNum)
LibraryList
findJDK
in interface LibraryList
verNum
- the VersionNumber
of the desired J2SE defintion.JDK
representing the J2SE definition.public JLibrary findLibrary(java.lang.String libName)
LibraryList
findLibrary
in interface LibraryList
public java.lang.String findUniqueJDKName()
LibraryList
findUniqueJDKName
in interface LibraryList
public java.lang.String findUniqueLibraryName()
LibraryList
findUniqueLibraryName
in interface LibraryList
public java.util.List getJdkList()
LibraryList
getJdkList
in interface LibraryList
public void setJdkList(java.util.List jdkList)
public java.util.List getLibraryList()
LibraryList
getLibraryList
in interface LibraryList
public void setLibraryList(java.util.List libList)
public abstract java.lang.String getListName()
LibraryList
getListName
in interface LibraryList
public boolean isChildJDK(JDK jdk)
LibraryList
isChildJDK
in interface LibraryList
public boolean isChildLibrary(JLibrary lib)
LibraryList
isChildLibrary
in interface LibraryList
public boolean isTransient()
LibraryList
isTransient
in interface LibraryList
public boolean mayHaveChildren()
Element
Element
interface to provide a convenient way of determining whether an object may have children without having to test the object's type with the instanceof
operator or having to downcast to a more specific type.
An implementation of Element
that represents a leaf in a tree structure should return false
from this method. An implementation of Element
that could represent a non-leaf in a tree structure should return true
from this method, even if it does not currently contain any children.
mayHaveChildren
in interface Element
true
if this Element
may contain child Element
s.public java.util.Iterator getChildren()
Element
Element
interface to provide a convenient way of getting an Iterator
over any contained child Element
s without having to test the object's type with the instanceof
operator or having to downcast to a more specific type.
An implementation of Element
that represents a leaf in a tree structure should return null
from this method. An implementation of Element
that could represent a non-leaf in a tree structure should return either an Iterator
over the child Element
s or null
if there are no children.
getChildren
in interface Element
Iterator
over any child Element
s contained by this Element
. If there are no children, null
is returned.public Attributes getAttributes()
Element
Attributes
object that encodes the attributes of the Element
. Changing the attribute settings on the return object changes the element attributes. Subclasses should use their super class attributes object to define their own attributes. This allows subclasses to inherit their super class attributes. If a subclass does not wish to inherit attributes, they should first call getAttributes().clear()
and define new attributes.getAttributes
in interface Element
public java.lang.Object getData()
Data
Data
. The getData()
method provides a standard means for getting the data element whether or not it is same object as its Element
object.getData
in interface Data
Data
instance.public boolean canAdd(Element element)
Folder
Element
can be added to the Folder
.canAdd
in interface Folder
element
- the Element
that is about to be added to this Folder
.true
if the specified Element
can be added to this Folder
; false
if the Element
cannot be added.public boolean add(Element child)
Folder
Element
to the end of the Folder
.add
in interface Folder
public boolean canRemove(Element element)
Folder
Element
can be removed from this Folder
.canRemove
in interface Folder
element
- the Element
that is about to be removed from this Folder
.true
if the specified Element
can be removed from this Folder
; false
if the Element
cannot be removed.public boolean remove(Element child)
Folder
Element
. If the child object appears more than once, only the first instance is removed.remove
in interface Folder
child
- The child object to remove.public boolean containsChild(Element child)
Folder
true
if the folder contains the specified child Element
; returns false
otherwise.containsChild
in interface Folder
public int size()
Folder
size
in interface Folder
public void removeAll()
Folder
removeAll
in interface Folder
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 void setOwner(Dirtyable owner)
SubDirtyable
SubDirtyable
implementation will be persisted.setOwner
in interface SubDirtyable
owner
- The Dirtyable
object in which this SubDirtyable
will be saved.public boolean isDirty()
Dirtyable
isDirty
in interface Dirtyable
true
if the data in the object has been modified.public void markDirty(boolean dirty)
Dirtyable
markDirty(...)
instead of setDirty(...)
so that the JavaBeans Introspector
will not mistakenly identify "dirty" as a JavaBean property.markDirty
in interface Dirtyable
dirty
- If true
, sets the object as being dirty; if false
, sets the object as being up-to-date.
|
Extension SDK | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 1997, 2004, Oracle. All rights reserved.