oracle.ide.inspector
Interface Inspectable2

All Superinterfaces:

Inspectable

public interface Inspectable2
extends Inspectable

Inspectable2 is a replacement API for Inspectable and offers a custom dialog hook in lieu of a Customizer. The hook offers the integrator far more control while at the same time simplifying the mechanics of the InspectorWindow in that it is up to any custom dialog to fire any related UpdateMessage notifications, rather than being left as the responsibility of the InspectorWindow to try and figure it all out based on individual PropertyChangeEvent notifications fired by the Customizer. Additionally, Inspectable2 allows for the providing of often used actions for optional display in the InspectorWindow implementation.

Method Summary

javax.swing.Icon	getCustomDialogIcon() Get the Icon associated with the custom dialog, if any.
java.lang.String	getCustomDialogToolTipText() Get the tooltip text associated with the custom dialog, if any.
javax.swing.Action[]	getLinkActions() Deprecated. If the ComponentLevelActions interface is implemented, getLinkActions will not be called. If the ComponentLevelActions interface is not implemented, getLinkActions will be called and the results will be placed in the "more" dropdown on the Property Inspector toolbar.
boolean	hasCustomDialog() Determine whether or not a custom dialog is supported.
void	showCustomDialog(java.awt.Component parent) Display the custom dialog if any.

Methods inherited from interface oracle.ide.inspector.Inspectable

getAdditionalTabPages, getCustomizer, getPropertyModel, getTarget, setContext

Method Detail

hasCustomDialog

boolean hasCustomDialog()

Determine whether or not a custom dialog is supported.

Returns:

true if a custom dialog is available.

getCustomDialogIcon

javax.swing.Icon getCustomDialogIcon()

Get the Icon associated with the custom dialog, if any.

Returns:

the Icon to use when representing the custom dialog.

getCustomDialogToolTipText

java.lang.String getCustomDialogToolTipText()

Get the tooltip text associated with the custom dialog, if any.

Returns:

the tooltip to use when representing the custom dialog.

showCustomDialog

void showCustomDialog(java.awt.Component parent)

Display the custom dialog if any. It is the responsibility of the implementation to ensure that any necessary UpdateMessage is sent upon changes made in the custom dialog.

Parameters:

parent - the host of the custom dialog.

getLinkActions

javax.swing.Action[] getLinkActions()

Deprecated. If the ComponentLevelActions interface is implemented, getLinkActions will not be called. If the ComponentLevelActions interface is not implemented, getLinkActions will be called and the results will be placed in the "more" dropdown on the Property Inspector toolbar.

Get an array of actions for display in an InspectorWindow to serve as quick links to common operations.

Returns:

an array of applicable Action instances.