public interface Displayable
Displayable
interface defines methods that an object must implement in order to be displayed in the various controls used by the IDE.Modifier and Type | Method and Description |
---|---|
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 |
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.lang.String |
toString()
Returns the Short Label displayed to a user.
|
java.lang.String getShortLabel()
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
.Displayable
that can be shown to the user.java.lang.String getLongLabel()
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.Displayable
that can be shown to the user.javax.swing.Icon getIcon()
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.Icon
to be displayed for the Displayable
.java.lang.String getToolTipText()
Displayable
. In many cases it may be appropriate for this method to return the same value as getLongLabel()
.Displayable
.java.lang.String toString()
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 class java.lang.Object
Object.toString()
, getShortLabel()