oracle.ide.panels

Class TabbedPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

oracle.ide.panels.DefaultTraversablePanel

oracle.ide.panels.TabbedPanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, GridBagConstants, ApplyListener, ApplyNotifier, NavigableUIContainer, Traversable

public class TabbedPanel
extends DefaultTraversablePanel

This is a NavigableUIContainer implementation whose appearance is based on JTabbedPane; each page of a TabbedPanel is a Traversable and the order of the pages is specified by an array of Navigables.

This implementation only supports a single level of tabs; it does not support nested tabs (i.e. "tabs within tabs").

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_TAB_INDEX Put this key as a design time object in the TraversableContext, with an Integer as the value, to select a specific tab onEntry.

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface oracle.ide.panels.NavigableUIContainer

NAVIGABLE_UI_CONTAINER

Fields inherited from interface oracle.ide.controls.GridBagConstants

ANCHOR_C, ANCHOR_E, ANCHOR_N, ANCHOR_NE, ANCHOR_NW, ANCHOR_S, ANCHOR_SE, ANCHOR_SW, ANCHOR_W, FILL_NONE, FILL_X, FILL_XY, FILL_Y

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
TabbedPanel(Navigable[] rootNavigables)
TabbedPanel(Navigable[] rootNavigables, int tabPlacement)
TabbedPanel(Navigable[] rootNavigables, javax.swing.plaf.TabbedPaneUI ui)

Method Summary

Modifier and Type	Method and Description
void	addApplyListener(ApplyListener applyListener) Adds an ApplyListener that will be called when the user applies or cancels changes.
protected void	addListener(java.lang.Class eventClass, java.util.EventListener listener)
void	apply(ApplyEvent e) This method is called when the changes made in the NavigableUIContainer are to be committed to the original data structures.
void	cancel(ApplyEvent e) This method is called when the changes made in the NavigableUIContainer are to be discarded.
static Navigable	createNavigable(java.lang.String labelText, Navigable[] tabs) Creates a Navigable instance for a TabbedPanel with the specified tabs.
boolean	displayDetailNodesAsChildren() Returns true if the UI container is displaying detail nodes with the children rather than in a separate tree.
void	enableTabForNavigable(Navigable nav, boolean enable) Enables/disables the appropriate tab for the given navigable.
protected void	fireApply(ApplyEvent event) Fires the "apply" message to all registered ApplyListener objects.
protected void	fireCancel(ApplyEvent event) Fires the "cancel" message to all registered ApplyListener objects.
protected Navigable	getCurrentNavigable() Concrete subclasses must implement this method to return the Navigable that is currently selected in the UI.
protected Traversable	getCurrentTraversable() Concrete subclasses must implement this method to return the Traversable that is currently selected in the UI.
java.lang.String	getHelpID() This method allows a subclass to implement a dynamic means of determining the help ID.
protected java.util.Iterator	getListenerIterator(java.lang.Class listenerClass)
protected Navigable[]	getRootNavigables()
protected void	maybeRefreshUI(TraversableContext tc)
protected TraversableContext	newTraversableContext() Returns a new TraversableContext that is initialized based on the Navigable returned by getCurrentNavigable().
void	onEntry(TraversableContext tc) This implementation passes the onEntry call through the current Traversable being displayed in the tabbed pane.
void	onExit(TraversableContext tc) This implementation passes the onExit call through the current Traversable being displayed in the tabbed pane.
protected void	refreshUI(TraversableContext tc)
void	removeApplyListener(ApplyListener applyListener) Removes a previously added ApplyListener so that it no longer receives notification when the user applies or cancels changes.
protected void	removeListener(java.lang.Class eventClass, java.util.EventListener listener)
void	setRootNavigables(Navigable[] rootNavigables) Sets the root-level Navigable instances for the UI.
void	setStatusIndicator(StatusIndicator indicator, int index) Uses the given status indicator to configure the tab at the given index to show the status of that tab.
void	updateImage(java.awt.Image image)

