oracle.ide.db.controls

Class ListButtons

java.lang.Object

oracle.ide.db.controls.ListButtons

public final class ListButtons
extends java.lang.Object

Associated a number of buttons to use with a JList to add/remove/move elements in the list. The JList must have a DefaultListModel for a model. This panel provides a Container for the JList and all the buttons that should be added to a parent panel in place of the list.

A Helper must be provided for the add and remove buttons to be included as the Helper is responsible for actioning those buttons.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListButtons.Controller A ListButtons Controller is repsonsible for controlling all of the customisable behaviour of a ListButtons instance, e.g.
static interface	ListButtons.Helper Deprecated. - use Controller
static class	ListButtons.HelperAdapter Deprecated. - use Controller

Constructor Summary

Constructors

Constructor and Description
ListButtons(javax.swing.JList list, ListButtons.Controller controller)
ListButtons(javax.swing.JTree tree, ListButtons.Controller controller)
ListButtons(SelectableComponent sc, ListButtons.Controller controller)

Method Summary

Methods

Modifier and Type	Method and Description
void	addCustomButton(javax.swing.Icon icon, java.lang.String text, java.lang.String buttonName) Adds a custom button to the bottom of the button list.
void	enableButtons() Enables/disables the buttons on the panel according to the rules of the Helper registered.
javax.swing.JComponent	getComponent() Gets the component containing the list and all the buttons.
javax.swing.JLabel	getLabel() Gets the label from the title bar for the wrapped component.
SelectableComponent	getSelectableComponent() Returns the SelectableComponent wrapping the list (or tree) this ListButtons is operating on.
void	setAddButton(javax.swing.AbstractButton button) Sets the add button to be used in the toolbar of the component.
void	setEnabled(boolean enabled) Enable/disable the panel and all the buttons.
void	setRemoveButton(javax.swing.AbstractButton button) Sets the add button to be used in the toolbar of the component.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListButtons

public ListButtons(javax.swing.JList list,
           ListButtons.Controller controller)

ListButtons

public ListButtons(javax.swing.JTree tree,
           ListButtons.Controller controller)

ListButtons

public ListButtons(SelectableComponent sc,
           ListButtons.Controller controller)

Method Detail

getLabel

public javax.swing.JLabel getLabel()

Gets the label from the title bar for the wrapped component. Can be null.

Returns:

the list label.

getComponent

public javax.swing.JComponent getComponent()

Gets the component containing the list and all the buttons.

getSelectableComponent

public SelectableComponent getSelectableComponent()

Returns the SelectableComponent wrapping the list (or tree) this ListButtons is operating on.

setAddButton

public void setAddButton(javax.swing.AbstractButton button)

Sets the add button to be used in the toolbar of the component. This can only be called once, before getComponent is called. The default add button should be good enough for most uses.

setRemoveButton

public void setRemoveButton(javax.swing.AbstractButton button)

Sets the add button to be used in the toolbar of the component. This can only be called once, before getComponent is called. The default remove button should be good enough for most uses.

addCustomButton

public final void addCustomButton(javax.swing.Icon icon,
                   java.lang.String text,
                   java.lang.String buttonName)

Adds a custom button to the bottom of the button list. Provide and icon and tooltip text for the display of the button, and a unique name for the button which will be used as the component name, and as the identifier on the ListButtons.Controller for the customButtonPressed method.

You must have a ListButtons.Controller registered to use this method.

Parameters:

icon - the icon for the button

tttext - the button's tooltip text (and accessible description)

buttonName - a unique name to identify the component

enableButtons

public void enableButtons()

Enables/disables the buttons on the panel according to the rules of the Helper registered.

See Also:

ListButtons.Helper

setEnabled

public void setEnabled(boolean enabled)

Enable/disable the panel and all the buttons.