oracle.dss.queryBuilder
Class TreeShuttlePanel

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.dss.queryBuilder.ShuttlePanel
                                |
                                +--oracle.dss.queryBuilder.TreeShuttlePanel

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

Direct Known Subclasses:

FavoritesPanel, ItemsTreeShuttlePanel

public class TreeShuttlePanel

extends ShuttlePanel

This class handles the TreeShuttle panel in the QueryBuilder.

See Also:

Serialized Form

Inner classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

TreeShuttlePanel(QueryBuilder queryBuilder)
Constructor that creates the TreeShuttlePanel based on the settings of the QueryBuilder's properties.

TreeShuttlePanel(QueryBuilder queryBuilder, boolean blnShowsRootHandles)
Constructor that creates the TreeShuttlePanel based on the settings of the QueryBuilder's properties and the root handles.

TreeShuttlePanel(QueryBuilder queryBuilder, java.lang.String curDimension)
Constructor that creates the TreeShuttlePanel based on the settings of the QueryBuilder's properties and the current dimension.

Method Summary

void	allCollapsing(javax.swing.tree.DefaultMutableTreeNode parent) Performs a collapse on all levels to the parent node.
void	clearSelection() Clears the selection from the shuttle component.
void	collapseAllToRoot() Performs a collapse on all levels to the root.
void	expandAllFromRoot() Performs an expand on all levels below the root down to the lowest level.
javax.swing.tree.DefaultMutableTreeNode	generateRootNode() Creates the root node and populates it with measures and dimensions.
java.lang.Object[]	getAllItems() Retrieves the array of all items from the shuttle component.
java.lang.String	getCurDimension() Retrieves the current dimension.
boolean	getPopupVisible() Retrieves whether the mouse popup is visible.
java.lang.Object[]	getSelectedItems() Retrieves an array of selected items from the shuttle component.
java.lang.String	getTitle() Retrieves the title of this panel.
javax.swing.JTree	getTree() Retrieves the JTree that is contained in this panel.
void	insertItems(java.lang.Object[] newItems) Inserts an array of items into the shuttle component.
boolean	isSelectableItemPresent() Indicates to the shuttle if any items that are suitable for shuttling are present.
void	refreshTree() Refreshes the tree with the new root TreeNode object.
void	removeAllItems() Removes all the nodes in the tree.
void	removeSelectedItems() Removes the selected nodes in the tree.
boolean	setActive(boolean isActive) Specifies whether the component is active or inactive.
void	setCurDimension(java.lang.String newDimension) Specifies the current dimension.
void	setPopupVisible(boolean bVisible) Specifies whether the mouse popup is visible.

Methods inherited from class oracle.dss.queryBuilder.ShuttlePanel

fireFocusEvent, fireMouseEvent, getComponent, getHelpContextId, getImage, getImageIcon, registerFocusListener, registerMouseListener, setAvailable, unregisterFocusListener, unregisterMouseListener, validateContents

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUIClassID, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setLayout, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, contains, createImage, createImage, dispatchEvent, enable, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TreeShuttlePanel

public TreeShuttlePanel(QueryBuilder queryBuilder,
                        java.lang.String curDimension)

Constructor that creates the TreeShuttlePanel based on the settings of the QueryBuilder's properties and the current dimension.

Parameters:

queryBuilder - A reference to the parent QueryBuilder bean.

curDimension - The dimension for which the steps are displayed.

TreeShuttlePanel

public TreeShuttlePanel(QueryBuilder queryBuilder)

Constructor that creates the TreeShuttlePanel based on the settings of the QueryBuilder's properties.

Parameters:

queryBuilder - A reference to the parent QueryBuilder bean.

TreeShuttlePanel

public TreeShuttlePanel(QueryBuilder queryBuilder,
                        boolean blnShowsRootHandles)

Constructor that creates the TreeShuttlePanel based on the settings of the QueryBuilder's properties and the root handles.

Parameters:

queryBuilder - A reference to the parent QueryBuilder bean.

blnShowRootHandles - true if this panel will show handles, for the root directory, false if it will not.

Method Detail

setCurDimension

public void setCurDimension(java.lang.String newDimension)

Specifies the current dimension.

Parameters:

newDimension - The unique name of the dimension.

getTree

public javax.swing.JTree getTree()

Retrieves the JTree that is contained in this panel.

Returns:

The JTree component.

getCurDimension

public java.lang.String getCurDimension()

Retrieves the current dimension.

Returns:

The current dimension.

generateRootNode

public javax.swing.tree.DefaultMutableTreeNode generateRootNode()

Creates the root node and populates it with measures and dimensions.

Returns:

The root note.

getSelectedItems

public java.lang.Object[] getSelectedItems()

Retrieves an array of selected items from the shuttle component.

Overrides:

getSelectedItems in class ShuttlePanel

Returns:

An array of selected items.

getAllItems

public java.lang.Object[] getAllItems()

Retrieves the array of all items from the shuttle component.

Overrides:

getAllItems in class ShuttlePanel

Returns:

An array of objects.

insertItems

public void insertItems(java.lang.Object[] newItems)

Inserts an array of items into the shuttle component.

Overrides:

insertItems in class ShuttlePanel

Parameters:

newItems - The array of items to be inserted.

removeSelectedItems

public void removeSelectedItems()

Removes the selected nodes in the tree.

Overrides:

removeSelectedItems in class ShuttlePanel

removeAllItems

public void removeAllItems()

Removes all the nodes in the tree.

Overrides:

removeAllItems in class ShuttlePanel

expandAllFromRoot

public void expandAllFromRoot()

Performs an expand on all levels below the root down to the lowest level.

collapseAllToRoot

public void collapseAllToRoot()

Performs a collapse on all levels to the root.

allCollapsing

public void allCollapsing(javax.swing.tree.DefaultMutableTreeNode parent)

Performs a collapse on all levels to the parent node.

Parameters:

parent - The parent to which the levels should collapse.

getTitle

public java.lang.String getTitle()

Retrieves the title of this panel.

Overrides:

getTitle in class ShuttlePanel

Returns:

The panel title.

clearSelection

public void clearSelection()

Clears the selection from the shuttle component.

Overrides:

clearSelection in class ShuttlePanel

setActive

public boolean setActive(boolean isActive)

Specifies whether the component is active or inactive.

Overrides:

setActive in class ShuttlePanel

Parameters:

isActive - true if the component is active, false if the component is inactive.

Returns:

true if the operation was successful, false otherwise.

refreshTree

public void refreshTree()

Refreshes the tree with the new root TreeNode object.

setPopupVisible

public void setPopupVisible(boolean bVisible)

Specifies whether the mouse popup is visible.

Parameters:

bVisible - true if the popup is visible, false if the popup is not visible.

getPopupVisible

public boolean getPopupVisible()

Retrieves whether the mouse popup is visible.

Returns:

true if the popup is visible, false if the popup is not visible.

isSelectableItemPresent

public boolean isSelectableItemPresent()

Indicates to the shuttle if any items that are suitable for shuttling are present.

Overrides:

isSelectableItemPresent in class ShuttlePanel

Returns:

true if items to shuttle are available, false if no items are available for shuttling.