Methods inherited from class oracle.ide.panels.DefaultTraversablePanel

gbc, gbc, getComponent, getDefaultTitle, getExitTransition, getText, setDefaultTitle, setHelpID

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.ide.panels.Traversable

getComponent, getExitTransition

Field Detail

DEFAULT_TAB_INDEX

public static final java.lang.String DEFAULT_TAB_INDEX

Put this key as a design time object in the TraversableContext, with an Integer as the value, to select a specific tab onEntry.

• If the index is invalid (out of range), then the value will be ignored.
• If the tab at the index is disabled, then the nearest enabled tab will be selected instead.
• If the index is -1, this will ensure no tab is selected.

If the selected tab is changed onEntry, and the current tab fails to exit then the user is prompted and the selection will not be changed.

See Also:

TraversableContext.putDesignTimeObject(java.lang.String, java.lang.Object), Constant Field Values

Constructor Detail

TabbedPanel

public TabbedPanel(Navigable[] rootNavigables)

TabbedPanel

public TabbedPanel(Navigable[] rootNavigables,
                   int tabPlacement)

TabbedPanel

public TabbedPanel(Navigable[] rootNavigables,
                   javax.swing.plaf.TabbedPaneUI ui)

Method Detail

createNavigable

public static Navigable createNavigable(java.lang.String labelText,
                                        Navigable[] tabs)

Creates a Navigable instance for a TabbedPanel with the specified tabs.

onEntry

public void onEntry(TraversableContext tc)

This implementation passes the onEntry call through the current Traversable being displayed in the tabbed pane.

Specified by:

onEntry in interface Traversable

Parameters:

tc - The data wrapper where the Traversable locates the data that it needs to populate the UI.

See Also:

Traversable.onEntry(TraversableContext)

onExit

public void onExit(TraversableContext tc)
            throws TraversalException

This implementation passes the onExit call through the current Traversable being displayed in the tabbed pane.

Specified by:

onExit in interface Traversable

Parameters:

tc - The data object where changes made in the UI should be copied so that the changes can be accessed by other Traversables.

Throws:

TraversalException - if the user has entered either incomplete, invalid, or inconsistent data. This exception prevents the property dialog or wizard from continuing and forces the user to stay on the current Traversable until the data entered is valid or the user cancels. The exception class itself is capable of carrying an error message that will be shown to the user. Refer to its javadoc for details.

See Also:

Traversable.onExit(TraversableContext)

updateImage

public void updateImage(java.awt.Image image)

enableTabForNavigable

public void enableTabForNavigable(Navigable nav,
                                  boolean enable)

Enables/disables the appropriate tab for the given navigable. If the current tab is being disabled then tab selection moves back to the first enabled tab. If not it moves forward. Note: if this is the only tab or the only remaining enabled * tab and it is being disabled then the tab is disabled but the selected tab contents are still shown.

Parameters:

nav - the navigable object contained in the panel tab to enable/disable

enable - enable the tab if true else disable

refreshUI

protected void refreshUI(TraversableContext tc)

getCurrentNavigable

protected Navigable getCurrentNavigable()

Concrete subclasses must implement this method to return the Navigable that is currently selected in the UI.

Returns:

the current navigable or null if no navigable is current.

getCurrentTraversable

protected Traversable getCurrentTraversable()

Concrete subclasses must implement this method to return the Traversable that is currently selected in the UI.

Returns:

the current traversable, or null if no tranversable is current.

setStatusIndicator

public void setStatusIndicator(StatusIndicator indicator,
                               int index)

Uses the given status indicator to configure the tab at the given index to show the status of that tab.

Parameters:

indicator - the status indicator to use - if null the tab component for the given index will be removed (and the default used).

index - the tab index to configure

See Also:

StatusIndicator.configureTab(javax.swing.JTabbedPane, int)

