oracle.javatools.ui.builders

Class BasicBuilder<T>

java.lang.Object

oracle.javatools.ui.builders.BasicBuilder<T>

Direct Known Subclasses:

BreadcrumbsTableBuilder, ListBuilder, TableBuilder, TreeBuilder

public abstract class BasicBuilder<T>
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BasicBuilder.Instructions Instructions on exactly what to build

Field Summary

Fields

Modifier and Type	Field and Description
protected BasicBuilder.Instructions	instructions

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasicBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	buildToolbar(oracle.javatools.ui.builders.BuiltBasic builtBasic)
protected abstract BasicBuilder.Instructions	createInstructions()
void	setActions(javax.swing.Action... actions) Add action(s) to the toolbar.
void	setActionsSecondary(javax.swing.Action... actions) Add additional (less important) action(s) to the component toolbar.
void	setActionsSecondary(java.lang.String moreActionsText, javax.swing.Action... actions) Add additional (less important) action(s) to the component toolbar.
ListenableCollection<T>	setCheckable(java.util.Collection<T> initiallyCheckedItems) Make the items in the component checkable.
void	setDoubleClickListener(java.awt.event.ActionListener actionListener) The given actionListener will be called when an item in the component is double clicked
void	setEmptyText(java.lang.String emptyText) Set the text to overlay on the component when the component is empty
void	setEmptyTextLarge(java.lang.String emptyText) Set the text to overlay on the component when the component is empty.
void	setLabel(java.lang.String labelText) Add a label (and a titlebar to contain it). The label text can optionally contain an '&' to mark the next character as a mnemonic which will be used as the shortcut for the component.
void	setResizable(boolean resizable) Allow the component to be resized in place by the user dragging the mouse.
void	setRollover(boolean rollover) Add rollover highlighting to the items
void	setSelection(T... selection) Set the item(s) that will be initially selected.
void	setSelectionEnabledAction(javax.swing.Action action) Disable the action when there is no selection, enable it when there is selection
void	setSelectionEnabledComponent(javax.swing.JComponent component) Components added to the builder with this method will be enabled and disabled as selection is gained or lost.
void	setTitlebar(boolean titlebar) Create a titlebar for the component, the titlebar can contain a label and toolbar There is no need to call this method in addition to label() or other builder methods that require a titlebar/toolbar.
void	setToolbarComponents(javax.swing.JComponent... components) Add components(s) to the toolbar.

Methods inherited from class java.lang.Object

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

Field Detail

instructions

protected BasicBuilder.Instructions instructions

Constructor Detail

BasicBuilder

protected BasicBuilder()

Method Detail

createInstructions

protected abstract BasicBuilder.Instructions createInstructions()

buildToolbar

protected void buildToolbar(oracle.javatools.ui.builders.BuiltBasic builtBasic)

setResizable

public void setResizable(boolean resizable)

Allow the component to be resized in place by the user dragging the mouse.

Parameters:

resizable -

setEmptyText

public void setEmptyText(java.lang.String emptyText)

Set the text to overlay on the component when the component is empty

Parameters:

emptyText - the user visible text to display

setEmptyTextLarge

public void setEmptyTextLarge(java.lang.String emptyText)

Set the text to overlay on the component when the component is empty. The text will be rendered in a large size suitable for larger lists.

Parameters:

emptyText - the user visible text to display

setDoubleClickListener

public void setDoubleClickListener(java.awt.event.ActionListener actionListener)

The given actionListener will be called when an item in the component is double clicked

Parameters:

actionListener -

setLabel

public void setLabel(java.lang.String labelText)

Add a label (and a titlebar to contain it).
The label text can optionally contain an '&' to mark the next character as a mnemonic which will be used as the shortcut for the component.

Parameters:

labelText -

setTitlebar

public void setTitlebar(boolean titlebar)

Create a titlebar for the component, the titlebar can contain a label and toolbar
There is no need to call this method in addition to label() or other builder methods that require a titlebar/toolbar.

Parameters:

titlebar -

setActions

public void setActions(javax.swing.Action... actions)

Add action(s) to the toolbar.

Parameters:

actions -

setToolbarComponents

public void setToolbarComponents(javax.swing.JComponent... components)

Add components(s) to the toolbar.

Parameters:

actions -

setActionsSecondary

public void setActionsSecondary(javax.swing.Action... actions)

Add additional (less important) action(s) to the component toolbar. They may appear in a "More Actions" style drop list.

Parameters:

actions -

setActionsSecondary

public void setActionsSecondary(java.lang.String moreActionsText,
                       javax.swing.Action... actions)

Add additional (less important) action(s) to the component toolbar. They may appear in a "More Actions" style drop list.

Parameters:

moreActionsText - the name (including mnemonic) for the drop list button, or null to accept the default

actions -

setSelection

public void setSelection(T... selection)

Set the item(s) that will be initially selected. If omitted then the first item will be selected by default.

Parameters:

selection -

setCheckable

public ListenableCollection<T> setCheckable(java.util.Collection<T> initiallyCheckedItems)

Make the items in the component checkable. The given collection of items is used to set the initially checked items (use an empty collection for no initial checks). The returned collection is an always upto date set of what is currently selected. This second collection can be manipulated externally and the results will be reflected in the UI. e.g. To check an item after the component has been build add an item to the returned collection.

Parameters:

initiallyCheckedItems - the collection of checked items, initially it contains the starting items that should be checked.

Returns:

a live collection of what is currently selected. This collection can be manipulated to programatically change the current selection.

setRollover

public void setRollover(boolean rollover)

Add rollover highlighting to the items

Parameters:

rollover -

setSelectionEnabledComponent

public void setSelectionEnabledComponent(javax.swing.JComponent component)

Components added to the builder with this method will be enabled and disabled as selection is gained or lost. e.g. useful if a dialog has an "OK" button that can only be enabled when something is selected.

Parameters:

component - a component to enable only when there is a selection

setSelectionEnabledAction

public void setSelectionEnabledAction(javax.swing.Action action)

Disable the action when there is no selection, enable it when there is selection

Parameters:

action - an action to enable only when there is a selection