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


oracle.dss.datautil.gui.dialog
Class MeasureListDialog

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--javax.swing.JDialog
                                |
                                +--oracle.bali.ewt.dialog.JEWTDialog
                                      |
                                      +--oracle.dss.datautil.gui.StandardDialog
                                            |
                                            +--oracle.dss.datautil.gui.dialog.MeasureListDialog
All Implemented Interfaces:
javax.accessibility.Accessible, HelpContext, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public class MeasureListDialog
extends StandardDialog

Allows a user to select from a list of measures. The MeasureListDialog wraps the MeasureListPanel in a dialog that the user can invoke. Use the MeasureListDialog when you want to display a list of measures, allow the user to select one, then have the dialog disappear.

See Also:
MeasureListPanel, Serialized Form

Fields inherited from class oracle.dss.datautil.gui.StandardDialog
CANCEL, OK, UNDEFINED

 

Fields inherited from class oracle.bali.ewt.dialog.JEWTDialog
ACTION_APPLY, BUTTON_APPLY, BUTTON_CANCEL, BUTTON_CLOSE, BUTTON_DEFAULT, BUTTON_HELP, BUTTON_NONE, BUTTON_OK, PROPERTY_CLOSED

 

Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

 

Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

 

Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

 

Constructor Summary
MeasureListDialog(java.awt.Dialog parent, MetadataManager metadataManager, java.awt.Component component, java.lang.String strTitle, boolean blnModal, BIFilter filter)
          Constructor that specifies all arguments for displaying the MeasureListDialog with a dialog as its parent.
MeasureListDialog(java.awt.Frame parent, MetadataManager metadataManager, java.awt.Component component, java.lang.String strTitle, boolean blnModal, BIFilter filter)
          Constructor that specifies all arguments for displaying the MeasureListDialog with a frame as its parent.
MeasureListDialog(MetadataManager metadataManager, java.awt.Component component)
          Deprecated. As of 2.6.0.21, replaced by MeasureListDialog(Dialog, MetadataManager, Component, String, boolean, BIFilter) or by MeasureListDialog(Frame, MetadataManager, Component, String, boolean, BIFilter).
MeasureListDialog(MetadataManager metadataManager, java.awt.Component component, BIFilter filter)
          Deprecated. As of 2.6.0.21, replaced by MeasureListDialog(Dialog, MetadataManager, Component, String, boolean, BIFilter) or by MeasureListDialog(Frame, MetadataManager, Component, String, boolean, BIFilter).
MeasureListDialog(MetadataManager metadataManager, java.awt.Component component, java.lang.String strTitle, boolean blnModal)
          Deprecated. As of 2.6.0.21, replaced by MeasureListDialog(Dialog, MetadataManager, Component, String, boolean, BIFilter) or by MeasureListDialog(Frame, MetadataManager, Component, String, boolean, BIFilter).
MeasureListDialog(MetadataManager metadataManager, java.awt.Component component, java.lang.String strTitle, boolean blnModal, BIFilter filter)
          Deprecated. As of 2.6.0.21, replaced by MeasureListDialog(Dialog, MetadataManager, Component, String, boolean, BIFilter) or by MeasureListDialog(Frame, MetadataManager, Component, String, boolean, BIFilter).

 

Method Summary
 int display()
          Displays this MeasureListDialog so that it is centered over the component that invokes it, which is often a button.
 MeasureListPanel getMeasureListPanel()
          Retrieves the MeasureListPanel object that is used to display the folders and measures.
 java.lang.String getSelectedMeasure()
          Retrieves the String that represents a single measure.
 java.lang.String[] getSelectedMeasures()
          Retrieves an array that contains a list of all the selected measures.
 void setLocale(java.util.Locale locale)
          Specifies the locale that this MeasureListDialog uses.

 

Methods inherited from class oracle.dss.datautil.gui.StandardDialog
display, getHelpContextID, getHelpProvider, getReturnCode, setContent, setHelpContextID, setHelpProvider

 

Methods inherited from class oracle.bali.ewt.dialog.JEWTDialog
addActionListener, addCustomButton, addNotify, addPropertyChangeListener, addVetoableChangeListener, createDialog, dispose, getAccessibleContext, getButtonMask, getButtonMnemonic, getCancelButtonMnemonic, getCancelButtonText, getCenterOver, getContent, getCustomButton, getCustomButtonCount, getDefaultButton, getInitialFocus, getMaximunInitialSize, getMinimumSize, getOKButtonMnemonic, getOKButtonText, getPreferredSize, isCancelled, isDialogClosingEvent, isOKButtonEnabled, pack, removeActionListener, removeCustomButton, removePropertyChangeListener, removeVetoableChangeListener, runDialog, setButtonMask, setCancelButtonMnemonic, setCancelButtonText, setCenterOver, setDefaultButton, setInitialFocus, setMaximumInitialSize, setMaximumInitialSize, setMinimumSize, setMinimumSize, setOKButtonEnabled, setOKButtonMnemonic, setOKButtonText, setPreferredSize, setPreferredSize

 

Methods inherited from class javax.swing.JDialog
getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, remove, setContentPane, setDefaultCloseOperation, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setLocationRelativeTo, update

 

Methods inherited from class java.awt.Dialog
getTitle, hide, isModal, isResizable, setModal, setResizable, setTitle, show

 

Methods inherited from class java.awt.Window
addWindowListener, applyResourceBundle, applyResourceBundle, getFocusOwner, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getOwnedWindows, getOwner, getToolkit, getWarningString, isShowing, postEvent, removeWindowListener, setCursor, toBack, toFront

 

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, removeNotify, setFont, validate

 

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, disable, dispatchEvent, enable, enable, enableInputMethods, getBackground, getBounds, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputMethodRequests, getLocation, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setForeground, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Constructor Detail

