Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


oracle.dss.queryBuilder
Class ShuttlePanel

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.dss.queryBuilder.ShuttlePanel
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable
Direct Known Subclasses:
DimensionListShuttlePanel, StepTreeShuttlePanel, TreeShuttlePanel

public class ShuttlePanel
extends javax.swing.JPanel

This class handles the Shuttle 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
ShuttlePanel(QueryBuilder queryBuilder)
          Constructor that creates the ShuttlePanel based on the settings of the QueryBuilder's properties.
ShuttlePanel(QueryBuilder queryBuilder, java.awt.LayoutManager layoutManager)
          Constructor that creates the ShuttlePanel based on the settings of the QueryBuilder's properties and on the LayoutManager.

 

Method Summary
 void clearSelection()
          Clears the selection from the shuttle component.
 void fireFocusEvent(java.awt.event.FocusEvent e)
          Dispatches a focus event to all listeners.
 void fireMouseEvent(java.awt.event.MouseEvent e)
          Dispatches a mouse event to all listeners.
 java.lang.Object[] getAllItems()
          Retrieves the array of all items from the shuttle component.
 java.awt.Component getComponent()
          Retrieves the component that is associated with the ShuttlePanel.
 java.lang.String getHelpContextId()
          Retrieves the Help context ID for this panel.
 java.awt.Image getImage()
          Retrieves the image for this panel.
 javax.swing.ImageIcon getImageIcon()
          Retrieves the image icon for this panel.
 java.lang.Object[] getSelectedItems()
          Retrieves an array of selected items from the shuttle component.
 java.lang.String getTitle()
          Retrieves the title of 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 registerFocusListener(java.awt.event.FocusListener listener)
          Adds classes that want to be notified when a particular component in the ShuttlePanel gains focus.
 void registerMouseListener(java.awt.event.MouseListener listener)
          Adds classes that want to be notified when a particular component in the ShuttlePanel generates a mouse event.
 void removeAllItems()
          Removes all the items from the shuttle component.
 void removeSelectedItems()
          Removes the selected items from the shuttle component.
 boolean setActive(boolean bIsActive)
          Specifies whether the component is active or inactive.
 void setAvailable(boolean blnAvailable)
          Specifies whether the panel is available.
 void unregisterFocusListener(java.awt.event.FocusListener listener)
          Removes classes that do not want to be notified when a particular component in the ShuttlePanel gains focus.
 void unregisterMouseListener(java.awt.event.MouseListener listener)
          Removes classes that do not want to be notified when a particular component in the ShuttlePanel generates a mouse event.
 boolean validateContents(java.lang.Object hintValidate)
          Validates the contents of the panel.

 

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

ShuttlePanel

public ShuttlePanel(QueryBuilder queryBuilder,
                    java.awt.LayoutManager layoutManager)
Constructor that creates the ShuttlePanel based on the settings of the QueryBuilder's properties and on the LayoutManager.
Parameters:
queryBuilder - A reference to the parent QueryBuilder bean.
layoutManager - The LayoutManager that is used for the panel.

ShuttlePanel

public ShuttlePanel(QueryBuilder queryBuilder)
Constructor that creates the ShuttlePanel based on the settings of the QueryBuilder's properties.
Parameters:
queryBuilder - A reference to the parent QueryBuilder bean.
Method Detail

setAvailable

public void setAvailable(boolean blnAvailable)
Specifies whether the panel is available.
Parameters:
blnAvailable - true if the panel is available, false if the panel is not available.

registerFocusListener

public void registerFocusListener(java.awt.event.FocusListener listener)
Adds classes that want to be notified when a particular component in the ShuttlePanel gains focus.
Parameters:
listener - The listener that waits for the panel to gain focus.

unregisterFocusListener

public void unregisterFocusListener(java.awt.event.FocusListener listener)
Removes classes that do not want to be notified when a particular component in the ShuttlePanel gains focus.
Parameters:
listener - The listener that waits for the panel to gain focus.

registerMouseListener

public void registerMouseListener(java.awt.event.MouseListener listener)
Adds classes that want to be notified when a particular component in the ShuttlePanel generates a mouse event.
Parameters:
listener - The listener that waits for the panel to generate an event.

unregisterMouseListener

public void unregisterMouseListener(java.awt.event.MouseListener listener)
Removes classes that do not want to be notified when a particular component in the ShuttlePanel generates a mouse event.
Parameters:
listener - The listener that waits for the panel to generate an event.

fireFocusEvent

public void fireFocusEvent(java.awt.event.FocusEvent e)
Dispatches a focus event to all listeners.
Parameters:
e - The event to dispatch.

fireMouseEvent

public void fireMouseEvent(java.awt.event.MouseEvent e)
Dispatches a mouse event to all listeners.
Parameters:
e - The event to dispatch.

getComponent

public java.awt.Component getComponent()
Retrieves the component that is associated with the ShuttlePanel.
Returns:
The component.

getHelpContextId

public java.lang.String getHelpContextId()
Retrieves the Help context ID for this panel. The default Help context ID is the full class path for this panel. To set a different Help context ID, use method setHelpContextID(String). The Help context ID is used when listening for the user event to display Help for this panel.
Returns:
The Help context ID for this panel

getSelectedItems

public java.lang.Object[] getSelectedItems()
Retrieves an array of selected items from the shuttle component.
Returns:
An array of selected items.

getAllItems

public java.lang.Object[] getAllItems()
Retrieves the array of all items from the shuttle component.
Returns:
An array of objects.

insertItems

public void insertItems(java.lang.Object[] newItems)
Inserts an array of items into the shuttle component.
Parameters:
newItems - The array of items to be inserted.

removeSelectedItems

public void removeSelectedItems()
Removes the selected items from the shuttle component.

removeAllItems

public void removeAllItems()
Removes all the items from the shuttle component.

clearSelection

public void clearSelection()
Clears the selection from the shuttle component.

isSelectableItemPresent

public boolean isSelectableItemPresent()
Indicates to the shuttle if any items that are suitable for shuttling are present.
Returns:
true if items to shuttle are available, false if no items are available for shuttling.

getImageIcon

public javax.swing.ImageIcon getImageIcon()
Retrieves the image icon for this panel.
Returns:
The icon to be displayed for this panel.

getImage

public java.awt.Image getImage()
Retrieves the image for this panel. Typically this image is displayed on the left side of a wizard.
Returns:
The image to be displayed for this panel.

getTitle

public java.lang.String getTitle()
Retrieves the title of this panel.
Returns:
The panel title.

setActive

public boolean setActive(boolean bIsActive)
Specifies whether the component is active or inactive.
Parameters:
bIsActive - true if the component is active, false if the component is inactive.
Returns:
true if the operation was successful, false otherwise.

validateContents

public boolean validateContents(java.lang.Object hintValidate)
Validates the contents of the panel.
Parameters:
hintValidate - A hint object to help in the validation process.
Returns:
true if the operation was successful, false if the operation was not successful.

Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


Copyright © 2003, Oracle. All Rights Reserved.