oracle.dss.queryBuilder
Class FavoritesPanel

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

All Implemented Interfaces:

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

public class FavoritesPanel

extends TreeShuttlePanel

This class handles the Favorites 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

FavoritesPanel(QueryBuilder queryBuilder, java.lang.String strDimension)
Constructor that creates the FavoritesPanel based on the settings of the QueryBuilder's properties.

Method Summary

interface	createModel() Creates the root node and populates it with selections and the folders in which the selections are stored.
java.lang.Object[]	getAllItems() Retrieves the array of all favorites for the current dimension.
javax.swing.ImageIcon	getImageIcon() Retrieves the image icon for this panel.
java.lang.Object[]	getSelectedItems() Retrieves an array of Step objects that are selected on this panel.
java.lang.String	getTitle() Retrieves the title of the panel.
boolean	isSelectableItemPresent() Indicates to the shuttle if any items that are suitable for shuttling are present.
void	reloadFavorites() Specifies a new model on the tree and updates its expansion listener.
boolean	setActive(boolean isActive) Specifies whether the component is active or inactive.
void	setCurrentDimension(java.lang.String strDimension) Specifies the current dimension.

Methods inherited from class oracle.dss.queryBuilder.TreeShuttlePanel

allCollapsing, clearSelection, collapseAllToRoot, expandAllFromRoot, generateRootNode, getCurDimension, getPopupVisible, getTree, insertItems, refreshTree, removeAllItems, removeSelectedItems, setCurDimension, setPopupVisible

Methods inherited from class oracle.dss.queryBuilder.ShuttlePanel

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

FavoritesPanel

public FavoritesPanel(QueryBuilder queryBuilder,
                      java.lang.String strDimension)

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

Parameters:

queryBuilder - A reference to the parent QueryBuilder bean.

strDimension - The dimension for which the favorites are displayed.

Method Detail

setCurrentDimension

public void setCurrentDimension(java.lang.String strDimension)

Specifies the current dimension.

Parameters:

strDimension - The unique name of the dimension.

setActive

public boolean setActive(boolean isActive)

Specifies whether the component is active or inactive.

Overrides:

setActive in class TreeShuttlePanel

Parameters:

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

Returns:

true if the operation was successful, false otherwise.

getSelectedItems

public java.lang.Object[] getSelectedItems()

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

Overrides:

getSelectedItems in class TreeShuttlePanel

Returns:

An array of selected Step objects.

getAllItems

public java.lang.Object[] getAllItems()

Retrieves the array of all favorites for the current dimension. The items in the array are MemberSteps.

Overrides:

getAllItems in class TreeShuttlePanel

Returns:

An array of objects.

reloadFavorites

public void reloadFavorites()

Specifies a new model on the tree and updates its expansion listener. Application developers should not call this method; it is for internal use only.

createModel

public createModel()

Creates the root node and populates it with selections and the folders in which the selections are stored. Application developers should not call this method; it is for internal use only.

Returns:

A DefaultMutableTreeNode value that represents the updated tree.

getTitle

public java.lang.String getTitle()

Retrieves the title of the panel.

Overrides:

getTitle in class TreeShuttlePanel

Returns:

The panel title.

getImageIcon

public javax.swing.ImageIcon getImageIcon()

Retrieves the image icon for this panel.

Overrides:

getImageIcon in class ShuttlePanel

Returns:

The icon to be displayed for this panel.

isSelectableItemPresent

public boolean isSelectableItemPresent()

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

Overrides:

isSelectableItemPresent in class TreeShuttlePanel

Returns:

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