getHelpID

public java.lang.String getHelpID()

Description copied from class: DefaultTraversablePanel

This method allows a subclass to implement a dynamic means of determining the help ID.

Specified by:

getHelpID in interface Traversable

Overrides:

getHelpID in class DefaultTraversablePanel

addApplyListener

public void addApplyListener(ApplyListener applyListener)

Description copied from interface: ApplyNotifier

Adds an ApplyListener that will be called when the user applies or cancels changes.

Specified by:

addApplyListener in interface ApplyNotifier

removeApplyListener

public void removeApplyListener(ApplyListener applyListener)

Description copied from interface: ApplyNotifier

Removes a previously added ApplyListener so that it no longer receives notification when the user applies or cancels changes.

Specified by:

removeApplyListener in interface ApplyNotifier

apply

public void apply(ApplyEvent e)

Description copied from interface: ApplyListener

This method is called when the changes made in the NavigableUIContainer are to be committed to the original data structures. This normally occurs when the user pushes the "OK", "Apply", or "Finish" button.

This method is called as soon as the user's action is recognized. Typically, if the NavigableUIContainer is editing a copy of the original data, there will be an ApplyListener registered that is responsible for flushing the changes from the edited data copy back to the original data structure. The API in the oracle.ide.panels package does not specify when such an ApplyListener is registered or whether one is registered at all.

If you are writing code that must depend on the registration order of such an ApplyListener, you will need to consult the documentation for the code that instantiates the NavigableUIContainer to determine if the registration order for ApplyListeners is specified there.

Specified by:

apply in interface ApplyListener

Parameters:

e - The ApplyEvent that provides contextual information about when the ApplyEvent was fired.

cancel

public void cancel(ApplyEvent e)

Description copied from interface: ApplyListener

This method is called when the changes made in the NavigableUIContainer are to be discarded. This normally occurs when the user pushes the "Cancel" button.

No data validation occurs when the user cancels, and the NavigableUIContainer may or may not call the onExit method of the currently showing Traversable. In general, onExit will not be called.

Specified by:

cancel in interface ApplyListener

Parameters:

e - The ApplyEvent that provides contextual information about when the ApplyEvent was fired.

setRootNavigables

public void setRootNavigables(Navigable[] rootNavigables)

Description copied from interface: NavigableUIContainer

Sets the root-level Navigable instances for the UI.

Specified by:

setRootNavigables in interface NavigableUIContainer

displayDetailNodesAsChildren

public boolean displayDetailNodesAsChildren()

Description copied from interface: NavigableUIContainer

Returns true if the UI container is displaying detail nodes with the children rather than in a separate tree. That is:

• When the UI container is displaying two trees, where the second tree shows the "detail" of a selected node in the first tree, this method returns false.
• When the UI container is displaying only one tree, where the "detail" of the selected node is to be rendered as children of the selected node (instead of nodes in a separate tree), this method returns true. That is, the tree displays detail nodes as children.

Specified by:

displayDetailNodesAsChildren in interface NavigableUIContainer

addListener

protected void addListener(java.lang.Class eventClass,
                           java.util.EventListener listener)

removeListener

protected void removeListener(java.lang.Class eventClass,
                              java.util.EventListener listener)

getRootNavigables

protected Navigable[] getRootNavigables()

maybeRefreshUI

protected final void maybeRefreshUI(TraversableContext tc)

newTraversableContext

protected TraversableContext newTraversableContext()

Returns a new TraversableContext that is initialized based on the Navigable returned by getCurrentNavigable().

getListenerIterator

protected java.util.Iterator getListenerIterator(java.lang.Class listenerClass)

fireApply

protected void fireApply(ApplyEvent event)

Fires the "apply" message to all registered ApplyListener objects.

fireCancel

protected void fireCancel(ApplyEvent event)

Fires the "cancel" message to all registered ApplyListener objects.