oracle.ide.panels
Interface NavigableUIContainer

All Superinterfaces:

ApplyNotifier, Traversable

All Known Implementing Classes:

AbstractUIContainer

public interface NavigableUIContainer

extends ApplyNotifier, Traversable

A "UI container" is a class that is capable of rendering Navigables and providing the interactions for user manipulation of the Navigables. In order to provide the extensibility support required by Navigable implementations and to provide a notification mechanism for classes that use instances of UI container directly, the UI container is required to implement this interface.

Essentially then, this interface provides the means of specifying a tree structure using Navigable instances without specifying a dependency on any particular UI container implementation. This allows Navigables to be used in a variety of tree-based UI implementations.

Field Summary

static java.lang.String

NAVIGABLE_UI_CONTAINER Constant used to get an instance of NavigableUIContainer from TraversableContext.getDesignTimeObject(String).

Method Summary

boolean	displayDetailNodesAsChildren() Returns true if the UI container is displaying detail nodes with the children rather than in a separate tree.
void	setRootNavigables(Navigable[] rootNavigables) Sets the root-level Navigable instances for the UI.

Methods inherited from interface oracle.ide.panels.ApplyNotifier

addApplyListener, removeApplyListener

Methods inherited from interface oracle.ide.panels.Traversable

getComponent, getExitTransition, onEntry, onExit

Field Detail

NAVIGABLE_UI_CONTAINER

public static final java.lang.String NAVIGABLE_UI_CONTAINER

Constant used to get an instance of NavigableUIContainer from TraversableContext.getDesignTimeObject(String).

See Also:

Constant Field Values

Method Detail

setRootNavigables

public void setRootNavigables(Navigable[] rootNavigables)

Sets the root-level Navigable instances for the UI.

displayDetailNodesAsChildren

public boolean displayDetailNodesAsChildren()

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.