oracle.ide.model.panels
Class ProjectContentNavigable

java.lang.Object
  oracle.ide.panels.MetaTraversable
      oracle.ide.panels.Navigable
          oracle.ide.model.panels.ProjectContentNavigable

All Implemented Interfaces:

Copyable

public abstract class ProjectContentNavigable
extends Navigable

Nested Class Summary

Nested classes/interfaces inherited from class oracle.ide.panels.Navigable

Navigable.NavigableComparator

Field Summary

static java.lang.String

PROPERTIES_NODE_LABEL

Fields inherited from class oracle.ide.panels.Navigable

BOLD, DEFAULT_CHILD_COMPARATOR_KEY, ITALIC, NAVIGABLE_COMPARATOR, PLAIN

Constructor Summary

ProjectContentNavigable()

Method Summary

protected void	appendChildNavigables(javax.swing.tree.DefaultMutableTreeNode parent, NavigableContext nc) This method calls Navigable.getChildNavigables() to get the list of child Navigable objects.
protected abstract Navigable	getGenericNavigable(java.lang.String label, java.lang.String contentSetKey)
java.lang.Class	getTraversableClass() Returns the class object of the described Traversable.
boolean	isUsingTraversableDefaultConstructor() Returns true of the construction of the associated Traversable uses its default constructor; returns false if a constructor other than the default is used.
protected boolean	mayHaveChildren(NavigableContext nc) Overridable method to determine whether a Navigable may have children such that a + may be shown next to it in the tree.
Traversable	newTraversable(ApplyNotifier applyNotifier) This method specifies the Traversable that will be used in association with the Navigable; in general, only NavigableUIContainer implementations should call this method directly.
static void	setDefaultContentSet(java.lang.String contentSetKey)

Methods inherited from class oracle.ide.panels.Navigable

addChildNavigable, appendChildNodes, appendDetailNavigables, copyTo, copyToImpl, createDetailRootNode, createTreeNode, createTreeNodeImpl, getChildComparator, getChildNavigables, getChildren, getDetailNavigables, getDisplayStyle, getIcon, getLongLabel, getRawShortLabel, getShortLabel, getToolTipText, setChildComparator, setChildNavigables, setDataScope, setDisplayStyle, setShortLabel, sortNavigables, toString

Methods inherited from class oracle.ide.panels.MetaTraversable

copyToImpl, findHelpID, newTraversable, setHelpID, setNameLink

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTIES_NODE_LABEL

public static final java.lang.String PROPERTIES_NODE_LABEL

Constructor Detail

ProjectContentNavigable

public ProjectContentNavigable()

Method Detail

setDefaultContentSet

public static void setDefaultContentSet(java.lang.String contentSetKey)

getGenericNavigable

protected abstract Navigable getGenericNavigable(java.lang.String label,
                                                 java.lang.String contentSetKey)

newTraversable

public Traversable newTraversable(ApplyNotifier applyNotifier)

Description copied from class: MetaTraversable

This method specifies the Traversable that will be used in association with the Navigable; in general, only NavigableUIContainer implementations should call this method directly.

NOTE: Subclasses should override the MetaTraversable.newTraversable() method instead of this method whenever possible. The reason for this is that the implementation of this method takes care of registering the Traversable returned by newTraversable() as an ApplyListener.

Implementations should return a new Traversable instance each time this method is called; specifically the implementation should not attempt to cache the returned Traversable because caching is the responsibility of the NavigableUIContainer that is rendering this Navigable.

By default, this method uses the Class that was specified when this Navigable was created and calls Class.newInstance() on that Class to create the new Traversable. If the class is null or the class does not implement a public default constructor or the newly created object cannot be cast to Traversable, this method will return an instance of DefaultTraversablePanel. If the class implements the ApplyListener interface, then the Traversable instance will be added as an ApplyListener to the NavigableUIContainer as well.

Overrides:

newTraversable in class MetaTraversable

Parameters:

applyNotifier - Subclasses that override this method can register an ApplyListener with the NavigableUIContainer.

Returns:

A Traversable which represents the detail UI component that is shown when the user selects this Navigable in the NavigableUIContainer.

getTraversableClass

public java.lang.Class getTraversableClass()

Description copied from class: MetaTraversable

Returns the class object of the described Traversable.

Overrides:

getTraversableClass in class MetaTraversable

isUsingTraversableDefaultConstructor

public boolean isUsingTraversableDefaultConstructor()

Description copied from class: MetaTraversable

Returns true of the construction of the associated Traversable uses its default constructor; returns false if a constructor other than the default is used.

Overrides:

isUsingTraversableDefaultConstructor in class MetaTraversable

mayHaveChildren

protected boolean mayHaveChildren(NavigableContext nc)

Description copied from class: Navigable

Overridable method to determine whether a Navigable may have children such that a + may be shown next to it in the tree. Implementations can override this when the result is known a priori and a call to getChildNavigables() could be expensive. The test should include detail Navigable instances as well if the NavigableContext specifies that detail nodes should be shown as children

Overrides:

mayHaveChildren in class Navigable

Parameters:

nc - The NavigableContext used to determine the context of the check

Returns:

true if the navigable may have children

appendChildNavigables

protected void appendChildNavigables(javax.swing.tree.DefaultMutableTreeNode parent,
                                     NavigableContext nc)

Description copied from class: Navigable

This method calls Navigable.getChildNavigables() to get the list of child Navigable objects. Then this method calls appendChildNodes to append the child Navigables to the specified parent.

Overrides:

appendChildNavigables in class Navigable

Parameters:

parent - The node to which the child nodes will be added.

nc - The NavigableContext in which this Navigable should render the child tree nodes.