oracle.ide.palette
Interface PaletteEditor

All Superinterfaces:

Invokable

All Known Implementing Classes:

PaletteEditor

public interface PaletteEditor

extends Invokable

The PaletteEditor interface should be implemented by clients that are interested in adding their own invokable dialogs to the Component Palette. By creating your own PaletteEditor, you can tell any item on the palette to invoke your editor by changing the editor tag in the palette.xml file.

Method Summary

java.lang.String	getHelpId() Return the HelpId associated with this editor.
javax.swing.ImageIcon	getIcon() Return the Icon to be displayed by the editor.
java.lang.String	getTag() Returns the String represenation of whatever tag or snippet should be inserted into the Code Editor or HTML Editor.
java.lang.String	getTitle() Return title to be displayed by the editor.
javax.swing.JComponent	getUI() Return the UI, generally JPanel(...) to be displayed when the editor is invoked.
boolean	validate() Returns true if the UI has been validated and the dialog can be disposed.

Methods inherited from interface oracle.ide.addin.Invokable

invoke

Method Detail

getTitle

public java.lang.String getTitle()

Return title to be displayed by the editor.

getIcon

public javax.swing.ImageIcon getIcon()

Return the Icon to be displayed by the editor.

getUI

public javax.swing.JComponent getUI()

Return the UI, generally JPanel(...) to be displayed when the editor is invoked.

getHelpId

public java.lang.String getHelpId()

Return the HelpId associated with this editor.

validate

public boolean validate()

Returns true if the UI has been validated and the dialog can be disposed. Returns false otherwise.

getTag

public java.lang.String getTag()

Returns the String represenation of whatever tag or snippet should be inserted into the Code Editor or HTML Editor.