MeasureListDialog

public MeasureListDialog(java.awt.Dialog parent,
MetadataManager metadataManager,
                         java.awt.Component component,
                         java.lang.String strTitle,
                         boolean blnModal,
BIFilter filter)
Constructor that specifies all arguments for displaying the MeasureListDialog with a dialog as its parent.
Parameters:
parent - The dialog to serve as the parent.
metadataManager - A MetadataManager object that is used for populating the tree with folders and measures.
component - The component over which the MeasureListDialog is centered when it is displayed.
strTitle - The title for the dialog.
blnModal - true if the dialog is modal, false if the dialog is not modal.
filter - A BIFilter object that filters the tree model.

MeasureListDialog

public MeasureListDialog(java.awt.Frame parent,
MetadataManager metadataManager,
                         java.awt.Component component,
                         java.lang.String strTitle,
                         boolean blnModal,
BIFilter filter)
Constructor that specifies all arguments for displaying the MeasureListDialog with a frame as its parent.
Parameters:
parent - The frame to serve as the parent.
metadataManager - A MetadataManager object that is used for populating the tree with folders and measures.
component - The component over which the MeasureListDialog is centered when it is displayed.
strTitle - The title for the dialog.
blnModal - true if the dialog is modal, false if the dialog is not modal.
filter - A BIFilter object that filters the tree model.

MeasureListDialog

public MeasureListDialog(MetadataManager metadataManager,
                         java.awt.Component component,
                         java.lang.String strTitle,
                         boolean blnModal,
BIFilter filter)
Deprecated. As of 2.6.0.21, replaced by MeasureListDialog(Dialog, MetadataManager, Component, String, boolean, BIFilter) or by MeasureListDialog(Frame, MetadataManager, Component, String, boolean, BIFilter).
A MeasureListDialog should have a parent dialog or frame associated with it to ensure proper focus handling. Use the constructor that accepts all arguments.
Parameters:
metadataManager - A MetadataManager object that is used for populating the tree with folders and measures.
component - The component over which the MeasureListDialog is centered when it is displayed.
strTitle - The title for the dialog.
blnModal - true if the dialog is modal, false if the dialog is not modal.
filter - A BIFilter object that filters the tree model.

MeasureListDialog

public MeasureListDialog(MetadataManager metadataManager,
                         java.awt.Component component,
                         java.lang.String strTitle,
                         boolean blnModal)
Deprecated. As of 2.6.0.21, replaced by MeasureListDialog(Dialog, MetadataManager, Component, String, boolean, BIFilter) or by MeasureListDialog(Frame, MetadataManager, Component, String, boolean, BIFilter).
A MeasureListDialog should have a parent dialog or frame associated with it to ensure proper focus handling. Use the constructor that accepts all arguments.
Parameters:
metadataManager - A MetadataManager object that is used for populating the tree with folders and measures.
component - The component over which the MeasureListDialog is centered when it is displayed.
strTitle - The title for the dialog.
blnModal - true if the dialog is modal, false if the dialog is not modal.

MeasureListDialog

public MeasureListDialog(MetadataManager metadataManager,
                         java.awt.Component component,
BIFilter filter)
Deprecated. As of 2.6.0.21, replaced by MeasureListDialog(Dialog, MetadataManager, Component, String, boolean, BIFilter) or by MeasureListDialog(Frame, MetadataManager, Component, String, boolean, BIFilter).
A MeasureListDialog should have a parent dialog or frame associated with it to ensure proper focus handling. Use the constructor that accepts all arguments.
Parameters:
metadataManager - A MetadataManager object that is used for populating the tree with folders and measures.
component - The component over which the MeasureListDialog is centered when it is displayed.

MeasureListDialog

public MeasureListDialog(MetadataManager metadataManager,
                         java.awt.Component component)
Deprecated. As of 2.6.0.21, replaced by MeasureListDialog(Dialog, MetadataManager, Component, String, boolean, BIFilter) or by MeasureListDialog(Frame, MetadataManager, Component, String, boolean, BIFilter).
A MeasureListDialog should have a parent dialog or frame associated with it to ensure proper focus handling. Use the constructor that accepts all arguments.
Parameters:
metadataManager - A MetadataManager object that is used for populating the tree with folders and measures.
component - The component over which the MeasureListDialog is centered when it is displayed.
Method Detail

getMeasureListPanel

public MeasureListPanel getMeasureListPanel()
Retrieves the MeasureListPanel object that is used to display the folders and measures.
Returns:
The MeasureListPanel object.

display

public int display()
Displays this MeasureListDialog so that it is centered over the component that invokes it, which is often a button. You set the component to invoke this dialog in a constructor of this class.
Returns:
A constant that represents OK or CANCEL. The valid constants are:
  • OK
  • CANCEL
See Also:
StandardDialog.OK, StandardDialog.CANCEL

getSelectedMeasure

public java.lang.String getSelectedMeasure()
Retrieves the String that represents a single measure. If only one measure is selected, then it retrieves that measure. If multiple measures are selected, then it retrieves the first selected measure.
Returns:
The selected measure.

getSelectedMeasures

public java.lang.String[] getSelectedMeasures()
Retrieves an array that contains a list of all the selected measures. If only one measure is selected, then it retrieves an array of size 1 that contains the selected measure. If multiple measures are selected, then it retrieves an appropriately sized array that contains all the selected measures.
Returns:
The list of the selected measures.

setLocale

public void setLocale(java.util.Locale locale)
Specifies the locale that this MeasureListDialog uses.
Overrides:
setLocale in class java.awt.Component
Parameters:
locale - The Locale for this MeasureListDialog.

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


Copyright © 2003, Oracle. All Rights Reserved.