|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.0.0) E17493-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.jdevimpl.audit.model.DefaultContentDirectory
public class DefaultContentDirectory
Constructor Summary | |
---|---|
DefaultContentDirectory(ContentDirectory parent,
java.lang.String relativePath)
|
|
DefaultContentDirectory(java.net.URL url,
java.lang.String relativePath,
java.util.Collection<ContentRoot> roots)
|
Method Summary | |
---|---|
boolean |
canContainJavaSources()
Gets whether this directory can contain Java sources. |
Attributes |
getAttributes()
This method returns an Attributes object that encodes the
attributes of the Element . |
java.util.Iterator<Element> |
getChildren()
Gets the children of this content set directory. |
java.util.Collection<java.lang.String> |
getContentSetKeys()
Gets the keys of the content sets containing this directory. |
java.lang.Object |
getData()
Returns the data object associated with this Element . |
int |
getDepth()
Gets the depth of this directory. |
javax.swing.Icon |
getIcon()
Returns an Icon that can be shown in association with this
Displayable . |
java.lang.String |
getLongLabel()
Returns a long label that can be displayed to the user. |
java.lang.String |
getName()
Gets the simple name of this directory. |
java.lang.String |
getRelativePath()
Gets the slash-separated path of this directory relative to its content set root directory. |
java.util.Collection<ContentRoot> |
getRoots()
Gets the ContentRoot s containing this directory. |
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()
Gets the URL of this directory. |
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. |
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 |
Constructor Detail |
---|
public DefaultContentDirectory(java.net.URL url, java.lang.String relativePath, java.util.Collection<ContentRoot> roots)
public DefaultContentDirectory(ContentDirectory parent, java.lang.String relativePath)
Method Detail |
---|
public java.lang.String getRelativePath()
ContentDirectory
getRelativePath
in interface ContentDirectory
public int getDepth()
ContentDirectory
getDepth
in interface ContentDirectory
public java.lang.String getName()
ContentDirectory
getName
in interface ContentDirectory
public java.net.URL getURL()
ContentDirectory
getURL
in interface Locatable
getURL
in interface ContentDirectory
URL
identifying this Locatable
.public java.util.Collection<ContentRoot> getRoots()
ContentDirectory
ContentRoot
s containing this directory.
getRoots
in interface ContentDirectory
public java.util.Collection<java.lang.String> getContentSetKeys()
ContentDirectory
getContentSetKeys
in interface ContentDirectory
public boolean canContainJavaSources()
ContentDirectory
canContainJavaSources
in interface ContentDirectory
public void setURL(java.net.URL url)
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.
Required by {#link Locatable}.
setURL
in interface Locatable
url
- The URL
to set.public boolean mayHaveChildren()
ContentDirectory
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.
A ContentDirectory
should always return true
.
mayHaveChildren
in interface Element
mayHaveChildren
in interface ContentDirectory
true
if this Element
may contain
child Element
s.public java.util.Iterator<Element> getChildren()
ContentDirectory
The children are Node
and ContentDirectory
elements for the file and directories directly contained by the directory.
getChildren
in interface Element
getChildren
in interface ContentDirectory
Iterator
over any child Element
s
contained by this Element
. If there are no children,
null
is returned.public Attributes getAttributes()
ContentDirectory
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.
The default attributes of a ContentDirectory
are empty.
getAttributes
in interface Element
getAttributes
in interface ContentDirectory
public java.lang.Object getData()
ContentDirectory
Element
.
Implementations will often simply return this
, since
the Element is often its own data object.
If the implementation returns an object other than this
,
be sure to set ElementAttributes.DECORATES_DATA_ELEMENT
.
The data of a ContentDirectory
is itself.
getData
in interface Element
getData
in interface ContentDirectory
Element
instance.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()
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.0.0) E17493-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |