oracle.dss.queryBuilder
Class DimensionListShuttlePanel

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

All Implemented Interfaces:

javax.accessibility.Accessible, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.PropertyChangeListener, QueryAccessListener, java.io.Serializable

Direct Known Subclasses:

MembersPanel, PreviewPanel, StepsPanel

public class DimensionListShuttlePanel

extends ShuttlePanel

implements java.beans.PropertyChangeListener, QueryAccessListener

This class provides shuttling behavior for panels that have dimension members and that work in the QueryBuilder. These dimension members are displayed using the DimensionList.

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

DimensionListShuttlePanel(QueryBuilder queryBuilder, DimensionPanel dimensionPanel, boolean blnAvailable)
Constructor that creates the DimensionListShuttlePanel based on the settings of the QueryBuilder's properties.

DimensionListShuttlePanel(QueryBuilder queryBuilder, java.lang.String curDimension, boolean blnAvailable)
Constructor that creates the DimensionListShuttlePanel based on the settings of the QueryBuilder's properties.

Method Summary

void	clearSelection() Deselects any items that are currently selected.
void	dataAccessChanged(DataAccessChangedEvent e) Called when a DataAccess cursor in the QueryAccess (either available or selection) changes due to a selection change coupled with a request for the cursor by a client.
void	dimensionsChanged(DimensionsChangedEvent e) Called when the dimensionality of the QueryAccess has changed.
java.lang.Object[]	getAllItems() Retrieves the array of all items from this panel.
java.lang.Object[]	getAllItems(int intAction) Retrieves the array of all items from this panel.
java.lang.String	getCurDimension() Retrieves the current dimension.
java.lang.Object[]	getSelectedItems() Retrieves an array of objects that are selected on this panel.
java.lang.Object[]	getSelectedItems(int intAction) Retrieves an array of objects that are selected on this panel.
java.lang.String	getTitle() Retrieves the title of this panel.
void	insertItems(java.lang.Object[] newItems) Inserts an array of Step objects into the panel.
boolean	isSelectableItemPresent() Indicates to the shuttle if any items that are suitable for shuttling are present.
void	removeAllItems() Removes all the items.
void	removeSelectedItems() Removes the selected items.
void	selectionChanged(SelectionChangedEvent e) Called when a selection in the QueryAccess (either available or selected) is changed with a resulting change in cursor data.
boolean	setActive(boolean isActive) Specifies whether the component is active or inactive.
void	setCurrentDimension(java.lang.String strDimension) Specifies the current dimension and refreshes the steps based on the new setting.
void	setHierarchy(java.lang.String strHierarchy) Specifies the hierarchy for this panel.

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

Methods inherited from interface java.beans.PropertyChangeListener

propertyChange

Constructor Detail

DimensionListShuttlePanel

public DimensionListShuttlePanel(QueryBuilder queryBuilder,
                                 java.lang.String curDimension,
                                 boolean blnAvailable)

Constructor that creates the DimensionListShuttlePanel based on the settings of the QueryBuilder's properties. The constructor creates a JTree, populates it with data, and assigns various default properties to the tree.

Parameters:

queryBuilder - A reference to the parent QueryBuilder bean.

curDimension - The current dimension to display.

blnAvailable - true if this panel will show available lists, false if it will not.

DimensionListShuttlePanel

public DimensionListShuttlePanel(QueryBuilder queryBuilder,
DimensionPanel dimensionPanel,
                                 boolean blnAvailable)

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

Parameters:

queryBuilder - A reference to the parent QueryBuilder bean.

dimensionPanel - The parent of this DimensionListShuttlePanel.

blnAvailable - true if this panel will show available lists, false if it will not.

Method Detail

setCurrentDimension

public void setCurrentDimension(java.lang.String strDimension)

Specifies the current dimension and refreshes the steps based on the new setting.

Parameters:

strDimension - The unique name of the new dimension.

getCurDimension

public java.lang.String getCurDimension()

Retrieves the current dimension.

Returns:

The unique name of the current dimension.

getSelectedItems

public java.lang.Object[] getSelectedItems(int intAction)

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

Parameters:

intAction - The action that is associated with the objects.

Returns:

An array of selected objects.

getAllItems

public java.lang.Object[] getAllItems(int intAction)

Retrieves the array of all items from this panel. The items in the array are MemberSteps, and their actions (add, keep, remove) are determined by the action that is passed into the method.

Parameters:

intAction - The action that is associated with the MemberSteps.

Returns:

An array of objects.

getSelectedItems

public java.lang.Object[] getSelectedItems()

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

Overrides:

getSelectedItems in class ShuttlePanel

Returns:

An array of selected objects.

getAllItems

public java.lang.Object[] getAllItems()

Retrieves the array of all items from this panel. The items in the array are MemberSteps.

Overrides:

getAllItems in class ShuttlePanel

Returns:

An array of objects.

setHierarchy

public void setHierarchy(java.lang.String strHierarchy)

Specifies the hierarchy for this panel.

Parameters:

strHierarchy - The hierarchy for the items of this panel.

insertItems

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

Inserts an array of Step objects into the panel. If the items in the array are not Steps, then they are ignored.

Overrides:

insertItems in class ShuttlePanel

Parameters:

newItems - An array of Step objects.

removeSelectedItems

public void removeSelectedItems()

Removes the selected items.

Overrides:

removeSelectedItems in class ShuttlePanel

removeAllItems

public void removeAllItems()

Removes all the items.

Overrides:

removeAllItems in class ShuttlePanel

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()

Deselects any items that are currently selected.

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<\code> if the operation was successful, false<\code> otherwise.

selectionChanged

public void selectionChanged(SelectionChangedEvent e)

Called when a selection in the QueryAccess (either available or selected) is changed with a resulting change in cursor data.

Specified by:

selectionChanged in interface QueryAccessListener

Parameters:

e - The event that provides the new selection.

dataAccessChanged

public void dataAccessChanged(DataAccessChangedEvent e)

Called when a DataAccess cursor in the QueryAccess (either available or selection) changes due to a selection change coupled with a request for the cursor by a client.

Specified by:

dataAccessChanged in interface QueryAccessListener

Parameters:

e - The event that provides the new DataAccess.

dimensionsChanged

public void dimensionsChanged(DimensionsChangedEvent e)

Called when the dimensionality of the QueryAccess has changed.

Specified by:

dimensionsChanged in interface QueryAccessListener

Parameters:

e - The event that describes the dimensionality change.

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.