oracle.ide.model
Interface Displayable

All Known Subinterfaces:

ChildFilter, CmtMessage, CmtModelNode, Container, DerivedLibrary, Document, Element, ExternalToolType, Folder, GalleryWizard, InspectorPage, JavaNode, Layout, Library, LibraryList, MacroExpander, Node, Palette, PaletteItem, PalettePage, TextDocument, WorkEnvironment

All Known Implementing Classes:

AbstractDerivedLibrary, AbstractGalleryWizard, AbstractLibrary, Applications, AppServerAccessExtGroupInfo, BaseLayout, CategoryFolder, CmtFolder, CodeEditorExtGroupInfo, CompilerExtGroupInfo, ConnectionNode, DatabaseAccessExtGroupInfo, DataContainer, DefaultContainer, DefaultDisplayable, DefaultDocument, DefaultElement, DefaultFilter, DefaultFolder, DefaultLibraryList, DefaultNode, GalleryElement, GalleryFolder, IdeLayout, JavaClassNode, JavaSourceNode, JLibraryList, Layouts, Navigable, PropertiesContainer, RunProcess, TextNode, XMLDataContainer

public interface Displayable

The Displayable interface defines methods that an object must implement in order to be displayed in the various controls used by the IDE.

Method Summary

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.

Method Detail

getShortLabel

public java.lang.String getShortLabel()

Returns a short label that can be displayed to the user. Generally, the value of the returned 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.

Returns:

a short descriptive label of the Displayable that can be shown to the user.

getLongLabel

public java.lang.String getLongLabel()

Returns a long label that can be displayed to the user. Generally, the value of the returned 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.

Returns:

a long descriptive label of the Displayable that can be shown to the user.

getIcon

public javax.swing.Icon getIcon()

Returns an 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.

Returns:

the Icon to be displayed for the Displayable.

getToolTipText

public java.lang.String getToolTipText()

Returns the tool tip text to show when the mouse pointer pauses over a UI component that represents this Displayable. In many cases it may be appropriate for this method to return the same value as getLongLabel().

Returns:

the tooltip to show when the mouse pointer pauses over a UI component that represents this Displayable.

toString

public java.lang.String toString()

Returns the Short Label displayed to a user. This overrides the toString method in java.lang.Object.

Implementors of the Displayable interface should override this as appropriate. The default implementation is the same as getShortLabel

See Also:

Object.toString(), getShortLabel()