oracle.ide.externaltools.macro
Interface MacroPicker

public interface MacroPicker

Interface to the macro picker UI. The macro picker UI is a simple UI component allowing the user to choose from all the available macros.

Method Summary

void	addListSelectionListener(javax.swing.event.ListSelectionListener lsl) Add a list selection listener, which will be notified when the return value of getSelectedMacro() might have changed.
java.awt.Component	getComponent() Get the UI component for this picker.
MacroExpander	getSelectedMacro() Get the selected macro.
void	removeListSelectionListener(javax.swing.event.ListSelectionListener lsl) Remove a list selection listener previously added with addListSelectionListener().
MacroExpander	runDialog(java.awt.Component parent) Utility to run the macro picker in a dialog.

Method Detail

getComponent

java.awt.Component getComponent()

Get the UI component for this picker. You can embed this into a dialog.

Returns:

a component for this picker.

getSelectedMacro

MacroExpander getSelectedMacro()

Get the selected macro.

Returns:

a MacroExpander instance. May return null if there is no current selection.

addListSelectionListener

void addListSelectionListener(javax.swing.event.ListSelectionListener lsl)

Add a list selection listener, which will be notified when the return value of getSelectedMacro() might have changed.

Parameters:

lsl - a list selection listener.

removeListSelectionListener

void removeListSelectionListener(javax.swing.event.ListSelectionListener lsl)

Remove a list selection listener previously added with addListSelectionListener().

Parameters:

lsl - a list selection listener to remove.

runDialog

MacroExpander runDialog(java.awt.Component parent)

Utility to run the macro picker in a dialog.

Parameters:

parent - a component to parent the dialog on (for modality)

Returns:

a macro expander instance, or null if the user canceled.