public class DeployedModule extends java.lang.Object implements Element, AppServerTarget
Constructor and Description |
---|
DeployedModule(AppServer server,
java.lang.String deployedModuleName) |
Modifier and Type | Method and Description |
---|---|
AppServer |
getAppServer() |
java.lang.String |
getAppServerName() |
Attributes |
getAttributes()
This method returns an
Attributes object that encodes the
attributes of the Element . |
java.util.Iterator<Element> |
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 object associated with this
Element . |
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() |
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 |
isComparable(DeployedModule comp) |
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 |
setAppServer(AppServer server) |
void |
setAppServerName(java.lang.String name) |
void |
setName(java.lang.String name) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
toString
public DeployedModule(AppServer server, java.lang.String deployedModuleName)
public AppServer getAppServer()
getAppServer
in interface AppServerTarget
public void setAppServer(AppServer server)
setAppServer
in interface AppServerTarget
public java.lang.String getAppServerName()
getAppServerName
in interface AppServerTarget
public void setAppServerName(java.lang.String name)
setAppServerName
in interface AppServerTarget
public java.lang.String getName()
public void setName(java.lang.String name)
public boolean isComparable(DeployedModule comp)
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<Element> 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()
Element
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
.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
.