oracle.dss.queryBuilder
Class StepTreeShuttlePanel

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ConditionsPanel

public abstract class StepTreeShuttlePanel

extends ShuttlePanel

This class handles the StepTreeShuttle panel in the QueryBuilder. This class is a superclass of the ConditionsPanel class. This class is the graphical user interface that list steps in a tree-like structure and allows shuttling.

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

StepTreeShuttlePanel(QueryBuilder queryBuilder, java.lang.String currentDimension, boolean isSelected)
Constructor that creates the StepTreeShuttlePanel based on the settings of the QueryBuilder's properties.

Method Summary

void	clearSelection() Clears the selection on the tree.
java.lang.Object[]	getAllItems() Retrieves the array of all items from the shuttle component.
java.lang.String	getCurrentDimension() Retrieves the current dimension.
java.lang.Object[]	getSelectedItems() Retrieves an array of Step objects that are selected on this panel.
Step	getSelectedStep() Retrieves the currently selected step.
javax.swing.JTree	getTree() Retrieves the JTree that is contained in this panel.
void	insertItems(java.lang.Object[] newItems) Inserts an array of Step objects into the tree.
boolean	isSelectableItemPresent() Indicates to the shuttle if any items that are suitable for shuttling are present.
void	moveSelectedNode(boolean moveUp) Moves the currently selected node up or down.
void	removeAllItems() Removes all the nodes in the tree.
void	removeSelectedItems() Removes the selected nodes from the tree.
void	resizeMainPnlToFitVisible() Resizes the width of the editor for the steps, when the splitter is resized.
boolean	setActive(boolean isActive) Specifies whether the component is active or inactive.
void	setCurrentDimension(java.lang.String newDimension) Specifies the current dimension.
void	setEnabled(boolean isEnabled) Specifies whether to enable the editing of the steps.

Methods inherited from class oracle.dss.queryBuilder.ShuttlePanel

fireFocusEvent, fireMouseEvent, getComponent, getHelpContextId, getImage, getImageIcon, getTitle, 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, 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

StepTreeShuttlePanel

public StepTreeShuttlePanel(QueryBuilder queryBuilder,
                            java.lang.String currentDimension,
                            boolean isSelected)

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

Parameters:

queryBuilder - A reference to the parent QueryBuilder bean.

currentDimension - The dimension for which the steps are displayed

isSelected - true if this panel is on the Selected side of the shuttle, false if this panel is on the Available side.

Method Detail

resizeMainPnlToFitVisible

public void resizeMainPnlToFitVisible()

Resizes the width of the editor for the steps, when the splitter is resized. Application developers should not call this method. It is for internal use only.

setCurrentDimension

public void setCurrentDimension(java.lang.String newDimension)

Specifies the current dimension.

Parameters:

newDimension - The unique name of the dimension.

getCurrentDimension

public java.lang.String getCurrentDimension()

Retrieves the current dimension.

Returns:

The current dimension.

setEnabled

public void setEnabled(boolean isEnabled)

Specifies whether to enable the editing of the steps.

Overrides:

setEnabled in class javax.swing.JComponent

Parameters:

isEnabled - true if editing is enabled, false is editing is disabled.

getSelectedStep

public Step getSelectedStep()

Retrieves the currently selected step.

Returns:

The currently selected Step object

getSelectedItems

public java.lang.Object[] getSelectedItems()

Retrieves an array of Step objects that are selected on this panel.

Overrides:

getSelectedItems in class ShuttlePanel

Returns:

An array of selected Step objects.

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 Step objects into the tree. If items in the array are not steps, then they are ignored.

Overrides:

insertItems in class ShuttlePanel

Parameters:

newItems - The array of Step objects to be inserted.

removeSelectedItems

public void removeSelectedItems()

Removes the selected nodes from the tree.

Overrides:

removeSelectedItems in class ShuttlePanel

removeAllItems

public void removeAllItems()

Removes all the nodes in the tree.

Overrides:

removeAllItems in class ShuttlePanel

clearSelection

public void clearSelection()

Clears the selection on the tree.

Overrides:

clearSelection in class ShuttlePanel

getTree

public javax.swing.JTree getTree()

Retrieves the JTree that is contained in this panel.

Returns:

The JTree component.

moveSelectedNode

public void moveSelectedNode(boolean moveUp)

Moves the currently selected node up or down.

Parameters:

moveUp - true if the node should move up, false if the node should move down.

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.

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.